From 3654085b14518e9b88410ffb5f12e0dc573aa752 Mon Sep 17 00:00:00 2001 From: Timo Sirainen Date: Fri, 5 Jan 2001 08:21:07 +0000 Subject: [PATCH] updated docs git-svn-id: http://svn.irssi.org/repos/irssi/trunk@1071 dbcabf3a-b0e7-0310-adc4-f8d773084564 --- docs/help/in/action.in | 2 +- docs/help/in/exec.in | 35 +++++++++++++++++++++++++++++++++++ docs/help/in/lastlog.in | 14 +++++++++----- docs/help/in/load.in | 14 ++++++++++++++ docs/help/in/rehash.in | 11 +++++++++++ docs/help/in/restart.in | 10 +++++----- docs/help/in/rmrejoins.in | 9 +++++++++ docs/help/in/savewindows.in | 12 ++++++++++++ docs/help/in/server.in | 4 ---- docs/help/in/unload.in | 8 ++++++++ docs/help/in/wait.in | 10 ++++++++++ 11 files changed, 114 insertions(+), 15 deletions(-) create mode 100644 docs/help/in/exec.in create mode 100644 docs/help/in/load.in create mode 100644 docs/help/in/rehash.in create mode 100644 docs/help/in/rmrejoins.in create mode 100644 docs/help/in/savewindows.in create mode 100644 docs/help/in/unload.in create mode 100644 docs/help/in/wait.in diff --git a/docs/help/in/action.in b/docs/help/in/action.in index 26d93a19..896e8d19 100644 --- a/docs/help/in/action.in +++ b/docs/help/in/action.in @@ -2,7 +2,7 @@ @SYNTAX:action@ Same as ME, but gets channel or nick as an additional parameter. -Example: /action #irssi yawns +Example: /ACTION #irssi yawns (This outputs the following to #irssi: * Nick yawns) See also: ME diff --git a/docs/help/in/exec.in b/docs/help/in/exec.in new file mode 100644 index 00000000..9efd3e44 --- /dev/null +++ b/docs/help/in/exec.in @@ -0,0 +1,35 @@ + +@SYNTAX:exec@ + + -: Don't print "process terminated ..." message + -nosh: Don't start command through /bin/sh + -out: Send output to active channel/query + -msg: Send output to specified nick/channel + -notice: Send output to specified nick/channel as notices + -name: Name the process so it could be accessed easier + + -window: Move the output of specified process to active window + -close: Forcibly close (or "forget") a process that doesn't die. + This only removes all information from irssi concerning the + process, it doesn't send SIGKILL or anything the process. + -: Send a signal to process. can be either numeric + or one of the few most common ones (hup, term, kill, ...) + + -in: Send text to standard input of the specified process + +Execute specified command in background. Output of process is printed +to active window by default, but can be also sent as messages or +notices to specified nick or channel. + +Processes can be accessed either by their ID or name if you named it. +Process identifier must always begin with '%' character, like %0 or +%name. + +Once the process is started, it's output can still be redirected +elsewhere with the -window, -msg, etc. options. You can send text to +standard input of the process with -in option. + +-close option shouldn't probably be used if there's a better way to +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. diff --git a/docs/help/in/lastlog.in b/docs/help/in/lastlog.in index 128dcfa7..853771eb 100644 --- a/docs/help/in/lastlog.in +++ b/docs/help/in/lastlog.in @@ -1,12 +1,16 @@ @SYNTAX:lastlog@ - -word Shows only the lines matching the 'word' - -new - -away + -: don't print the "Lastlog:" and "End of Lastlog" messages. + -new: show only lines since last /LASTLOG + -regexp: `text' is a regular expression + -word: `text' must match to full words + -level: what levels to check, like -public -msgs (default is all) + : text to search for, or all if empty + : maximum number of lines to show + : skip the last `start' lines -Shows the given number of lines of log from the -current window. +Shows the given number of lines of log from the current window. See also: diff --git a/docs/help/in/load.in b/docs/help/in/load.in new file mode 100644 index 00000000..e887e101 --- /dev/null +++ b/docs/help/in/load.in @@ -0,0 +1,14 @@ + +@SYNTAX:load@ + +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. + +See also: UNLOAD + diff --git a/docs/help/in/rehash.in b/docs/help/in/rehash.in new file mode 100644 index 00000000..2fb55791 --- /dev/null +++ b/docs/help/in/rehash.in @@ -0,0 +1,11 @@ + +@SYNTAX:rehash@ + +IRC Operator command. + +This command is used to force the current server to reload it's +ircd.conf configuration file. This is useful for effecting +configuration changes without starting a new server. + +See also: OPER, RESTART + diff --git a/docs/help/in/restart.in b/docs/help/in/restart.in index 7387b88c..14cd940f 100644 --- a/docs/help/in/restart.in +++ b/docs/help/in/restart.in @@ -1,12 +1,12 @@ @SYNTAX:restart@ -IRC Operator command. +IRC Operator command. -This command is used to completely restart the server. A side effect -of this is that the configuration file will be read again. However, -it is generally more useful for clearing out internal buffers and -other wasted memory. +This command is used to completely restart the server. A side effect of +this is that the configuration file will be read again. However, it is +generally more useful for clearing out internal buffers and other +wasted memory. See also: OPER, DIE diff --git a/docs/help/in/rmrejoins.in b/docs/help/in/rmrejoins.in new file mode 100644 index 00000000..a485e93a --- /dev/null +++ b/docs/help/in/rmrejoins.in @@ -0,0 +1,9 @@ + +@SYNTAX:rmrejoins@ + +Removes the pending rejoins from the channel rejoin list in active +server. Channels are added to rejoin list when join failed because of +netsplits in server ("Channel is temporarily unavailable"). + +See also: JOIN + diff --git a/docs/help/in/savewindows.in b/docs/help/in/savewindows.in new file mode 100644 index 00000000..7808fd1e --- /dev/null +++ b/docs/help/in/savewindows.in @@ -0,0 +1,12 @@ + +@SYNTAX:savewindows@ + +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 /SAVEWINDOWS. + +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". + diff --git a/docs/help/in/server.in b/docs/help/in/server.in index 5453470d..3d3ebee5 100644 --- a/docs/help/in/server.in +++ b/docs/help/in/server.in @@ -1,10 +1,6 @@ @SYNTAX:server@ -/SERVER ADD [-auto | -noauto] [-ircnet ] [-host - ] [-cmdspeed ] [-cmdmax ] - [-port ]
[ []] - -auto: Automatically connect to server at startup (default) -noauto: Don't connect to server at startup -ircnet: Specify what IRC network this server belongs to diff --git a/docs/help/in/unload.in b/docs/help/in/unload.in new file mode 100644 index 00000000..4bfdeb95 --- /dev/null +++ b/docs/help/in/unload.in @@ -0,0 +1,8 @@ + +@SYNTAX:unload@ + +Unload a running plugin. List of running plugins can be shown with +/LOAD. + +See also: LOAD + diff --git a/docs/help/in/wait.in b/docs/help/in/wait.in new file mode 100644 index 00000000..4f5dc2f8 --- /dev/null +++ b/docs/help/in/wait.in @@ -0,0 +1,10 @@ + +@SYNTAX:wait@ + +Wait for before sending the next command to server. + +This could be useful for example when identifying to NickServ; after +sending the identify message you'd wait 3 seconds before joining to +channels so NickServ has time to identify you to ChanServ which then +auto-ops you when joining. +