Site Tools


help_root

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
help_root [2017/07/06 02:01]
127.0.0.1 external edit
help_root [2018/10/16 02:00] (current)
150.101.89.227 Clean up displayed text of links
Line 6: Line 6:
 to help!  Anonymous editing of the help files is not allowed at this time.  ​ to help!  Anonymous editing of the help files is not allowed at this time.  ​
  
-If you're new to epic, you can read [[getting_started]]+If you're new to EPIC, you can read [[getting_started]].
- +
-+
- +
-.+
  
 Enjoy! Enjoy!
Line 51: Line 47:
 |[[admin]]|Ask the server how to contact the server admin.| |[[admin]]|Ask the server how to contact the server admin.|
 |[[connect_command|connect]]|Ask a server on the network to link to another server not on the network (oper only).| |[[connect_command|connect]]|Ask a server on the network to link to another server not on the network (oper only).|
-|[[ctcp_action]]|Tell someone or a channel what you are doing.| +|[[ctcp_action|ctcp action]]|Tell someone or a channel what you are doing.| 
-|[[ctcp_clientinfo]]|Ask another client what ctcp commands they support.| +|[[ctcp_clientinfo|ctcp clientinfo]]|Ask another client what ctcp commands they support.| 
-|[[ctcp_echo]]|Ask another client to send you a string back.| +|[[ctcp_echo|ctcp echo]]|Ask another client to send you a string back.| 
-|[[ctcp_finger]]|Ask another client about the man behind the mask.| +|[[ctcp_finger|ctcp finger]]|Ask another client about the man behind the mask.| 
-|[[ctcp_ping]]|Ask another client to respond, to measure lag time.| +|[[ctcp_ping|ctcp ping]]|Ask another client to respond, to measure lag time.| 
-|[[ctcp_time]]|Ask another client what time they think it is.| +|[[ctcp_time|ctcp time]]|Ask another client what time they think it is.| 
-|[[ctcp_userinfo]]|Ask another client for its user-customizable string.| +|[[ctcp_userinfo|ctcp userinfo]]|Ask another client for its user-customizable string.| 
-|[[ctcp_utc]]|Tell another client to insert the current time here.| +|[[ctcp_utc|ctcp utc]]|Tell another client to insert the current time here.| 
-|[[ctcp_version]]|Ask another client what software version it is.| +|[[ctcp_version|ctcp version]]|Ask another client what software version it is.| 
-|[[dcc_chat]]|Initiate a private conversation with someone outside of irc.| +|[[dcc_chat|dcc chat]]|Initiate a private conversation with someone outside of irc.| 
-|[[dcc_close]]|Terminate a dcc session.| +|[[dcc_close|dcc close]]|Terminate a dcc session.| 
-|[[dcc_closeall]]|Terminate every dcc session.| +|[[dcc_closeall|dcc closeall]]|Terminate every dcc session.| 
-|[[dcc_list]]|Show all of the dcc sessions.| +|[[dcc_list|dcc list]]|Show all of the dcc sessions.| 
-|[[dcc_raw]]|Send data to a dcc socket connection.| +|[[dcc_raw|dcc raw]]|Send data to a dcc socket connection.| 
-|[[dcc_rename]]|Change the nickname associated with a dcc session.|+|[[dcc_rename|dcc rename]]|Change the nickname associated with a dcc session.|
 |[[deop]]|Revoke your own irc operatorship privileges (oper only)| |[[deop]]|Revoke your own irc operatorship privileges (oper only)|
 |[[describe]]|Tell another nick what you are doing with a [[ctcp action]].| |[[describe]]|Tell another nick what you are doing with a [[ctcp action]].|
Line 71: Line 67:
 |[[flush]]|Suppress display of stuff coming from the server when you're being flooded.| |[[flush]]|Suppress display of stuff coming from the server when you're being flooded.|
 |[[hostname]]|Change your virtual hostname.| |[[hostname]]|Change your virtual hostname.|
-|[[info_command]]|Ask the client and server about the software you're using.|+|[[info_command|info]]|Ask the client and server about the software you're using.|
 |[[ison]]|Ask the server if nicknames in a list are on the network.| |[[ison]]|Ask the server if nicknames in a list are on the network.|
 |[[kill]]|Remove someone from the irc network. (oper only)| |[[kill]]|Remove someone from the irc network. (oper only)|
Line 78: Line 74:
 |[[load]]|Import and run commands from a file.| |[[load]]|Import and run commands from a file.|
 |[[lusers]]|Ask the server how many users and servers are on the network.| |[[lusers]]|Ask the server how many users and servers are on the network.|
-|[[map_command]]|Ask the server to show you the topology of the network.|+|[[map_command|map]]|Ask the server to show you the topology of the network.|
 |[[mesg]]|Permit or revoke global write access to your pty.| |[[mesg]]|Permit or revoke global write access to your pty.|
-|[[motd_command]]|Ask the server for the Message Of The Day.|+|[[motd_command|motd]]|Ask the server for the Message Of The Day.|
 |[[names]]|Ask the server about who is on what channels.| |[[names]]|Ask the server about who is on what channels.|
 |[[note]]|Leave a message for someone when they are away (rare)| |[[note]]|Leave a message for someone when they are away (rare)|
Line 94: Line 90:
 |[[squit]]|Remove a server from the network. (oper only)| |[[squit]]|Remove a server from the network. (oper only)|
 |[[stats]]|Ask the server for statistics (oper only)| |[[stats]]|Ask the server for statistics (oper only)|
