# Description: help

noautoload

set help(admin) {
Usage: /admin [<server>]
  Asks for the specified or current servers administrative information
}

set help(alias) {
Usage: /alias [<name> [<command>]]
  Makes a new command named <name> which runs the specified <command>, which can be any tcl or irc commands
  If no arguments are given then /alias displays the names of all existing aliases
  If a <name> is given but no command then the <command> for that alias is displayed if it exists.
  Aliases may not overwrite built in or loaded commands but an alias can overwrite an existing alias.
  The following variables are available in an alias:
    $nick and $nicks are the currently selected nicknames in the nicklist if it exists
    $channel is the current channel if there is one
    $window is the name of the current window
}

set help(ame) {
Usage: /ame <text>
  Sends a CTCP ACTION to every channel you are on
See Also: me, describe
}

set help(amsg) {
Usage: /amsg <text>
  Sends the text to every channel you are on
See Also: msg
}

set help(away) {
Usage: /away [<text>]
  If text is given, mark yourself as away, else unmark away
}

set help(ban) {
Usage: /ban [<channel>] (<nick> [<mask>])|<ban>
  Gets a users address and bans them in the current or specified channel
  Optional <mask> determines the type of ban, the default is 3
  If a normal banmask is given then this is the same as /mode +b
See Also: banmask
}

set help(beep) {
Usage: /beep
       /beep <number> <delay>
  In the first usage, beeps once
  In the second usage, beeps the <number> of times with a <delay> microsecond pause between
}

set help(bind) {
Usage: /bind [<key> [<command>]]
  With no arguments, all existing bindings are displayed
  If <command> is specified, it is bound to the keystroke <key>, otherwise the current binding for <key> is displayed
  If <command> is "" then the binding is removed
  ^ is shorthand for Control-, the modifiers are Control- Shift- and Alt-
  Bindings are case sensitive: ^C is control-shift-c and ^c is control-c. the F keys must be uppercase
}

set help(bk) {
Usage: /bk [<channel>] <nick> [<message>]
  Opens the ban/kick dialog for <nick> in the channel <channel>, or the current one
}

set help(clear) {
Usage: /clear [<window>|all] [[-]<number>]
  If no number is given, clears the entire scrollback buffer
  A negative number clears <number> lines from the beggining of the buffer
  Otherwise <number> lines are cleared from the end of the buffer
See Also: windownames
}

set help(close) {
Usage: /close [<window>|<string>] [<window>|<string>]...
  Closes the current window or the window specific by <window>
  If <string> appears and is not a valid window name it is matched against the window title
See Also: windownames
}

set help(color) {
Usage: /color [-foreground|-background|-selectforeground|-selectbackground] all|<object>|<tag> [<color>]
  Sets the color of tag <tag> or <object> to the specified color
  If <color> is not given, a color picker allows a color to be chosen
  <color> can be a colorname (defined in /usr/X11R6/lib/X11/rgb.txt) or a #hex number
  Common tags are default, ts, me, numeric, privmsg, notice, action, hilight, url, nicks, @nicks +nicks, <>, @<>, +<>, mynick,
my<>, mytext, @, +, info, error, join, part, quit, server, anything you see at the start of a line inside [ brackets ]
  Objects are status, chan, query, dccchat, cmdline, nicklist, @nicklist, +nicklist, and chantopic
  Abbreviations may be used: -fg -bg -sf -sb
}

set help(ctcp) {
Usage: /ctcp <nick>|<channel> <ctcp> [<text>]
  Send <ctcp> to the target as a ctcp command with optional arguments <text>
  /ctcp <nick> ping is the same as /ping <nick>
See Also: reply, describe, me, ame, ping
}

set help(dcc) {
Usage: /dcc
       /dcc send <nick> [<file>]
       /dcc get <nick> [<file>]
       /dcc chat <nick>
       /dcc accept <nick>
       /dcc close chat|send|get [<file>|<nick>]
       /dcc resume <nick> <file>
}

