From 0b2d864a47afea4425a42cda84cc4b170054d744 Mon Sep 17 00:00:00 2001 From: Pekka Riikonen Date: Sat, 30 Nov 2002 16:13:10 +0000 Subject: [PATCH] Toni's help file patch. --- apps/irssi/docs/help/in/action.in | 5 +---- apps/irssi/docs/help/in/admin.in | 5 ++--- apps/irssi/docs/help/in/ban.in | 2 +- apps/irssi/docs/help/in/cat.in | 2 +- apps/irssi/docs/help/in/cd.in | 2 +- apps/irssi/docs/help/in/close.in | 7 ++++++- apps/irssi/docs/help/in/dehilight.in | 7 ++----- apps/irssi/docs/help/in/exec.in | 3 +++ apps/irssi/docs/help/in/getkey.in | 1 + apps/irssi/docs/help/in/info.in | 1 + apps/irssi/docs/help/in/key.in | 2 ++ apps/irssi/docs/help/in/kick.in | 2 +- apps/irssi/docs/help/in/lastlog.in | 2 +- apps/irssi/docs/help/in/layout.in | 6 ++++-- apps/irssi/docs/help/in/load.in | 7 ++----- apps/irssi/docs/help/in/log.in | 18 +++++++++--------- apps/irssi/docs/help/in/motd.in | 5 ++--- apps/irssi/docs/help/in/msg.in | 9 +++++---- apps/irssi/docs/help/in/names.in | 10 ++++------ apps/irssi/docs/help/in/part.in | 5 ++--- apps/irssi/docs/help/in/query.in | 8 ++------ apps/irssi/docs/help/in/quit.in | 8 +++----- apps/irssi/docs/help/in/save.in | 6 ++---- apps/irssi/docs/help/in/sconnect.in | 5 +++-- apps/irssi/docs/help/in/script.in | 2 +- apps/irssi/docs/help/in/server.in | 9 +++------ apps/irssi/docs/help/in/shutdown.in | 3 +-- apps/irssi/docs/help/in/stats.in | 2 ++ apps/irssi/docs/help/in/users.in | 7 ++----- apps/irssi/docs/help/in/whois.in | 2 +- 30 files changed, 71 insertions(+), 82 deletions(-) diff --git a/apps/irssi/docs/help/in/action.in b/apps/irssi/docs/help/in/action.in index 89123fcc..6f0b9f1b 100644 --- a/apps/irssi/docs/help/in/action.in +++ b/apps/irssi/docs/help/in/action.in @@ -1,9 +1,6 @@ @SYNTAX:action@ -Same as ME, but gets channel as an additional parameter. -Example: /ACTION #irssi yawns -(This outputs the following to #irssi: * Nick yawns) +Same as ME, but gets channel as an additional parameter. Example: /ACTION silc yawns (This outputs the following to channel silc: * Nick yawns) See also: ME - diff --git a/apps/irssi/docs/help/in/admin.in b/apps/irssi/docs/help/in/admin.in index f854cd0f..76160f02 100644 --- a/apps/irssi/docs/help/in/admin.in +++ b/apps/irssi/docs/help/in/admin.in @@ -5,7 +5,6 @@ Displays the administrative details about the given server. If no server is specified, the server you are connected to is used. -This command may be an alias. - -See also: INFO +This command is an alias of INFO. +See also: INFO, STATS diff --git a/apps/irssi/docs/help/in/ban.in b/apps/irssi/docs/help/in/ban.in index 32bf76e9..2a22e26a 100644 --- a/apps/irssi/docs/help/in/ban.in +++ b/apps/irssi/docs/help/in/ban.in @@ -24,5 +24,5 @@ Examples: /BAN * Shows the ban list of the current channel. -See also: KNOCKOUT, KICKBAN +See also: KICK diff --git a/apps/irssi/docs/help/in/cat.in b/apps/irssi/docs/help/in/cat.in index ea324aa3..51c07678 100644 --- a/apps/irssi/docs/help/in/cat.in +++ b/apps/irssi/docs/help/in/cat.in @@ -4,5 +4,5 @@ Outputs the contents of the specified file. Equivalent to UNIX 'cat' command. -See also: CD +See also: EXEC diff --git a/apps/irssi/docs/help/in/cd.in b/apps/irssi/docs/help/in/cd.in index dd62f710..1d9f8d62 100644 --- a/apps/irssi/docs/help/in/cd.in +++ b/apps/irssi/docs/help/in/cd.in @@ -4,5 +4,5 @@ Changes the current working directory. Equivalent to UNIX 'cd' command. -See also: DCC GET +See also: EXEC diff --git a/apps/irssi/docs/help/in/close.in b/apps/irssi/docs/help/in/close.in index 7ce6dffd..e7f8043f 100644 --- a/apps/irssi/docs/help/in/close.in +++ b/apps/irssi/docs/help/in/close.in @@ -4,5 +4,10 @@ Operator command. Makes the server to close connection to another server or router. -See also: OPER, SILCOPER +You need to use same name of the server as configured in silcd.conf. + +Example: /CLOSE sauna.silcnet.org + +See also: SCONNECT, OPER, SILCOPER + diff --git a/apps/irssi/docs/help/in/dehilight.in b/apps/irssi/docs/help/in/dehilight.in index 34f856a5..7c87d1f9 100644 --- a/apps/irssi/docs/help/in/dehilight.in +++ b/apps/irssi/docs/help/in/dehilight.in @@ -1,9 +1,6 @@ @SYNTAX:dehilight@ -Makes irssi not to highlight items containing the text. -If parameter is a number, deletes the specified hilight -entry from the list. - -See also: HILIGHT +Remove given highlight. If parameter is a number, deletes the specified hilight entry from the list. +See also: HILIGHT, SET HILIGHT diff --git a/apps/irssi/docs/help/in/exec.in b/apps/irssi/docs/help/in/exec.in index c33ec59f..d88af57f 100644 --- a/apps/irssi/docs/help/in/exec.in +++ b/apps/irssi/docs/help/in/exec.in @@ -35,3 +35,6 @@ standard input of the process with -in option. kill the process. It is meant to remove the processes that don't die even with SIGKILL. This option just closes the pipes used to communicate with the process and frees all memory it used. + +See also: CAT, CD + diff --git a/apps/irssi/docs/help/in/getkey.in b/apps/irssi/docs/help/in/getkey.in index bb1c4c58..82fdfdb6 100644 --- a/apps/irssi/docs/help/in/getkey.in +++ b/apps/irssi/docs/help/in/getkey.in @@ -8,3 +8,4 @@ client posesses the corresponding private key as well. You will be prompted to verify and accept the fetched public key. The public key is saved into your local key directory (~/.silc/clientkeys/). +See also: WHOIS, KEY diff --git a/apps/irssi/docs/help/in/info.in b/apps/irssi/docs/help/in/info.in index 12e0b2f3..e4e9eec7 100644 --- a/apps/irssi/docs/help/in/info.in +++ b/apps/irssi/docs/help/in/info.in @@ -5,3 +5,4 @@ Displays the administrative details about the given server. If no server is specified, the server you are connected to is used. +See also: STATS diff --git a/apps/irssi/docs/help/in/key.in b/apps/irssi/docs/help/in/key.in index 062c2ad3..a14b49f1 100644 --- a/apps/irssi/docs/help/in/key.in +++ b/apps/irssi/docs/help/in/key.in @@ -103,3 +103,5 @@ Examples: /KEY MSG nick set secretkey -responder /KEY MSG foo agreement 10.2.1.7 5000 /KEY MSG bar negotiate 10.2.1.7 5000 + +See also: WHOIS, CHANNEL, GETKEY diff --git a/apps/irssi/docs/help/in/kick.in b/apps/irssi/docs/help/in/kick.in index 3e73dbe2..1f67d34f 100644 --- a/apps/irssi/docs/help/in/kick.in +++ b/apps/irssi/docs/help/in/kick.in @@ -8,5 +8,5 @@ you are channel operator. The default alias for /KICK is /K. -See also: KNOCKOUT +See also: BAN diff --git a/apps/irssi/docs/help/in/lastlog.in b/apps/irssi/docs/help/in/lastlog.in index 0c508c4f..732a4712 100644 --- a/apps/irssi/docs/help/in/lastlog.in +++ b/apps/irssi/docs/help/in/lastlog.in @@ -18,5 +18,5 @@ Shows the given number of lines of log from the current window. -See also: +See also: LOG, SET LOG, WINDOW LOG diff --git a/apps/irssi/docs/help/in/layout.in b/apps/irssi/docs/help/in/layout.in index d0cde15e..0d6d26f9 100644 --- a/apps/irssi/docs/help/in/layout.in +++ b/apps/irssi/docs/help/in/layout.in @@ -7,7 +7,9 @@ run irssi, all the channels and queries are exactly in the same windows where they were when you called /LAYOUT SAVE. 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". +just marked "next time you join to 'channel' in server that has tag +'silcnet' place it to this window". /LAYOUT RESET removes the saved layout. + +See also: SAVE diff --git a/apps/irssi/docs/help/in/load.in b/apps/irssi/docs/help/in/load.in index 16ce9be5..7b427454 100644 --- a/apps/irssi/docs/help/in/load.in +++ b/apps/irssi/docs/help/in/load.in @@ -4,11 +4,8 @@ Load a plugin. If full path isn't given, irssi searches the plugin from directories: - ~/.irssi/modules/ - /lib/irssi/modules/ - -See plugins page of http://irssi.org/ to see if there's any plugins -you'd want to use. +~/.silc/modules/ +/path/to/silc/modules/ (by default /usr/local/silc/modules) See also: UNLOAD diff --git a/apps/irssi/docs/help/in/log.in b/apps/irssi/docs/help/in/log.in index 6a61ef9f..ea5948f3 100644 --- a/apps/irssi/docs/help/in/log.in +++ b/apps/irssi/docs/help/in/log.in @@ -22,19 +22,19 @@ All of these are parsed with strftime(): /SET log_close_string - Text written to log when it's closed /SET log_day_changed - Text written to log when day changes -NOTE: Log files are locked after opened, so two Irssis can't +NOTE: Log files are locked after opened, so two clients 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 Toni ~/silclogs/Toni.log MSGS + - Logs all messages from/to nick `Toni' -/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. +/LOG OPEN -targets silc ~/silclogs/silc/silc-%%Y-%%m-%%d + - Logs all messages in channel silc. Log is rotated daily, so + logs in 1. May 2000 goes to file "silc-2000-05-01", when the + day is changed the log is closed and new log is opened as + "silc-2000-05-02". -See also: SET LOG, WINDOW LOG +See also: LASTLOG, SET LOG, WINDOW LOG diff --git a/apps/irssi/docs/help/in/motd.in b/apps/irssi/docs/help/in/motd.in index ba354408..d066ee68 100644 --- a/apps/irssi/docs/help/in/motd.in +++ b/apps/irssi/docs/help/in/motd.in @@ -1,7 +1,6 @@ @SYNTAX:motd@ -Shows the motd of the current server. This contains -usually some useful info on the server, administrator and -the rules. +Shows the motd of the current or given server. This contains usually some useful info on the server, administrator and the rules. +See also: INFO, ADMIN, STATS diff --git a/apps/irssi/docs/help/in/msg.in b/apps/irssi/docs/help/in/msg.in index 6267a679..153d82e8 100644 --- a/apps/irssi/docs/help/in/msg.in +++ b/apps/irssi/docs/help/in/msg.in @@ -1,9 +1,10 @@ @SYNTAX:msg@ -Sends a message to a remote client. Usually this -is used for sending private messages to other persons. +Sends a private message to someone. -Examples: +Example: -/MSG friend Hi, what's up? +/MSG Toni Hi, what's up? + +See also: QUERY diff --git a/apps/irssi/docs/help/in/names.in b/apps/irssi/docs/help/in/names.in index d3512d0b..6882ecba 100644 --- a/apps/irssi/docs/help/in/names.in +++ b/apps/irssi/docs/help/in/names.in @@ -6,17 +6,15 @@ -voices: show voiced people in list -normal: show rest of the people in list -Shows the names (nicks) in the specified channels. /NAMES ** -shows all nicks in all channels, you probably don't want -to do this. +Shows users of specified channels. /NAMES ** shows all nicks in all channels, you probably don't want to do this. Examples: /NAMES - shows nicks in the current channel. -/NAMES -ops #c1,#c2 - - shows operators in channels #c1 and #c2 +/NAMES -ops silc,beginners + - shows operators in channels silc and beginners -See also: WHO, CHANNEL +See also: USERS, WHO, WHOIS, WHOWAS, CHANNEL diff --git a/apps/irssi/docs/help/in/part.in b/apps/irssi/docs/help/in/part.in index ff3b12fb..c10d6e75 100644 --- a/apps/irssi/docs/help/in/part.in +++ b/apps/irssi/docs/help/in/part.in @@ -1,8 +1,7 @@ @SYNTAX:part@ -Parts from the current or specified channel. Depending -on your settings, closes the corresponding window, too. +Parts from the current or specified channel. Depending on your settings it closes the corresponding window also. -See also: LEAVE, JOIN +See also: JOIN diff --git a/apps/irssi/docs/help/in/query.in b/apps/irssi/docs/help/in/query.in index 52f191ee..2631e68a 100644 --- a/apps/irssi/docs/help/in/query.in +++ b/apps/irssi/docs/help/in/query.in @@ -1,13 +1,9 @@ @SYNTAX:query@ -Starts a private conversation with the nick. All text you -type that would normally be sent to your channel now goes to -the specified nick in the form of MSGs. +Starts a private conversation with given person. -Usually this command opens up a new window, too. - -The query is ended by giving command UNQUERY +The query session is ended by giving command UNQUERY See also: UNQUERY, WINDOW, MSG, SET QUERY diff --git a/apps/irssi/docs/help/in/quit.in b/apps/irssi/docs/help/in/quit.in index 1c1e7bac..39cf8842 100644 --- a/apps/irssi/docs/help/in/quit.in +++ b/apps/irssi/docs/help/in/quit.in @@ -1,10 +1,8 @@ @SYNTAX:quit@ -This ends your session. If a quit message is supplied, it -will be displayed to anyone else on any channel you were on -before quitting. If one isn't specified, the text "Leaving" is -used. +This ends your session. -/EXIT does the same. +If a quit message is supplied, it will be displayed to everyone on all channels you were on before quitting. If quit message isn't specified, the text "leaving" is used. +See also: EXIT diff --git a/apps/irssi/docs/help/in/save.in b/apps/irssi/docs/help/in/save.in index a6d5ea5b..664d8668 100644 --- a/apps/irssi/docs/help/in/save.in +++ b/apps/irssi/docs/help/in/save.in @@ -1,8 +1,6 @@ @SYNTAX:save@ -Saves the current Irssi configuration into the configuration -file. - -See also: RELOAD +Saves the current configuration. +See also: RELOAD, LAYOUT diff --git a/apps/irssi/docs/help/in/sconnect.in b/apps/irssi/docs/help/in/sconnect.in index f77c5d3d..61627774 100644 --- a/apps/irssi/docs/help/in/sconnect.in +++ b/apps/irssi/docs/help/in/sconnect.in @@ -5,7 +5,8 @@ Operator command. Makes an server to connect to another server or router. The is the hostname or IP addres of the server. -Example: /SCONNECT silc.silcnet.org 706 +You need to use same name of the server as configured in silcd.conf. -See also: OPER, SILCOPER, CLOSE, SHUTDOWN +Example: /SCONNECT sauna.silcnet.org +See also: CLOSE, OPER, SILCOPER diff --git a/apps/irssi/docs/help/in/script.in b/apps/irssi/docs/help/in/script.in index 0354512b..fc2f6410 100644 --- a/apps/irssi/docs/help/in/script.in +++ b/apps/irssi/docs/help/in/script.in @@ -15,5 +15,5 @@ Without any parameters, /SCRIPT acts in same way as if you would call /SCRIPT LI /SCRIPT RESET unloads all loaded scripts and resets the perl interpreter. -See also: LOAD, UNLOAD +See also: LOAD, UNLOAD, RUN diff --git a/apps/irssi/docs/help/in/server.in b/apps/irssi/docs/help/in/server.in index ac514f73..1218ea60 100644 --- a/apps/irssi/docs/help/in/server.in +++ b/apps/irssi/docs/help/in/server.in @@ -4,11 +4,9 @@ -4, -6: specify explicitly whether to use IPv4 or IPv6 address -auto: Automatically connect to server at startup (default) -noauto: Don't connect to server at startup - -silcnet: Specify what network this server belongs to - -host: Specify what host name to use, if you have multiple + -silcnet: Specify the network this server belongs to + -host: Specify what host name to bind to, if you have multiple interfaces -!: don't autojoin channels - -cmdspeed: Same as /SET cmd_queue_speed, see section 3.1 - -cmdmax: Same as /SET cmd_max_at_once, see section 3.1 -port: This is pretty much like the port argument later, except this can be used to modify existing server's port. @@ -27,5 +25,4 @@ where the server is connected (ie. /window new hide; /SERVER LIST -See also: RMRECONNS, DISCONNECT, RECONNECT - +See also: RMRECONNS, DISCONNECT, RECONNECT, CONNECT diff --git a/apps/irssi/docs/help/in/shutdown.in b/apps/irssi/docs/help/in/shutdown.in index 48ff58c9..e71d1007 100644 --- a/apps/irssi/docs/help/in/shutdown.in +++ b/apps/irssi/docs/help/in/shutdown.in @@ -1,7 +1,6 @@ @SYNTAX:shutdown@ -Operator command. Shutdowns the server. +Operator command. Shuts the server down. See also: OPER, SILCOPER, CLOSE - diff --git a/apps/irssi/docs/help/in/stats.in b/apps/irssi/docs/help/in/stats.in index 58418794..310cc87c 100644 --- a/apps/irssi/docs/help/in/stats.in +++ b/apps/irssi/docs/help/in/stats.in @@ -2,3 +2,5 @@ @SYNTAX:stats@ Shows various server and network statistics. + +See also: INFO, ADMIN diff --git a/apps/irssi/docs/help/in/users.in b/apps/irssi/docs/help/in/users.in index 71cf2db2..4fe4760b 100644 --- a/apps/irssi/docs/help/in/users.in +++ b/apps/irssi/docs/help/in/users.in @@ -1,11 +1,8 @@ @SYNTAX:users@ -Shows users of the specified channel. The channel must be either joined or it -needs to be a public channel (without secret or private flags set). +Lists users of given channel. The channel must be either joined or it needs to be a public channel (without secret or private flags set). Alias WHO is by default USERS * command. -See also: WHOIS, WHOWAS - - +See also: NAMES, WHOIS, WHOWAS diff --git a/apps/irssi/docs/help/in/whois.in b/apps/irssi/docs/help/in/whois.in index 1533b0c3..d153a023 100644 --- a/apps/irssi/docs/help/in/whois.in +++ b/apps/irssi/docs/help/in/whois.in @@ -26,5 +26,5 @@ informations is received. If you want to send your information in WHOIS you can set the information with ATTR command. See HELP ATTR. -See also: WHOWAS, CHANNEL, ATTR +See also: WHOIS, CHANNEL, ATTR, NAMES, WHO -- 2.24.0