-|[[time_command]]|Ask the server what time it thinks it is.|+|[[time_command|time]]|Ask the server what time it thinks it is.|
 |[[trace]]|Create a traceroute to a remote server (oper only)| |[[trace]]|Create a traceroute to a remote server (oper only)|
 |[[uping]]|Ping the server.| |[[uping]]|Ping the server.|
-|[[userhost_command]]|Ask the server for a nick's userhost.|+|[[userhost_command|userhost]]|Ask the server for a nick's userhost.|
 |[[userip]]|Ask the server for a nick's ip address.| |[[userip]]|Ask the server for a nick's ip address.|
 |[[usrip]]|Ask the server for a nick's ip address.| |[[usrip]]|Ask the server for a nick's ip address.|
-|[[version_command]]|Ask the server what software it is using.|+|[[version_command|version]]|Ask the server what software it is using.|
 |[[wallchops]]|Send a message to channel operators.| |[[wallchops]]|Send a message to channel operators.|
 |[[wallops]]|Send a message to all irc operators (oper only).| |[[wallops]]|Send a message to all irc operators (oper only).|
Line 106: Line 102:
 ======Commands====== ======Commands======
 |[[abort]]|Kill the client with SIGABRT (trap to gdb)| |[[abort]]|Kill the client with SIGABRT (trap to gdb)|
-|[[alias_command]]|Create your own commands|+|[[alias_command|alias]]|Create your own commands|
 |[[allocdump]]|Write debug info about malloc()s to file| |[[allocdump]]|Write debug info about malloc()s to file|
 |[[assign]]|Create your own variables| |[[assign]]|Create your own variables|
Line 174: Line 170:
 |[[echo]]|Display something to a window.| |[[echo]]|Display something to a window.|
 |[[eval]]|Expand variables in a statement again and execute it.| |[[eval]]|Expand variables in a statement again and execute it.|
-|[[exec_command]]|Run unix commands in a subshell.|+|[[exec_command|exec]]|Run unix commands in a subshell.|
 |[[fe]]|Iterate over a word list| |[[fe]]|Iterate over a word list|
 |[[fec]]|Iterate over the characters in a string| |[[fec]]|Iterate over the characters in a string|
Line 286: Line 282:
 |[[parsekey]]|Execute a keybinding by name.| |[[parsekey]]|Execute a keybinding by name.|
 |[[pause]]|Nonblocking sleep for a time, or until the user presses a key.| |[[pause]]|Nonblocking sleep for a time, or until the user presses a key.|
-|[[perl_command]]|Run something in a perl interpreter.| +|[[perl_command|perl]]|Run something in a perl interpreter.| 
-|[[pop_command]]|Remove the last word from a variable.|+|[[pop_command|pop]]|Remove the last word from a variable.|
 |[[pretend]]|Pretend the server just sent the client a string.| |[[pretend]]|Pretend the server just sent the client a string.|
-|[[push_command]]|Add a word to the end of a variable.|+|[[push_command|push]]|Add a word to the end of a variable.|
 |[[queue]]|Add a command to a named queue for executing later.| |[[queue]]|Add a command to a named queue for executing later.|
 |[[quote]]|Send a string directly to the server.| |[[quote]]|Send a string directly to the server.|
 |[[rbind]]|Display all of the sequences bound to a keybinding.| |[[rbind]]|Display all of the sequences bound to a keybinding.|
-|[[repeat_command]]|Execute some commands multiple times.|+|[[repeat_command|repeat]]|Execute some commands multiple times.|
 |[[return]]|Early termination of the current atomic scope.| |[[return]]|Early termination of the current atomic scope.|
-|[[ruby_command]]|Run something in a ruby interpreter.|+|[[ruby_command|ruby]]|Run something in a ruby interpreter.|
 |[[say]]|Say something to the current channel.| |[[say]]|Say something to the current channel.|
 |[[send]]|Say something to the current target.| |[[send]]|Say something to the current target.|
Line 443: Line 439:
 |[[subpackage]]|Add a segment to the namespace for stuff you [[load]].| |[[subpackage]]|Add a segment to the namespace for stuff you [[load]].|
 |[[switch]]|Multi-path regular expression matched block statement.| |[[switch]]|Multi-path regular expression matched block statement.|
-|[[tcl_command]]|Run some command in a tcl interpreter.|+|[[tcl_command|tcl]]|Run some command in a tcl interpreter.|
 |[[silence]]|Server-side ignores (not on all servers)| |[[silence]]|Server-side ignores (not on all servers)|
 |[[timer]]|Run a command later.| |[[timer]]|Run a command later.|
Line 454: Line 450:
 |[[usleep]]|Blocking sleep of the client, less than a second.| |[[usleep]]|Blocking sleep of the client, less than a second.|
 |[[wait]]|Nonblocking suspending of execution until previous server request finished.| |[[wait]]|Nonblocking suspending of execution until previous server request finished.|
-|[[which_command]]|Find the full path of a [[load]]ed file.|+|[[which_command|which]]|Find the full path of a [[load]]ed file.|
 |[[while]]|Execute a block while some expression is true.| |[[while]]|Execute a block while some expression is true.|