set help(describe) {
Usage: /describe <nick>|<channel>|<dcc> <text>
  Sends a CTCP ACTION to the specified target
See Also: me, ame
}

set help(disconnect) {
Usage: /disconnect [<text>]
  Disconnects, with the optional message <text>, from the server without exiting
}

set help(echo) {
Usage: /echo [<window>|all|current] <text>
  Echoes the <text> to the target, nothing is sent to the server
  If no target is given the text is echoed to the window it was typed in
See Also: windownames
}

set help(exec) {
Usage: /exec
       /exec [-o] <command>
       /exec -m <target> <command>
       /exec -in <pid> <string>
       /exec -<signal> <pid>
  Executes the <command> or if none is given returns a list of the currently running commands
  With no switches output of <command> is echoed to the current window
  -o send the output of <command> to the current window, which can be a query, channel, or dcc chat window
  -m <nick> will msg the output to <target>, which can be a nick, channel, or =nick for dcc
  To write to a running process use -in <pid> <string> where string is the text to send
  To send a signal to a running process the form is -signal <pid> where signal is a number from 1 to 15
  <pid> takes the form %number as shown by running the exec command with no arguments
}

set help(font) {
Usage: /font [<window>|all|chan|chat|menu|cmdline|chantopic|nicklist] [<font>]
  Changes the font in the specified window(s) to <font> if one is given, else displays the name of the current font
  An integer can optionally follow the font name and will be used as the point size
Note: A font must have a foundry for it to be available. For a list of fonts see /tcl font families or xlsfonts and xfontsel
}

set help(help) {
Usage: /help [<topic>]
  Lists all available commands, including aliases, or displays the help for <topic>
}

set help(hide) {
Usage: /hide [<window>|all|<string>]
  Hides the current or specified window
  If "all" is given, every window except the current window is hidden
  If <string> appears and is not a valid window title then it is matched against window titles
Note: At least one window will always be visible and only windows with command lines are hidable
See Also: show, windownames
}

set help(ial) {
Usage: /ial [on|off|clear]
       /ial find|search <string>
  In the first usage, displays the status of the IAL, turns the IAL on or off, or clears the contents of the IAL
  In the second usage, searches the IAL for anything matching the glob style string <string>
}

set help(ignore) {
Usage: /ignore [<mask> [<type>]]
       /ignore -clear [<type>]
  With no arguments the current ignore list is displayed
  Ignores all events of type <type> from the wildcard string <mask>
  <mask> is matched case insensitve against the persons address in the form nick!ident@host.com
  Valid keyowrds for <type> are ALL, MSGS, NOTICES, PUBLIC, INVITES, and CTCP
  If <type> is not given it defaults to ALL
  To remove a mask from the ignore list use type NONE
  To clear the ignore list for a type use the -clear option
Note: ignogre uses glob style matching, this means that the characters [ ] \ * ? are not matched normally. If you want to match any of these literally you must escape it with a backslash
}

set help(info) {
Usage: /info
  Shows the client version and date, and other information about the client
  Also shows how long the client has been running and how long it has bee connected to the current server
}

set help(invite) {
Usage: /invite [<channel>] <nick>
  Invites <nick> into <channel>
  If no channel is given, the current one, if any, is used
}

set help(join) {
Usage: /join <channel>[,<channel>,...] [<key>,[<key>,...]]
  Joins <channel> using optional <key>
}

set help(kick) {
Usage: /kick [<channel>] <nick> [<text>]
  Kicks <nick> from the current or specified channel with the optional message <text>
}

set help(knock) {
Usage: /knock <channel>
  Asks for an invite to a channel that is set invite only
}

set help(links) {
Usage: /links [<server>]
  Queries the current or specified server for information on its connections to other servers
}

set help(list) {
Usage: /list
  Retrieves the current list of public channels from the server
}

set help(load) {
Usage: /load <script>|<dir>
  Loads the script <script>, or all files in <dir>
  Searches current directory unless a path is given
}

