1
0
mirror of https://github.com/irssi/irssi.git synced 2025-02-02 15:08:01 -05:00

Help files by lite

git-svn-id: http://svn.irssi.org/repos/irssi/trunk@536 dbcabf3a-b0e7-0310-adc4-f8d773084564
This commit is contained in:
Timo Sirainen 2000-07-26 17:52:19 +00:00 committed by cras
parent 1fe6d11d7e
commit d9f9b64c76
111 changed files with 1304 additions and 27 deletions

View File

@ -6,13 +6,11 @@ test -z "$srcdir" && srcdir=.
PKG_NAME="Irssi" PKG_NAME="Irssi"
(test -f $srcdir/configure.in \ if test ! -f $srcdir/configure.in; then
## put other tests here echo -n "**Error**: Directory \`$srcdir\' does not look like the"
) || {
echo -n "**Error**: Directory "\`$srcdir\'" does not look like the"
echo " top-level $PKG_NAME directory" echo " top-level $PKG_NAME directory"
exit 1 exit 1
} fi
# get versions # get versions
version_date=`date +%Y%m%d` version_date=`date +%Y%m%d`
@ -21,6 +19,29 @@ echo "/* automatically created by autogen.sh */" > irssi-version.h.in
echo "#define IRSSI_VERSION \"@VERSION@\"" >> irssi-version.h.in echo "#define IRSSI_VERSION \"@VERSION@\"" >> irssi-version.h.in
echo "#define IRSSI_VERSION_DATE \"$version_date\"" >> irssi-version.h.in echo "#define IRSSI_VERSION_DATE \"$version_date\"" >> irssi-version.h.in
# generate colorless.theme
echo "formats = {" > colorless.theme
files=`find src -name 'module-formats.c'`
for i in $files; do
file=`echo "$i"|sed 's@^src/@@'`
file=`echo "$file"|sed 's@/module-formats\.c$@@'`
echo " \"$file\" = {" >> colorless.theme
cat $i | perl -e 'while (<>) { if (/^\W*{\W*"([^"]*)",\W*"([^"]*)".*/) { $key = $1; $value = $2; $value =~ s/\$([0-9])(\%.-)/\$\{\1\}\2/g; $value =~ s/%[krgybmpcwKRGYBMPCW01234567]//g; print(" $key = \"$value\";\n"); } }' >> colorless.theme
echo " };" >> colorless.theme
done
echo "};" >> colorless.theme
# create help files
perl syntax.pl
files=`echo docs/help/in/*.in|sed -e 's/docs\/help\/in\///g' -e 's/Makefile.in //'`
cat docs/help/in/Makefile.am.gen|sed "s/@HELPFILES@/$files/g" > docs/help/in/Makefile.am
files=`echo $files|sed 's/\.in//g'`
cat docs/help/Makefile.am.gen|sed "s/@HELPFILES@/$files/g" > docs/help/Makefile.am
# *********** a bit modified GNOME's macros/autogen.sh ********** # *********** a bit modified GNOME's macros/autogen.sh **********
DIE=0 DIE=0
@ -133,17 +154,3 @@ if test x$NOCONFIGURE = x; then
else else
echo Skipping configure process. echo Skipping configure process.
fi fi
# generate colorless.theme
echo "formats = {" > colorless.theme
files=`find src -name 'module-formats.c'`
for i in $files; do
file=`echo "$i"|sed 's@^src/@@'`
file=`echo "$file"|sed 's@/module-formats\.c$@@'`
echo " \"$file\" = {" >> colorless.theme
cat $i | perl -e 'while (<>) { if (/^\W*{\W*"([^"]*)",\W*"([^"]*)".*/) { $key = $1; $value = $2; $value =~ s/\$([0-9])(\%.-)/\$\{\1\}\2/g; $value =~ s/%[krgybmpcwKRGYBMPCW01234567]//g; print(" $key = \"$value\";\n"); } }' >> colorless.theme
echo " };" >> colorless.theme
done
echo "};" >> colorless.theme

View File

@ -1,7 +1,7 @@
AC_INIT(src) AC_INIT(src)
AM_CONFIG_HEADER(config.h) AM_CONFIG_HEADER(config.h)
AM_INIT_AUTOMAKE(irssi, 0.7.93) AM_INIT_AUTOMAKE(irssi, 0.7.94)
AM_MAINTAINER_MODE AM_MAINTAINER_MODE
@ -198,7 +198,9 @@ dnl ** curses checks
dnl ** dnl **
if test "x$want_textui" = "xyes"; then if test "x$want_textui" = "xyes"; then
saved_LIBS="$LIBS"
AC_CHECK_CURSES AC_CHECK_CURSES
LIBS="$saved_LIBS"
if test "x$has_ncurses" != "x"; then if test "x$has_ncurses" != "x"; then
AC_CHECK_LIB(ncurses, use_default_colors, [ AC_CHECK_LIB(ncurses, use_default_colors, [
@ -377,8 +379,6 @@ src/irc/bot/Makefile
src/irc/dcc/Makefile src/irc/dcc/Makefile
src/irc/notifylist/Makefile src/irc/notifylist/Makefile
src/irc/flood/Makefile src/irc/flood/Makefile
src/silc/Makefile
src/silc/core/Makefile
src/fe-common/Makefile src/fe-common/Makefile
src/fe-common/core/Makefile src/fe-common/core/Makefile
src/fe-common/irc/Makefile src/fe-common/irc/Makefile
@ -395,6 +395,7 @@ servertest/Makefile
scripts/Makefile scripts/Makefile
docs/Makefile docs/Makefile
docs/help/Makefile docs/help/Makefile
docs/help/in/Makefile
stamp.h stamp.h
irssi.spec irssi.spec
irssi-version.h irssi-version.h

View File

@ -1,6 +1,8 @@
helpdir = $(datadir)/irssi/help helpdir = $(datadir)/irssi/help
help_DATA = \ help_DATA = \
help @HELPFILES@
EXTRA_DIST = $(help_DATA) EXTRA_DIST = $(help_DATA)
SUBDIRS = in

View File

@ -1,4 +1,13 @@
Sample help file. Here work the standard text formats,
like %_bolds%_ and %Rcolors%n. So, only thing we need now HELP [<command>]
is the actual helps, anyone care to write them? :) Epic has
pretty good, maybe we could use them...? Shows help on commands. Try:
/HELP command
Also try, for example:
/SET beep
or
/SET auto
See also:

View File

@ -0,0 +1,2 @@
EXTRA_DIST = \
@HELPFILES@

9
docs/help/in/action.in Normal file
View File

@ -0,0 +1,9 @@
@SYNTAX:action@
Same as ME, but gets channel or nick as an additional parameter.
Example: /action #irssi yawns
(This outputs the following to #irssi: * Nick yawns)
See also: ME

8
docs/help/in/admin.in Normal file
View File

@ -0,0 +1,8 @@
@SYNTAX:admin@
Displays the administrative details about the given server. If
no server is specified, the server you are connected to is
used. If a nickname is supplied then it gives the administrative
information for that person's current server.

16
docs/help/in/alias.in Normal file
View File

@ -0,0 +1,16 @@
@SYNTAX:alias@
Creates a new alias or shows matching defined aliases.
Without parameters shows all defined aliases.
Examples:
/ALIAS w
- shows all defined aliases starting with letter w.
/ALIAS -send
- removes alias 'send'.
See also: UNALIAS

28
docs/help/in/away.in Normal file
View File

@ -0,0 +1,28 @@
@SYNTAX:away@
-one
-all
This command marks you as being "away". It is used to tell people that
you currently aren't paying attention to your screen. You might use it
if you are taking a nap, in the shower, getting some food, or otherwise
just aren't there at the moment. When you're "away" you will see "(zZzZ)"
in your statusbar.
Anyone who does a WHOIS on your nickname will see that you are away,
as well as your away message. Anyone doing a WHO that returns information
about you will also see that you're gone.
By default, if someone sends you a MSG while you are away, your client
will beep. You can turn this off by setting BEEP_WHEN_AWAY to OFF.
If you send a MSG to someone who is away, you will automatically be
notified of this. By default, you will only receive this notification
once. If you wish to see it every time (to tell when a person is no
longer marked away, for instance), change SHOW_AWAY_ONCE to OFF.
You can remove your away status by using AWAY with no arguments.
See also: SET AWAY

7
docs/help/in/ban.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:ban@
Bans the specified nick or userhost mask.
See also: BANTYPE, KNOCKOUT

16
docs/help/in/bantype.in Normal file
View File

@ -0,0 +1,16 @@
@SYNTAX:bantype@
This command shows or views the current ban type.
The ban type is used by BAN and KNOCKOUT commands.
Normal - *!user@*.domain.net
Host - *!*@host.domain.net
Domain - *!*@*.domain.net
Custom [nick] [user] [host] [domain]
eg. /bantype custom nick domain - nick!*@*.domain.net
eg. /bantype custom user host - *!user@host.domain.net
See also: BAN, KNOCKOUT

6
docs/help/in/beep.in Normal file
View File

@ -0,0 +1,6 @@
@SYNTAX:beep@
Outputs the bell-character, usually causing
your terminal beep.

8
docs/help/in/cat.in Normal file
View File

@ -0,0 +1,8 @@
@SYNTAX:cat@
Outputs the contents of the specified file. Equivalent to
UNIX 'cat' command.
See also: CD

8
docs/help/in/cd.in Normal file
View File

@ -0,0 +1,8 @@
@SYNTAX:cd@
Changes the current working directory. Equivalent to UNIX
'cd' command.
See also: DCC GET

35
docs/help/in/channel.in Normal file
View File

@ -0,0 +1,35 @@
@SYNTAX:channel@
Irssi can automatically join to specified channels in specified
IRC networks. It can also automatically send the password when
manually joining to channel without specifying the password.
/CHANNEL ADD [-auto | -noauto] [-bots <masks>] [-botcmd <command>]
<channel> <ircnet> [<password>]
With -bots and -botcmd arguments you can automatically send
commands to someone in channel. This is useful for automatically
getting ops for channels, for example
/CHANNEL ADD -auto -bots "*!bot@bothost.org bot*!*@host2.org"
-botcmd "msg $0 op mypass" #channel ircnet
You can also use the -botcmd without -bots argument. The command is
then sent whenever you join the channel.
If you want to remove some settings from existing channel record,
for example bots, just give the -bots "" parameters to it. Password
can be removed by setting it to - (or actually, "" works too).
You can remove the channels with
/CHANNEL REMOVE <channel> <ircnet>
/CHANNEL LIST displays list of channels with settings.
/CHANNEL without any arguments displays list of channels you have
joined. You can also use /CHANNEL to join to channels just as with
/JOIN, like /CHANNEL #a.
See also: TS, JOIN

9
docs/help/in/clear.in Normal file
View File

@ -0,0 +1,9 @@
@SYNTAX:clear@
This command clears the current window of all text. It is useful
for wiping a screen that has rendered improperly (such as due
to a bad termcap entry) or that contains sensitive information
(such as one's OPER password).

11
docs/help/in/connect.in Normal file
View File

@ -0,0 +1,11 @@
@SYNTAX:connect@
-ircnet the IRCNet
-host the host
This command makes irssi to connect to specified server.
Current connections are kept and another one is created.
See also: SERVER

7
docs/help/in/ctcp.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:ctcp@
Sends a CTCP-message. For example CTCP ACTION, or CTCP VERSION.
See also: ME, ACTION

7
docs/help/in/cycle.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:cycle@
Cycles (leaves and joins) the current channel or the specified channel.
See also: JOIN, LEAVE, PART

11
docs/help/in/date.in Normal file
View File

@ -0,0 +1,11 @@
@SYNTAX:time@
This displays the time of day, local to the server queried (thus,
the time returned may not be the same as the client's local time).
If the server name is omitted, the client's current server is used.
If a nickname is given, that client's server is queried.
Same as /TIME.

21
docs/help/in/dcc.in Normal file
View File

@ -0,0 +1,21 @@
@SYNTAX:dcc@
This is a command to handle different DCC-connections. DCC is mainly
used for more reliable and faster chatting and for sending and receiving
files.
/DCC CHAT nick
- Sends a chat connection request to remote client or accepts
a chat connection, if the remote end has already sent a request.
/DCC GET nick
- Gets the file offered by remote client. The file is downloaded and
saved into the current working directory.
/DCC SEND nick file
- Sends a DCC SEND request to remote client. Remote end has to accept
the request before the transmission can be started.
/DCC CLOSE type nick
- Closes a DCC-connection. Type can be either SEND, GET or CHAT.
See also: CD

View File

@ -0,0 +1,9 @@
@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

10
docs/help/in/deop.in Normal file
View File

@ -0,0 +1,10 @@
@SYNTAX:deop@
Takes off the channel operator privileges from the
specified nick(s).
Wildcards in the nick are allowed.
See also: OP

10
docs/help/in/devoice.in Normal file
View File

@ -0,0 +1,10 @@
@SYNTAX:devoice@
Takes off the voice from the specified nick(s). This makes them
not to be able to send messages to the moderated (+m) channel.
Wildcards in the nick are allowed.
See also: VOICE, MODE

7
docs/help/in/die.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:die@
IRC-operator command. Makes IRC-server to die.
See also: OPER

View File

@ -0,0 +1,7 @@
@SYNTAX:disconnect@
Disconnects from the specified IRC-server.
See also: CONNECT, SERVER

5
docs/help/in/echo.in Normal file
View File

@ -0,0 +1,5 @@
@SYNTAX:echo@
Prints text into the current window. Useful for scripts.

6
docs/help/in/eval.in Normal file
View File

@ -0,0 +1,6 @@
@SYNTAX:eval@
Evaluates the given commands and executes them. Internal variables
are expanded. See the special_vars.txt file in the docs-directory.

9
docs/help/in/format.in Normal file
View File

@ -0,0 +1,9 @@
@SYNTAX:format@
-reset
-delete
Allows you to view/change irssi's messages.
Use this command with care.

5
docs/help/in/hash.in Normal file
View File

@ -0,0 +1,5 @@
@SYNTAX:hash@
Not available.

13
docs/help/in/help.in Normal file
View File

@ -0,0 +1,13 @@
@SYNTAX:help@
Shows help on commands. Try:
/HELP command
Also try, for example:
/SET beep
or
/SET auto
See also:

16
docs/help/in/hilight.in Normal file
View File

@ -0,0 +1,16 @@
@SYNTAX:hilight@
-mask: Match only for nick, <text> is a nick mask
-regexp: <text> is a regular expression
-word: <text> must match to full words
-nick: Hilight only the nick, not the whole line
-color: Print the message with <color>
-level: Match only for <level> messages, default is
publics,msgs,notices,actions
-channels: Match only in <channels>
For regular expressions, see `man 7 regex`.
See also: DEHILIGHT, SET HILIGHT

26
docs/help/in/ignore.in Normal file
View File

@ -0,0 +1,26 @@
@SYNTAX:ignore@
-regexp: <pattern> is a regular expression
-word: <pattern> must match to full words
-pattern: <pattern> must match to the message's text
-replies: Ignore replies to nick in channels. For example
"/IGNORE -replies *!*@*.fi PUBLIC" ignores everyone
from Finland, but also anyone sending message
"tofinnishnick: blahblah".
-except: *DON'T* ignore
-channels: Ignore only in channels
<mask>: Either a nick mask or list of channels
<levels>: List of levels to ignore
<^levels>: List of levels to NOT ignore
(/ignore -except nick notices = /ignore nick ^notices)
/IGNORE without any arguments displays list of ignores.
The best match always wins, so you can have:
/IGNORE * CTCPS
/IGNORE -except *!*@host.org CTCPS
See also: UNIGNORE

6
docs/help/in/info.in Normal file
View File

@ -0,0 +1,6 @@
@SYNTAX:info@
Shows information about the IRC creators, debuggers, slaves and
a lot of other people who no longer have much to do with irc.

7
docs/help/in/invite.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:invite@
Invites the specified nick to the current channel.
See also:

View File

@ -0,0 +1,9 @@
@SYNTAX:invitelist@
Shows the +I modes of the current channel. +I mode
allows free joins of clients with certain userhost mask
even if the channel is invite only.
See also: INVITE, MODE

21
docs/help/in/ircnet.in Normal file
View File

@ -0,0 +1,21 @@
@SYNTAX:ircnet@
-kicks: Maximum number of nicks in one /KICK command
-msgs: Maximum number of nicks in one /MSG command
-modes: Maximum number of mode changes in one /MODE command
-whois: Maximum number of nicks in one /WHOIS command
-cmdspeed: Same as /SET cmd_queue_speed, see section 3.1
-cmdmax: Same as /SET cmd_max_at_once, see section 3.1
-nick, -user, -realname: Specify what nick/user/name to use
-host: Specify what host name to use, if you have multiple
-autosendcmd: Command to send after connecting to a server
With -autosendcmd argument you can automatically run any commands
after connecting to ircnet. This is useful for automatically
identifying yourself to NickServ, for example
Shows and changes the settings of defined IRC networks.
See also: CONNECT

7
docs/help/in/ison.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:ison@
Tells whether specified nicks are online.
See also:

13
docs/help/in/join.in Normal file
View File

@ -0,0 +1,13 @@
@SYNTAX:join@
Joins a specified channel. Channel names usually begin with #-sign,
which may be omitted here.
JOIN is aliased to J by default. Example: /j irssi
(This joins to the channel #irssi)
Description
See also: LEAVE, WINDOW CLOSE

16
docs/help/in/kick.in Normal file
View File

@ -0,0 +1,16 @@
@SYNTAX:kick@
This command "kicks" the specified user off of the specified
channel. It is typically used to remove troublemakers, flooders,
or people otherwise making a nuisanse of themselves on the channel.
The reason for the kick is recommended, but not required by the IRC
servers
If the <channel> is omitted, removes the nick from the current
channel.
The default alias for /KICK is /K.
See also: KNOCKOUT

10
docs/help/in/kickban.in Normal file
View File

@ -0,0 +1,10 @@
@SYNTAX:kickban@
Kicks off and bans a nick from the current channel.
A reason for the kick can be supplied.
Default alias for /KICKBAN is /KB.
See also: KNOCKOUT, BANTYPE

18
docs/help/in/kill.in Normal file
View File

@ -0,0 +1,18 @@
@SYNTAX:kill@
IRC operator command.
KILL is used to forcibly remote a client from the irc network.
It works similarly to KICK, except that a reason must be
given (even if it is meaningless or flat-out wrong).
In general, KILL is useful only as a warning tool for abusive
users. Modern irc clients (this one included) have automated
means for reconnecting to a server after a disconnection (whether
due to a KILL or something else), so KILL is by no means a
permanent solution. It is not intended as a means for personal
vendettas; this practice is generally frowned upon.
See also: OPER

11
docs/help/in/knockout.in Normal file
View File

@ -0,0 +1,11 @@
@SYNTAX:knockout@
Kicks user off the channel and bans him/her. Ban
lasts the given number of seconds or 5 minutes
by default.
Default alias for /KNOCKOUT is /KN.
See also: BANTYPE, BAN, KICK

12
docs/help/in/lastlog.in Normal file
View File

@ -0,0 +1,12 @@
@SYNTAX:lastlog@
-word Shows only the lines matching the 'word'
-new
-away
Shows the given number of lines of log from the
current window.
See also:

9
docs/help/in/links.in Normal file
View File

@ -0,0 +1,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.
See also:

9
docs/help/in/list.in Normal file
View File

@ -0,0 +1,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 "Excessive flood".
See also:

42
docs/help/in/log.in Normal file
View File

@ -0,0 +1,42 @@
@SYNTAX:log@
-noopen: Create the entry to log list, but don't start logging
-autoopen: Automatically open this log file at startup
-targets: Log only in specified channels/nicks
-window: Log the active window
-rotate: Reopen the log file every hour, day, week or month.
This makes only sense if you specify date/time formats
to file name.
<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 0644.
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 -rotate day -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

7
docs/help/in/lusers.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:lusers@
Shows user statistics of the current IRC network.
See also:

5
docs/help/in/map.in Normal file
View File

@ -0,0 +1,5 @@
@SYNTAX:map@
Not available in IRC.

8
docs/help/in/me.in Normal file
View File

@ -0,0 +1,8 @@
@SYNTAX:me@
Sends a CTCP ACTION to the current channel or query.
For example: /me sits back.
See also: ACTION, CTCP

11
docs/help/in/mircdcc.in Normal file
View File

@ -0,0 +1,11 @@
@SYNTAX:mircdcc@
Selects whether to send mIRC style CTCPs in DCC chat
session.
If a mIRC user sends first a CTCP, mIRC style CTCPs is
automatically selected for that DCC Chat session.
See also: SET MIRC

24
docs/help/in/mode.in Normal file
View File

@ -0,0 +1,24 @@
@SYNTAX:mode@
Changes and/or views modes. You can either change
your own modes or channel modes (given that you're
a channel operator).
Examples:
/MODE * +s
- Makes the current channel secret
/MODE #irssi -o Beel0
- Deops user Beel0 on channel #irssi
/MODE * +b *!*@*.org
- Bans on the current channel all users coming
from .org hosts.
/MODE yournick +w
- Makes you to see the wallops.
See also: BAN, VOICE, OP, DEOP

7
docs/help/in/motd.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:motd@
Shows the motd of the current server. This contains
usually some useful info on the server, administrator and
the rules.

15
docs/help/in/msg.in Normal file
View File

@ -0,0 +1,15 @@
@SYNTAX:msg@
Sends a message to a nick or a channel. Usually this
is used for sending private messages to other persons.
Examples:
/MSG friend Hi, what's up?
/MSG #irssi Hello, is the new gtk-version out already?
(This format is rarely needed.)
See also: CTCP, /

13
docs/help/in/names.in Normal file
View File

@ -0,0 +1,13 @@
@SYNTAX:names@
Shows the names (nicks) on the specified channel.
Examples:
/NAMES * - shows nicks on the current channel.
/NAMES #42 - shows nicks on the channel #42.
See also: WHO, CHANNEL

7
docs/help/in/nctcp.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:nctcp@
Sends a CTCP reply notice to the nick/channel.
See also: CTCP, ACTION, MSG, NOTICE

6
docs/help/in/netsplit.in Normal file
View File

@ -0,0 +1,6 @@
@SYNTAX:netsplit@
Irssi keeps track of people who were lost in net splits. With this
command you can get a list of them.

6
docs/help/in/nick.in Normal file
View File

@ -0,0 +1,6 @@
@SYNTAX:nick@
Changes your nick. This should be hardly rarely
used or needed.

28
docs/help/in/note.in Normal file
View File

@ -0,0 +1,28 @@
@SYNTAX:note@
NOTE is a sort of turbo-charged messaging system for irc. In short,
it achieves at the server level what the client attempts to do with MSG
and NOTIFY. The messaging system resembles modern voicemail systems
(except in text); messages can be sent, stored, or set for deferred
delivery. The client notification system works like NOTIFY, except with
greater accuracy and flexibility.
The most common uses of NOTE are its SPY and SEND functions. SPY is similar
to NOTIFY, except it can accept a full address to spy on, not just a nickname.
SEND, as its name implies, sends a note to a user; if that user is not currently
online, it will be delivered if the user logs onto irc within a set time period.
When referring to a particular user, NOTE can deal with the standard
nick!user@host notation. Wildcards are allowed, and any portion may be omitted,
so long as the identifier remains unambiguous.
Examples:
To send a note to Joebob (whose account is jbriggs@drivein.com):
/NOTE SEND joebob!jbriggs@drivein.com Hey there! Great movie!
To spy on anyone from blah.com for the next 30 days:
/NOTE SPY +30 *!*@*.blah.com A blah.com user is active
This command is Not available in the IRCNet.

10
docs/help/in/notice.in Normal file
View File

@ -0,0 +1,10 @@
@SYNTAX:notice@
Sends a notice to the nick or the channel. Usually notices are
used in bots and scripts for different kinds of replies. The
IRC protocol states that notices may not generate replies to
avoid msg loops.
See also: NCTCP, MSG

15
docs/help/in/notify.in Normal file
View File

@ -0,0 +1,15 @@
@SYNTAX:notify@
-away: Notifies about away-status changes
-idle: Notifies if idle time is first larger than <minutes>
(default is hour) and then it drops down.
-list: Lists the notify list entries with all their settings
<mask>: Either a simple "nick" or "nick!*@*blah.org".
The nick can't contain wildcards, but the user/host can.
/NOTIFY without any arguments displays if the people in notify
list are online or offline.
See also: UNNOTIFY, SET NOTIFY

8
docs/help/in/op.in Normal file
View File

@ -0,0 +1,8 @@
@SYNTAX:op@
Gives the channel operator privileges for the specified
nick(s). Wildcards in the nick are allowed.
See also: DEOP, MODE, VOICE, DEVOICE, KICK

10
docs/help/in/oper.in Normal file
View File

@ -0,0 +1,10 @@
@SYNTAX:oper@
Gives you operator priviledges if the correct nickname and
password are given. If password is not given, you will be
prompted for one. If no nickname is given, your current
nickname will be used.
See also: KILL, DIE

8
docs/help/in/part.in Normal file
View File

@ -0,0 +1,8 @@
@SYNTAX:part@
Parts from the current or specified channel. Depending
on your settings, closes the corresponding window, too.
See also: LEAVE, JOIN

View File

@ -0,0 +1,7 @@
@SYNTAX:perlflush@
Stops and removes all Perl-scripts which have been run.
See also: RUN

10
docs/help/in/ping.in Normal file
View File

@ -0,0 +1,10 @@
@SYNTAX:ping@
Sends CTCP PING to another IRC client. This is used
to find out the speed of IRC network. When the PONG
reply comes in, irssi shows the interval time between
sending the request and receiving the reply.
See also: CTCP

11
docs/help/in/query.in Normal file
View File

@ -0,0 +1,11 @@
@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.
Usually this command opens up a new window, too.
See also: WINDOW, MSG, SET QUERY

10
docs/help/in/quit.in Normal file
View File

@ -0,0 +1,10 @@
@SYNTAX:quit@
This ends your irc 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.
/EXIT does the same.

5
docs/help/in/quote.in Normal file
View File

@ -0,0 +1,5 @@
@SYNTAX:quote@
Sends server raw data without parsing.

15
docs/help/in/rawlog.in Normal file
View File

@ -0,0 +1,15 @@
@SYNTAX:rawlog@
All data that is received or sent to server is kept in a raw log
buffer for a while. Also event redirections are kept there. This is
very useful for debugging purposes.
/RAWLOG SAVE <filename> - Save the current raw log buffer to file
/RAWLOG OPEN <filename> - Like /RAWLOG SAVE, but keep the log file
open and write all new log to it.
/RAWLOG CLOSE - Close the open raw log
/SET rawlog_lines <count> - Specify the number of raw log lines to
keep in memory.

10
docs/help/in/reconnect.in Normal file
View File

@ -0,0 +1,10 @@
@SYNTAX:reconnect@
You can reconnect to server with /RECONNECT <n>.
/RECONNECT without any arguments will disconnect from the
active server and reconnect back immediately.
See also: SERVER, DISCONNECT

7
docs/help/in/reload.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:reload@
Reloads the irssi's configuration file.
See also: SAVE

12
docs/help/in/restart.in Normal file
View File

@ -0,0 +1,12 @@
@SYNTAX:restart@
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.
See also: OPER, DIE

View File

@ -0,0 +1,7 @@
@SYNTAX:rmreconns@
Removes the pending reconnections from the reconnect list.
See also: CONNECT, RECONNECT, SERVER

12
docs/help/in/rping.in Normal file
View File

@ -0,0 +1,12 @@
@SYNTAX:rping@
IRC Operator command.
This command works like the PING command (CTCP PING), except
it is used on a server instead of a client. As with PING, it
is used to test the relative distance another server is from
you across the irc network.
See also: OPER

7
docs/help/in/run.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:run@
Runs a perl-script. For more information, see the
perl.txt in the docs-directory of irssi.
See also: PERLFLUSH

8
docs/help/in/save.in Normal file
View File

@ -0,0 +1,8 @@
@SYNTAX:save@
Saves the current Irssi configuration into the configuration
file.
See also: RELOAD

8
docs/help/in/sconnect.in Normal file
View File

@ -0,0 +1,8 @@
@SYNTAX:sconnect@
IRC Operator command. Makes an IRC server to connect
to another server.
See also: OPER, SQUIT, RESTART

View File

@ -0,0 +1,12 @@
@SYNTAX:scrollback@
/SCROLLBACK, or the default alias /SB:
/SB CLEAR - Clear screen, free all memory used by texts in window.
/SB HOME - Jump to start of the buffer
/SB END - Jump to end of the buffer
/SB GOTO [[-|+]line#|time] - Jump to specified line or timestamp.
See also: SET SCROLL

33
docs/help/in/server.in Normal file
View File

@ -0,0 +1,33 @@
@SYNTAX:server@
/SERVER ADD [-auto | -noauto] [-ircnet <ircnet>] [-host
<hostname>] [-cmdspeed <ms>] [-cmdmax <count>]
[-port <port>] <address> [<port> [<password>]]
-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
-host: Specify what host name to use, if you have multiple
-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.
/SERVER disconnects the server in active window and connects
to the new one. It will take the same arguments as /CONNECT.
If you prefix the address with the + character, Irssi won't
disconnect the active server, and it will create a new window
where the server is connected (ie. /window new hide;
/connect address)
/SERVER without any arguments displays the list of connected
servers.
/SERVER REMOVE <address> [<port>]
/SERVER LIST
See also: RMRECONNS, DISCONNECT, RECONNECT

19
docs/help/in/servlist.in Normal file
View File

@ -0,0 +1,19 @@
@SYNTAX:servlist@
SERVLIST gives the list of services currently present on the
IRC network. It can take two arguments.
<mask> limits the output to the services which names matches
the mask.
<type> limits the output to the services of the specified type.
The fields returned are:
Service name.
Server who introduced the service.
Distribution mask.
Service type.
Hop count to the service.
A comment.
See also: SQUERY

18
docs/help/in/set.in Normal file
View File

@ -0,0 +1,18 @@
@SYNTAX:set@
You can view or change the settings with /SET command.
/SET without any arguments displays all the settings.
/SET <key> displays settings whose key (partly) matches <key>
/SET <key> <value> sets <key> to <value>
Boolean settings accept only values ON, OFF and TOGGLE. You can
also use /TOGGLE command to change them, so /TOGGLE <key> behaves
like /SET <key> TOGGLE. /TOGGLE also accepts arguments ON and OFF
when /TOGGLE behaves exactly like /SET.
Remember that changes are not saved until you use /SAVE!
See also: TOGGLE

22
docs/help/in/silence.in Normal file
View File

@ -0,0 +1,22 @@
@SYNTAX:silence@
Works only in the Undernet.
SILENCE is similar in many respects to IGNORE, except that it is
server-based. What this means is the server will never even send
you messages from anyone you have SILENCEd, whereas it will with
IGNORE, where your client is responsible for filtering the messages
out. This has the advantage of not bogging your client down with
excessive data as it tries to filter out messages.
The default behavior is to SILENCE a nick!user@host pattern, and
if such a pattern is not passed as the argument, it must be prepended
with a plus ('+') to be added to your silence list. If a pattern is
prepended with a minus ('-'), it will be removed from your silence list.
If you only specify a nickname, you can list the patterns in the
silence list owned by that nickname. If no arguments are given, your
own silence list is displayed.
See also: IGNORE

5
docs/help/in/squery.in Normal file
View File

@ -0,0 +1,5 @@
@SYNTAX:squery@
/SQUERY sends a query to specified service.

7
docs/help/in/squit.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:squit@
IRC Operator command. Makes server to quit IRC network.
See also: OPER, DIE, RESTART

20
docs/help/in/stats.in Normal file
View File

@ -0,0 +1,20 @@
@SYNTAX:stats@
Shows some irc server usage statistics.
c - Shows C and N lines for a given server. These are
the names of the servers that are allowed to connect.
h - Shows H and L lines for a given server (Hubs and Leaves).
k - Show K lines for a server. This shows who is not
allowed to connect and possibly at what time they are
not allowed to connect.
i - Shows I lines. This is who CAN connect to a server.
l - Shows information about amount of information passed
to servers and users.
m - Shows a count for the number of times the various
commands have been used since the server was booted.
o - Shows the list of authorized operators on the server.
u - Shows the uptime for a server
y - Shows Y lines, which lists the various connection
classes for a given server.

11
docs/help/in/time.in Normal file
View File

@ -0,0 +1,11 @@
@SYNTAX:time@
This displays the time of day, local to the server queried (thus,
the time returned may not be the same as the client's local time).
If the server name is omitted, the client's current server is used.
If a nickname is given, that client's server is queried.
Same as /DATE.

11
docs/help/in/toggle.in Normal file
View File

@ -0,0 +1,11 @@
@SYNTAX:toggle@
/TOGGLE <key> behaves like /SET <key> TOGGLE. /TOGGLE also
accepts arguments ON and OFF when /TOGGLE behaves exactly
like /SET.
Remember that changes are not saved until you use /SAVE!
See also: SET

6
docs/help/in/topic.in Normal file
View File

@ -0,0 +1,6 @@
@SYNTAX:topic@
Shows or/and changes the topic of the current or specified
channel.

8
docs/help/in/trace.in Normal file
View File

@ -0,0 +1,8 @@
@SYNTAX:trace@
Without a specified server it shows the current connections on
the local server. If you specify a remote server it will show
all servers between your current server and that remote server
as well as the connections on that remote server.

7
docs/help/in/ts.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:ts@
Shows topics of all channels you're on.
See also: CHANNEL, TOPIC

7
docs/help/in/unalias.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:unalias@
Removes an alias.
See also: ALIAS

7
docs/help/in/unban.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:unban@
Removes the specified ban(s) from the channel.
See also: BAN, KNOCKOUT

7
docs/help/in/unignore.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:unignore@
Unignores the specified userhost mask.
See also: IGNORE

7
docs/help/in/unnotify.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:unnotify@
Removes an entry from the notify list.
See also: NOTIFY

7
docs/help/in/unquery.in Normal file
View File

@ -0,0 +1,7 @@
@SYNTAX:unquery@
Removes a query window of specified nick.
See also: QUERY, SET QUERY

12
docs/help/in/uping.in Normal file
View File

@ -0,0 +1,12 @@
@SYNTAX:uping@
IRC Operator command. Works only in the Undernet (ircu).
This command works like the PING command (CTCP PING), except
it is used on a server instead of a client. As with PING, it
is used to test the relative distance another server is from
you across the irc network.
See also: RPING, OPER

5
docs/help/in/userhost.in Normal file
View File

@ -0,0 +1,5 @@
@SYNTAX:userhost@
Shows the userhost info of the specified nick.

9
docs/help/in/ver.in Normal file
View File

@ -0,0 +1,9 @@
@SYNTAX:ver@
Sends a CTCP VERSION request to the nick. This is used
to find out which client and/or script the nick
is using.
See also: CTCP

8
docs/help/in/version.in Normal file
View File

@ -0,0 +1,8 @@
@SYNTAX:version@
Shows the version info of the current or specified
IRC server.
See also: ADMIN, STATS

Some files were not shown because too many files have changed in this diff Show More