diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/help/in/accept.in | 16 | ||||
| -rw-r--r-- | docs/help/in/action.in | 10 | ||||
| -rw-r--r-- | docs/help/in/admin.in | 10 | ||||
| -rw-r--r-- | docs/help/in/alias.in | 19 | ||||
| -rw-r--r-- | docs/help/in/away.in | 13 | ||||
| -rw-r--r-- | docs/help/in/ban.in | 25 | ||||
| -rw-r--r-- | docs/help/in/beep.in | 8 | ||||
| -rw-r--r-- | docs/help/in/bind.in | 14 | ||||
| -rw-r--r-- | docs/help/in/cat.in | 14 | ||||
| -rw-r--r-- | docs/help/in/cd.in | 10 | ||||
| -rw-r--r-- | docs/help/in/channel.in | 19 | ||||
| -rw-r--r-- | docs/help/in/clear.in | 8 | ||||
| -rw-r--r-- | docs/help/in/connect.in | 30 | ||||
| -rw-r--r-- | docs/help/in/ctcp.in | 10 | ||||
| -rw-r--r-- | docs/help/in/cycle.in | 10 |
15 files changed, 110 insertions, 106 deletions
diff --git a/docs/help/in/accept.in b/docs/help/in/accept.in index 4e6bf948..699441a8 100644 --- a/docs/help/in/accept.in +++ b/docs/help/in/accept.in @@ -1,30 +1,30 @@ -Syntax: +%9Syntax:%9 @SYNTAX:accept@ -Parameters: +%9Parameters:%9 - A comma-separated list of nicknames to add or remove. If no argument is - given, your accept list is displayed. + A comma-separated list of nicknames to add or remove; if no argument is + given, your accept list will be displayed. -Description: +%9Description:%9 Allows you to specify who you want to receive private messages and notices from while you have callerid enabled. When you have callerid enabled, messages from other users are blocked and - the sender is notified; you are also notified but at most once per minute. + the sender is notified. Users are automatically removed from the accept list if they quit, split or change nickname; the accept list is lost when you disconnect. This command only works on IRC servers that support the callerid user mode. -Examples: +%9Examples:%9 /ACCEPT mike,bob,-john,-sarah /ACCEPT sarah,-bob -See also: IGNORE, SILENCE +%9See also:%9 IGNORE, SILENCE diff --git a/docs/help/in/action.in b/docs/help/in/action.in index 1e27338e..23b1a5d6 100644 --- a/docs/help/in/action.in +++ b/docs/help/in/action.in @@ -1,23 +1,23 @@ -Syntax: +%9Syntax:%9 @SYNTAX:action@ -Parameters: +%9Parameters:%9 -<server tag>: The server tag you want to send the action emote to. A target nickname or channel and the message. -Description: +%9Description:%9 Sends an action emote to a nickname or a channel. -Examples: +%9Examples:%9 /ACTION #irssi is hungry! /ACTION mike had an awesome day @ work /ACTION -efnet #irssi is happy it's Friday -See also: ME +%9See also:%9 ME diff --git a/docs/help/in/admin.in b/docs/help/in/admin.in index d5be3275..2b6f8b73 100644 --- a/docs/help/in/admin.in +++ b/docs/help/in/admin.in @@ -1,22 +1,22 @@ -Syntax: +%9Syntax:%9 @SYNTAX:admin@ -Parameters: +%9Parameters:%9 A nickname or server for which you want to know the administrative details; if no argument is given, the server you are connected to will be used. -Description: +%9Description:%9 Displays the administrative details of a server. -Examples: +%9Examples:%9 /ADMIN /ADMIN orwell.freenode.net /ADMIN mike -See also: INFO +%9See also:%9 INFO diff --git a/docs/help/in/alias.in b/docs/help/in/alias.in index 02359606..d444aca3 100644 --- a/docs/help/in/alias.in +++ b/docs/help/in/alias.in @@ -1,32 +1,33 @@ -Syntax: +%9Syntax:%9 @SYNTAX:alias@ -Parameters: +%9Parameters:%9 A name of the alias and the command to execute. You can prepend the alias - with the '-' character to remove the alias. If no argument is given, your + with the "-" character to remove the alias; if no argument is given, your aliases will be displayed. -Description: +%9Description:%9 - Creates or updates an alias. You can use the ';' character to separate + Creates or updates an alias; you can use the ";" character to separate multiple commands. - The parametesr given to the alias are expanded in '$[\d]' For example $0, + The parametesr given to the alias are expanded in "$[\d]" For example $0, $1, $2, $8, $12, ... If you don't use any parameters in your alias, all parameters will be automatically appended after it. -Examples: +%9Examples:%9 + /ALIAS /ALIAS COMEBACK SAY I was hoping for a battle of wits, but you seem to be unarmed. /ALIAS -COMEBACK /ALIAS ATAG SCRIPT EXEC Irssi::active_win->change_server(Irssi::server_find_tag("$0")); - /ALIAS UNACT SCRIPT EXEC foreach $$w (Irssi::windows()) { Irssi::command("window goto $$w->{refnum}")\;} ; WINDOW GOTO $winref + /ALIAS UNACT SCRIPT EXEC foreach $$w (Irssi::windows()) { Irssi::command("window goto $$w->{refnum}")\;}; WINDOW GOTO $winref /ALIAS QOP ^MSG Q op $C -See also: BIND, UNALIAS +%9See also:%9 BIND, UNALIAS diff --git a/docs/help/in/away.in b/docs/help/in/away.in index 06cd1078..16479856 100644 --- a/docs/help/in/away.in +++ b/docs/help/in/away.in @@ -1,16 +1,16 @@ -Syntax: +%9Syntax:%9 @SYNTAX:away@ -Parameters: +%9Parameters:%9 - -one: Marks yourself as away on the server you are connected to. + -one: Marks yourself as away on the active server. -all: Marks yourself as away on all the servers you are connected to. You away message; if no argument is given, your away status will be removed. -Description: +%9Description:%9 Marks yourself as "away"; this method is used to inform people that you are not paying attention to your screen. @@ -22,11 +22,12 @@ Description: Anyone who does a WHOIS on your nickname will see that you are away, as well as your away message. -Examples: +%9Examples:%9 + /AWAY /AWAY I'm getting some food. /AWAY zZzZ /AWAY -one Feeding the cat! -See also: DISCONNECT +%9See also:%9 DISCONNECT diff --git a/docs/help/in/ban.in b/docs/help/in/ban.in index 72474dce..a696f7a4 100644 --- a/docs/help/in/ban.in +++ b/docs/help/in/ban.in @@ -1,41 +1,42 @@ -Syntax: +%9Syntax:%9 @SYNTAX:ban@ -Parameters: +%9Parameters:%9 - -normal: Uses the *!*user@*.domain.net format. + -normal: Uses the *!*user@*.domain.tld format. -user: Uses the *!*user@* format. - -host: Uses the *!*@host.domain.net format. - -domain: Uses the *!*@*.domain.net format. + -host: Uses the *!*@host.domain.tld format. + -domain: Uses the *!*@*.domain.tld format. -custom: Uses the custom format. - A channel and the nicknames or hostnames to ban. If no arguments are given + A channel and the nicknames or hostnames to ban; if no arguments are given the bans in the active channel are displayed. If no ban format parameter is given, the value of the ban_type setting will be used to generate the hostmask to ban. -Description: +%9Description:%9 Adds one or more bans to a channel. -Configuring the custom format: +%9Configuring the custom format:%9 You must set the custom ban_type to the format you would like to use. For example, if you set the custom ban_type to "nick domain", it will generate - a ban based on the nick!*@*.domain.net format. + a ban based on the nick!*@*.domain.tld format. -Examples: +%9Examples:%9 + /BAN /BAN mike /BAN -host bob - /BAN *!*@*.basement.cat + /BAN *!*@*.google.com /BAN -domain sarah /SET ban_type custom nick domain /SET ban_type custom user host -See also: KICKBAN, KNOCKOUT +%9See also:%9 KICKBAN, KNOCKOUT diff --git a/docs/help/in/beep.in b/docs/help/in/beep.in index fdb3857a..d8a06fff 100644 --- a/docs/help/in/beep.in +++ b/docs/help/in/beep.in @@ -1,15 +1,15 @@ -Syntax: +%9Syntax:%9 @SYNTAX:beep@ -Description: +%9Description:%9 Outputs the bell-character, usually causing your terminal to beep. -Examples: +%9Examples:%9 /BEEP -See also: CLEAR +%9See also:%9 CLEAR diff --git a/docs/help/in/bind.in b/docs/help/in/bind.in index 5eff4145..d6151b23 100644 --- a/docs/help/in/bind.in +++ b/docs/help/in/bind.in @@ -1,25 +1,27 @@ -Syntax: +%9Syntax:%9 @SYNTAX:bind@ -Parameters: +%9Parameters:%9 -list: Displays a list of all the bindable commands. -delete: Removes the binding, - A name of the binding and the command to perform. + A name of the binding and the command to perform; if no parameter is given, + the list of bindings will be displayed. Details: - Adds or removes a binding. The binding itself is case-sensitive and may + Adds or removes a binding; the binding itself is case-sensitive and may contain as many characters as you want. Uppercase characters usually indicate that you need to keep the shift-key pressed to use the binding. -Examples: +%9Examples:%9 + /BIND /BIND meta-c /CLEAR /BIND meta-q change_window 16 /BIND -delete meta-y @@ -28,5 +30,5 @@ Examples: /BIND ^[[11~ command AWAY I'm off for today :) /BIND ^[[12~ command AWAY -See also: ALIAS +%9See also:%9 ALIAS diff --git a/docs/help/in/cat.in b/docs/help/in/cat.in index 981771b7..3a3ed32b 100644 --- a/docs/help/in/cat.in +++ b/docs/help/in/cat.in @@ -1,21 +1,21 @@ -Syntax: +%9Syntax:%9 @SYNTAX:cat@ -Parameters: +%9Parameters:%9 The file to display. -Description: +%9Description:%9 Displays the contents of the specified file into the active window. -Examples: +%9Examples:%9 /CAT /etc/network/interfaces - /CAT /home/mike/unicorns.txt - /CAT kitties.txt + /CAT /home/mike/resume.txt + /CAT contact_details.txt -See also: CD, EXEC +%9See also:%9 CD, EXEC diff --git a/docs/help/in/cd.in b/docs/help/in/cd.in index fad74c3f..bc6b7aac 100644 --- a/docs/help/in/cd.in +++ b/docs/help/in/cd.in @@ -1,21 +1,21 @@ -Syntax: +%9Syntax:%9 @SYNTAX:cd@ -Parameters: +%9Parameters:%9 The directory to change into. -Description: +%9Description:%9 Changes the current active directory. -Examples: +%9Examples:%9 /CD /home/public_ftp /CD /home/mike /CD /var/log -See also: CAT +%9See also:%9 CAT diff --git a/docs/help/in/channel.in b/docs/help/in/channel.in index 32ac6620..80d27064 100644 --- a/docs/help/in/channel.in +++ b/docs/help/in/channel.in @@ -1,9 +1,9 @@ -Syntax: +%9Syntax:%9 @SYNTAX:channel@ -Parameters: +%9Parameters:%9 LIST: Displays the list of configured channels. ADD: Adds a channel to your configuration. @@ -20,20 +20,19 @@ Parameters: If no parameters are given, the list of channels you have joined will be displayed. -Description: +%9Description:%9 Adds, removes or displays the configuration of channels; this method is used to automate and simplify your workflow. -Examples: - - /CHANNEL ADD -auto #irssi Freenode - /CHANNEL ADD -auto -bots "*!@*.meow.net *!basement@cat.org" -botcmd "msg $0 op myPassword" #hideout Freenode - /CHANNEL ADD -auto -bots "Q!TheQBot@CServe.quakenet.org" -botcmd "^MSG Q op #irssi" #irssi Quakenet +%9Examples:%9 /CHANNEL /CHANNEL LIST + /CHANNEL ADD -auto #irssi Freenode + /CHANNEL ADD -auto -bots "*!@*.google.com *!bot@google.com" -botcmd "msg $0 op WzerTrzq" #hideout Freenode + /CHANNEL ADD -auto -bots "Q!TheQBot@CServe.quakenet.org" -botcmd "^MSG Q op #irssi" #irssi Quakenet /CHANNEL REMOVE #hideout Freenode - -See also: JOIN, TS + +%9See also:%9 JOIN, TS diff --git a/docs/help/in/clear.in b/docs/help/in/clear.in index fb4172c8..ad5b8bf8 100644 --- a/docs/help/in/clear.in +++ b/docs/help/in/clear.in @@ -1,19 +1,19 @@ -Syntax: +%9Syntax:%9 @SYNTAX:clear@ -Parameters: +%9Parameters:%9 -all: Clear all the windows The window number to clear; if no argument is given, the active window is used. -Description: +%9Description:%9 Clears the window of all text; you may use this to clear a windows that contains sensitive information or has rendered improperly. -See also: REDRAW +%9See also:%9 REDRAW diff --git a/docs/help/in/connect.in b/docs/help/in/connect.in index 69ed91b9..c1f95de0 100644 --- a/docs/help/in/connect.in +++ b/docs/help/in/connect.in @@ -1,38 +1,38 @@ -Syntax: +%9Syntax:%9 @SYNTAX:connect@ -Parameters: +%9Parameters:%9 - -4: Connect using IPv4. - -6: Connect using IPv6. - -ssl: Connect using SSL encryption. + -4: Connects using IPv4. + -6: Connects using IPv6. + -ssl: Connects using SSL encryption. -ssl_cert: The SSL client certificate file. -ssl_pkey: The SSL client private key, if not included in the certificate file. - -ssl_verify: Verify the SSL certificate of the server. + -ssl_verify: Verifies the SSL certificate of the server. -ssl_cafile: The file with the list of CA certificates. -ssl_capath: The directory which contains the CA certificates. - -noproxy: Ignore the global proxy configuration. + -noproxy: Ignores the global proxy configuration. -network: The network this connection belongs to -host: The hostname you would like to connect from. -rawlog: Immediately open rawlog after connecting. - -!: Don't autojoin channels. - -noautosendcmd: Don't execute autosendcmd. + -!: Doesn't autojoin channels. + -noautosendcmd: Doesn't execute autosendcmd. - A network or server to connect to. You can optionally specify a custom port, + A network or server to connect to; you can optionally specify a custom port, password and nickname. -Description: +%9Description:%9 Opens a new connection to the specified network or server. -Examples: +%9Examples:%9 /CONNECT Freenode /CONNECT -6 Freenode - /CONNECT -4 -! -host my.cute.hostname.tld -network Freenode orwell.freenode.net - /CONNECT kitties.example.com 6667 myPassword BasementCat + /CONNECT -4 -! -host office.google.com -network Freenode orwell.freenode.net + /CONNECT secure.server.google.com 6667 WzerT8zq mike -See also: DISCONNECT, RMRECONNS, SERVER +%9See also:%9 DISCONNECT, RMRECONNS, SERVER diff --git a/docs/help/in/ctcp.in b/docs/help/in/ctcp.in index 44d03064..93818061 100644 --- a/docs/help/in/ctcp.in +++ b/docs/help/in/ctcp.in @@ -1,17 +1,17 @@ -Syntax: +%9Syntax:%9 @SYNTAX:ctcp@ -Parameters: +%9Parameters:%9 A target nickname or channel and a command. -Description: +%9Description:%9 Sends a CTCP request towards the given target nickname or channel. -Examples: +%9Examples:%9 /CTCP mike PING /CTCP #irssi VERSION @@ -19,5 +19,5 @@ Examples: /CTCP sarah CLIENTINFO /CTCP john TIME -See also: ACTION, ME +%9See also:%9 ACTION, ME diff --git a/docs/help/in/cycle.in b/docs/help/in/cycle.in index 3cb28ee4..c44a976a 100644 --- a/docs/help/in/cycle.in +++ b/docs/help/in/cycle.in @@ -1,22 +1,22 @@ -Syntax: +%9Syntax:%9 @SYNTAX:cycle@ -Parameters: +%9Parameters:%9 A channel and the message. If no argument is given, the active channel will be used. -Description: +%9Description:%9 Leaves and rejoins a channel. -Examples: +%9Examples:%9 /CYCLE /CYCLE #irssi /CYCLE #irssi BRB :) -See also: JOIN, PART +%9See also:%9 JOIN, PART |