-|[[window_add]]|Add a nickname to your query list.| +|[[window]]|Manipulate the EPIC on-screen display areas known as "​windows"​.| 
-|[[window_back]]|Go back to the previous current window, swapping it in if necessary.| +|[[window_add|window add]]|Add a nickname to your query list.| 
-|[[window_balance]]|Make all the windows the same size.| +|[[window_back|window back]]|Go back to the previous current window, swapping it in if necessary.| 
-|[[window_beep_always]]|Beep even if the window is hidden.| +|[[window_balance|window balance]]|Make all the windows the same size.| 
-|[[window_channel]]|Change the current channel.| +|[[window_beep_always|window beep_always]]|Beep even if the window is hidden.| 
-|[[window_clear]]|Scroll down so nothing shows in the window.| +|[[window_channel|window channel]]|Change the current channel.| 
-|[[window]]|Do a bunch of stuff with your windows.| +|[[window_clear|window clear]]|Scroll down so nothing shows in the window.| 
-|[[window_create]]|Create a new screen.| +|[[window_create|window ​create]]|Create a new screen.| 
-|[[window_delete]]|Remove a screen you don't want any more.| +|[[window_delete|window delete]]|Remove a screen you don't want any more.| 
-|[[window_describe]]|Let me tell you about your window.| +|[[window_describe|window describe]]|Let me tell you about your window.| 
-|[[window_discon]]|Disassociate the window from its server. | +|[[window_discon|window discon]]|Disassociate the window from its server. | 
-|[[window_double]]|Turn on the double status bar.| +|[[window_double|window double]]|Turn on the double status bar.| 
-|[[window_echo]]|Output something to the window.| +|[[window_echo|window echo]]|Output something to the window.| 
-|[[window_fixed]]|Forbid changing the window'​s size.| +|[[window_fixed|window fixed]]|Forbid changing the window'​s size.| 
-|[[window_flush]]|Delete the scrollback below what you see.| +|[[window_flush|window flush]]|Delete the scrollback below what you see.| 
-|[[window_flush_scrollback]]|Delete the entire scrollback.| +|[[window_flush_scrollback|window flush_scrollback]]|Delete the entire scrollback.| 
-|[[window_goto]]|Switch to the window, counting from the top of screen| +|[[window_goto|window goto]]|Switch to the window, counting from the top of screen| 
-|[[window_grow]]|Increase the size of the window.| +|[[window_grow|window grow]]|Increase the size of the window.| 
-|[[window_hide]]|Remove a window from the screen.| +|[[window_hide|window hide]]|Remove a window from the screen.| 
-|[[window_hide_others]]|Make this window the only one on the screen.| +|[[window_hide_others|window hide_others]]|Make this window the only one on the screen.| 
-|[[window_hold_interval]]|How often the status bar updates when holding stuff in this window.| +|[[window_hold_interval|window hold_interval]]|How often the status bar updates when holding stuff in this window.| 
-|[[window_hold_mode]]|Stop displaying stuff to the window, but save it in the scrollback.| +|[[window_hold_mode|window hold_mode]]|Stop displaying stuff to the window, but save it in the scrollback.| 
-|[[window_hold_slider]]|How much to scroll down when you hit <​enter>​.| +|[[window_hold_slider|window hold_slider]]|How much to scroll down when you hit <​enter>​.| 
-|[[window_indent]]|Overrule [[set indent]] for this window.| +|[[window_indent|window indent]]|Overrule [[set indent]] for this window.| 
-|[[window_kill]]|Delete a window you don't want any more.| +|[[window_kill|window kill]]|Delete a window you don't want any more.| 
-|[[window_kill_all_hidden]]|Delete all of the hidden (invisible) windows.| +|[[window_kill_all_hidden|window kill_all_hidden]]|Delete all of the hidden (invisible) windows.| 
-|[[window_kill_others]]|Make this the only window left for the whole client.| +|[[window_kill_others|window kill_others]]|Make this the only window left for the whole client.| 
-|[[window_killable]]|Forbid the killing of this window.| +|[[window_killable|window killable]]|Forbid the killing of this window.| 
-|[[window_killswap]]|Kill this window, and swap in an invisible window in its place.| +|[[window_killswap|window killswap]]|Kill this window, and swap in an invisible window in its place.| 
-|[[window_last]]|Go back to the previous current window, but not if it's hidden.| +|[[window_last|window last]]|Go back to the previous current window, but not if it's hidden.| 
-|[[window_lastlog]]|How many logical lines of output to save.| +|[[window_lastlog|window lastlog]]|How many logical lines of output to save.| 
-|[[window_lastlog_level]]|What levels of output should be saved to the lastlog.| +|[[window_lastlog_level|window lastlog_level]]|What levels of output should be saved to the lastlog.| 
-|[[window_level]]|What levels of output should be sent to this window.| +|[[window_level|window level]]|What levels of output should be sent to this window.| 
-|[[window_list]]|Describe all the windows.| +|[[window_list|window list]]|Describe all the windows.| 
-|[[window_log]]|Turn on or off the window'​s log file.| +|[[window_log|window log]]|Turn on or off the window'​s log file.| 
-|[[window_logfile]]|Change the window'​s log filename.| +|[[window_logfile|window logfile]]|Change the window'​s log filename.| 
-|[[window_move]]|Move the window up or down on the screen.| +|[[window_move|window move]]|Move the window up or down on the screen.| 
-|[[window_move_to]]|Move the window to the Nth place, counting from the top of the screen.| +|[[window_move_to|window move_to]]|Move the window to the Nth place, counting from the top of the screen.| 
-|[[window_name]]|Change the window'​s name.| +|[[window_name|window name]]|Change the window'​s name.| 
-|[[window_new]]|Create a new window, splitting a visible window in half.| +|[[window_new|window new]]|Create a new window, splitting a visible window in half.| 
-|[[window_new_hide]]|Create a new hidden window.| +|[[window_new_hide|window new_hide]]|Create a new hidden window.| 
-|[[window_next]]|Swap the current window with the hidden window with the next higher refnum.| +|[[window_next|window next]]|Swap the current window with the hidden window with the next higher refnum.| 
-|[[window_noserv]]|Disassociate the window from the server.| +|[[window_noserv|window noserv]]|Disassociate the window from the server.| 
-|[[window_notified]]|Toggle whether the window is notifying that it has output since it's been hidden.| +|[[window_notified|window notified]]|Toggle whether the window is notifying that it has output since it's been hidden.| 
-|[[window_notify]]|Toggle whether the window should notify you when it has output while it's hidden.| +|[[window_notify|window notify]]|Toggle whether the window should notify you when it has output while it's hidden.| 
-|[[window_notify_level]]|Toggle what types of output cause the window to notify you while it's hidden.| +|[[window_notify_level|window notify_level]]|Toggle what types of output cause the window to notify you while it's hidden.| 
-|[[window_notify_name]]|What the window'​s name looks like on the status bar when it's notifying you.| +|[[window_notify_name|window notify_name]]|What the window'​s name looks like on the status bar when it's notifying you.| 
-|[[window_number]]|Change the window'​s refnum.| +|[[window_number|window number]]|Change the window'​s refnum.| 
-|[[window_pop]]|Go back to the window you last [[window push]]ed.| +|[[window_pop|window pop]]|Go back to the window you last [[window push]]ed.| 
-|[[window_previous]]|Swap the current window with the hidden window with the next lower refnum.| +|[[window_previous|window previous]]|Swap the current window with the hidden window with the next lower refnum.| 
-|[[window_prompt]]|What the input prompt should be for this window, if we are [[query]]ing an [[exec]]ed process.| +|[[window_prompt|window prompt]]|What the input prompt should be for this window, if we are [[query]]ing an [[exec]]ed process.| 
-|[[window_push]]|Save the current window'​s refnum onto a stack.| +|[[window_push|window push]]|Save the current window'​s refnum onto a stack.| 
-|[[window_query]]|Change the window'​s current query target.| +|[[window_query|window query]]|Change the window'​s current query target.| 
-|[[window_rebuild_scrollback]]|Throw away the scrollback buffer, and rebuild it from the lastlog.| +|[[window_rebuild_scrollback|window rebuild_scrollback]]|Throw away the scrollback buffer, and rebuild it from the lastlog.| 
-|[[window_refnum]]|Change the current window to another visible window.| +|[[window_refnum|window refnum]]|Change the current window to another visible window.| 
-|[[window_refnum_or_swap]]|Change the current window to another visible window, swapping it in if necessary.| +|[[window_refnum_or_swap|window refnum_or_swap]]|Change the current window to another visible window, swapping it in if necessary.| 
-|[[window_refresh]]|Redraw the window.| +|[[window_refresh|window refresh]]|Redraw the window.| 
-|[[window_rejoin]]|Join a channel on a window'​s server, putting it in whichever window claims it.| +|[[window_rejoin|window rejoin]]|Join a channel on a window'​s server, putting it in whichever window claims it.| 
-|[[window_remove]]|Remove a nick from the window'​s query list.| +|[[window_remove|window remove]]|Remove a nick from the window'​s query list.| 
-|[[window_scrolladj]]|Whether to insert space at the bottom, or pull scrollback back down from the top when a window grows in size.| +|[[window_scrolladj|window scrolladj]]|Whether to insert space at the bottom, or pull scrollback back down from the top when a window grows in size.| 
-|[[window_scrollback]]|How big the window'​s scrollback buffer should be.| +|[[window_scrollback|window scrollback]]|How big the window'​s scrollback buffer should be.| 
-|[[window_scroll_backward]]|Go back some number of lines in scrollback.| +|[[window_scroll_backward|window scroll_backward]]|Go back some number of lines in scrollback.| 
-|[[window_scroll_end]]|Go to the end (newest) of the scrollback.| +|[[window_scroll_end|window scroll_end]]|Go to the end (newest) of the scrollback.| 
-|[[window_scroll_forward]]|Go forward some number of lines in scrollback.| +|[[window_scroll_forward|window scroll_forward]]|Go forward some number of lines in scrollback.| 
-|[[window_scroll_start]]|Go to the start (oldest) of the scrollback. | +|[[window_scroll_start|window scroll_start]]|Go to the start (oldest) of the scrollback. | 
-|[[window_search_back]]|Go backwards in scrollback to find a string.| +|[[window_search_back|window search_back]]|Go backwards in scrollback to find a string.| 
-|[[window_search_forward]]|Go forwards in scrollback to find a string.| +|[[window_search_forward|window search_forward]]|Go forwards in scrollback to find a string.| 
-|[[window_server]]|Change which server this window is associated with.| +|[[window_server|window server]]|Change which server this window is associated with.| 
-|[[window_show]]|Make a hidden window visible (by splitting a visible window)| +|[[window_show|window show]]|Make a hidden window visible (by splitting a visible window)| 
-|[[window_show_all]]|Make all hidden windows visible (by splitting visible windows)| +|[[window_show_all|window show_all]]|Make all hidden windows visible (by splitting visible windows)| 
-|[[window_shrink]]|Make a window smaller| +|[[window_shrink|window shrink]]|Make a window smaller| 
-|[[window_size]]|Set the window size to an absolute value.| +|[[window_size|window size]]|Set the window size to an absolute value.| 
-|[[window_skip]]|Can [[bind next_window]] move to this window?| +|[[window_skip|window skip]]|Can [[bind next_window]] move to this window?| 
-|[[window_stack]]|Show the refnums saved ont he stack.| +|[[window_stack|window stack]]|Show the refnums saved on the stack.| 
-|[[window_status_format]]|The status line for a single line status bar.| +|[[window_status_format|window status_format]]|The status line for a single line status bar.| 
-|[[window_status_format1]]|The bottom line of a double line status bar.| +|[[window_status_format1|window status_format1]]|The bottom line of a double line status bar.| 
-|[[window_status_format2]]|The top line of a double line status bar.| +|[[window_status_format2|window status_format2]]|The top line of a double line status bar.| 
-|[[window_status_special]]|What %. should be on this window'​s status bar.| +|[[window_status_special|window status_special]]|What %. should be on this window'​s status bar.| 
-|[[window_swap]]|Make this window invisible, and make a hidden window visible, taking its place.| +|[[window_swap|window swap]]|Make this window invisible, and make a hidden window visible, taking its place.| 
-|[[window_swappable]]|Change you change the visibility of this window? (Ie, hide a visible window)| +|[[window_swappable|window swappable]]|Change you change the visibility of this window? (Ie, hide a visible window)| 
-|[[window_topline]]|How many toplines show in this window?| +|[[window_topline|window topline]]|How many toplines show in this window?| 
-|[[window_toplines]]|Change one of the window'​s toplines.| +|[[window_toplines|window toplines]]|Change one of the window'​s toplines.| 
-|[[window_unclear]]|Push down the scrollback so it's visible in the window.| +|[[window_unclear|window unclear]]|Push down the scrollback so it's visible in the window.| 
-|[[xdebug_command]]|Change some internal debugging flags.|+|[[xdebug_command|xdebug]]|Change some internal debugging flags.|
 |[[xecho]]|Output to a window, with flags| |[[xecho]]|Output to a window, with flags|
 |[[xeval]]|Run some commands, with flags.| |[[xeval]]|Run some commands, with flags.|
