Toni's help file patch.
authorPekka Riikonen <priikone@silcnet.org>
Sat, 30 Nov 2002 16:13:10 +0000 (16:13 +0000)
committerPekka Riikonen <priikone@silcnet.org>
Sat, 30 Nov 2002 16:13:10 +0000 (16:13 +0000)
30 files changed:
apps/irssi/docs/help/in/action.in
apps/irssi/docs/help/in/admin.in
apps/irssi/docs/help/in/ban.in
apps/irssi/docs/help/in/cat.in
apps/irssi/docs/help/in/cd.in
apps/irssi/docs/help/in/close.in
apps/irssi/docs/help/in/dehilight.in
apps/irssi/docs/help/in/exec.in
apps/irssi/docs/help/in/getkey.in
apps/irssi/docs/help/in/info.in
apps/irssi/docs/help/in/key.in
apps/irssi/docs/help/in/kick.in
apps/irssi/docs/help/in/lastlog.in
apps/irssi/docs/help/in/layout.in
apps/irssi/docs/help/in/load.in
apps/irssi/docs/help/in/log.in
apps/irssi/docs/help/in/motd.in
apps/irssi/docs/help/in/msg.in
apps/irssi/docs/help/in/names.in
apps/irssi/docs/help/in/part.in
apps/irssi/docs/help/in/query.in
apps/irssi/docs/help/in/quit.in
apps/irssi/docs/help/in/save.in
apps/irssi/docs/help/in/sconnect.in
apps/irssi/docs/help/in/script.in
apps/irssi/docs/help/in/server.in
apps/irssi/docs/help/in/shutdown.in
apps/irssi/docs/help/in/stats.in
apps/irssi/docs/help/in/users.in
apps/irssi/docs/help/in/whois.in

index 89123fccd57b2f4d8b59499c67eb4f66fc2db426..6f0b9f1b980a491a120883ddb00731a9132fcf09 100644 (file)
@@ -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
-
index f854cd0f4f53d4e7c5b7a93b9fd83ddfdfab3a5b..76160f02b4901f1973a70b84f8bfe48baf7cd013 100644 (file)
@@ -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
index 32bf76e931790afbdc51170562cc57e14b391473..2a22e26aad0da00392f9f5b7073ed8ac35ee9757 100644 (file)
@@ -24,5 +24,5 @@ Examples:
     /BAN *
         Shows the ban list of the current channel.
 
-See also: KNOCKOUT, KICKBAN
+See also: KICK
 
index ea324aa3eb092c91ec6d511f3c5190b2ef9d91fc..51c07678dd7f846c774f668d9dc8beb537082452 100644 (file)
@@ -4,5 +4,5 @@
 Outputs the contents of the specified file. Equivalent to
 UNIX 'cat' command.
 
-See also: CD
+See also: EXEC
 
index dd62f710f60819fc17a797830c8605313b434352..1d9f8d62e9e7b371d10d3a8b0dffdffbda4e3726 100644 (file)
@@ -4,5 +4,5 @@
 Changes the current working directory. Equivalent to UNIX
 'cd' command.
 
-See also: DCC GET
+See also: EXEC
 
index 7ce6dffd846f8ad1de69b211e7af4121b7131c96..e7f8043f6ed00d2265b4f1fb9a189e5cd5f10aba 100644 (file)
@@ -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
+
 
index 34f856a572a031d68c1ec71208c04765610ddc16..7c87d1f97c61fe2189b4c545f80dad4147d65371 100644 (file)
@@ -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
index c33ec59f89df87bdd221e51800620c808fba56de..d88af57fb1e705172a9c91feb7f939d30068fda6 100644 (file)
@@ -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
+
index bb1c4c5857e851f8224f792d588ca41b70eb6ab4..82fdfdb67d751eb136691d3148960bfc0ac27707 100644 (file)
@@ -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
index 12e0b2f39fa5d58d4a5bbc9cf68a30394ee74a58..e4e9eec7ca1938f8fcb489231fca2d7b72464007 100644 (file)
@@ -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
index 062c2ad303ca1cb9a8a8a26eb163bdab75b29c74..a14b49f1d681177ea7e0abd76f07e4664eb0355c 100644 (file)
@@ -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
index 3e73dbe247cc5ec07a72dd3e56ac3486dccd7f30..1f67d34fc9ff61238b2925f01b9b0c45a226b69c 100644 (file)
@@ -8,5 +8,5 @@ you are channel operator.
 
 The default alias for /KICK is /K.
 
