# Description: help

noautoload

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

set help(alias) {
Usage: /alias <command>
  Makes a new command that runs the specified <command>, which can be any tcl or irc commands
}

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>]
  Gets a users address and bans them in the current or specified channel
  Optional <mask> determines the type of ban, the default is 3
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
}

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

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>]
  Closes the current or specified window
See Also: windownames
}

set help(color) {
Usage: /color <tag> [<color>]
  Sets the color of tag <tag> to the specified color
  If <color> is not given, a color picker allows a color to be chosen
  <color> can be colorname (defined in /usr/X11R6/lib/X11/rgb.txt) or a #hex number
See Also: tags
}

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>]
       /dcc resume <nick> <file>
}

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

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 [-o|-m <nick>] <command>
  Executes the <command>
  -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 <nick>
  With no switches output is echoed to the current window
}

set help(font) {
Usage: /font [<window>|all|channel|chat|menu|cmdline|topic|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 size
Note: A font must have a foundry for it to be available. For a list of fonts seexlsfonts 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]
  Hides the current or specified window
  If \"all\" is given, every window except the current window is hidden
Note: At least one window will always be visible
See Also: show
}

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 matchins wildcard string <string>
}

set help(ignore) {
Usage: /ignore [<mask> [<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
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(links) {
Usage: /links [<server>]
  Queries the current server for information on all of its links, or only the given <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>
  
}

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> [<match>...] <command>
}

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(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(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
  Rereads all the files loaded at startup, usually in ~/.roxirc unless RoxIRC was started with the -f flag
}

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
}


set help(show) {
Usage: /show [<window>|<number>[,<window>|<number>,...]]
  With no arguments, shows a list of windows that are currently hidden
}

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
       /timer
  
  
  <delay> is specified in milleconds, or append "s" for seconds, "m" for minutes, "h" for hours
  To repeat infinitely set <repetitions> to 0
}

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
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" is as if you had double clicked on the most recently detected URL
}

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 RockShox!rox@hydrogen.lighter.net the masks will be:
  1: *!*rox@hydrogen.lighter.net
  2: *!*@hydrogen.lighter.net
  3: *!*rox@*.lighter.net
  4: *!*@*.lighter.net
  5: RockShox!rox@hydrogen.lighter.net
  6: RockShox!*@*
}

set help(windownames) {
Window names can be specified by channel name for channel windows, or by nick for query windows, or =nick for dcc chat windows, or "status" for the status window.
Some commands have additional keywords that can be used as a windowname, these are documented in the help for the command
}

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

style,nicklist: options for configuring the appearance of the nicklist. see "man n entry" for a full list of options. do NOT specify a font here, use /font nicklist
style,channel: options for configuring the appearance of the channel text. see "man n text" for a full list of options. do NOT specify a font here, use /font channel
style,chat: options for configuring the appearance of the chat text. see "man n text" for a full list of options. do NOT specify a font here, use /font chat
style,status: options for configuring the appearance of the status window text. see "man n text" for a full list of options. do NOT specify a font here, use /font status

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
}