Line 568: Line 564:
 |[[cexist]]|Does a command exist?| |[[cexist]]|Does a command exist?|
 |[[chanmode]]|What is the mode of a channel?| |[[chanmode]]|What is the mode of a channel?|
-|[[channel_function]]|Summarize users on channel (op, voice, nick)|+|[[channel_function|channel]]|Summarize users on channel (op, voice, nick)|
 |[[chanusers]]|Who is on a channel?| |[[chanusers]]|Who is on a channel?|
 |[[chanwin]]|What window is this channel in?| |[[chanwin]]|What window is this channel in?|
Line 581: Line 577:
 |[[cofilter]]|Return words from 2nd variable, based on which words in 1st variable aren't matched by a pattern.| |[[cofilter]]|Return words from 2nd variable, based on which words in 1st variable aren't matched by a pattern.|
 |[[common]]|Return words common to two word lists.| |[[common]]|Return words common to two word lists.|
-|[[connect_function]]|Establish a [[dcc raw]] socket connection.|+|[[connect_function|connect]]|Establish a [[dcc raw]] socket connection.|
 |[[convert]]|Convert a hostname to paddr, or paddr to hostname.| |[[convert]]|Convert a hostname to paddr, or paddr to hostname.|
 |[[copattern]]|Return words from 2nd variable, based on which words in 1st variable are matched by a pattern.| |[[copattern]]|Return words from 2nd variable, based on which words in 1st variable are matched by a pattern.|
