Seeding from the 1.2 tree.

This commit is contained in:
Dan Mashal
2013-01-01 03:00:55 -08:00
parent d8c87c4ded
commit 87b806a563
1424 changed files with 260320 additions and 0 deletions

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.

View File

@@ -0,0 +1,15 @@
Synopsis:
set cpu_saver_every [<minutes>]
Description:
This determines how often the client will update status bar, check the
time, and check the notify list.
See Also:
set(4) cpu_saver_after
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.

View File

@@ -0,0 +1,16 @@
Synopsis:
set current_window_level [<lastlog levels>]
Description:
This variable takes a lastlog level description (eg. "MSGS,PUBLIC,CRAP")
which defines which levels are redirected to the current window. This
means all output with the levels in this variable are *NOT* sent to
their regular window, but the current window instead.
Example:
To send all output with the level "CRAP" to the current window:
/set current_window_level CRAP
See Also:
window(4) level

View File

@@ -0,0 +1,10 @@
Synopsis:
set dcc_auto_timeout [<seconds>]
Description:
This variable determines after how many seconds an offered DCC connection
will be automatically closed if the user hasn't accepted.
See Also:
dcc(1) close, closeall

View File

@@ -0,0 +1,16 @@
Synopsis:
set dcc_long_pathnames [on|off|toggle]
Description:
When turned on, this variable will cause the client to display the
full pathnames of all files being transferred to or from the client
via DCC. When off, only the filenames are shown, not their parent
directories.
See Also:
dcc(1) list
Other Notes:
This setting does not affect the actual filename, only how it is
displayed.

View File

@@ -0,0 +1,19 @@
Synopsis:
set dcc_sliding_window [<number>]
Description:
This implements a simplified version of the traditional sliding window
algorithm for DCC SENDs. The client keeps <size> packets ready to
send at all times, which can speed up DCC file transfers a great deal
over slow network connections. No special support is required by the
receiving client.
The size is measured in 2k blocks, and is set by default at 2 (4k).
No error correction is even attemted by the client, rather it relies
completely on TCP to keep things straight. The feature can effectively be
disabled by setting it to 1.
See Also:
dcc(1) list

View File

@@ -0,0 +1,13 @@
Synopsis:
set dcc_store_path [<path>]
Description:
This sets the default directory to store files retrieved with DCC GET.
Naturally, the client must have write permissions in the chosen
directory for it to work properly (the client will not warn if it has
insufficient access). The default is to save the file to the current
directory.
See Also:
cd(4); dcc(1) get

View File

@@ -0,0 +1,32 @@
Synopsis:
set debug [<level>]
Description:
When turned on, this variable enables various degrees of debugging
while the client is running. It is useful for seeing precisely where
a particular alias or function is failing, what variables are being
assigned what values, etc. There are three general classes of debug
output, each assigned a unique number.
Bit Value Purpose
0 1 displays all commands executed, including aliases
1 2 displays all actual alias and variable substitutions
2 4 displays all function calls and their return values
Multiple classes may be displayed at once by adding the desired
values together. A setting of 0 (zero) turns off debugging.
Examples:
To show all commands executed and alias expansion:
/set debug 3
To show everything:
/set debug 7
See Also:
set(4) hold_mode
Other Notes:
This command can generate a lot of output, so setting HOLD_MODE on is
recommended.

View File

@@ -0,0 +1,10 @@
Synopsis:
set dispatch_unknown_command [on|off|toggle]
Description:
When this is set ON, all commands unknown to the client will be sent to the
server.
See Also:
quote(5).

View File