set help(log) {
Usage: /log [<window>] [on [<file>]|off|flush]
  With no arguments, displays the current logging status in the current window or <window>
  Turns logging in the current or specified window on or off
  If a filename is not specified then a file selection dialog allows you to select a file
  If the flush option is used, flush the buffer to the file, see note
Note: Logging always appends to a file, never truncates or overwrites
Note: The log has a 2048 byte buffer, so lines will not immediately appear in the logfile
See Also: windowname
}

set help(lusers) {
Usage: /lusers
  Queries the server on information about the number of clients, etc. on the server and network
}

set help(me) {
Usage: /me <text>
  Sends a CTCP ACTION to the current channel, query, or dcc chat with text <text>
See Also: describe, ame
}

set help(mode) {
Usage: /mode [<channel>|<nick>] <mode>
  
}

set help(motd) {
Usage: /motd [<server>]
  Asks for the current or specified servers Message Of The Day
}

set help(msg) {
Usage: /msg <nick> <text>
  Send a private message <text> to <nick>
}

set help(names) {
Usage: /names <channel>
  Show who is in the channel <channel>. If you are currently in the channel then the nicklist is refreshed
}

set help(newwin) {
Usage: /newwin
  Open a new channel window
}

set help(nick) {
Usage: /nick <nick>
  Changes your nick to <nick>
}

set help(notice) {
Usage: /notice <nick> <text>
  Sends a notice to <nick>
}

set help(notify) {
Usage: /notify [[-]<nick> [[-]<nick>...]]
  If no nicks are given, shows the list of online and offline nicks in the notify list
  Specifying a nick adds it to the list, unless it is preceeded by a -, in which case it is removed
  Mulitple additions and removals may be done at once
}

set help(on) {
Usage: /on <event> [<match>...] <command>
  For running a command or script when an event happens
  A list of events and their match arguments appears below
  In addition, there are a number of variables made available to the command on top of the normal global variables, which provide additional information from the event, they are listed after the match arguments
    connect
    disconnect
    away
    unaway
    join <channel> <nick!ident@host>, $nick $address $channel
    part <channel> <nick!ident@host>, $nick $address $channel
    quit <nick!ident@host> <message>, $nick $address $line
    text <target> <nick!ident@host> <text>, $nick $address $line $target
    action <target> <nick!ident@host> <text>, $nick $address target $line
    notice <target> <nick!ident@host> <text>, $nick $address $line $target
    umode
    mode <channel> <nick!ident@host>, $nick $address $channel $mode $key $limit
    op <channel> <nick!ident@host> <opped nick>, $nick $address $channel $onick
    deop <channel> <nick!ident@host> <deopped nick>, $nick $address $channel $onick
    voice <channel> <nick!ident@host> <voiced nick>, $nick $address $channel $vnick
    devoice <channel> <nick!ident@host> <devoiced nick>, $nick $address $channel $vnick
    ban <channel> <nick!ident@host>, $nick $address $channel $ban
    unban <channel> <nick!ident@host>, $nick $address $channel $ban
    exception <channel> <nick!ident@host> $nick $address $channel $exception
    unexception <channel> <nick!ident@host> $nick $address $channel $exception
    nick <nick!ident@host>, $nick $address $newnick
    kick <channel> <nick!ident@host> <kicked nick>, $nick $address $channel $knick
    topic <channel> <nick!ident@host>, $nick $address $channel $line
    invite <nick!ident@host> <channel>, $nick $address $channel
    notify <nick!ident@host>, $nick $address
    unnotify <nick!ident@host>, $nick $address
    chatrequest <nick!ident@host>, $id $nick $address
    chatconnect <nick>, $id $nick $ip
    chat <nick> <text>, $id $nick $line
    chatclose <nick>, $id $nick $ip
    filerequest <nick!ident@host> <file>, $id $nick $address $ip $file $size
    getconnect <nick> <file>, $id $nick $ip $file
    getfail <nick> <file>, $id $nick $ip $file
    getdone <nick> <file>, $id $nick $ip $file
    sendconnect <nick> <file>, $id $nick $ip $file
    sendfail <nick> <file>, $id $nick $ip $file
    senddone <nick> <file>, $id $nick $ip $file
}