Line 606: Line 602:
 |[[eof]]|Is the [[open]] file at end-of-file?​| |[[eof]]|Is the [[open]] file at end-of-file?​|
 |[[epic]]|Returns 1, because you're using epic!| |[[epic]]|Returns 1, because you're using epic!|
-|[[exec_function]]|Run a unix command in a subshell, returning three [[open]] fds.|+|[[exec_function|exec]]|Run a unix command in a subshell, returning three [[open]] fds.|
 |[[exp]]|Exponent operation (x %%**%% y)| |[[exp]]|Exponent operation (x %%**%% y)|
 |[[ferror]]|Does the [[open]] file have an error condition?| |[[ferror]]|Does the [[open]] file have an error condition?|
Line 661: Line 657:
 |[[indextoitem]]|Convert a Karll array index number to an item number.| |[[indextoitem]]|Convert a Karll array index number to an item number.|
 |[[indextoword]]|What word in list contains the '​index'​th character?| |[[indextoword]]|What word in list contains the '​index'​th character?|
-|[[info_function]]|Return structured information about the client.|+|[[info_function|info]]|Return structured information about the client.|
 |[[insert]]|Insert a word into a string at the "​index"​th character.| |[[insert]]|Insert a word into a string at the "​index"​th character.|
 |[[insertw]]|Insert a word into a list.| |[[insertw]]|Insert a word into a list.|
Line 689: Line 685:
 |[[key]]|What is the channel key of a channel?| |[[key]]|What is the channel key of a channel?|
 |[[killpid]]|Kill a unix process.| |[[killpid]]|Kill a unix process.|
-|[[lastlog_function]]|Search the lastlog and return matching lines as values I can pass to [[line]].|+|[[lastlog_function|lastlog]]|Search the lastlog and return matching lines as values I can pass to [[line]].|
 |[[left]]|Return the first N characters of a string.| |[[left]]|Return the first N characters of a string.|
 |[[leftpc]]|Return the longest initial part of the string that contains N printable characters.| |[[leftpc]]|Return the longest initial part of the string that contains N printable characters.|
Line 699: Line 695:
 |[[listen]]|Open a server tcp socket.| |[[listen]]|Open a server tcp socket.|
 |[[loadinfo]]|What file is loading right now?| |[[loadinfo]]|What file is loading right now?|
-|[[log_function]]|Natural logarithm of a number.|+|[[log_function|log]]|Natural logarithm of a number.|
 |[[log10]]|Base-10 logarithm of a number.| |[[log10]]|Base-10 logarithm of a number.|
 |[[logctl]]|Low-level manipulation of logfiles.| |[[logctl]]|Low-level manipulation of logfiles.|
