diff options
| -rw-r--r-- | docs/help/in/alias.in | 2 | ||||
| -rw-r--r-- | docs/help/in/lastlog.in | 45 | ||||
| -rw-r--r-- | docs/help/in/layout.in | 31 | ||||
| -rw-r--r-- | docs/help/in/levels.in | 73 | ||||
| -rw-r--r-- | docs/help/in/links.in | 21 | ||||
| -rw-r--r-- | docs/help/in/list.in | 27 | ||||
| -rw-r--r-- | docs/help/in/load.in | 23 | ||||
| -rw-r--r-- | docs/help/in/log.in | 81 | ||||
| -rw-r--r-- | docs/help/in/lusers.in | 21 |
9 files changed, 207 insertions, 117 deletions
diff --git a/docs/help/in/alias.in b/docs/help/in/alias.in index e57ad194..13fcb55a 100644 --- a/docs/help/in/alias.in +++ b/docs/help/in/alias.in @@ -23,7 +23,7 @@ %9Examples:%9 /ALIAS - /ALIAS J JOIN + /ALIAS UH USERHOST /ALIAS COMEBACK SAY I was hoping for a battle of wits, but you seem to be unarmed. /ALIAS -COMEBACK /ALIAS UNACT SCRIPT EXEC \$_->activity(0) for Irssi::windows diff --git a/docs/help/in/lastlog.in b/docs/help/in/lastlog.in index b7cadf8a..41522cb2 100644 --- a/docs/help/in/lastlog.in +++ b/docs/help/in/lastlog.in @@ -1,22 +1,37 @@ +%9Syntax:%9 + @SYNTAX:lastlog@ - -clear: remove all lastlog lines from window +%9Parameters:%9 + + -: Doesn't print the "Lastlog:" and "End of Lastlog" messages. + -file: Output the lastlog to a file instead of the active window. + -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. + -clear: Removes the previous results from the active window. + -count: Displays how many lines match. + -case: Performs a case-sensitive matching. + -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. + + The pattern to search for and the maximum of lines to display; if no + parameter is given, the entire window buffer will be displayed. + +%9Description:%9 + + Searches the active window for a pattern and displays the result. - -: don't print the "Lastlog:" and "End of Lastlog" messages. - -file: write lastlog to file instead of screen - -window: which window's lastlog to check (output is always to active) - -case: Case-sensitive matching - -force: Force displaying lastlog even if it's longer than 1000 lines - -new: show only lines since last /LASTLOG - -regexp: `text' is a regular expression - -word: `text' must match to full words - -<level>: levels to check (default is all; /help levels for details) - <pattern>: text to search for, or all if empty - <count>: maximum number of lines to show - <start>: skip the last `start' lines +%9Examples:%9 -Shows the given number of lines of log from the current window. + /LASTLOG holiday + /LASTLOG "is on vacation" + /LASTLOG -file -force ~/mike.log "mike" -See also: +%9See also:%9 HILIGHT, SCROLLBACK diff --git a/docs/help/in/layout.in b/docs/help/in/layout.in index d5e81438..041549d1 100644 --- a/docs/help/in/layout.in +++ b/docs/help/in/layout.in @@ -1,13 +1,28 @@ +%9Syntax:%9 + @SYNTAX:layout@ -Saves the current window layout to configuration (yes, you'll still -need to use /SAVE to save the configuration to file). Next time you run -irssi, all the channels and queries are exactly in the same windows -where they were when you called /LAYOUT SAVE. +%9Parameters:%9 + + SAVE: Saves your layout to the configuration. + RESET: Removes the saved layout from the configuration. + +%9Descripton:%9 + + Saves the layout of your window configuration; the next time you connect + to the server, you will join the channels in the same window as before. + + This method enables you to keep the same window layout when you start Irssi + the next time. + + You will need to use the SAVE command to confirm and commit the changes + into the configuration file. + +%9Examples:%9 + + /LAYOUT SAVE + /LAYOUT RESET -Channels aren't actually joined in those windows immediately, they're -just marked "next time you join to '#channel' in server that has tag -'ircnet' place it to this window". +%9See also:%9 SAVE, WINDOW -/LAYOUT RESET removes the saved layout. diff --git a/docs/help/in/levels.in b/docs/help/in/levels.in index b6ebed7e..c44a551a 100644 --- a/docs/help/in/levels.in +++ b/docs/help/in/levels.in @@ -1,35 +1,40 @@ -Message levels (or in short, levels) are used almost everywhere. -They describe what kind of messages we're dealing with. Here's a -list of them all: - - CRAP - Can be almost anything - MSGS - Private messages - PUBLIC - Public messages in channel - NOTICES - Notices - SNOTES - Server notices - CTCPS - CTCP messages - ACTIONS - Actions (/me) - usually ORed with PUBLIC or MSGS - JOINS - Someone joins a channel - PARTS - Someone parts a channel - QUITS - Someone quits IRC - KICKS - Someone gets kicked from channel - MODES - Channel mode is changed - TOPICS - Channel topic is changed - WALLOPS - Wallop is received - INVITES - Invite is received - NICKS - Someone changes nick - DCC - DCC related messages - DCCMSGS - DCC chat messages - CLIENTNOTICE - Irssi's notices - CLIENTERROR - Irssi's error messages - CLIENTCRAP - Some other messages from Irssi - -And a few special ones that could be included with the -levels above: - - HILIGHT - Text is highlighted - NOHILIGHT - Don't check highlighting for this message - NO_ACT - Don't trigger channel activity when printing - this message - NEVER - Never ignore or log this message + +%9Description:%9 + + These are the message levels that are used throughout Irssi; they describe + what kind of message is displayed. + + These are the common levels you can use: + + ACTIONS Actions by a nickname. + CLIENTCRAP Irssi's internal messages. + CLIENTERROR Irssi's internal error messages. + CLIENTNOTICE Irssi's internal notices. + CRAP Can be almost anything. + CTCPS CTCP messages. + DCC DCC protocol related messages. + DCCMSGS DCC chat messages. + INVITES An invite is received. + JOINS A nickname joins a channel. + KICKS A nickname gets kicked from a channel. + MODES A channel mode is modified. + MSGS Private messages. + NICKS A nickname changes to another nickname. + NOTICES Notices sent from a nickname. + PARTS A nickname leaves a channel. + PUBLIC Public messages in a channel. + QUITS A nickname disconnects from IRC. + SNOTES Notices sent from a server. + TOPICS A channel topic is modified. + WALLOPS A wallop is received. + + These are the special levels you can use: + + HILIGHT The text is highlighted. + NEVER Never ignores or logs the message. + NO_ACT Doesn't trigger any activity in the statusbar. + NOHILIGHT The text is not highlighted. + + When using levels from Irssi scripts, you need to prepend the level with + "MSGLEVEL_"; for example "CRAP" will be "MSGLEVEL_CRAP". diff --git a/docs/help/in/links.in b/docs/help/in/links.in index 95ee07c5..a2aaa689 100644 --- a/docs/help/in/links.in +++ b/docs/help/in/links.in @@ -1,9 +1,22 @@ +%9Syntax:%9 + @SYNTAX:links@ -Shows the links between the IRC servers of the -current IRC network. If a wildcard parameter is -specified, shows only the matching entries. +%9Parameters:%9 + + The server to search on and the string to match on; if no arguments are + given, the list of links of the active server will be displayed. + +%9Description:%9 + + Displays the links between an IRC server and its connections. + +%9Examples:%9 + + /LINKS + /LINKS ircsource.irssi.org + /LINKS ircsource.irssi.org *.hub -See also: MAP +%9See also:%9 LUSERS, MAP diff --git a/docs/help/in/list.in b/docs/help/in/list.in index a1f697e7..cbce105e 100644 --- a/docs/help/in/list.in +++ b/docs/help/in/list.in @@ -1,16 +1,25 @@ +%9Syntax:%9 + @SYNTAX:list@ -Lists the channel names. Trying to list all the channel -names usually causes you to be disconnected from the -server with the reason "Excess flood", as usually all -40000 channels form together and server naively attempts -to send you them. +%9Parameters:%9 + + -yes: Comfirms 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. + +%9Description:%9 + + Displays the channel names that match your request; requesting all channels + may cause the server to disconnect you for flooding. + +%9Examples:%9 -Thus, on IRCNet, you should rather use service ALIS -(Advanced Listing Service), which will allow you to query -for channel with specific name, topic, mode or usercount. -Type /SQUERY ALIS HELP to get more info about it. + /LIST + /LIST -yes + /LIST -yes *ubuntu* See also: SQUERY diff --git a/docs/help/in/load.in b/docs/help/in/load.in index 867654c7..643d09d3 100644 --- a/docs/help/in/load.in +++ b/docs/help/in/load.in @@ -1,16 +1,23 @@ +%9Syntax:%9 + @SYNTAX:load@ -Load a plugin. If full path isn't given, irssi searches the plugin from -directories: +%9Parameters%9 + + The name of the module and submodule to load. + +%9Description:%9 + + Loads a plugin; if the full path isn't given, it will attempt to load from + common directories in your installation path. - ~/.irssi/modules/ - <install dir, /usr/local or /usr maybe>/lib/irssi/modules/ + To load a perl script, you must use the SCRIPT command. -See plugins page of http://www.irssi.org/ to see if there's any plugins -you'd want to use. +%9Examples:%9 -To load a perl script you should use /SCRIPT. + /LOAD fish + /LOAD ~/irssi-fish/libfish.so -See also: UNLOAD +%9See also:%9 SCRIPT, UNLOAD diff --git a/docs/help/in/log.in b/docs/help/in/log.in index 09580793..647d4560 100644 --- a/docs/help/in/log.in +++ b/docs/help/in/log.in @@ -1,41 +1,48 @@ +%9Syntax:%9 + @SYNTAX:log@ - -noopen: Create the entry to log list, but don't start logging - -autoopen: Automatically open this log file at startup - -<server tag>: Targets are logged only in this server - -targets: Log only in specified channels/nicks (space separated list) - -window: Log output in the window. Active window is used by default, or - you can give the window's refnum in -targets. - <filename>: File name where to log, it is parsed with - strftime(), so %%d=day, etc. see "man strftime" for - more info. - <levels>: Defaults to ALL - <id>: ID number of log. - -/SET log_create_mode <mode> - Specifies what file mode to use with - the created log files. Default is 0600. - -All of these are parsed with strftime(): -/SET log_timestamp <text> - Specifies the time stamp format. - Default is "%%H:%%M ". -/SET log_open_string <text> - Text written to log when it's opened -/SET log_close_string <text> - Text written to log when it's closed -/SET log_day_changed <text> - Text written to log when day changes - -NOTE: Log files are locked after opened, so two Irssis can't -accidentally try to write to the same log file. - -Examples: - -/LOG OPEN -targets cras ~/irclogs/cras.log MSGS - - Logs all messages from/to nick `cras' - -/LOG OPEN -targets #linux ~/irclogs/linux/linux-%%Y-%%m-%%d - - Logs all messages in channel #linux. Log is rotated daily, so - logs in 1. May 2000 goes to file "linux-2000-05-01", when the - day is changed, Irssi closes the log and starts logging to - "linux-2000-05-02" etc. - -See also: SET LOG, WINDOW LOG +%9Parameters:%9 + + OPEN: Opens a logfile. + CLOSE: Closes a logfile. + START: Starts logging a log entry. + STOP: Stops logging a log entry. + + -noopen: Saves the entry in the configuration, but doesn't actually + start logging. + -autoopen: Automatically opens the log at startup. + -window: Displays the output to the active window, or the window + specified in the targets parameter. + -<server tag>: The server tag the targets must be on. + -targets: Logs the specified nickhames or channels. + -colors: Also log the color codes of the messages. + + The filename of the log and the levels to match; if no argument is given, + the list of open logs will be displayed. + +%9Description:%9 + + Opens a logfile and stores the messages of the given targets into it; the + logfiles will be locked so multiple clients cannot log to the same file. + + You may use any of the date formats to create a logrotation; we strongly + recommend you to enable autolog if you are interested in keeping logs. + +%9Examples:%9 + + /LOG OPEN -targets mike ~/irclogs/mike.log MSGS + /LOG OPEN -targets #irssi-freenode ~/irclogs/freenode/irssi-%%Y-%%m-%%d + /LOG CLOSE ~/irclogs/freenode/irssi-%%Y-%%m-%%d + /LOG STOP ~/irclogs/freenode/irssi-%%Y-%%m-%%d + /LOG START ~/irclogs/freenode/irssi-%%Y-%%m-%%d + + /SET autolog ON + +%9References:%9 + + https://github.com/irssi/irssi/blob/master/docs/formats.txt + +%9See also:%9 SET LOG, WINDOW LOG diff --git a/docs/help/in/lusers.in b/docs/help/in/lusers.in index abcd55c4..f9edf535 100644 --- a/docs/help/in/lusers.in +++ b/docs/help/in/lusers.in @@ -1,5 +1,24 @@ +%9Syntax:%9 + @SYNTAX:lusers@ -Shows user statistics of the current IRC network. +%9Parameters:%9 + + The server to search on and the remote sever to search on; if no arguments + are given, the active server will be used. + +%9Description:%9 + + Displays the user statistics of the active or remote server. + + The parameters to search on a remote server are no longer supported on most + IRC servers; we no longer provide examples for remote LUSERS to avoid all + confusion. + +%9Examples:%9 + + /LUSERS + +%9See also:%9 LINKS, MAP |