diff options
Diffstat (limited to 'docs/help/in')
-rw-r--r-- | docs/help/in/away.in | 4 | ||||
-rw-r--r-- | docs/help/in/channel.in | 2 | ||||
-rw-r--r-- | docs/help/in/connect.in | 33 | ||||
-rw-r--r-- | docs/help/in/dcc.in | 8 | ||||
-rw-r--r-- | docs/help/in/disconnect.in | 7 | ||||
-rw-r--r-- | docs/help/in/echo.in | 4 | ||||
-rw-r--r-- | docs/help/in/hilight.in | 3 | ||||
-rw-r--r-- | docs/help/in/ignore.in | 1 | ||||
-rw-r--r-- | docs/help/in/irssiproxy.in | 14 | ||||
-rw-r--r-- | docs/help/in/lastlog.in | 16 | ||||
-rw-r--r-- | docs/help/in/list.in | 17 | ||||
-rw-r--r-- | docs/help/in/msg.in | 4 | ||||
-rw-r--r-- | docs/help/in/network.in | 8 | ||||
-rw-r--r-- | docs/help/in/script.in | 2 | ||||
-rw-r--r-- | docs/help/in/server.in | 69 | ||||
-rw-r--r-- | docs/help/in/servlist.in | 23 | ||||
-rw-r--r-- | docs/help/in/squery.in | 16 | ||||
-rw-r--r-- | docs/help/in/window.in | 84 |
18 files changed, 204 insertions, 111 deletions
diff --git a/docs/help/in/away.in b/docs/help/in/away.in index e0cf3685..75bc46c4 100644 --- a/docs/help/in/away.in +++ b/docs/help/in/away.in @@ -8,8 +8,8 @@ -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. - + Your away message; if no argument is given, your away status will be removed. + %9Description:%9 Marks yourself as 'away'; this method is used to inform people that you diff --git a/docs/help/in/channel.in b/docs/help/in/channel.in index 01bea3c1..86e824c2 100644 --- a/docs/help/in/channel.in +++ b/docs/help/in/channel.in @@ -7,6 +7,7 @@ LIST: Displays the list of configured channels. ADD: Adds a channel to your configuration. + MODIFY: Modifies a channel in your configuration. REMOVE: Removes a channel from your configuration. -auto: Automatically join the channel. @@ -36,6 +37,7 @@ /CHANNEL ADD -auto #basementcat Quakenet secret_lair /CHANNEL ADD -auto -bots '*!@*.irssi.org *!bot@irssi.org' -botcmd 'msg $0 op WzerTrzq' #hideout Freenode /CHANNEL ADD -auto -bots 'Q!TheQBot@CServe.quakenet.org' -botcmd '^MSG Q op #irssi' #irssi Quakenet + /CHANNEL MODIFY -noauto #irssi Freenode /CHANNEL REMOVE #hideout Freenode %9Special Example:%9 diff --git a/docs/help/in/connect.in b/docs/help/in/connect.in index 1c1aa2bb..e861ad74 100644 --- a/docs/help/in/connect.in +++ b/docs/help/in/connect.in @@ -5,21 +5,24 @@ %9Parameters:%9 - -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: 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: 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. - -!: Doesn't autojoin channels. - -noautosendcmd: Doesn't execute autosendcmd. + -4: Connects using IPv4. + -6: Connects using IPv6. + -tls: Connects using TLS encryption. + -tls_cert: The TLS client certificate file. + -tls_pkey: The TLS client private key, if not included in the certificate file. + -tls_pass: The password for the TLS client private key or certificate. + -tls_verify: Verifies the TLS certificate of the server. + -tls_cafile: The file with the list of CA certificates. + -tls_capath: The directory which contains the CA certificates. + -tls_ciphers: TLS cipher suite preference lists. + -tls_pinned_cert: Pinned x509 certificate fingerprint. + -tls_pinned_pubkey: Pinned public key fingerprint. + -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. + -!: Doesn't autojoin channels. + -noautosendcmd: Doesn't execute autosendcmd. A network or server to connect to; you can optionally specify a custom port, password and nickname. diff --git a/docs/help/in/dcc.in b/docs/help/in/dcc.in index c348b1ae..18a77ee9 100644 --- a/docs/help/in/dcc.in +++ b/docs/help/in/dcc.in @@ -36,10 +36,10 @@ %9Examples:%9 /DCC CHAT mike - /DCC GET bob 'summer vacation.mkv' - /DCC SEND sarah documents/resume.pdf - /DCC CLOSE mike - /DCC CLOSE bob 'summer vacation.mkv' + /DCC GET bob "summer vacation.mkv" + /DCC SEND sarah "summer vacation.mkv" + /DCC CLOSE get mike + /DCC CLOSE send bob "summer vacation.mkv" %9See also:%9 CD diff --git a/docs/help/in/disconnect.in b/docs/help/in/disconnect.in index ace1a3df..bd4a4e17 100644 --- a/docs/help/in/disconnect.in +++ b/docs/help/in/disconnect.in @@ -10,10 +10,11 @@ %9Description:%9 - Disconnects from one or more IRC servers; the list of all the servers you - are connected to can be retrieved via the SERVER command. + Disconnects from an IRC server; the list of all the servers you are + connected to can be retrieved via the SERVER command. - Use the wildcard character '*' if you want to disconnect from all servers. + Use the wildcard character '*' if you want to disconnect from the active + server. %9Examples:%9 diff --git a/docs/help/in/echo.in b/docs/help/in/echo.in index a730e282..4ff23730 100644 --- a/docs/help/in/echo.in +++ b/docs/help/in/echo.in @@ -6,10 +6,10 @@ %9Parameters:%9 -current: Displays the output in the active window. - -window: Displays the ouput in the target window. + -window: Displays the output in the target window. -level: Displays the output with a given message level. - The text ouput; if no target is given, the active window will be used. + The text output; if no target is given, the active window will be used. %9Description:%9 diff --git a/docs/help/in/hilight.in b/docs/help/in/hilight.in index fabbc2ea..0726e5e7 100644 --- a/docs/help/in/hilight.in +++ b/docs/help/in/hilight.in @@ -10,6 +10,7 @@ -line: Highlights the whole line. -mask: Highlights all messages from users matching the mask. -full: The text must match the full word. + -matchcase: The text must match case. -regexp: The text is a regular expression. -color: The color the display the highlight in. -actcolor: The color to mark the highlight activity in the statusbar. @@ -31,7 +32,7 @@ /HILIGHT /HILIGHT mike /HILIGHT -regexp mi+ke+ - /HILIGHT -mask bob!*@*.irssi.org -color %%G + /HILIGHT -mask -color %%G bob!*@*.irssi.org /HILIGHT -full -color %%G -actcolor %%Y redbull %9References:%9 diff --git a/docs/help/in/ignore.in b/docs/help/in/ignore.in index 8c2b1c90..b0a547c1 100644 --- a/docs/help/in/ignore.in +++ b/docs/help/in/ignore.in @@ -41,7 +41,6 @@ /IGNORE #irssi NO_ACT JOINS PARTS QUITS /IGNORE mike NO_ACT -MSGS /IGNORE -regexp -pattern - /IGNORE mike NO_ACT -MSGS %9See also:%9 ACCEPT, SILENCE, UNIGNORE diff --git a/docs/help/in/irssiproxy.in b/docs/help/in/irssiproxy.in new file mode 100644 index 00000000..79d75b91 --- /dev/null +++ b/docs/help/in/irssiproxy.in @@ -0,0 +1,14 @@ + +@SYNTAX:irssiproxy@ + +%9Description:%9 + + Displays the list of clients connected to irssiproxy. + +%9Examples:%9 + + /IRSSIPROXY + /IRSSIPROXY STATUS + +%9See also:%9 LOAD PROXY, SET irssiproxy + diff --git a/docs/help/in/lastlog.in b/docs/help/in/lastlog.in index e7b90d42..e96e2ed5 100644 --- a/docs/help/in/lastlog.in +++ b/docs/help/in/lastlog.in @@ -10,15 +10,19 @@ -window: Specifies the window to check. -new: Only displays results since the previous lastlog. -away: Only displays results since you previous away status. - -level: Specifies the levels to check. + -<level>: Specifies the levels to check (e.g. -joins -quits -hilight) -clear: Removes the previous results from the active window. -count: Displays how many lines match. -case: Performs a case-sensitive matching. + -date: Prepends each row with the message's date -regexp: The given text pattern is a regular expression. -word: The text must match full words. -force: Forces to display the lastlog, even if it exceeds 1000 lines. - -after: Only displays results after the given line number. - -before: Only displays results before the given line number. + -after: Include this many lines of content after the match. + -before: Include this many lines of content before the match. + -<#>: Include this many lines of content around the match. + <count>: Display a maximum number of `count' lines. + <start>: Skip the last `start' lines. The pattern to search for and the maximum of lines to display; if no parameter is given, the entire window buffer will be displayed. @@ -30,8 +34,10 @@ %9Examples:%9 /LASTLOG holiday - /LASTLOG 'is on vacation' - /LASTLOG -file -force ~/mike.log 'mike' + /LASTLOG 'is on vacation' 10 + /LASTLOG -force -file ~/mike.log 'mike' + /LASTLOG -hilight + /LASTLOG -5 searchterm %9See also:%9 HILIGHT, SCROLLBACK diff --git a/docs/help/in/list.in b/docs/help/in/list.in index 14858337..b796eed0 100644 --- a/docs/help/in/list.in +++ b/docs/help/in/list.in @@ -7,8 +7,8 @@ -yes: Confirms that you want to receive a large amount of data. - The text a channel must match; if no argument is given, the list of all - channels will be displayed. + If the exact name of a channel is given, the only information about this + channel is requested; otherwise, a list of all channels will be displayed. %9Description:%9 @@ -19,7 +19,16 @@ /LIST /LIST -yes - /LIST -yes *ubuntu* + /LIST #ubuntu + /LIST #*ubuntu*,>1 -%9See also:%9 QUOTE, STATS, WHOIS +%9Remarks:%9 + + Not all networks support server-side filtering and may provide a network + service or service bot instead; on IRCnet, you may use the List service: + + /SQUERY List HELP + /MSG ALIS HELP + +%9See also:%9 STATS, SQUERY, WHOIS diff --git a/docs/help/in/msg.in b/docs/help/in/msg.in index dc70f1f3..9e0879e4 100644 --- a/docs/help/in/msg.in +++ b/docs/help/in/msg.in @@ -11,6 +11,9 @@ The target nickname or channel and the message to send. + Use the wildcard character '*' if you want to use the active nickname or + channel. + %9Description:%9 Sends a message to a nickname or channel. @@ -19,6 +22,7 @@ /MSG mike Hi, what's up? /MSG #irssi I am awesome :) + /MSG * Do you want to build a snowman? %9See also:%9 ACTION, DCC, JOIN diff --git a/docs/help/in/network.in b/docs/help/in/network.in index 046d9feb..ba08ef69 100644 --- a/docs/help/in/network.in +++ b/docs/help/in/network.in @@ -7,6 +7,7 @@ LIST: Displays the list of configured networks. ADD: Adds a network to your configuration. + MODIFY: Modifies a network in your configuration. REMOVE: Removes a network from your configuration. -nick: Specifies the nickname to use. @@ -32,6 +33,12 @@ additional commands to the server. -cmdmax: Specifies the maximum number of commands to perform before starting the internal flood protection. + -sasl_mechanism Specifies the mechanism to use for the SASL authentication. + At the moment irssi only supports the 'plain' and the + 'external' mechanisms. + -sasl_username Specifies the username to use during the SASL authentication. + -sasl_password Specifies the password to use during the SASL authentication. + The name of the network to add, edit or remove; if no parameter is given, the list of networks will be displayed. @@ -53,6 +60,7 @@ /NETWORK ADD -usermode +iw -nick mike -realname 'The one and only mike!' -host staff.irssi.org Freenode /NETWORK ADD -autosendcmd '^MSG NickServ identify WzerT8zq' Freenode /NETWORK ADD -autosendcmd '^MSG Q@CServe.quakenet.org AUTH mike WzerT8zq; WAIT 2000; OPER mike WzerT8zq; WAIT 2000; MODE mike +kXP' Quakenet + /NETWORK MODIFY -usermode +gi EFnet /NETWORK REMOVE Freenode %9See also:%9 CHANNEL, CONNECT, SERVER diff --git a/docs/help/in/script.in b/docs/help/in/script.in index 6e94ef7f..e90135ad 100644 --- a/docs/help/in/script.in +++ b/docs/help/in/script.in @@ -12,6 +12,8 @@ RESET: Unloads all the scripts. -permanent: In combination with EXEC, the code will be loaded into the memory. + -autorun: When passed to RESET the scripts in the autorun folder are + reloaded. If no argument is given, the list of active scripts will be displayed. diff --git a/docs/help/in/server.in b/docs/help/in/server.in index 5628b19f..44de0efc 100644 --- a/docs/help/in/server.in +++ b/docs/help/in/server.in @@ -5,43 +5,47 @@ %9Parameters:%9 - LIST: Displays the list of servers you are connected to. - CONNECT: Connects to the given server. - ADD: Adds a server to your configuration. - REMOVE: Removes a server from your configuration. - PURGE: Purges the commands queued to be sent to the server. + LIST: Displays the list of servers you are connected to. + CONNECT: Connects to the given server. + ADD: Adds a server to your configuration. + MODIFY: Modifies a server in your configuration. + REMOVE: Removes a server from your configuration. + PURGE: Purges the commands queued to be sent to the server. - -!: Doesn't autojoin the channels. - -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_pass: Verifies 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. - -auto: Automatically connects to the server on startup. - -noauto: Doesn't connect to the server on startup. - -network: The network the server belongs to. - -host: The hostname you would like to connect from. - -cmdspeed: Specifies the minimum amount of time, expressed in - milliseconds, that the client must wait before sending - additional commands to the server. - -cmdmax: Specifies the maximum number of commands to perform - before starting the internal flood protection. - -port: Specifies the port to connect to the server. - -noproxy: Ignores the global proxy configuration. - -rawlog: Immediately open rawlog after connecting. - -noautosendcmd: Doesn't execute autosendcmd. + -!: Doesn't autojoin the channels. + -4: Connects using IPv4. + -6: Connects using IPv6. + -tls: Connects using TLS encryption. + -tls_cert: The TLS client certificate file. + -tls_pkey: The TLS client private key, if not included in the + certificate file. + -tls_pass: The password for the TLS client private key or certificate. + -tls_verify: Verifies the TLS certificate of the server. + -tls_cafile: The file with the list of CA certificates. + -tls_capath: The directory which contains the CA certificates. + -tls_ciphers: TLS cipher suite preference lists. + -tls_pinned_cert: Pinned x509 certificate fingerprint. + -tls_pinned_pubkey: Pinned public key fingerprint. + -auto: Automatically connects to the server on startup. + -noauto: Doesn't connect to the server on startup. + -network: The network the server belongs to. + -host: The hostname you would like to connect from. + -cmdspeed: Specifies the minimum amount of time, expressed in + milliseconds, that the client must wait before sending + additional commands to the server. + -cmdmax: Specifies the maximum number of commands to perform + before starting the internal flood protection. + -port: Specifies the port to connect to the server. + -noproxy: Ignores the global proxy configuration. + -rawlog: Immediately open rawlog after connecting. + -noautosendcmd: Doesn't execute autosendcmd. The server, port and network to add, modify or remove; if no argument is given, the list of servers you are connected to will be returned. %9Description:%9 - Displays, adds, modifies or removes the network configuration of IRC + Displays, adds, modifies or removes the network configuration of IRC servers. When using the ADD parameter on a server that already exists, the @@ -60,8 +64,9 @@ /SERVER CONNECT chat.freenode.net /SERVER CONNECT +chat.freenode.net /SERVER ADD -network Freenode -noautosendcmd orwell.freenode.net - /SERVER ADD -! -auto -host staff.irssi.org -port 6667 -4 -network Freenode -noproxy orwell.freenode.net - /SERVER REMOVE -network Freenode orwell.freenode.net + /SERVER ADD -! -auto -host staff.irssi.org -4 -network Freenode -noproxy orwell.freenode.net 6667 + /SERVER MODIFY -network Freenode -noauto orwell.freenode.net + /SERVER REMOVE orwell.freenode.net 6667 Freenode /SERVER PURGE /SERVER PURGE orwell.freenode.net diff --git a/docs/help/in/servlist.in b/docs/help/in/servlist.in new file mode 100644 index 00000000..0a0d025f --- /dev/null +++ b/docs/help/in/servlist.in @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +@SYNTAX:servlist@ + +%9Parameters:%9 + + <mask> limits the output to the services which names matches + the mask. + <type> limits the output to the services of the specified type. + +%9Description:%9 + + List the network services currently present on the + IRC network. + +%9Examples:%9 + + /SERVLIST *@javairc.* + /SERVLIST * 0xD000 + +%9See also:%9 SQUERY + diff --git a/docs/help/in/squery.in b/docs/help/in/squery.in new file mode 100644 index 00000000..59ee8008 --- /dev/null +++ b/docs/help/in/squery.in @@ -0,0 +1,16 @@ + +%9Syntax:%9 + +@SYNTAX:squery@ + +%9Parameters:%9 + + <service> - Service nickname or full hostmask of service to query. + <message> - Message to send to the service. + +%9Description:%9 + + /SQUERY sends a query to the specified service. + +%9See also:%9 SERVLIST, LIST, MSG + diff --git a/docs/help/in/window.in b/docs/help/in/window.in index c965d3fb..6dde6c50 100644 --- a/docs/help/in/window.in +++ b/docs/help/in/window.in @@ -5,49 +5,49 @@ %9Parameters:%9 - LOG: Modifies the logging status. - LOGFILE: Modifies the location to the log file. - NEW: Creates a new window. - CLOSE: Closes a window. - REFNUM: Go to the window with the given number. - GOTO: Go to the window with the given nickname, channel or number. - NEXT: Go to the next window. - LAST: Go to the last window. - PREVIOUS: Go to the previous window. - LEVEL: Modifies the text levels to display in the window. - IMMORTAL: Modifies the window mortality status. - SERVER: Set the active server of the window. - ITEM PREV: Go to the previous item in the window. - ITEM NEXT: Go to the next item in the window. - ITEM GOTO: Go to the specified nickname, channel or window item number. - ITEM MOVE: Move the active window item to another window. - NUMBER: Move the active window to another position. - NAME: Give the window a name. - HISTORY: Clears the window history buffer. - MOVE PREV: Move the window down. - MOVE NEXT: Move the window up. - MOVE FIRST: Move the window to the first position. - MOVE LAST: Move the window to the last position. - MOVE: Move the window. - LIST: List all the windows. - THEME: Applies a theme to the windows. - GROW: Increase the window size when using split windows. - SHRINK: Decrease the window size when using split windows. - SIZE: Modify the window size when using split windows. - BALANCE: Balance the window locations when using split windows. - HIDE: Hide the window when using split windows. - SHOW: Show the window when using split windows. - UP: Go to the window above when using split windows. - DOWN: Go to the window below when using split windows. - LEFT: Go to the previous window. - RIGHT: Go to the next window. - STICK: Make the window sticky. - MOVE LEFT: Move the window to the previous location. - MOVE RIGHT: Move the window to the next location. - MOVE UP: Move the window up when using split windows. - MOVE DOWN: Move the window down when using split windows. + LOG: %|Turn on or off logging of the active window, optionally specifying the log file to use. + LOGFILE: %|Sets the location of the log file to use for window logging without starting to log. + NEW: %|Creates a new hidden or split window. + CLOSE: %|Closes the current window, the specified one or all windows in the given range. + REFNUM: %|Go to the window with the given number. + GOTO: %|Go to the window with activity, with the given nickname, channel or with the specified number. + NEXT: %|Go to the next window numerically. + LAST: %|Go to the previously active window. + PREVIOUS: %|Go to the previous window numerically. + LEVEL: %|Changes the text levels to display in the window, or query the current level. + IMMORTAL: %|Modifies or queries the window mortality status. Immortal windows have an extra protection against WINDOW CLOSE. + SERVER: %|Change the active server of the window or the server stickyness. If the server is sticky, it cannot be cycled with next_window_item/previous_window_item + ITEM PREV: %|Make the previous item in this window active. + ITEM NEXT: %|Make the next item in this window active. + ITEM GOTO: %|Change to the query with the specified nickname, channel with the given name or window item number. + ITEM MOVE: %|Move the active window item to another window, or move the channel or query item specified by their name to the current window. + NUMBER: %|Change the active window number to the specified number, swapping the window already in that place if required. With -sticky, protect the window number from renumbering done by windows_auto_renumber. (To re-set the sticky attribute, use WINDOW NUMBER again without -sticky.) + NAME: %|Change or clear the window name. Window names must be unique. + HISTORY: %|Set or clear a specific named history to use for this window. All windows with the same named history will share a history. + MOVE PREV: %|Move the window to the place of the numerically previous window. At the first position, move the window to the end and renumber the consecutive block that it was part of. + MOVE NEXT: %|Move the window to the place of the numerically next window. At the last position, move the window to the first position and renumber the consecutive block at first position (if any) + MOVE FIRST: %|Move the window to the first position. Any windows inbetween are moved to their numerically next positions. + MOVE LAST: %|Move the window to the last position. Any windows inbetween are moved to their numerically previous positions. + MOVE: %|Move the window to the specified number or the first number that is in use when moving the window in the direction of the specified position. Any windows inbetween are shifted towards the old position of the window (unused positions remain empty) + LIST: %|List all the windows. + THEME: %|Applies or removes a per-window theme. + GROW: %|Increase the size of the active split window by the specified number of lines. + SHRINK: %|Decrease the size of the active split window by the specified number of lines. + SIZE: %|Set the current split window size to the specified numer of lines. + BALANCE: %|Balance the heights of all split windows. + HIDE: %|Hides the current split window, or the split window specified by number or item name. + SHOW: %|Show the window specified by number or item name as a new split windows. It is made sticky when autostick_split_windows is turned on. + UP: %|Set the split window above the current one active. At the top, wraps to the bottom. + DOWN: %|Set the split window below the current one active. At the bottom, wraps to the top. + LEFT: %|Go to the previous window numerically that is part of the current sticky group (or not part of any sticky group). + RIGHT: %|Go to the next window numerically that is part of the current sticky group (or not part of any sticky group). + STICK: %|Make the currently active window sticky, or stick the window specified by number to the currently visible split window. Or turn off stickyness of the currently active window or the window specified by number. + MOVE LEFT: %|Move the window to the numerically previous location inside the current sticky group. + MOVE RIGHT: %|Move the window to the numerically next location inside the current sticky group. + MOVE UP: %|Move the current window to the sticky group of the split window above. If no sticky group remains, the split window collapses. + MOVE DOWN: %|Move the current window to the sticky group of the split window below. If no sticky group remains, the split window collapses. - Add the required arguments for the given command. + %|Add the required arguments for the given command. Without arguments, the details (size, immortality, levels, server, name and sticky group) of the currently active window are displayed. If used with a number as argument, same as WINDOW REFNUM. %9Description:%9 |