set help(option) {
Usage: /option [<window>] popup|menubar|nicklist|topic [on|off]
  Changes or reports the status of the named option for the specified window, or the current window if one is not specified. The popup option will deiconify and raise a window when there is activity in the window. The menubar option shows or hides the menubar at the top of every window. The nicklist option will display or hide the nicklist in channel windows. The topic option controls the display of the topic in a channel window.
}

set help(part) {
Usage: /part [<channel>[,<channel>...]|all]
  Leaves the current or specified channel
}

set help(ping) {
Usage: /ping <nick>|<channel> [<nick>|<channel>...]
  Send a CTCP ping request to <nick> or <channel> and display the round trip time
}

set help(position) {
Usage: /position [<channel>] save|forget|reset
}

set help(qbk) {
Usage: /qbk [<channel>] <nick>[,<nick2>,...]
  Kicks and bans <nick> from the optional <channel> with no prompts
  Uses banmask 3 and the first line from your kick message preferences
See Also: banmask, bk, ban, kick
}

set help(query) {
Usage: /query <nick> [<text>]
  Opens a query window with <nick> and sends text <text> if given
}

set help(quiet) {
Usage: /quiet <command>
  Suppresses the normal output from the command
}

set help(quit) {
Usage: /quit [<text>]
  Quit irc and exit the client, with optional message <text>
}

set help(quote) {
Usage: /quote <text>
  Sends <text> to the server unmodified
}

set help(reload) {
Usage: /reload [file|directory]...
  Rereads the files loaded at startup, usually in ~/.roxirc unless RoxIRC was started with the -f flag
  Or if files or directories are specified they will be loaded instead
}

set help(reply) {
Usage: /reply <nick>|<channel> <ctcp> <reply>
  Send a CTCP <ctcp> reply to the target
See Also: ctcp
}

set help(save) {
Usage: /save [<file>]
  Saves the current settings to ~/.roxirc/prefs or optional <file>
}

set help(savebuf) {
Usage: /savebuf [<window>] [<file>]
  Saves the contents of <window> or the current window to <file>
  If no filename is given, a file selection dialog will be displayed
See Also: windowname
}

set help(say) {
Usage: /say <text>
  Sends <text> to the current window as if you typed it, whether its a channel, query, or dcc chat
  This is usually only used in scripts and aliases and events
}

set help(search) {
Usage: /search [<word>]
  Searches the scrollback buffer for any occurance of <word> and highlights it
  If no word is given all highlighting is removed
}

set help(server) {
Usage: /server <hostname>|<group> [<port>] [<password>]
       /server <hostname>:<port> [<password>]
  
}

set help(set) {
Usage: /set
       /set <var> [<value>]
  In the first usage, print all the variables and their values
  In the second usage prints the value of variable <var> and changes the value if given
  For information of the setable variables see /help prefs
}


set help(show) {
Usage: /show [all|<window>|<number>|<glob>]...
  With no arguments, shows a list of windows that are currently hidden and their number
  Otherwise will show the named or numbered windows if they are hidden
  If an argument is not a window name or number then it is matched against the window titles
}

set help(sping) {
Usage: /sping
  Pings the current server and tells you the round trip time
}

set help(stats) {
Usage: /stats <type>
  
}

set help(tcl) {
Usage: /tcl <command>
  Executes a tcl command
}

set help(timer) {
Usage: /timer <repetitions> <delay> <command>
       /timer cancel|stop|off <number>|all|<glob>
       /timer
  Runs a command at a specified interval
  <delay> is specified in milleconds, or append "s" for seconds, "m" for minutes, "h" for hours
  To repeat infinitely set <repetitions> to 0
  If an error is encountered when executing a command then the remaining repetitions are cancelled
  To cancel a timer use the numbers shown when /timer is run with no options, or use "all" to cancel all timers.
  If the argument to stop is not a number or "all" then it is matched against the timers as a glob style pattern.
}