-|[[longtoip]]|Convert a 32 bit integer (from dcc) into a p-addr.|+|[[longtoip]]|Convert a 32 bit integer (from DCC) into a p-addr.|
 |[[mask]]|Normalize a string into a nick!user@host pattern for banning.| |[[mask]]|Normalize a string into a nick!user@host pattern for banning.|
 |[[match]]|Return the string that is best matched by a pattern.| |[[match]]|Return the string that is best matched by a pattern.|
Line 718: Line 714:
 |[[nochops]]|Who is not a channel operator?| |[[nochops]]|Who is not a channel operator?|
 |[[nohighlight]]|Convert highlight characters to reverse chars, the way it's done on the input prompt.| |[[nohighlight]]|Convert highlight characters to reverse chars, the way it's done on the input prompt.|
-|[[notify_function]]|Low level manipulation of your notifies.|+|[[notify_function|notify]]|Low level manipulation of your notifies.|
 |[[notifywindows]]|Which hidden windows are notifying they have output?| |[[notifywindows]]|Which hidden windows are notifying they have output?|
 |[[notw]]|Remove a word from a list.| |[[notw]]|Remove a word from a list.|
Line 733: Line 729:
 |[[pass]]|Remove all but certain characters from a string.| |[[pass]]|Remove all but certain characters from a string.|
 |[[pattern]]|Return all words from list that are matched by pattern.| |[[pattern]]|Return all words from list that are matched by pattern.|
-|[[perl_function]]|Run some code in perl.|+|[[perl_function|perl]]|Run some code in perl.|
 |[[perlcall]]|Call a perl function (simple form)| |[[perlcall]]|Call a perl function (simple form)|
 |[[perlxcall]]|Call a perl function (advanced form)| |[[perlxcall]]|Call a perl function (advanced form)|
 |[[pid]]|What is the process id?| |[[pid]]|What is the process id?|
-|[[pop_function]]|Remove the last word from a variable.|+|[[pop_function|pop]]|Remove the last word from a variable.|
 |[[ppid]]|What is my parent'​s process id?| |[[ppid]]|What is my parent'​s process id?|
 |[[prefix]]|What is the common leading substring on all of the words in a list?| |[[prefix]]|What is the common leading substring on all of the words in a list?|
 |[[printlen]]|How many columns on the screen does this string take up?| |[[printlen]]|How many columns on the screen does this string take up?|
-|[[push_function]]|Add a word to the end of a variable.|+|[[push_function|push]]|Add a word to the end of a variable.|
 |[[querywin]]|Which window claims this nick as a query?| |[[querywin]]|Which window claims this nick as a query?|
 |[[qword]]|Get a word from a list as a qword (so it can be used as a dword)| |[[qword]]|Get a word from a list as a qword (so it can be used as a dword)|
Line 757: Line 753:
 |[[remws]]|Remove several certain words from a word list.| |[[remws]]|Remove several certain words from a word list.|
 |[[rename]]|Rename a file.| |[[rename]]|Rename a file.|
-|[[repeat_function]]|Repeat a string several times.|+|[[repeat_function|repeat]]|Repeat a string several times.|
 |[[rest]]|Return a string starting with a certain character position.| |[[rest]]|Return a string starting with a certain character position.|
 |[[restw]]|Return a word list starting with a certain word.| |[[restw]]|Return a word list starting with a certain word.|
Line 771: Line 767:
 |[[rpattern]]|Return all of the patterns from a list that matches a string.| |[[rpattern]]|Return all of the patterns from a list that matches a string.|
 |[[rsubstr]]|Find the last instance of a substring in a larger string.| |[[rsubstr]]|Find the last instance of a substring in a larger string.|
-|[[ruby_function]]|Run some code using ruby.|+|[[ruby_function|ruby]]|Run some code using ruby.|
 |[[sar]]|Search And Replace a string in a larger string.| |[[sar]]|Search And Replace a string in a larger string.|
 |[[sedcrypt]]|Crypt/​Decrypt a string as though sending it to a person.| |[[sedcrypt]]|Crypt/​Decrypt a string as though sending it to a person.|
Line 779: Line 775:
 |[[setitem]]|Set an item in a Karll Array.| |[[setitem]]|Set an item in a Karll Array.|
 |[[sha256]]|SHA256 message digest of a string (Strong crypto hashing).| |[[sha256]]|SHA256 message digest of a string (Strong crypto hashing).|
-|[[shift_function]]|Remove the first word from a variable.|+|[[shift_function|shift]]|Remove the first word from a variable.|
 |[[shiftbrace]]|Remove and return the {...} at the start of a variable.| |[[shiftbrace]]|Remove and return the {...} at the start of a variable.|
 |[[sin]]|Sine of number.| |[[sin]]|Sine of number.|
Line 790: Line 786:
 |[[startupfile]]|What file did the client load at startup?| |[[startupfile]]|What file did the client load at startup?|
 |[[stat]]|Return info about a file.| |[[stat]]|Return info about a file.|
-|[[status_function]]|Get the status bar.|+|[[status_function|status]]|Get the status bar.|
 |[[stime]]|Human readable form of the time.| |[[stime]]|Human readable form of the time.|
 |[[strftime]]|Format the current time any way you want.| |[[strftime]]|Format the current time any way you want.|
Line 805: Line 801:
 |[[tan]]|Tangent of number.| |[[tan]]|Tangent of number.|
 |[[tanh]]|Hyperbolic Tangent.| |[[tanh]]|Hyperbolic Tangent.|
