Initial import of the ircii-pana-1.1-final source tree.

git-svn-id: svn://svn.code.sf.net/p/bitchx/code/tags/ircii-pana-1.1-final@1 13b04d17-f746-0410-82c6-800466cd88b0
This commit is contained in:
Kevin Easton
2008-02-25 09:25:32 +00:00
commit 28febcfea9
1429 changed files with 250653 additions and 0 deletions

View File

@@ -0,0 +1,7 @@
Section 4: Miscellaneous Commands 
This section contains all the commands that didn't really fit anywhere else.
Most of them aren't commands you'll find yourself using on a daily basis,
such as encryption, command history, menu manipulation, and character set
digraphs.

23
bitchx-docs/4_Misc/abort Normal file
View File

@@ -0,0 +1,23 @@
Synopsis:
abort [<filename>]
Description:
This command causes two things to happen, after which the client exits
immediately.
First, a SAVE is performed, with the data dumped either to the specified
file, or to "irc.aborted" if none. Second, it will drop a core file in
the current directory.
This command is used mainly for debugging purposes.
See Also:
quit(1); save(5)
Restrictions:
The core file will only be produced if the EPIC_DEBUG #define is enabled
in the source file config.h at compile time. It is disabled by default.
Other Notes:
Although it uses SAVE, this command will not clobber the .ircrc file,
unless it happens to be the filename specified.

11
bitchx-docs/4_Misc/beep Normal file
View File

@@ -0,0 +1,11 @@
Synopsis:
beep
Description:
This command makes the terminal beep. It's a simple alternative to
embedded Gs for client notices. It cannot be used to send a beep to
another client.
See Also:
bind(4) beep; set(4) beep

View File

@@ -0,0 +1,11 @@
Synopsis:
bind <key> backspace
Description:
This function causes the cursor to be moved one space to the left, and
character previously in that position is deleted. It has no effect if
the cursor is at the beginning of the input line.
See Also:
bind(4) delete_character

View File

@@ -0,0 +1,10 @@
Synopsis:
bind <key> backward_character
Description:
This function causes the cursor to move one space to the left. It has
no effect if the cursor is at the beginning of the input line.
See Also:
bind(4) forward_character

View File

@@ -0,0 +1,13 @@
Synopsis:
bind <key> backward_history
Description:
This replaces the contents of the input line with the previous command
in the client's command history buffer. The command history buffer is
circular, such that using BACKWARD_HISTORY when at the first command
will produce the last command in the buffer. The original contents of
the input line, if any, are not preserved.
See Also:
bind(4) forward_history, shove_to_history; history(4)

View File

@@ -0,0 +1,14 @@
Synopsis:
bind <key> backward_word
Description:
This function moves the cursor backward until it reaches the beginning
of a word. If the cursor is currently in the middle of a word, it is
shifted to the beginning of that word. If it is already at the
beginning of a word, or on whitespace of any kind, it is moved back to
the previous word. It has no effect if the cursor is at the beginning
of the first word.
See Also:
bind(4) forward_word

View File

@@ -0,0 +1,12 @@
Synopsis:
bind <key> beginning_of_line
Description:
This function moves the cursor to the beginning of the input line.
This may be a position not currently visible on screen, due to the
way the client wraps long input. It has no visible effect when the
cursor is already at the beginning of the input line.
See Also:
bind(4) end_of_line

View File