set help(topic) {
Usage: /topic [<channel>] <text>
       /topic
  If <text> is simply ":" then the topic is removed
}

set help(trace) {
Usage: /trace <nick>|<server>
}

set help(ts) {
Usage: /ts [<window>|channels|chats|all] [on|off]
   Turns time stamping on or off in the given windows
}

set help(umode) {
Usage: /umode <mode>
  Set your user modes, see numeric 004 for the available modes
}

set help(unalias) {
Usage: /unalias [<command>]
  Deletes the specified alias or displays all of the current aliases
See Also: alias
}

set help(url) {
Usage: /url [on|off|last|clear]
  With no arguments, opens the URL List window
  Otherwise turns url catching on or off, or clears the list
  "last" launches the most recently detected URL
See Also: set
}

set help(users) {
Usage: /users
  
}

set help(wall) {
Usage: /wall [<channel>] <text>
  Sends a notice to all ops on <channel> or current channel, with message <text>
}

set help(who) {
Usage: /who <nick>|<hostmask>
  
}

set help(whois) {
Usage: /whois <nick>[,<nick>...]
  
}

set help(whowas) {
Usage: /whowas <nick>[,<nick>...]
  
}

set help(banmask) {
There are 6 address masks
With base address nick!ident@host.domain.com the masks will be:
  1: *!*ident@host.domain.com
  2: *!*@host.domain.com
  3: *!*ident@*.domain.com
  4: *!*@*.domain.com
  5: nick!ident@host.domain.com
  6: nick!*@*
}

set help(windownames) {
Window names can be specified by channel name for channel windows, by nick for query windows, =nick for dcc chat windows, or "status" for the status window
The keyword "current" may be used to target whichever window currently has focus, if none have focus then status is used.
Some commands have additional keywords that can be used as a windowname to target multiple windows, these are documented in the help for the command
}

set help(flood) {
The flood protection is controlled by the variables FLOOD FLOODTIME FLOODDELAY FLOODLINES and FLOODMAXQ.
When FLOOD is on, and RoxIRC sends more than FLOODLINES lines to server in less than FLOODTIME milliseconds the flood protection is activated.
The outgoing lines are buffered up to a maximum of FLOODMAXQ lines and one line is sent every FLOODDELAY milliseconds.
While in flood mode all CTCP requests are dropped.
Server PONGS are not subject to the buffering.
Normal operation is resumed after all the buffered lines have been sent to the server.
}