-See also: KNOCKOUT
+See also: BAN
 
index 0c508c4f51cb15e34d4217f740d35f0b80e9f0ca..732a47124edc44064fef4fb6b9069be8b044c607 100644 (file)
@@ -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
 
index d0cde15eb12d20d7b0ae212594f255bb0e3ade17..0d6d26f9caae275a94df073b3da395d66ae70a84 100644 (file)
@@ -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
index 16ce9be588df1dcc18a6d8cbc764a9141d437a77..7b427454dfdfd18662af6ddb2f287240267b616d 100644 (file)
@@ -4,11 +4,8 @@
 Load a plugin. If full path isn't given, irssi searches the
 plugin from directories:
 
- ~/.irssi/modules/
- <install dir, /usr/local or /usr maybe>/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
 
index 6a61ef9f0c8e25348f70f9096f37dd01f89f064e..ea5948f3df6d54b04cc95a93baf43a7f8d3b5f5b 100644 (file)
@@ -22,19 +22,19 @@ All of these are parsed with strftime():
 /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
+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
 
index ba3544088e4064ce3ff156553538623fd97e69fa..d066ee68b2b68ca592797331453a9b467e3439da 100644 (file)
@@ -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
index 6267a6790f64e27415ddb592b9c17751dc3e5ce3..153d82e8c24935dd74656f1817b9b9c1dbc9d93d 100644 (file)
@@ -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
index d3512d0bba50084bca7737ff8be8899e1dfa03f1..6882ecba78714304d51765b331fe4a0beba6e3b7 100644 (file)
@@ -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
 
index ff3b12fb64ce679c9096021fc5e7cd05771a0c5b..c10d6e7595060f1433ce9568d4404cc4ad1fd37c 100644 (file)
@@ -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
 
index 52f191eef1dad3abdcf8c7226b84a7df96709426..2631e68aec52cb0f281bef12fedea99e66c1c810 100644 (file)
@@ -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
 
index 1c1e7bac089d226010a2d238e6997c8efd50146d..39cf8842af8d53cd6fa8ad7afbf5730ee030bd7c 100644 (file)
@@ -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
index a6d5ea5be516327e93df7316a1b17fd66d743155..664d8668cb085e7d62e9e7aac79ec23a2b7bcc89 100644 (file)
@@ -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
index f77c5d3d978752c89a1acd3affe52d2354edf6da..6162777401f3b0f3dca62cbf8b4d3ceb7b3bb8dc 100644 (file)
@@ -5,7 +5,8 @@ Operator command. Makes an server to connect to another
 server or router.  The <server> 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
index 0354512bde4c2577519eb6428a5c7a8ea91d2fd7..fc2f6410b6be1025d4b3ea4b7049380da616e157 100644 (file)
@@ -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
 
index ac514f73f7cf5d12d1f5bf8588b1cd42b44d875f..1218ea609850ecebfb7f5aec98edfade8a2bf9ac 100644 (file)
@@ -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
index 48ff58c9c81ece6273561e549af79ea709531ea5..e71d100787dee87306b42f36eec6496222fcf640 100644 (file)
@@ -1,7 +1,6 @@
 
 @SYNTAX:shutdown@
 
-Operator command.  Shutdowns the server.
+Operator command.  Shuts the server down.
 
 See also: OPER, SILCOPER, CLOSE
-
index 58418794ead28f757a0a8f595ecc329d462274df..310cc87c4b25684a53bb91716753484105b04940 100644 (file)
@@ -2,3 +2,5 @@
 @SYNTAX:stats@
 
 Shows various server and network statistics.
+
+See also: INFO, ADMIN
index 71cf2db271d4e998557f85259ca8d90b01203a6a..4fe4760b3d258c3d11c2f96c1dd0fe680b79af30 100644 (file)
@@ -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
index 1533b0c31805a708981429d0946ffcee7c4d0639..d153a023e55f76e54f2a410ef1d22c88bdfc0361 100644 (file)
@@ -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