@@ -0,0 +1,38 @@
Synopsis:
bind [<key/series> [<function> [<args>]]]
Description:
BIND is used to bind a keystroke (or series of keystrokes) to a given
function or command. Traditionally, such key bindings have been used
for cursor control and input line editing. However, there really is
no limit to what can be bound to a key.
Most often, functions are bound to a control key (typing a key while
depressing the control key on the keyboard). EPIC provides a mechanism
for overriding existing bindings to insert literal characters, by binding
a key to QUOTE_CHARACTER.
Using BIND with no specified function will display the function bound
to the given key. If no key is given, all bindings are displayed.
Examples:
To bind the QUOTE_CHARACTER function to ^Q (control-Q):
/bind ^Q quote_character
To bind the right arrow (ESC-[-C) to FORWARD_CHARACTER:
/bind ^[ meta1_character
/bind meta1-[ meta2_character
/bind meta2-C forward_character
See Also:
Key_Bindings(7); parsekey(5); rbind(4)
Other Notes:
Case is important with literal characters with BIND. However, it is
not important in control characters. Thus, 'C' and 'c' are treated
independently, but '^C' and '^c' are the same.
Be careful when binding literal keys (such as 'c' alone) to functions.
If the wrong keys get bound, it may be impossible to unbind them
without restarting the client.

View File

@@ -0,0 +1,16 @@
Synopsis:
bind <key> blink
Description:
This function toggles the current blink setting. Due to internal
limitations of the client, BLINK is displayed as an F on the input line,
regardless of the key it is bound to.
See Also:
bind(4) highlight_off, reverse, underline, bold;
set(4) blink_video
Other Notes:
Blinking text can be typed at any time, but it will only be displayed
if BLINK_VIDEO is on.

View File

@@ -0,0 +1,16 @@
Synopsis:
bind <key> bold
Description:
This function toggles the current boldface setting. Due to internal
limitations of the client, BOLD is displayed as a B on the input line,
regardless of the key it is bound to.
See Also:
bind(4) blink, highlight_off, reverse, underline;
set(4) bold_video
Other Notes:
Boldfaced text can be typed at any time, but it will only be displayed
if BOLD_VIDEO is on.

View File

@@ -0,0 +1,14 @@
Synopsis:
bind <key> clear_screen
Description:
This function clears the current window of all text. Additionally, it
will restart the window if it has been stopped by HOLD_MODE or the key
function TOGGLE_STOP_SCREEN.
Aliases:
This function is effectively equivalent to "CLEAR -unhold".
See Also:
bind(4) refresh_screen; clear(4); set(4) hold_mode; window(4) hold_mode

View File

@@ -0,0 +1,14 @@
Synopsis:
bind <key> command_completion
Description:
This function attempts to complete a command name used on the input
line, much like modern Unix shells do. It can expand both builtin
commands and aliases. It only attempts to expand the first word on
the input line, and only if it is prefixed by the command character,
and thus unlike Unix shells, the cursor does not need to be near the
command name to expand it.
See Also:
alias(5); set(4) cmdchars

View File

@@ -0,0 +1,10 @@
Synopsis:
bind <key> delete_character
Description:
This function deletes the character currently under the cursor, then
shifts any text to the right of the cursor one space to the left.
See Also:
bind(4) backspace

View File

@@ -0,0 +1,12 @@
Synopsis:
bind <key> delete_next_word
Description:
This function deletes text on the input line from the position of the
cursor forward to the end of the first word found. If is it in the
middle of a word, that word is truncated. If it is on whitespace, all
text and whitespace to the end of the next word are deleted.
See Also:
bind(4) delete_previous_word

View File

@@ -0,0 +1,13 @@
Synopsis:
bind <key> delete_previous_word
Description:
This function deletes text on the input line from the position of the
cursor backward to the beginning of the first word found. If is it in
the middle of a word, the beginning of that word is chopped. If it
is on whitespace, all text and whitespace to the beginning of the
previous word are deleted.
See Also:
bind(4) delete_next_word, delete_to_previous_space

View File

@@ -0,0 +1,14 @@
Synopsis:
bind <key> delete_to_previous_space
Description:
This function deletes everything to the left of the cursor until a
space is found. If the character immediately before the cursor is
whitespace of some kind, it does nothing.
See Also:
bind(4) delete_previous_word
Other Notes:
The function deletes up to the space, but not including the space.

View File

@@ -0,0 +1,11 @@
Synopsis:
bind <key> end_of_line
Description:
This function moves the cursor to the last character on the input line.
This position may not be currently visible, due to the manner in which
EPIC handles input line wrapping.
See Also:
bind(4) beginning_of_line

View File

@@ -0,0 +1,24 @@
Synopsis:
bind <key> enter_digraph
Description:
This function allows special characters not present on the keyboard to
be composed, such as European characters containing accents, umlauts,
or tildes. The exact characters available are dependent on the
character set in use by the client.
To enter a digraph, the key bound to this function is typed, followed
by the desired character pair.
In order for the client to properly display these characters, the
appropriate character map must be used; the default ASCII translation
table will not work. Additionally, the client must be set to pass 8
bit characters (also disabled by default).
By default, EPIC uses the same digraphs as available on the DEC vt320
and vt420 terminal emulators, and those used in the Elvis text editor.
The DIGRAPH command with no arguments will list the current table.
See Also:
digraph(4); set(4) eight_bit_characters, translation

View File

@@ -0,0 +1,10 @@
Synopsis:
bind <key> enter_menu
Description:
This function causes the client to enter the menu specified by the
MENU variable. Of course, this menu must have already been loaded.
See Also:
Menus(7); mload(4); set(4) menu

View File

@@ -0,0 +1,10 @@
Synopsis:
bind <key> erase_line
Description:
This function clears the contents of the input line. The data cleared
is not preserved in the command history.
See Also:
bind(4) erase_to_beg_of_line, erase_to_end_of_line

View File

@@ -0,0 +1,10 @@
Synopsis:
bind <key> erase_to_beg_of_line
Description:
This function erases all text from (but not including) the cursor to
the beginning of the input line.
See Also:
bind(4) erase_line, erase_to_end_of_line

View File

@@ -0,0 +1,10 @@
Synopsis:
bind <key> erase_to_end_of_line
Description:
This function erases all text from (and including) the cursor to the end
of the input line.
See Also:
bind(4) erase_line, erase_to_beg_of_line

View File

@@ -0,0 +1,10 @@
Synopsis:
bind <key> forward_character
Description:
This function causes the cursor to move right by one character. It has
no effect if the cursor is at the end of the input line.
See Also:
bind(4) backward_character

View File

@@ -0,0 +1,12 @@
Synopsis:
bind <key> forward_history
Description:
This function replaces the contents of the current input buffer with
the next entry in the command history. The history buffer is circular,
so this will often be the first command in the buffer (unless the
BACKWARD_HISTORY function has been used recently).
See Also:
bind(4) backward_history, shove_to_history; history(4)

View File

@@ -0,0 +1,10 @@
Synopsis:
bind <key> forward_word
Description:
This function moves the cursor forward to the beginning of the next
word in the input line.
See Also:
bind(4) backward_word

View File

@@ -0,0 +1,10 @@
Synopsis:
bind <key> highlight_off
Description:
This function turns off any special highlighting in use prior to this
character, including ANSI color escape sequences.
See Also:
bind(4) blink, bold, reverse, underline

View File

@@ -0,0 +1,23 @@
Synopsis:
bind <key> meta1_character
Description:
This function allows the user to access an alternate keymap. When the
key bound to this function is pressed, the next key pressed can be
assigned a new meaning. This allows for a sequence of keys to be bound
to a function, such that only that combination of keys will execute
the function. This is how escape sequences are entered.
Aliases:
META2, META3, and META5 through META19_CHARACTERs are identical
in function as META1_CHARACTER. META4_CHARACTER has some special
characteristics described in its own help file.
See Also:
bind(4) meta4_character
Restrictions:
At most, key sequences may contain 2 keys. For longer sequences (such
as those required to control the arrow keys), one of the pair must be
composed of 2 keys as well.

View File

@@ -0,0 +1,12 @@
Synopsis:
bind <key> meta4_character
Description:
This key function is identical to the other meta functions, except that
it is sticky. This means that every character typed after the META4
key will execute the META4 version of those keys. The key is unstuck
when the META4 key is entered again (an on/off switch of sorts).
See Also:
bind(4) meta1_character

View File

@@ -0,0 +1,14 @@
Synopsis:
bind <key> next_window
Description:
This function causes the client to change the current window to the one
immediately below the current one in the window list. If the current
window is the last in the list, the first becomes the current window.
Aliases:
This function has the same effect as the WINDOW NEXT command.
See Also:
bind(4) previous_window, swap_next_window; window(4) next

View File

@@ -0,0 +1,7 @@
Synopsis:
bind <key> nothing
Description:
This function causes the specified key to do nothing, effectively
disabling it.

View File

@@ -0,0 +1,12 @@
Synopsis:
bind <key> parse_command <commands>
Description:
This function causes the specified command(s) to be executed when the
given key is pressed. If multiple commands are desired, they may be
surrounded with curly braces. Command-line expando variables ($*, $2,
$n-m, etc.) are expanded as if there were no arguments given.
See Also:
parsekey(5)

View File

@@ -0,0 +1,10 @@
Synopsis:
bind <key> send_line
Description:
This causes pmpaste to be invoked to add the current contents
of the system clipboard to the input line.
See Also:
pmpaste(5)

View File

@@ -0,0 +1,14 @@
Synopsis:
bind <key> previous_window
Description:
This function causes the client to change the current window to the one
immediately above the current one in the window list. If the current
window is the first in the list, the last becomes the current window.
Aliases:
This key function has the same effect as the WINDOW PREVIOUS command.
See Also:
bind(4) next_window, swap_previous_window; window(4) previous

View File

@@ -0,0 +1,13 @@
Synopsis:
bind <key> quit_irc
Description:
This function causes the client to sign off from the irc network.
Aliases:
Thus function has the same effect as the QUIT command, except that a
specific QUIT reason cannot be specified.
See Also:
quit(1)

View File

@@ -0,0 +1,8 @@
Synopsis:
bind <key> quote_character
Description:
This function quotes, or escapes, the next key entered. It overrides
the key's normal default meaning and forces it to insert itself into
the input buffer.

View File

@@ -0,0 +1,18 @@
Synopsis:
bind <key> refresh_inputline
Description:
This function causes the client to redraw the input line. It is mostly
only useful when another process sends data to the client's tty, which
sometimes corrupts the display of the input line (but not the actual
contents).
This command is mostly deprecated, as REFRESH_SCREEN takes care of the
input line, as well as the rest of the screen. It is only really useful
for times when it may not be wise to refresh the rest of the screen,
such as if there were special ANSI escape sequences in the display
window or status bar. This is rarely the case, though.
See Also:
bind(4) refresh_screen

View File

@@ -0,0 +1,12 @@
Synopsis:
bind <key> refresh_screen
Description:
This function causes the client to redraw the screen line by line. It
is mostly only useful when another process sends data to the client's
tty, which sometimes corrupts the screen display (but not the actual
contents).
See Also:
bind(4) refresh_inputline

View File

@@ -0,0 +1,15 @@
Synopsis:
bind <key> reverse
Description:
This function toggles the current reverse video setting. Due to internal
limitations of the client, REVERSE is displayed as a V on the input line,
regardless of the key it is bound to.
See Also:
bind(4) blink, bold, highlight_off, underline;
set(4) reverse_video
Other Notes:
Boldfaced text can be typed at any time, but it will only be displayed
if REVERSE_VIDEO is on.

View File

@@ -0,0 +1,18 @@
Synopsis:
bind <key> scroll_backward
Description:
This function allows the user to move backwards in the client's lastlog
one page at a time. The percentage of the screen that makes up a page is
defined by the set(4) scrollback_ratio variable. This is useful for
reviewing events as they happened, in a manner easier than LASTLOG
provides.
This function requires that SCROLL be on in order to function. The
SCROLL_START function must be used to use the scrollback feature, and
SCROLL_END must be used to exit it.
See Also:
bind(4) scroll_end, scroll_forward, scroll_start; lastlog(1); set(4)
hold_mode, scroll, scrollback_ratio

View File

@@ -0,0 +1,10 @@
Synopsis:
bind <key> scroll_end
Description:
This function is used to end the lastlog scrollback mode.
See Also:
bind(4) scroll_backward, scroll_forward, scroll_start; lastlog(1);
set(4) hold_mode, scroll

View File

@@ -0,0 +1,18 @@
Synopsis:
bind <key> scroll_forward
Description:
This function allows the user to move forward in the client's lastlog
one page at a time. The percentage of the screen that makes up a page is
defined by the set(4) scrollback_ratio variable. This is useful for
reviewing events as they happened, in a manner easier than LASTLOG
provides.
This function requires that SCROLL be on in order to function. The
SCROLL_START function must be used to use the scrollback feature, and
SCROLL_END must be used to exit it.
See Also:
bind(4) scroll_end, scroll_backward, scroll_start; lastlog(1); set(4)
hold_mode, scroll, scrollback_ratio

View File

@@ -0,0 +1,14 @@
Synopsis:
bind <key> scroll_start
Description:
This function causes the client to enter scrollback mode. This allows
the lastlog buffer to be viewed interactively. Any server messages
received while in scrollback mode are queued, and are not displayed
until the client exits scrollback mode. It is generally a good idea to
set HOLD_MODE on while in scrollback mode.
See Also:
bind(4) scroll_backward, scroll_end, scroll_forward; lastlog(1);
set(4) hold_mode, scroll

View File

@@ -0,0 +1,15 @@
Synopsis:
bind <key> self_insert
Description:
This function overrides the key's default value, causing it to insert
itself into the input buffer, instead of doing what it would normally
do. This can be used to intentionally prevent certain control keys
from being misused.
This function has a similar effect on the specified key as the
QUOTE_CHARACTER function does on the key it precedes.
See Also:
bind(4) quote_character

View File

@@ -0,0 +1,11 @@
Synopsis:
bind <key> send_line
Description:
This function causes the current input buffer to be sent to the current
server, in a manner like that of SENDLINE. To quell any confusion,
this is typically the default behavior of the return/enter key.
See Also:
sendline(5)

View File

@@ -0,0 +1,12 @@
Synopsis:
bind <key> shove_to_history
Description:
This function causes the current input buffer to be placed in the
history buffer. The command itself is not actually executed. This
is useful for remembering a partially complete command, such that
it can be completed at a later time.
See Also:
bind(4) backward_history, forward_history; history(4)

View File

@@ -0,0 +1,15 @@
Synopsis:
bind <key> stop_irc
Description:
This command causes the client process to temporarily stop, returning
the user to the parent process that started the client (usually the
user's command shell). This is useful for executing commands that
aren't well suited to EXEC.
Other Notes:
Care should be taken with the length of time that the client is stopped
for. Unless it was originally started with the -S command line option,
it will have no way of listening to the server. This means that it
could be disconnected from the server if it misses a PING message.

View File

@@ -0,0 +1,11 @@
Synopsis:
bind <key> swap_last_window
Description:
This function swaps the current window with the most recently hidden
window. If no windows are hidden, this function has no effect.
See Also:
bind(4) swap_next_window, swap_previous_window; window(4) hide, next,
swap

View File

@@ -0,0 +1,11 @@
Synopsis:
bind <key> swap_next_window
Description:
This function swaps the current window with the next hidden window in
the window list. If no windows are hidden, this function has no effect,
See Also:
bind(4) next_window, swap_last_window, swap_previous_window; window(4)
hide, next, swap

View File

@@ -0,0 +1,11 @@
Synopsis:
bind <key> swap_previous_window
Description:
This function swaps the current window with the first previous hidden
window in the window list. It has no effect if no windows are hidden.
See Also:
bind(4) previous_window, swap_last_window, swap_next_window; window(4)
hide, previous, swap

View File

@@ -0,0 +1,12 @@
Synopsis:
bind <key> switch_channels
Description:
This function changes the current channel in the current window. It
can be used to cycle through all channels in the window. However, it
will only switch to channels that are not already being directed to
another window.
See Also:
join(1)

View File

@@ -0,0 +1,15 @@
Synopsis:
bind <key> toggle_insert_mode
Description:
This toggles the client's default input mode between insert mode and
overwrite mode. In insert mode, text typed in inserted into the input
buffer, shifting text following the input to the right, preserving it.
In overwrite mode, text typed will overwrite any following text. The
mode is insignificant when there is no text following the cursor.
This function is equivalent to setting INSERT_MODE to "toggle".
See Also:
set(4) insert_mode

View File

@@ -0,0 +1,13 @@
Synopsis:
bind <key> toggle_stop_screen
Description:
This function is used to pause or unpause the screen. It is effectively
the same as setting HOLD_MODE to "toggle", except the client doesn't
wait for a screenful of data before pausing the screen. The screen is
automatically unpaused if the SEND_LINE function is used.
See Also:
bind(4) send_line, unstop_all_windows; set(4) hold_mode; window(4)
hold_mode

View File

@@ -0,0 +1,8 @@
Synopsis:
bind <key> transpose_characters
Description:
This function swaps the character under the cursor with the character
immediately before it. It has no effect if the cursor is at the end
of the input line, or if no characters precede the current one.

View File

@@ -0,0 +1,11 @@
Synopsis:
bind <key> type_text
Description:
This function inserts its arguments into the input buffer. It works
essentially like the TYPE command. The setting of INSERT_MODE will
affect how the text is inserted.
See Also:
set(4) insert_mode; type(5)

View File

@@ -0,0 +1,9 @@
Synopsis:
bind <key> unclear_screen
Description:
This function un-clears a /clear command or a /bind <key> clear_screen.
See Also:
bind(4) clear_screen; clear(4)

View File

@@ -0,0 +1,16 @@
Synopsis:
bind <key> underline
Description:
This function toggles the current underline setting. Due to internal
limitations of the client, UNDERLINE is displayed as a _ on the input line,
regardless of the key it is bound to.
See Also:
bind(4) blink, bold, highlight_off, reverse;
set(4) underline_video
Other Notes:
Underlined text can be typed at any time, but it will only be displayed
if UNDERLINE_VIDEO is on.

View File

@@ -0,0 +1,10 @@
Synopsis:
bind <key> unstop_all_windows
Description:
This functions turns off HOLD_MODE for all windows. If a window was
stopped with TOGGLE_STOP_WINDOW, it is restarted.
See Also:
bind(4) toggle_stop_window; set(4) hold_mode; window(4) hold_mode

View File

@@ -0,0 +1,12 @@
Synopsis:
bind <key> yank_from_cutbuffer
Description:
This function restores the last text string deleted from the input
buffer with DELETE_NEXT_WORD, DELETE_PREVIOUS_WORD, ERASE_LINE,
ERASE_TO_END_OF_LINE, or DELETE_TO_PREVIOUS_SPACE.
See Also:
bind(4) delete_next_word, delete_previous_word, delete_to_previous_space,
erase_line, erase_to_end_of_line

16
bitchx-docs/4_Misc/cd Normal file
View File

@@ -0,0 +1,16 @@
Synopsis:
cd [<path>]
Description:
This is used to change the current working directory. If a path is
specified, the client will try to change to that directory; else, it
displays the current directory. This is useful for other commands
that deal with files but don't necessarily use absolute pathnames,
such as EXEC, log files, or DCC file transfers.
See Also:
which(4); which(6)
Other Notes:
CD is smart enough to expand tildes (~) to the user's home directory.

19
bitchx-docs/4_Misc/clear Normal file
View File

@@ -0,0 +1,19 @@
Synopsis:
clear [-all|-hidden|-visible] [-unhold]
Description:
This command clears the current window of all text. It is useful for
wiping a screen that has rendered improperly (such as due to a bad
termcap entry) or that contains sensitive information (such as one's
OPER password).
Options:
-all clears all windows, not just the current one
-hidden clears all hidden windows
-visible clears all visible windows
-unhold sets the window's HOLD_MODE off as well
See Also:
unclear(4); bind(4) clear_screen; set(4) hold_mode;
window(4) hold_mode

View File

@@ -0,0 +1,50 @@
Synopsis:
digraph [-<flag> [<arg0> <arg1> [<arg2>]]]
Description:
DIGRAPH allows you to maintain your client's internal digraph table.
A digraph is a series of keystrokes that are used to represent other
characters that may not physically be available on your keyboard
(such as the British pound sign on U.S. keyboards). To actually
enter a digraph, a key must be bound to ENTER_DIGRAPH, which then
makes the client interpret the next two characters as the desired
special character.
If no arguments are given to DIGRAPH, the current digraph table is
shown. Depending on the flag given, digraphs may be added, deleted,
or the entire digraph table may be cleared. If the SAVE command is
used, any changes made to the client's default internal digraph
table are saved in your .ircrc file.
Options:
-add This takes 3 arguments, the two characters to type to get
the digraph, and the digraph itself. Any of the 3
characters may be represented as literal characters or
their decimal equivalent, in any combination.
-remove This takes 2 arguments, the two characters used to obtain a
specific digraph. Either the literal characters or
decimal values may be used, as with -add.
-clear This takes no arguments, it just clears the internal
digraph table.
Examples:
To add a digraph for the character "c" by composing "a" and "b":
/digraph -add a b c
Another way of adding the same digraph:
/digraph -add 61 62 63
To remove the digraph set above:
/digraph -remove a b
To clear the internal digraph table:
/digraph -clear
See Also:
bind(4) enter_digraph; set(4) translation
Other Notes:
If your translation table is set to anything other than Latin-1,
some (or all) characters may be converted to something your terminal
is incapable of displaying. Your mileage will vary.

View File

@@ -0,0 +1,52 @@
Synopsis:
encrypt [<nickname|channel> [<key>]]
Description:
This allows you to maintain an encrypted conversation with a person
or channel. Any messages you send to the specified target will
automatically be encrypted. If the recipient has likewise specified
the proper encryption key for you, the incoming message will
automatically be decrypted. Both parties must use the same key for
the messages to be decrypted. Anyone receiving an encrypted message
without specifying the proper key will instead see "[ENCRYPTED
MESSAGE]" on their screen.
Unencrypted messages may still be sent to targets which you are
currently encrypting messages to. This is done by inserting a ^E
(control-E) as the first character of the message. This must be a
literal ^E, so it will either need to be quoted with whatever key is
bound to QUOTE_CHARACTER, or be bound to SELF_INSERT. It will
appear in your input line as "E".
If no arguments are specified, a list of nicknames (or channels)
that encrypted messages are being sent to is shown, along with their
respective keys. If only a nickname or channel is given, the
encrypted session with that target is ended.
Examples:
To start an encrypted session with JoeBob using the key "foobar":
/encrypt joebob foobar
To start an encrypted session with channel #blah using key "booya":
/encrypt #blah booya
To list your current encrypted sessions:
/encrypt
To end your encrypted session with JoeBob:
/encrypt joebob
See Also:
SET ENCRYPT_PROGRAM
Other Notes:
IrcII's built-in encryption is fine for most purposes, but since the
raw algorithm is hardcoded into the client, it's not terribly secure.
It is generally suitable to deter prying eyes, but is certainly not
suitable for genuinely sensitive transactions. If this bothers you,
an external encryption program may be used. You will need to set
ENCRYPT_PROGRAM to this program's path.
Encrypted messages may be sent across DCC CHAT connections. However,
non-EPIC3 clients will probably be confused by them.

View File

@@ -0,0 +1,39 @@
Synopsis:
history [<number>]
! [<history number|history match>]
Description:
Command history is a useful little feature that allows you to
quickly recall commands previously executed. The conventions
followed are similar to those of the GNU bash or Cornell's tcsh Unix
command shells. There are two versions of this command, one which
just lists out the command history, and another which actually
recalls a specific command for use on the input line.
The HISTORY command is the simple version. All it does is spit out
a list of commands you've previously entered (the exact number is
determined by your HISTORY setting). You can limit the number of
items to list, or just list all of them. Each item is assigned a
unique index number, which can be referred to by !. This list can
be saved for later use, if you have HISTORY_FILE set to something.
The more complex version is the ! command. Based on the input you
give it, it searches through your command history list and finds the
first item that matches your query and puts it on the input line for
immediate use. You can search based on a partial string (such as a
command name, so search for the last use of it), or an index number.
Examples:
To list the 50 most recent items in your command history:
/history 50
To find the most recent use of the MSG command:
/!/msg
To use item 37 in your command history:
/!37
See Also:
bind(4) forward_history, backward_history, shove_to_history; set(4)
history, history_file

View File

@@ -0,0 +1,29 @@
Synopsis:
hostname <address>
Description:
This command has two related, though distinct, purposes. The first is
mostly of interest to users whose ip addresses may change mid-session,
or those who are behind a firewall. It allows the user to specify the
hostname or ip address to use for DCC connections.
The second use is only of interest to users on machines with multiple
network interfaces, such as multi-homed sites. It allows the user to
force the client to bind to a particular network address that the host
has. If no address is given, the client uses the address for the
host's primary network interface. A default hostname or ip address
may be set in the IRCHOST environment variables. The client must
reconnect to a server for the setting to take effect.
Aliases:
IRCHOST is equivalent in function to HOSTNAME.
See Also:
Environment(7); dcc(1); reconnect(1)
Other Notes:
The client may not bind to addresses that the current host does not
specifically handle; the client does no sanity checking for such host
names or ip addresses, and irc servers will ignore them. The client
must reconnect to a server before the setting will take effect.

View File

@@ -0,0 +1,23 @@
Synopsis:
ircuser <username>
Description:
This lets the user specify what username to send to irc servers when
connecting to the network. Naturally, it requires that the client
have this set before actually connecting to the network.
See Also:
reconnect(1)
Restrictions:
This command is generally useless for users on hosts that use identd
(RFC 1413). Most modern irc servers query the host's identd server
to (try to) obtain the user's real username, and will ignore what the
client sends it.
Other Notes:
Yes, this is one of the more controversial elements of EPIC. It's
intent is to provide privacy for those who desire it. Those who use
it for abusive purposes can expect to be dealt with accordingly on
the servers and networks they use.

17
bitchx-docs/4_Misc/mesg Normal file
View File

@@ -0,0 +1,17 @@
Synopsis:
mesg [yes|no]
Description:
This command works exactly like the Unix command of the same name. It
effectively removes the world-write permissions on the client's tty,
such that incoming talk requests and writes are blocked. It is most
useful for dodging "flash" bombs; talk requests with special escape
sequences in the username that scramble vt100 terminals.
MESG used with no arguments displays the current setting.
Other Notes:
This command has the undesired side effect of blocking legitimate talk
requests. Talk and write are not blocked, however, when sent from the
host's superuser.

17
bitchx-docs/4_Misc/mlist Normal file
View File

@@ -0,0 +1,17 @@
Synopsis:
mlist <menu name> [<menu name> ...]
Description:
This command is used to list the contents of the specified menu. More
than one menu may be listed at once. If the menu name contains spaces
(which they are allowed to), the name must be surrounded by double
quotes (").
See Also:
Menus(7); bind(4) enter_menu; mload(4); set(4) menu
Bugs:
MLIST does not react well if a specified menu name has not been
loaded (or does not otherwise exist). For this reason, special care
must be taken when listing menu names with spaces in them.

15
bitchx-docs/4_Misc/mload Normal file
View File

@@ -0,0 +1,15 @@
Synopsis:
mload <menu file> [<menu file> ...]
Description:
This command loads the specified menu files. Menus are a convenient way
to offer access to commands or specialized online help. See the Menus
help file for information about creating menus.
See Also:
Menus(7); bind(4) enter_menu; mlist(4); set(4) menu
Restrictions:
Currently, menus cannot be unloaded. They can, however, be clobbered by
loading a new menu on top of an existing name.

48
bitchx-docs/4_Misc/note Normal file
View File

@@ -0,0 +1,48 @@
Synopsis:
note <command> [&<password>] [+|-<flags>] [<arguments>]
Description:
NOTE is a sort of turbo-charged messaging system for irc. In short, it
achieves at the server level what the client attempts to do with MSG
and NOTIFY. The messaging system resembles modern voice mail systems
(except in text); messages can be sent, stored, or set for deferred
delivery. The client notification system works like NOTIFY, except
with greater accuracy and flexibility.
The most common uses of NOTE are its SPY and SEND functions. SPY is
similar to NOTIFY, except it can accept a full address to spy on, not
just a nickname. SEND, as its name implies, sends a note to a user; if
that user is not currently online, it will be delivered if the user logs
onto irc within a set time period.
When referring to a particular user, NOTE can deal with the standard
nick!user@host notation. Wildcards are allowed, and any portion may be
omitted, so long as the identifier remains unambiguous.
Examples:
To send a note to Joebob (whose account is jbriggs@drivein.com):
/note send joebob!jbriggs@drivein.com Hey there! Great movie!
To spy on anyone from blah.com for the next 30 days:
/note spy +30 *!*@*.blah.com A blah.com user is active
Aliases:
Most NOTE commands are aliases to NOTE USER with certain flags applied.
See Also:
msg(1); notice(1); notify(1)
Restrictions:
NOTE is not available everywhere. It is used primarily on Undernet,
though even there it is not fully deployed. No servers on EFnet are
known to support NOTE. There is much debate over whether the usefulness
of NOTE outweighs its potential for invasion of privacy, to say nothing
of it requiring enough server resources to make its use prohibitive. A
discussion of the various NOTE commands is beyond the scope of these
help files.
Other Notes:
NOTE was originally developed in 1990 by jarle@stud.cs.uit.no (Wizible
on irc). Wizible is the authoritative source of information for this
command.

10
bitchx-docs/4_Misc/rbind Normal file
View File

@@ -0,0 +1,10 @@
Synopsis:
rbind <bind function>
Description:
This command is used to display the keys (or multi-key sequences) bound
to the specified function.
See Also:
Key_Bindings(7); bind(4)

View File

@@ -0,0 +1,21 @@
Synopsis:
realname [<text>]
Description:
REALNAME is used to set the client's IRCNAME (hence the alias, below).
The IRCNAME is an arbitrary text string that is displayed in WHOIS and
WHO output. Typically it contains the user's real name, but it may
contain anything the user desires. Use of this command will override
any previous setting to REALNAME, as well as the $IRCNAME environment
variable (if set).
Aliases:
IRCNAME is functionally equivalent to REALNAME.
See Also:
Environment(7); reconnect(1); set(4) realname
Restrictions:
This command does not change the IRCNAME on the fly. The client must
disconnect and reconnect to a server before it will take effect.

View File

@@ -0,0 +1,12 @@
Synopsis:
set always_split_biggest [on|off|toggle]
Description:
When turned on, this setting causes all new windows to split the largest
window on-screen in half to make room for it. If off, the current
window is split, unless it is too small to accommodate both windows, in
which case the largest will be split anyway.
See Also:
window(4) new

View File

@@ -0,0 +1,16 @@
Synopsis:
set auto_new_nick [on|off|toggle]
Description:
When turned on, this setting will cause the client to try to auto-
matically generate a new nickname during connection to a server if the
default choice is not available. The new nickname is based on the
chosen nickname, and the client may try up to 9 to 17 variations of it
before giving up and prompting for a new nickname to be typed in.
If it is turned off, the client will always prompt for a new nickname
to be typed in if the client cannot use the default choice.
See Also:
nick(1); on(5) disconnect, 436; server(1); window(4) server

View File

@@ -0,0 +1,16 @@
Synopsis:
set auto_reconnect_delay <seconds>
Description:
When you are kill(3)ed or disconnected from a server unexpectedly,
the client will automatically reconnect <seconds> seconds after the
disconnect.
Bugs:
This only reconnects you to the current window, so if a server in a
non-current window disconnects, auto_reconnect will fail. This is arguably
a bug, and may be fixed sometime in a later version.
See Also:
server(1); disconnect(1); kill(3).

View File

@@ -0,0 +1,18 @@
Synopsis:
set auto_rejoin [on|off|toggle]
Description:
When turned on, this will cause the client to try to automatically
rejoin any channel it is kicked out of. It will correctly rejoin
channels that have a channel key set, provided that key has not
changed between the kick and the rejoin attempt.
If turned off, the client behaves normally when kicked from a channel.
See Also:
join(1); mode(1); on(5) kick
Other Notes:
This setting should be turned off if the client has loaded a script
that tries to handle automatic rejoins itself.

View File

@@ -0,0 +1,14 @@
Synopsis:
set auto_rejoin_delay <seconds>
Description:
Automatically waits <seconds> seconds before rejoining a channel when
kicked. Will only work if set(4) auto_rejoin is ON.
See Also:
join(1); set(4) auto_rejoin; on(5) kick
Other Notes:
Many channel operators don't like it if you rejoin too early. It is good
netiquette to keep <seconds> above 4.

View File

@@ -0,0 +1,13 @@
Synopsis:
set auto_unmark_away [on|off|toggle]
Description:
When turned on, this will cause the client to unmark the client as
being away with the server if the SEND_LINE key function is used (in
other words, if a message is sent to the server). If off, the client
will only try to remove its away status with an AWAY is issued with
no arguments.
See Also:
away(1); bind(4) send_line

View File

@@ -0,0 +1,16 @@
Synopsis:
set auto_whowas [on|off|toggle]
Description:
When turned on, this setting will cause the client to automatically
issue a WHOWAS for any WHOIS query that returns an error (generally
meaning the queried nickname is not on irc). The client will limit
the number of WHOWAS replies displayed to the number specified by
the NUM_OF_WHOWAS variable.
If this variable is turned off, the client will not automatically
send a WHOWAS after any failed WHOIS query.
See Also:
on(5) 401; set(4) num_of_whowas; whois(2); whowas(2)

View File

@@ -0,0 +1,10 @@
Synopsis:
set banner <text>
Description:
Changes the default "***" in front of informational messages from the
client.
See Also:
set(4) banner_expand.

View File

@@ -0,0 +1,20 @@
Synopsis:
set banner_expand [on|off|toggle]
Description:
If this is ON, the value of set(4) banner will be evaluated every time
it is displayed.
Practical:
This is useful if you like to display the current time ($Z) in your
banner.
Example:
/set banner_expand ON
/set banner $Z ***
9:00PM *** CTCP PING from MrFoo detected
See Also:
set(4) banner

View File

@@ -0,0 +1,14 @@
Synopsis:
set beep [on|off|toggle]
Description:
When turned off, this suppresses any audible beeps the client may try
to use. Any ^G processed by the client will be printed as a G.
This setting will override the BEEP_ON_MSG and BEEP_WHEN_AWAY settings,
and will effectively disable the BEEP command.
If on, the client will audibly display all beeps normally.
See Also:
beep(4); set(4) beep_max, beep_on_msg, beep_when_away

View File

@@ -0,0 +1,12 @@
Synopsis:
set beep_max [<number>]
Description:
This variable sets the maximum number of beeps that the client will
make audible in any single message. When set to 0 (zero), the client
does not suppress any beeps. Set the BEEP variable off to suppress
all beeps.
See Also:
beep(4); set(4) beep, beep_on_msg, beep_when_away

View File

@@ -0,0 +1,13 @@
Synopsis:
set beep_on_msg all|none
set beep_on_msg [-]<level> [[-]<level> ...]
Description:
This setting causes the client to beep whenever a specific event is
triggered, in addition to any messages containing embedded beeps.
The valid event types are MSG, NOTE, NOTICE, PUBLIC, WALL, and
WALLOP; refer to LASTLOG_LEVEL for information on these levels.
See Also:
beep(4); set(4) beep, beep_max, beep_when_away, lastlog_level

View File

@@ -0,0 +1,11 @@
Synopsis:
set beep_when_away [<number>]
Description:
This variable specifies the number of times the client should beep
when it is marked away and receives an incoming MSG. The variable
must be unset to disable this feature.
See Also:
beep(4); set(4) beep, beep_max, beep_on_msg

View File

@@ -0,0 +1,14 @@
Synopsis:
set blink_video [on|off|toggle]
Description:
This setting controls how blinking text is displayed in the input line
and the display window. If it is turned on, the BLINK key function
(usually ^F; Control-F) will toggle blinking text on and off. If off, it
will strip out all BLINKs In the displayed text, effectively disabling
blinking text.
See Also:
bind(4) blink, bold, highlight_off, reverse, underline;
set(4) blink_video, bold_video, reverse_video, underline_video

View File

@@ -0,0 +1,14 @@
Synopsis:
set bold_video [on|off|toggle]
Description:
This setting controls how boldfaced text is displayed in the input line
and the display window. If it is turned on, the BOLD key function
(usually ^B; Control-B) will toggle boldfacing on and off. If off, it
will strip out all BOLDs In the displayed text, effectively disabling
boldfacing.
See Also:
bind(4) blink, bold, highlight_off, reverse, underline;
set(4) blink_video, bold_video, reverse_video, underline_video

View File

@@ -0,0 +1,12 @@
Synopsis:
set channel_name_width [<number>]
Description:
This variable sets the maximum width a channel's name may use on the
client's status bar. If set to 0 (zero), there is no limit on the
length of the channel's name. This variable also affects the default
display of LIST and NAMES output.
See Also:
list(2); names(2); set(4) status_channel, status_format

View File

@@ -0,0 +1,10 @@
Synopsis:
set client_information [<text>]
Description:
The contents of this variable are appended to the client's default
CTCP VERSION reply.
See Also:
ctcp(1) version

View File

@@ -0,0 +1,11 @@
Synopsis:
set clock [on|off|toggle]
Description:
When turned on, the current time may be displayed in the status bar
with the STATUS_CLOCK variable. If off, STATUS_CLOCK will display
nothing.
See Also:
set(4) clock_24hour, clock_alarm, status_clock; time(1)

View File

@@ -0,0 +1,12 @@
Synopsis:
set clock_24hour [on|off|toggle]
Description:
When turned on, this setting causes the status bar clock to be shown
in 24-hour format (military style). When off, the clock will display
"AM" or "PM" to designate the true time. The clock is displayed in
the %Z expando in the status bar.
See Also:
set(4) clock, status_clock

View File

@@ -0,0 +1,14 @@
Synopsis:
set clock_alarm [<time>|off]
Description:
This variable sets an alarm that will go off that the specified time.
The time format may be in either 12-hour (AM or PM) or 24-hour format;
if no "AM" or "PM" is given, 24-hour format is assumed. The alarm
itself consists of a one-line message and a beep, repeated every 10
seconds until the next minute has elapsed. The setting of CLOCK has
no effect on the alarm.
See Also:
set(4) clock

View File

@@ -0,0 +1,10 @@
Synopsis:
set clock_format <text>
Description:
This determines the format of the status bar clock. It is unset by default,
and yields the traditional behavior until is given a value.
See Also:
set(4) clock_24hour, status_format

View File

@@ -0,0 +1,11 @@
Synopsis:
set cmdchars [<characters>]
Description:
This variable sets all characters that may be used as a command
character on the input line. Any number of characters may be
specified, and the slash '/' will always be assumed.
See Also:
set(4) command_mode

View File

@@ -0,0 +1,12 @@
Synopsis:
set color [on|off|toggle]
Description:
When turned on, the client will parse ^C color codes as used by several
GUI clients (ircle, mIRC). This requires a compile-time option in config.h
to be defined. The default is OFF. When OFF, color codes will be filtered
out of all output, and their color values ignored.
See Also:
echo(5)

View File

@@ -0,0 +1,26 @@
Synopsis:
set command_mode [on|off|toggle]
Description:
When turned on, this causes the client to behave somewhat like a MUD
client. The default input (when no command character is used) runs
a command instead of sending text to the current channel or query.
The normal leading "/" may be included with the command, but it is
not required in this mode. Additionally, if the leading character
is a "'", the remaining text in the input buffer is passed as the
argument to SEND.
The client behaves normally when COMMAND_MODE is off.
Examples:
To send a message to the current channel or query:
send Hi there!
'Hi there!
To force a message to be sent to the current channel during a query:
say Hi there!
See Also:
load(5) action, mudlike; say(1); send(5)

View File

@@ -0,0 +1,19 @@
Synopsis:
set comment_hack [on|off|toggle]
Description:
This variable determines how the client will handle C-style comments in
loaded scripts. When turned on, it causes the client to only recognize
such comments when they start at the beginning of a line. When off,
the comments may begin anywhere.
This feature is present primarily to retain compatibility with scripts
designed for older clients. See the COMMENT help file for details.
See Also:
comment(5)
Other Notes:
This setting replaces the compile-time #define of the same name that is
present in versions of EPIC prior to 3.001.

View File

@@ -0,0 +1,10 @@
Synopsis:
set connect_timeout [<number>]
Description:
This variable controls how many seconds a connect(5) waits before it
times out. This only controls new connect()s, and not ones in progress.
See Also:
connect(5); listen(5).

View File

@@ -0,0 +1,13 @@
Synopsis:
set continued_line [<text>]
Description:
The text in this variable, if any, will be prepended to any lines
printed that are wider than the display. This is to provide a visual
indicator that the line is part of the previous line, and not a new
message. This variable may be set in conjunction with the INDENT
variable.
See Also:
set(4) indent

View File

@@ -0,0 +1,14 @@
Synopsis:
set cpu_saver_after [<minutes>]
Description:
This triggers CPU Saver mode after <minutes> without a keypress.
See Also:
set(4) cpu_saver_every
Other Notes:
When CPU Saver is enabled, the status bar isn't updated and the notify list
isn't checked. If either this value or set(4) cpu_saver_every is 0,
CPU Saver mode will not activate.

Some files were not shown because too many files have changed in this diff Show More