set help(prefs) {
  authdelay:
    after estahblishing a tcp connection to a server, wait this many ms before sending registration info. (this usually helps)
    default: 750
  autoaway:
    integer
    default: 0
    amount of idle time in minutes after which you set /away automatically or 0 for off
  autounaway:
    integer from 0 to 2
    how to automatically unset your /away after activity. 0 is never, 1 is always unset on activity, 2 is only unset if you were set away automatically
  awayreason:
    string
    your away reason when you are set away automatically
  bold:
    boolean
    default: true
    show bold text
  dccchatautoclose:
    boolean
    default: false
    automatically close completed dcc chat sessions
  dccfileautoclose:
    boolean
    default: false
    automatically close completed or failed dcc file transfers
  dcchighport:
    integer
    default: 65535
    highest local port to recieve incoming dcc connections on
  dcclowport:
    integer
    default: 1025
    lowest local port to recieve incoming dcc connections on
  dccpacketsize:
    integer from 256 to 16384
    default: 512
    number of bytes to send before waiting for an ack during a dcc file send
  dcctimeout:
    integer
    default: 600
    number of seconds to wait for incoming dcc connections. outgoing connections use the system tcp timeout
  defaultdccdir:
    string
    default: ~
    directory to place files recieved via dcc
  defaultlogdir:
    string
    default: ~
    default directory for log files, buffer saves, and listbox saves
  flood:
    boolean
    default: true
    throttle sends to the server in order to prevent being disconnected
  flooddelay:
    integer from 100 to 5000
    default: 600
    number of millieconds to wait between sending lines to the server during flood protection
  floodlines:
    integer from 2 to 100
    default: 5
    activate flood protection after this many lines within floodtime
  floodmaxq:
    integer from 5 to 500
    default: 25
    maximum number of lines to hold in the send queue during flood protection. lines beyond this will be dropped
  floodtime:
    integer from 100 to 10000
    default: 1000
    activate flood protection when floodlines lines are sent within this many milliseconds
  gmt:
    boolean
    default: false
    sets the display of times to be in the local timezone or gmt
  history:
    integer
    default: 30
    number of lines to keep in the command line history per window
  host:
    string
    local hostname to bind to if system has multiple IPs
  ial:
    boolean
    default: true
    keep an internal address list of all users in channels that you are in
    see also /ial
  iconifyqueries:
    boolean
    default: false
    new query windows appear iconified
  ident:
    string
    default: your system username
    sets your ident on the server during initial connection
    this option is ignored by the server if you are running an ident server.
  margin:
    integer
    default: 0
    number of pixels to indent text that is longer than a single line
  maxbeeps:
    integer
    default: 3
    maximum number of bell (^G) characters to accept per line. set to 0 to disable bells
  menubar:
    boolean
    default: true
    sets if new windows show the menubar or not
  name:
    string
    your name as it appears in /whois
  netsplit:
    boolean
    default: true
    detect netsplits and convert them into an easier to read short format
  nicklist:
    boolean
    default: true
    specifies if new channel windows should show a list of nicknames on the channel
  opsinchan:
    boolean
    default: false
    shows an @ or + before a users nickname in the channel text
  port:
    integer
    default: 6667
    default port to connect to irc servers on
  reconnect:
    integer
    number of seconds to wait before a reconnect attempt after a connection is lost. if this is set too low the client may become unreponsive during network problems
    default: 5
  scrollback:
    integer
    default: 200
    number of lines to keep in the scrollback buffer per window
  showmotd: 
    boolean
    default: true
    show the irc servers Message Of The Day
  showops:
    boolean
    default: true
    show @ before chanops nicks and + before voiced nicks
  topic:
    boolean
    default: true
    sets if new channel windows should show the topic above the channel text or not
  ts:
    boolean
    default: false
    if set to true, new windows will have timestamps showing
  tsformat:
    string
    default: [%R]
    sets the formatting of the timestamp. common variables include %R (H:M) %T (H:M:S) %H (24 hour format) %I (12 hour format) %M (minutes) %S (seconds) %p (am/pm) %Z (timezone). for a full list see the man page for the clock command
  underline:
    boolean
    default: true
    show underlined text
  unsafedcc:
    boolean
    default: false
    connect to the ip supplied in the dcc request instead of the users actual address
  urlcommand:
    string
    command to run when a url is double clicked on. "$url" will be replaced by the actual url
  urls:
    boolean
    default: true
    parse text for urls and make them links and append them to the urls dialog
}

set help(configfile) {
geom,status: default geometry to open the status window with. uses a standard x11 geometry specifier
geom,channel: default geometry for channel windows
geom,chat: default geometry for chat windows

click,channel: commands to execute when the mouse is double-clicked in a channel
click,query: commands to execute when the mouse is double-clicked in a query window
click,dcc: commands to execute when the mouse is double-clicked in a dcc chat
click,nick: commands to execute when the mouse is double-clicked in a nicklist
click,status: commands to execute when the mouse is double-clicked in the status window

away: list of strings that appear in the menu to mark yourself as away with
nick: list of the nicks you want to use, most preferred first
chan: list of channels that appear in the menu
quit: list of quit reasons that appear in the quit and disconnect menus
kick: list of kick strings that are used in the various kick/ban dialogs, quick kick or ban will use the first entry from here
server: a list of servers that appear in the menu. the format is hostname:network:port:password:name. all fields are optional except hostname and network
}