-|[[tcl_function]]|Run some code using tcl.|+|[[tcl_function|tcl]]|Run some code using tcl.|
 |[[tdiff]]|Number converted to hours-minutes-seconds (long form)| |[[tdiff]]|Number converted to hours-minutes-seconds (long form)|
 |[[tdiff2]]|Number converted to hours-minutes-seconds (short form)| |[[tdiff2]]|Number converted to hours-minutes-seconds (short form)|
-|[[time_function]]|What is the current time, in whole seconds?|+|[[time_function|time]]|What is the current time, in whole seconds?|
 |[[timerctl]]|Low-level manipulation of [[timer]]s.| |[[timerctl]]|Low-level manipulation of [[timer]]s.|
 |[[tobase]]|Convert a base10 number to another base.| |[[tobase]]|Convert a base10 number to another base.|
Line 823: Line 819:
 |[[uniq]]|Remove duplicates from a word list.| |[[uniq]]|Remove duplicates from a word list.|
 |[[unlink]]|Remove a file.| |[[unlink]]|Remove a file.|
-|[[unshift_function]]|Add a string to the start of a string.|+|[[unshift_function|unshift]]|Add a string to the start of a string.|
 |[[unsplit]]|Convert a dword list into a uword list using a seperator.| |[[unsplit]]|Convert a dword list into a uword list using a seperator.|
 |[[urldecode]]|Convert a string from url format into normal.| |[[urldecode]]|Convert a string from url format into normal.|
 |[[urlencode]]|Convert a string into url format.| |[[urlencode]]|Convert a string into url format.|
-|[[userhost_function]]|What is the userhost of a nickname or current message?|+|[[userhost_function|userhost]]|What is the userhost of a nickname or current message?|
 |[[usermode]]|What is my usermode?| |[[usermode]]|What is my usermode?|
 |[[usetitem]]|Set an item in a Karll array (faster)| |[[usetitem]]|Set an item in a Karll array (faster)|
-|[[utime_function]]|What is the current time, including usec?| +|[[utime_function|utime]]|What is the current time, including usec?| 
-|[[version_function]]|What is the server version?| +|[[version_function|version]]|What is the server version?| 
-|[[which_function]]|Path search for a file.|+|[[which_function|which]]|Path search for a file.|
 |[[winchan]]|Translate between current channel and window refnum.| |[[winchan]]|Translate between current channel and window refnum.|
 |[[windowctl]]|Low-level manipulation of windows.| |[[windowctl]]|Low-level manipulation of windows.|
Line 839: Line 835:
 |[[write]]|Write a line to an [[open]] file.| |[[write]]|Write a line to an [[open]] file.|
 |[[writeb]]|Write some binary data to an [[open]] file.| |[[writeb]]|Write some binary data to an [[open]] file.|
-|[[xdebug_function]]|Manipulate the xdebug flags.|+|[[xdebug_function|xdebug]]|Manipulate the xdebug flags.|
 |[[xform]]|Transform a string from one form to another.| |[[xform]]|Transform a string from one form to another.|
 |[[yn]]|Bessel function of the second kind for integer order n.| |[[yn]]|Bessel function of the second kind for integer order n.|
Line 851: Line 847:
 |[[autojoin]]|Automatically join channels when you (re-)connect to server.| |[[autojoin]]|Automatically join channels when you (re-)connect to server.|
 |[[autoquery]]|Automatically create a new querywin when someone msgs you.| |[[autoquery]]|Automatically create a new querywin when someone msgs you.|
-|[[builtins]]|Top-level script for compatability with epic4.  Must load!|+|[[builtins]]|Top-level script for compatability with EPIC4.  Must load!|
 |[[chanmonitor]]|Displays output of non-current channels in hidden windows to a special visible window.| |[[chanmonitor]]|Displays output of non-current channels in hidden windows to a special visible window.|
 |[[commandqueues]]|Time-delay processing queues.| |[[commandqueues]]|Time-delay processing queues.|
Line 859: Line 855:
 |[[dcc_ports]]|Specify a port range to be used automatically for [[DCC]]s| |[[dcc_ports]]|Specify a port range to be used automatically for [[DCC]]s|
 |[[debug.irc]]|Aliases to help you debug/tune your script.| |[[debug.irc]]|Aliases to help you debug/tune your script.|
-|[[dump]]|Simulate the dump command from epic4.|+|[[dump]]|Simulate the dump command from EPIC4.|
 |[[edit_topic]]|Edit the topic of the current channel.| |[[edit_topic]]|Edit the topic of the current channel.|
 |[[epic-crypt-gpg]]|A shell script to use with [[crypt]].| |[[epic-crypt-gpg]]|A shell script to use with [[crypt]].|
Line 865: Line 861:
 |[[files]]|Examples of what you can do with [[open]] files.| |[[files]]|Examples of what you can do with [[open]] files.|
 |[[floodprot]]|Implement outbound flood protection.| |[[floodprot]]|Implement outbound flood protection.|
-|[[functions_script]]|Some utility commands and aliases.|+|[[functions_script|functions]]|Some utility commands and aliases.|
 |[[global]]|The script you should load in your epicrc.| |[[global]]|The script you should load in your epicrc.|
 |[[grep]]|An example of how to grep a file with [[open]].| |[[grep]]|An example of how to grep a file with [[open]].|
Line 880: Line 876:
 |[[mail]]|Check multiple mboxes at once.| |[[mail]]|Check multiple mboxes at once.|
 |[[man]]|A front end to the old help command.| |[[man]]|A front end to the old help command.|
-|[[map_script]]|A client-side implementation of the [[map]] command.|+|[[map_script|map]]|A client-side implementation of the [[map]] command.|
 |[[meta-compat]]|Backwards compatability for scripts that bound META keybindings.| |[[meta-compat]]|Backwards compatability for scripts that bound META keybindings.|
 |[[motd_script]]|A client side message-of-the-day script.| |[[motd_script]]|A client side message-of-the-day script.|