@@ -0,0 +1,18 @@
Synopsis:
set display [on|off|toggle]
Description:
When turned off, this setting will cause the client to suppress all
messages from being displayed (though it can still act on them
internally. However, ECHO can still be used to explicitly print
messages to the display.
See Also:
echo(5); xecho(5)
Other Notes:
This setting is automatically turned off while a script file is being
loaded, including the .ircrc file. It is turned on again when the
file finishes loading. This can be overridden by explicitly setting
DISPLAY on inside the loaded scripts.

View File

@@ -0,0 +1,24 @@
Synopsis:
set display_ansi [on|off|toggle]
Description:
When turned on, this setting will cause the client to allow escape
sequence color and highlight codes to be passed to the display window.
All other recognizable escape sequences will be removed.
If turned off, the behavior is to convert all instances of ^[ (the ESC
character) to [.
This setting only affects the display window, not the status bar. This has
the advantage of allowing ECHO and other commands to display special ANSI
escape sequences for color and highlighting, etc.
Note that this setting is meaningless unless set(4) color is turned ON.
See Also:
set(4) color, display; echo(5); xecho(5)
Other notes
Also note that due to ircII-EPIC's new behavior of removing all unrecognized
escape sequences, the client is no longer vulnerable to "flash" attacks and
such evil ANSI codes that could scramble a vt100-compatible display.

View File

@@ -0,0 +1,13 @@
Synopsis:
set do_notify_immediately [on|off|toggle]
Description:
When this is set ON, the notify list is checked on every /notify command.
Else, it will wait until the top of the minute to update. This was added
primarily to speed up server connects, since so many people have huge
notify lists which slow down an initial connection.
See Also:
notify(1); set(4) notify_handler, notify_level, notify_interval,
notify_on_termination

View File

@@ -0,0 +1,14 @@
Synopsis:
set eight_bit_characters [on|off|toggle]
Description:
When turned on, this setting allows 8-bit characters to be entered on
the input line. Character sets that are 8-bit include Swedish, Finnish,
Norwegian, and just about anything that isn't US-ASCII. Note that an
appropriate translation table must be used for the characters to be
displayed properly. Characters can be entered as digraphs, or with
various meta keys, depending on the environment the client runs in.
See Also:
digraph(4); set(4) translation

View File

@@ -0,0 +1,13 @@
Synopsis:
set encrypt_program [<program>]
Description:
This features allows the user to specify an alternate means of
encrypting (and decrypting) messages when ENCRYPT is used. Both the
sender and the recipient must use the same program for this to work
properly. In order to function with the client, the program must
take the encryption key as the first command-line argument.
See Also:
encrypt(5)

View File

@@ -0,0 +1,12 @@
Synopsis:
set floating_point_math [on|off|toggle]
Description:
When turned on, EPIC becomes capable of handling floating-point math
operations. In truth, all math is done in floating-point, except the
normal behavior is to convert everything to integers before actually
displaying them.
See Also:
Expressions(7)

View File

@@ -0,0 +1,11 @@
Synopsis:
set flood_after [<number>]
Description:
This setting specifies how many messages must be received before
triggering the FLOOD hook. Naturally, the hook is only triggered if
the message rate meets or exceeds the FLOOD_RATE setting.
See Also:
on(5) flood; set(4) flood_rate, flood_users, flood_warning

View File

@@ -0,0 +1,14 @@
Synopsis:
set flood_rate [<number>]
Description:
This variable sets the message rate (per second) that will trigger the
FLOOD hook, if the total message count exceeds the FLOOD_AFTER setting
at the given rate. Thus, if messages from a remote client outpace the
FLOOD_RATE for at least FLOOD_AFTER messages, the FLOOD hook is caught.
If FLOOD_RATE is larger than FLOOD_AFTER, the client will not trigger
the hook until at least FLOOD_RATE messages have been received.
See Also:
on(5) flood; set(4) flood_after, flood_users, flood_warning

View File

@@ -0,0 +1,11 @@
Synopsis:
set flood_users [<number>]
Description:
This variable sets the maximum number of users (unique nicknames) that
the client will perform flood protection for. Larger numbers may start
to affect client performance, so experiment with this value as needed.
See Also:
on(5) flood; set(4) flood_after, flood_rate, flood_warning

View File

@@ -0,0 +1,12 @@
Synopsis:
set flood_warning [on|off|toggle]
Description:
When turned on, the client will display a message to the user to that
effect (who is flooding, what type, etc.). If off, the client does
not warn the user that flood protection has kicked in, unless a custom
message is returned from within the FLOOD hook.
See Also:
on(5) flood; set(4) flood_after, flood_rate, flood_users

View File

@@ -0,0 +1,11 @@
Synopsis:
set full_status_line [on|off|toggle]
Description:
When turned on, the client's status bar will be drawn across the full
width of the screen. If off, it is only as long as needed to hold
the information it contains.
See Also:
set(4) status_format

View File

@@ -0,0 +1,15 @@
Synopsis:
set help_pager [on|off|toggle]
Description:
When turned on, the client will pause after every windowful of help,
much like HOLD_MODE. When off, the help will scroll until the end of
the file has been reached.
See Also:
help(1); set(4) help_service, hold_mode; window(4) hold_mode
Other Notes:
This setting has no effect when receiving help from a help service on
the irc network. Use HOLD_MODE instead.

View File

@@ -0,0 +1,15 @@
Synopsis:
set help_path [<directory>]
Description:
This variable, if set, contains the path to the top-level help directory
for ircII-EPIC. The path may be relative or absolute; absolute is
recommended.
See Also:
help(1)
Restrictions:
Unlike LOAD_PATH, and most other "path" settings, the HELP_PATH may
only contain a single directory, not a list to search through.

View File

@@ -0,0 +1,11 @@
Synopsis:
set help_prompt [on|off|toggle]
Description:
When turned on, the client will prompt for another help file to display
after displaying the first. If off, the client returns to input mode
immediately.
See Also:
help(1)

View File

@@ -0,0 +1,19 @@
Synopsis:
set help_window [on|off|toggle]
Description:
When turned on, this setting will cause the client to create a new
window to display help files in when HELP is used. The window creation
will obey the ALWAYS_SPLIT_BIGGEST setting. The window will be killed
when the user is finished using help.
If off, the client will display the help in the current window.
See Also:
help(1); set(4) always_split_biggest, help_prompt
Bugs:
This setting does not work well when HELP_PROMPT is turned off, as it
will end the HELP command immediately, this killing the new window
immediately.

View File

@@ -0,0 +1,11 @@
Synopsis:
set hide_private_channels [on|off|toggle]
Description:
When turned on, the client will not display the name of any current
channel in the status bar if that channel is +p or +s. Instead, it
will display "*private*".
See Also:
mode(1)

View File

@@ -0,0 +1,11 @@
Synopsis:
set high_bit_escape [0|1|2]
Description:
This controls how the client handles 8-bit characters. If set to 0, the
client will strip the 8th bit, yielding only a 7-bit ascii character. If
set to 1, and the 'km' termcap value is set (it should be), the client will
treat the character as an ESC-X sequence, where X is the character stripped
to its 7th bit. If set to 2, the client will treat the 8-bit character as
any other, and not perform any special parsing.

View File

@@ -0,0 +1,16 @@
Synopsis:
set highlight_char [bold|inverse|underline|<string>]
Description:
This setting determines how "highlighted" messages are to be displayed.
Messages from a user are tagged to be highlighted when the IGNORE
command is used, and the user's nick!user@host pattern is prepended
with a '+'.
The highlight character may be any of "bold", "inverse", or "underline",
or any arbitrary string. Typically the string will contain some ANSI
escape sequence that will do its own highlighting of the text.
See Also:
ignore(1); set(4) display_ansi

View File

@@ -0,0 +1,17 @@
Synopsis:
set history [<number>]
Description:
This setting controls the number of commands to be stored in the
client's internal history buffer. Setting it to 0 (zero) effectively
disables command history. However, the client will continue to save
commands to an external file unless HISTORY_FILE is disabled as well.
A command is inserted into the history buffer when it is executed, or
when the SHOVE_TO_HISTORY key function is used. The history buffer
is not purged when HISTORY is disabled.
See Also:
bind(4) backward_history, forward_history, shove_to_history;
history(4); set(4) history

View File

@@ -0,0 +1,22 @@
Synopsis:
set history_file [<filename>]
Description:
If this variable is set, the client will (attempt to) write out the
command history to the given file. It will also read the history from
this file. This has the advantage of keeping the client's memory
usage to a minimum, but it can slow performance.
This feature can be disabled by unsetting the variable, or setting it
to "<empty>". The HISTORY setting must also be disabled to completely
disable command history.
See Also:
bind(4) backward_history, forward_history, shove_to_history;
history(4); set(4) history
Other Notes:
Setting HISTORY_FILE to /dev/null is not recommended, as the behavior
is, at best, undefined, due to the various ways different Unixes handle
reads from and writes to the device.

View File

@@ -0,0 +1,20 @@
Synopsis:
set hold_mode [on|off|toggle]
Description:
When turned on, this setting causes the client to pause the held window
after each screenful of data, unless there is interaction by the user.
If the user does not issue a command of some sort within one screenful,
EPIC will buffer all further incoming messages. An issued command or a
simple carriage return will cause the display to advance another
screenful, and so on, until the display is up to date again.
See Also:
set(4) hold_mode_max, status_hold; window(4) hold_mode, new
Other Notes:
When using multiple ircII windows, the setting of HOLD_MODE does not
change the current HOLD_MODE of any windows. Rather, it refers to the
default mode for any new windows. The WINDOW HOLD_MODE command must
be used to hold and unhold individual windows.

View File

@@ -0,0 +1,20 @@
Synopsis:
set indent [on|off|toggle]
Description:
When turned on, long lines will be wrapped such that they are indented
to the same position as the second word on the first line. Subsequent
wrapping of the same line will be indented to the same place.
If CONTINUED_LINE is also set, the client will pad the wrapped portions
of the line with the CONTINUED_LINE contents, unless CONTINUED_LINE
happens to be longer than the indented space. CONTINUED_LINE will not
be truncated in this event; it is either displayed in full, or not at
all.
The client will never indent a line more than one-third the width of
the screen when INDENT is enabled.
See Also:
set(4) continued_line

View File

@@ -0,0 +1,33 @@
Synopsis:
set input_aliases [on|off|toggle]
Description:
This setting controls how variables and functions are expanded when used
directly on the input line. When turned on, references to them are
treated as though the command was passed through EVAL; then are expanded
inline before being passed to the calling command as arguments.
This setting will not automatically expand items inside parentheses or
curly braces, however. The opening brace or parenthesis must be
quoted with the quote character, '\', for expansion to occur. Nested
braces or parenthesis must be double quoted, and so on.
Examples:
Assuming INPUT_ALIASES is on, $0 is "foo", and $blah is "bar":
${[$0]} expands to "foo"
${[$blah]} expands to "bar"
${blah} expands to "bar", too
${ blah == [bar] } expands to "1"
${ [$0] == [foo] } expands to "1"
${ [$0] == [bar] } expands to "0"
${ [$0](booya) } expands to the return value of $foo(booya)
See Also:
Expressions(7); Special_Vars(7); eval(5)
Other Notes:
The behavior of INPUT_ALIASES is different when used inside a loaded
script. Variables and functions must use EVAL for inline expansion.
Instead, this setting causes the standard numeric expandos to return
the command line arguments used to start the client.

View File

@@ -0,0 +1,21 @@
Synopsis:
set input_prompt [<string>]
Description:
This setting allows the user to add a custom string the the beginning
of the input line (for display purposes). Much like the various Unix
shells, the prompt can contain any string desired.
It is generally used for displaying information about the current
target (such as a channel or queried nickname). Any variables used in
the prompt are re-evaluated after each command issued from the input
prompt.
Also note that any special highlight character (^B, ^C, etc) may be used
in this setting.
To disable the input prompt, unset the variable.
See Also:
Special_Vars(7)

View File

@@ -0,0 +1,12 @@
Synopsis:
set insert_mode [on|off|toggle]
Description:
When this setting is on, text typed on the input line in the middle of
a text string will shift the text to the right, making room for the
text being typed. If it is off, the typed text overwrites anything
ahead of it.
See Also:
bind(4) toggle_insert_mode

View File

@@ -0,0 +1,13 @@
Synopsis:
set inverse_video [on|off|toggle]
Description:
This setting controls how inverted text is displayed in the input line
and the display window. If it is turned on, the REVERSE key function
(usually ^V) will toggle inverse video on and off. If off, it will
strip out all REVERSEs In the displayed text, effectively disabling
reversed text.
See Also:
bind(4) highlight_off, reverse; set(4) bold_video, underline_video

View File

@@ -0,0 +1,10 @@
Synopsis:
set lastlog [<number>]
Description:
This option sets the size of the client's lastlog buffer. It can be
disabled if set to 0 (zero).
See Also:
lastlog(1); set(4) lastlog_level, log, logfile

View File

@@ -0,0 +1,39 @@
Synopsis:
set lastlog_level [[-]<level> [[-]<level> ...]]
Description:
This setting controls the type(s) of information that EPIC will store
in its lastlog buffer. Any single message type, or any combination,
may be used. If a type is prepended with a '-', messages of that type
are explicitly not saved (useful with the ALL type). Message types
may be abbreviated unambiguously.
Options:
actions public and private CTCP ACTION messages
ctcp CTCP messages (except ACTION and DCC)
dcc DCC messages
msgs MSG messages
notes NOTE messages (not supported on all servers)
notices NOTICE messages
opnotes operator broadcast messages
public public channel messages
snotes anything hooked by the SERVER_NOTICE hook
userlog1 - 4 reserved for the user (available with XECHO)
walls WALL messages (deprecated, no servers support it)
wallops WALLOP messages
crap everything else (channel joins/parts, mode changes...)
all all of the above
none none of the above
Examples:
To log everything except server and operator notices:
/set lastlog_level all -opnotes -snotes
See Also:
ctcp(1); dcc(1); msg(1); note(4); notice(1); on(5) server_notice; set(4)
lastlog; wallop(3); window(4) lastlog_level; xecho(5)
Bugs:
Message type names may only be abbreviated when including the type. The
full name must be given when excluding the type with a '-'.

View File

@@ -0,0 +1,25 @@
Synopsis:
set load_path [<directory>[:<directory> ...]]
Description:
This setting is used primarily by LOAD and WHICH (and thus the $which()
function). If the client tries to access a file and cannot find it, it
searches through each directory listed in the LOAD_PATH. It operates
much like the PATH statement in Unix shells. The directories are
searched sequentially.
Examples:
To set the path to your home directory, and the client's script library:
/set load_path ~:/usr/local/irc/script
To add ~/my_irc to the path:
/eval set load_path ${load_path}:~/my_irc
See Also:
Environment_Vars(7); File_Ops(6); load(4); which(5)
Other Notes:
The client will also obey the IRCPATH environment variable when first
starting the client. It will override LOAD_PATH until the client is
started completely (i.e. everything in the .ircrc has loaded).

View File

@@ -0,0 +1,15 @@
Synopsis:
set log [on|off|toggle]
Description:
This variable globally sets whether the client saves its lastlog buffer
to an external file. The actual buffer itself isn't saved, rather
anything that is saved to the buffer is also saved to the file.
If multiple windows are in use, this setting will affect all of them,
and will make no distinction in the log file as to which messages are
from which window. In this case, WINDOW LOG should be used.
See Also:
set(4) lastlog, logfile; window(4) log

View File

@@ -0,0 +1,11 @@
Synopsis:
set logfile [<filename>]
Description:
This variable sets the name of the file the client will log to when the
LOG variable is on. This setting can be overridden by a logfile setting
for a specific window.
See Also:
set(4) log; window(4) logfile

View File

@@ -0,0 +1,18 @@
Synopsis:
set mail [<0|1|2>]
Description:
This setting affects how the client checks for new mail. When set to
0 (zero), mail checking is disabled. When set to 1 (one), the client
will periodically report how many new messages have arrived since the
last check, and the total message count. When set to 2 (two), the
client shows the sender and subject of each new message as well.
See Also:
on(5) mail; set(4) status_mail
Other Notes:
The client will only search for new mail in the user's mail spool. The
mail spool directory location is hardcoded into the client at compile
time.

View File

@@ -0,0 +1,12 @@
Synopsis:
set max_recursions [<number>]
Description:
This setting limits the number of times a function or alias can call
itself before returning or exiting. This is a safety precaution to
prevent the client from looping infinitely. Setting this variable to
0 (zero) effectively disables alias recursion.
See Also:
load(5) recursion

View File

@@ -0,0 +1,11 @@
Synopsis:
set menu [<menu name>]
Description:
When defined, the client will display the specified menu (assuming it
has been loaded) on screen. Only one menu may be displayed at a time.
The ENTER_MENU key function is used to enter the menu.
See Also:
Menus(7); bind(4) enter_menu; mlist(4); mload(4)

View File

@@ -0,0 +1,10 @@
Synopsis:
set mirc_broken_dcc_resume [on|off|toggle]
Description:
This variable determines wether mIRC-compatible dcc(1) resume
capability is enabled.
See Also:
dcc(1) resume

View File

@@ -0,0 +1,13 @@
Synopsis:
set mode_stripper [on|off|toggle]
Description:
When turned on, the client can make use of the MODE_STRIPPED hook.
This essentially breaks down complex mode changes into single mode
changes, making each individual mode change easier to process and
act upon. This only affects the display of the modes, and it does
not interfere with the MODE hook.
See Also:
mode(1); on(5) mode_stripped

View File

@@ -0,0 +1,10 @@
Synopsis:
set nd_space_max [<number>]
Description:
This variable sets how many non-destructive spaces may appear in one line
of output.
See Also:
set(4) tab_max

View File

@@ -0,0 +1,11 @@
Synopsis:
set no_control_log [on|off|toggle]
Description:
When turned on, the client will strip all non-printable characters from
the logfile. When off, the default behavior of outputting directly to
the logfile is used.
See Also:
lastlog(1); set(4) logfile

View File

@@ -0,0 +1,15 @@
Synopsis:
set no_ctcp_flood [on|off|toggle]
Description:
When turned on, the client will only return at most one CTCP reply every
2 (two) seconds to any particular nickname. Additional CTCP requests
within that time frame are simply ignored.
See Also:
ctcp(1); ignore(1)
Other Notes:
The client checks this variable on a per-nickname basis. This makes it
ineffective when being flooded by multiple clients in concert.

View File

@@ -0,0 +1,14 @@
Synopsis:
set no_fail_disconnect [on|off|toggle]
Description:
When this is set ON, the client will not automatically try to reconnect
when a write() to a server fails. This is mostly only useful in situations
like mine, where you have a dialup static IP where packets are retained
when you are disconnected. This means that a person with a static IP can
set this ON, disconnect from the ISP, reconnect to the ISP, and never
leave irc.
See Also:
disconnect(1); discon(1); reconnect(1); server(1)

View File

@@ -0,0 +1,22 @@
Synopsis:
set notify_handler [<old|quiet|noisy>]
Description:
This setting controls when the client will report a signon or signoff
for a user in the notify list. The normal behavior is to check for
every nickname in the list at set intervals. This setting allows the
client to internally register a signon (or signoff) based on other
information that would clearly indicate it, such as a JOIN or QUIT.
Options:
noisy trigger NOTIFY on JOINs, SIGNOFFs, and 401 numerics
old normal behavior from stock 2.2.x ircII clients
quiet only trigger NOTIFY on WHOIS+ and ISON output
See Also:
ison(2); join(1); notify(1); on(5) 401; signoff(1); whois(2)
Other Notes:
The OLD and QUIET settings function the same. It is uncertain whether
this is the intended behavior.

View File

@@ -0,0 +1,16 @@
Synopsis:
set notify_interval <seconds>
Description:
This determines how often the notify list is sent to the server to be
checked.
See Also:
away(1); bind(4) send_line
Other Notes:
This value does not change the client's default behavior of checking the
notify list on the top of every minute, however, it does change how many
minutes will skip checking the list. For this variable, a multiple of 60
is advised, and a value less than 60 will be ignored.

View File

@@ -0,0 +1,11 @@
Synopsis:
set notify_level [<levels>]
Description:
This variable sets the client's default NOTIFY_LEVEL used when a new
window is created. Refer to SET LASTLOG_LEVEL for a full explanation
of the available levels.
See Also:
set(4) lastlog_level; window(4) notify_level, new

View File

@@ -0,0 +1,13 @@
Synopsis:
set notify_on_termination [on|off|toggle]
Description:
When turned on, this setting causes the client to display a message
when an EXECed process has terminated, and with what exit code.
See Also:
exec(5)
Other Notes:
This setting does not affect, nor is it affected by, the EXEC_EXIT hook.

View File

@@ -0,0 +1,13 @@
Synopsis:
set notify_userhost_automatic [on|off|toggle]
Description:
If this is ON, several things occur. When on(5) notify_signon is
hooked, a userhost(2) is issued on the person who signed on. The $2
parameter of on(5) notify_signon is set to the person's user@host.
When someone appears on the notify list whose hostname is already in
the internal list, it won't query the server.
See Also:
notify(1)

View File

@@ -0,0 +1,17 @@
Synopsis:
set novice [on|off|toggle]
Description:
This is a security option. When turned on, it prevents the user from
interactively setting any hooks, and issues an automatic PART if the
client is on a channel and a JOIN is issued (allowing the user to use
only one channel at a time).
See Also:
New_User(7); on(5); set(4) security
Other Notes:
This setting does not prevent hooks from being set from within loaded
files. It only prevents them from being set (or viewed) from the
input line.

View File

@@ -0,0 +1,11 @@
Synopsis:
set num_of_whowas [<number>]
Description:
This setting controls how many replies are displayed from the WHOWAS
command, or as a result of having AUTO_WHOWAS turned on. If set to 0
(zero), all replies are displayed.
See Also:
set(4) auto_whowas; whowas(2)

View File

@@ -0,0 +1,15 @@
Synopsis:
set pad_char [<character>]
Description:
If this variable is set, the character it is set to will be used to pad
right-aligned text, instead of using spaces. It can be set to a space,
or unset, to return to the default behavior.
See Also:
Expressions(7)
Other Notes:
This variable can actually be set to a string of any length. However,
only the first character is actually significant in this context.

View File

@@ -0,0 +1,9 @@
Synopsis:
set quit_message [<text>]
Description:
When you issue a /quit without arguments, <text> will be your quit reason.
See Also:
quit(1).

View File

@@ -0,0 +1,22 @@
Synopsis:
set realname [<text>]
Description:
If set, the client will use the value of this variable as its IRCNAME
when connecting to new servers. The variable may be set to anything
desired, including nothing. If unset, the client will use the value
in the environment variable IRCNAME, or failing that, the value in
the user's GCOS field in the system password file.
Aliases:
Setting this variable is essentially equivalent to using the REALNAME
command.
See Also:
Environment(7); realname(4); reconnect(1); server(1)
Other Notes:
The nature of irc servers is such that this information cannot be
changed on the fly. The client must establish a connection with a new
server (or reconnect to the current one) for the setting to take
effect.

View File

@@ -0,0 +1,10 @@
Synopsis:
set reverse_status_line [on|off|toggle]
Description:
When turned on, this setting will cause the client to display the status
bar in reversed text, making it stand out more clearly.
Other Notes:
This setting is not affected by the INVERSE_VIDEO setting.

View File

@@ -0,0 +1,14 @@
Synopsis:
set reverse_video [on|off|toggle]
Description:
This setting controls how reversed text is displayed in the input line
and the display window. If it is turned on, the REVERSE key function
(usually ^V; Control-V) will toggle reversed text on and off. If off, it
will strip out all REVERSEs In the displayed text, effectively disabling
reversed 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,12 @@
Synopsis:
set screen_options [<options>]
Description:
The contents of this variable are passed to the Screen program. Screen
is used when the client tries to create a new window, if the client was
started "behind" Screen. See the WINDOW and WINDOW CREATE help file for
more information.
See Also:
window(4)

View File

@@ -0,0 +1,19 @@
Synopsis:
set scroll [on|off|toggle]
Description:
When turned on, the client will scroll text in a continuous, flowing
fashion. Old messages are progressively moved to the top of the
screen (and off of it) as new text is added to the bottom.
When turned off, the client will overwrite old text with new text,
screen by screen. This is primarily aimed at users with extremely
dumb terminals (or terminal emulations) that cannot handle simple
scrolling. Typical behavior of such terminals includes repeated
overwriting of the last line in the display, instead of scrolling
the text upward. It is also useful for users on extremely slow links
(such as old 2400 bps modems), as it tends to be a bit quicker.
See Also:
set(4) scroll_lines, scrollback, scrollback_ratio

View File

@@ -0,0 +1,14 @@
Synopsis:
set scroll_lines [<number>]
Description:
This setting offers a compromise of sorts between the available modes
of the SCROLL variable. When the last line of the display contains
text, the client will scroll all text upward by the number of lines
specified. The normal behavior uses a setting of 1 (one). If it is
set to 0 (zero), the client automatically turns SCROLL off, and it
must be manually enabled again to turn scrolling back on.
See Also:
set(4) scroll

View File

@@ -0,0 +1,10 @@
Synopsis:
set scrollback [<lines>]
Description:
This variable determines how many lines maximum the scrollback buffer
can be. The default is 1024.
See Also:
set(4) scrollback_ratio, scroll_lines, scroll

View File

@@ -0,0 +1,11 @@
Synopsis:
set scrollback_ratio [<percent>]
Description:
This variable determines what percent of the screen will scroll every time
you scroll a window's contents up or down. This value should be between
10 and 100, as the client silently truncates it to those extremes.
See Also:
set(4) scroll, scroll_lines; bind(4) scroll_backward, scroll_forward

View File

@@ -0,0 +1,28 @@
Synopsis:
set security [<number>]
Description:
This variable allows the user to enable a number of security options,
with the intent of preventing a rogue hook or loaded script from
doing any potential damage.
The setting is based on a set of bits, each of which can be enabled or
disabled independently or in any combination. Each bit has a specific
value associated with it. The bits are additive, much like the DEBUG
setting.
Bit Value Purpose
0 1 prevents variables from being used as commands
1 2 the EXEC command may only be used interactively
2 4 the SET command may only be used interactively
Examples:
To disable EXEC and SET inside aliases or hooks:
/set security 6
To disable everything listed:
/set security 7
See Also:
set(4) debug, exec_protection, novice

View File

@@ -0,0 +1,17 @@
Synopsis:
set send_ignore_msg [on|off|toggle]
Description:
When turned on, any ignored user that sends a private message to the
client will be sent a notice stating that the user is being ignored.
When turned off, the user is not made aware of the IGNORE setting.
See Also:
ignore(1)
Other Notes:
Caution should be exercised with this setting. If the user is being
ignored for flooding, the automated notices sent by the client may
very well flood the client off irc. Unless there is a compelling
reason to do otherwise, this setting should be turned off.

View File

@@ -0,0 +1,19 @@
Synopsis:
set [<variable> [<value>]]
set [-]<variable>
Description:
This command is used to set the value of one of EPIC's numerous internal
variables. These variables affect all aspects of the client's behavior,
from enabling special text highlighting to enforcing strict security
features.
If no value for the given variable is specified, the current value is
displayed. The client will display all matching variables if the given
is ambiguous. If no variable name is given, all variables and their
values are displayed. If the variable name is preceded by a hyphen
(-), the variable is unset, giving it no value.
See Also:
New_User(7); on(5) set

View File

@@ -0,0 +1,14 @@
Synopsis:
set shell [<program>]
Description:
When the EXEC command is used, the program named in this variable is
spawned to execute the desired command. This is generally a command
shell of some sort, though it doesn't necessarily have to be one.
If the shell requires special command-line switches, they may be given
in the SHELL_FLAGS variable.
See Also:
exec(5); set(4) shell_flags

View File

@@ -0,0 +1,12 @@
Synopsis:
set shell_flags [<flags>]
Description:
This variable contains any flags that are to be passed to the command
shell used by the EXEC command. The -c switch is generally required
by all shells, though others may be available as well; consult your
shell's documentation.
See Also:
exec(5); set(4) shell

View File

@@ -0,0 +1,15 @@
Synopsis:
set shell_limit [<number>]
Description:
This setting is used to limit the amount of data returned by an EXECed
command. The client will only display the specified number of lines of
output, then will close the process. This is mostly useful to prevent
doing something accidentally that will generate gobs of output, such
as recursively listing the root directory.
If set to 0 (zero), the client does not limit the amount of output.
See Also:
exec(5)

View File

@@ -0,0 +1,11 @@
Synopsis:
set show_away_once [on|off|toggle]
Description:
When turned on, this setting causes the client to suppress AWAY messages
from a client when the same one is received more than once. However, if
the remote client changes its away message, it will be displayed again.
See Also:
away(1)

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