Line 888: Line 884:
 |[[nickcomp]]|Automatic nickname completion for channel text.| |[[nickcomp]]|Automatic nickname completion for channel text.|
 |[[nopaste]]|Prohibit accidental paste flooding.| |[[nopaste]]|Prohibit accidental paste flooding.|
-|[[notify_script]]|A scripted implementation of [[notify]]|+|[[notify_script|notify]]|A scripted implementation of [[notify]]|
 |[[paste]]|Allow a special paste mode for paste flooding.| |[[paste]]|Allow a special paste mode for paste flooding.|
-|[[pipe_script]]|Return ​the output from an [[exec]] command ​as a function.| +|[[pipe_script|pipe]]|Implement the function [[pipe_function|pipe]] that returns ​the output from an [[exec]] command.| 
-|[[pipe_function]]|The function implemented in the pipe script.| +|[[reconnect_script|reconnect]]|Automatically reconnect to servers when disconnected.|
-|[[reconnect_script]]|Automatically reconnect to servers when disconnected.|+
 |[[renumber]]|Automatically renumber your window refnums so there are no gaps.| |[[renumber]]|Automatically renumber your window refnums so there are no gaps.|
 |[[revdcc]]|Reverse dcc for those behind a firewall.| |[[revdcc]]|Reverse dcc for those behind a firewall.|
Line 905: Line 900:
 |[[tabkey.ce]]|Crazyeddy'​s and Fudd's tabkey script.| |[[tabkey.ce]]|Crazyeddy'​s and Fudd's tabkey script.|
 |[[tabkey.jm]]|Jm'​s tabkey script.| |[[tabkey.jm]]|Jm'​s tabkey script.|
-|[[utime_script]]|Functions for manipulating [[utime]]s.|+|[[utime_script|utime]]|Functions for manipulating [[utime]]s.|
  
 ======Special Topics====== ======Special Topics======
-|[[about_epic]]|Information about the epic project and software.|+|[[about_epic]]|Information about the EPIC project and software.|
 |[[arglist]]|How alias argument lists look and work.| |[[arglist]]|How alias argument lists look and work.|
 |[[arrays]]|How Karll arrays work.| |[[arrays]]|How Karll arrays work.|
Line 920: Line 915:
 |[[default_keybindings]]|Information about what [[BIND]] -DEFAULT does| |[[default_keybindings]]|Information about what [[BIND]] -DEFAULT does|
 |[[disambiguation]]|A template file we use for disambiguation pages.| |[[disambiguation]]|A template file we use for disambiguation pages.|
-|[[environment_variables]]|What environment variables does epic honor?|+|[[environment_variables]]|What environment variables does EPIC honor?|
 |[[etiquette]]|How should I behave on irc?| |[[etiquette]]|How should I behave on irc?|
 |[[expando_substitution]]|How do $'s get expanded?| |[[expando_substitution]]|How do $'s get expanded?|
Line 949: Line 944:
 |[[quoting_hell]]|What is quoting hell and how do I make it work for me?| |[[quoting_hell]]|What is quoting hell and how do I make it work for me?|
 |[[random_numbers]]|How the client generates random numbers.| |[[random_numbers]]|How the client generates random numbers.|
-|[[regex]]|How regular expressions work in epic.|+|[[regex]]|How regular expressions work in EPIC.|
 |[[referring_to_servers]]|How am I allowed to refer to servers?| |[[referring_to_servers]]|How am I allowed to refer to servers?|
 |[[rules_about_number_arguments]]|How numbers passed to built-in functions are handled.| |[[rules_about_number_arguments]]|How numbers passed to built-in functions are handled.|
Line 1008: Line 1003:
 |[[xdebug]]| |[[xdebug]]|
  
-======Non-existant ​stuff====== +======Non-existent ​stuff====== 
-These things exist in epic4, but they don't in epic5.   I need to do some+These things exist in EPIC4, but they don't in EPIC5.   I need to do some
 work to point you in the right direction for replacements for these things. work to point you in the right direction for replacements for these things.
 Many of the functions previously built in now live in the [[builtins]] script. Many of the functions previously built in now live in the [[builtins]] script.
  
-=====Help files exist for non-existant ​scripts=====+=====Help files exist for non-existent ​scripts=====
 |[[alias_script]]| |[[alias_script]]|
 |[[altchan.bj]]| |[[altchan.bj]]|
Line 1062: Line 1057:
 |[[window_script]]| |[[window_script]]|
  
-=====Help files exist for non-existant ​commands=====+=====Help files exist for non-existent ​commands=====
 |[[bind_command_completion]]|Command completion handled by tabkey scripts | |[[bind_command_completion]]|Command completion handled by tabkey scripts |
 |[[bind_backward_history]]|Implemented by [[history script]].| |[[bind_backward_history]]|Implemented by [[history script]].|
Line 1122: Line 1117:
 |[[window_scroll]]|An obsolete operation. ​ All windows are scrollable.| |[[window_scroll]]|An obsolete operation. ​ All windows are scrollable.|
  
-=====Help files exist for non-existant ​functions=====+=====Help files exist for non-existent ​functions=====
 |[[fabs]]|Use [[abs]] instead.| |[[fabs]]|Use [[abs]] instead.|
 |[[getppid]]|This was a mistake; the function is [[pid]]. | |[[getppid]]|This was a mistake; the function is [[pid]]. |
help_root.1499306468.txt.gz · Last modified: 2017/07/06 02:01 by 127.0.0.1