1
0
mirror of https://github.com/irssi/irssi.git synced 2024-12-04 14:46:39 -05:00

Applied grammar and styling corrections

Applied grammar and styling corrections.
This commit is contained in:
Geert Hauwaerts 2014-08-07 22:00:40 +02:00
parent f0aa2d2049
commit 71ab0fbda6
56 changed files with 112 additions and 129 deletions

View File

@ -6,15 +6,15 @@
%9Parameters:%9
A name of the alias and the command to execute. You can prepend the alias
with the "-" character to remove the alias; if no argument is given, your
with the '-' character to remove the alias; if no argument is given, your
aliases will be displayed.
%9Description:%9
Creates or updates an alias; you can use the ";" character to separate
Creates or updates an alias; you can use the ';' character to separate
multiple commands.
The parametesr given to the alias are expanded in "$[\d]" For example $0,
The parameters given to the alias are expanded in '$[\d]'; for example $0,
$1, $2, $8, $12, ...
If you don't use any parameters in your alias, all parameters will be

View File

@ -12,11 +12,11 @@
%9Description:%9
Marks yourself as "away"; this method is used to inform people that you
Marks yourself as 'away'; this method is used to inform people that you
are not paying attention to your screen.
You might use it when you are taking a nap, in the shower, getting some
food, or otherwise engaged. When you're "away" you will see "(zZzZ)" in
food, or otherwise engaged. 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

View File

@ -24,7 +24,7 @@
%9Configuring the custom format:%9
You must set the custom ban_type to the format you would like to use. For
example, if you set the custom ban_type to "nick domain", it will generate
example, if you set the custom ban_type to 'nick domain', it will generate
a ban based on the nick!*@*.domain.tld format.
%9Examples:%9

View File

@ -19,7 +19,7 @@
If no parameters are given, the list of channels you have joined will be
displayed.
%9Description:%9
Adds, removes or displays the configuration of channels; this method is
@ -34,8 +34,8 @@
/CHANNEL LIST
/CHANNEL ADD -auto #irssi Freenode
/CHANNEL ADD -auto #basementcat Quakenet secret_lair
/CHANNEL ADD -auto -bots "*!@*.irssi.org *!bot@irssi.org" -botcmd "msg $0 op WzerTrzq" #hideout Freenode
/CHANNEL ADD -auto -bots "Q!TheQBot@CServe.quakenet.org" -botcmd "^MSG Q op #irssi" #irssi Quakenet
/CHANNEL ADD -auto -bots '*!@*.irssi.org *!bot@irssi.org' -botcmd 'msg $0 op WzerTrzq' #hideout Freenode
/CHANNEL ADD -auto -bots 'Q!TheQBot@CServe.quakenet.org' -botcmd '^MSG Q op #irssi' #irssi Quakenet
/CHANNEL REMOVE #hideout Freenode
%9Special Example:%9

View File

@ -8,7 +8,7 @@
-all: Clear all the windows
The window number to clear; if no argument is given, the active window
is used.
will be used.
%9Description:%9

View File

@ -5,9 +5,10 @@
%9Parameters:%9
-auto: Inserts the completion without pressing a word completion character.
-auto: Inserts the completion without pressing a word completion
character.
-delete: Removes the completion from the configuration.
A key and the value to use as a replacement. If no argument is given, the
list of completions will be displayed.
@ -19,7 +20,7 @@
When a replacement has been found, Irssi will choose the most probable
matching word and replaces it; you may press TAB repeatedly to swap between
matches.
If you want to remove a completion which has the auto parameter set, you
need to enclose the completion between "'" characters.

View File

@ -27,19 +27,19 @@
and file transfers.
If you are behind NAT, or if the firewall is too restrictive, you might
want to try if using the passive parameter resolved your conneciton
want to try if using the passive parameter resolved your connection
problem.
You can send files which contain special character or spaces by enclosing
the filename within quotes. For example: "my file with spaces.txt".
the filename within quotes. For example: 'my file with spaces.txt'.
%9Examples:%9
/DCC CHAT mike
/DCC GET bob "summer vacation.mkv"
/DCC GET bob 'summer vacation.mkv'
/DCC SEND sarah documents/resume.pdf
/DCC CLOSE mike
/DCC CLOSE bob "summer vacation.mkv"
/DCC CLOSE bob 'summer vacation.mkv'
%9See also:%9 CD

View File

@ -10,7 +10,7 @@
%9Description:%9
Removes the channel operator privileges from the given nicknames; you may
use the wildcard character "*" in a nickname.
use the wildcard character '*' in a nickname.
%9Examples:%9

View File

@ -10,7 +10,7 @@
%9Description:%9
Removes the channel voice privileges from the given nicknames; you may use
the wildcard character "*" in a nickname.
the wildcard character '*' in a nickname.
If a channel is moderated, the users will require a voice or op in order to
be able to send messages to the channel.

View File

@ -5,15 +5,15 @@
%9Parameters:%9
The network to disconnect from and the message to advertise; if no parameters
are given, the active server will be used.
The network to disconnect from and the message to advertise; if no
parameters are given, the active server will be used.
%9Description:%9
Disconnects from one or more IRC servers; the list of all the servers you
are connected to can be retrieved via the SERVER command.
Use the wildcard character "*" if you want to disconnect from all servers.
Use the wildcard character '*' if you want to disconnect from all servers.
%9Examples:%9

View File

@ -10,9 +10,9 @@
%9Description:%9
Evaluates the given commands and executes them; you can use internal
variables and separate multiple commands by using the ";" character.
variables and separate multiple commands by using the ';' character.
%9Examples%9
%9Examples:%9
/EVAL echo I am connected to ${S} on ${chatnet} as ${N}
/EVAL echo My user privileges are +${usermode}; echo Let's party!

View File

@ -9,7 +9,8 @@
-nosh: Doesn't execute the command through /bin/sh.
-out: Sends the output to the active channel or query.
-msg: Sends the output to the specified nickname or channel.
-notice: Sends the output to the specified nickname or channel as notices.
-notice: Sends the output to the specified nickname or channel as
notices.
-name: Gives the process the specified name.
-window: Displays the output in the active window.
-close: Forcibly closes a process that doesn't die.
@ -29,7 +30,7 @@
The output of the process can be redirected to various targets, such as
a window, a channel, a nickname or a query.
The process identifier must always begin with the "%%" character. For
The process identifier must always begin with the '%%' character. For
example %%0.
If you remove a process with the close parameter, it will only make Irssi

View File

@ -5,12 +5,13 @@
%9Description:%9
Forces an immediate flush of the buffers if the related settings are enabled.
Forces an immediate flush of the buffers if the related settings are
enabled.
%9Examples:%9
/FLUSHBUFFER
/SET write_buffer_size
/SET write_buffer_timeout

View File

@ -9,7 +9,8 @@
-full: Indicates that the pattern must match a full word.
-pattern: The text pattern to ignore.
-except: Negates the ignore.
-replies: Also ignore nicknames who are talking to anyone who matches the ignore.
-replies: Also ignore nicknames who are talking to anyone who matches
the ignore.
-network: Ignores only on a specific network.
-channels: Ignores only on specific channels.
-time: The timeout to automatically remove the ignore.
@ -21,8 +22,8 @@
Ignores nicknames or text that matches a pattern.
The special level "NO_ACT" can be used to ignore activity in the statusbar
without actually ignoring the message; this behaviour is somewhat special
The special level 'NO_ACT' can be used to ignore activity in the statusbar
without actually ignoring the message; this behavior is somewhat special
because it is allowed in addition to other ignores for the same target.
%9Examples:%9

View File

@ -1,20 +0,0 @@
%9Syntax:%9
INVITELIST
%9Description:%9
Displays the invitelist for the active channel; nicknames who match the
masks will be able to join the channel if its invite only.
This is not a command, but a default alias.
%9Examples:%9
/INVITELIST
%9References:%9
/ALIAS INVITELIST MODE $C +I

View File

@ -9,7 +9,7 @@
-invite Joins the channel you were last invited to.
-<server tag> The server tag on which you want to join the channel.
The channel names, separated by a commma, to join and the channel key.
The channel names, separated by a comma, to join and the channel key.
%9Description:%9

View File

@ -3,7 +3,7 @@
@SYNTAX:kick@
%9Parameters%9
%9Parameters:%9
The channel and the nicknames, separated by a comma, to kick from the
channel and the reason thereof; if no channel is given, the active channel

View File

@ -5,9 +5,9 @@
%9Parameters:%9
The channel and the nicknames, separated by a comma, to kickban from the
channel and the reason thereof; if no channel is given, the active channel
will be used.
The channel and the nicknames, separated by a comma, to kick and ban from
the channel and the reason thereof; if no channel is given, the active
channel will be used.
%9Description:%9

View File

@ -11,7 +11,7 @@
Sends an invitation request to the channel operators of the target channel;
this command may not work on all IRC servers.
The following conditions must be met:
* You are not banned from the channel.

View File

@ -5,7 +5,7 @@
%9Parameters:%9
-: Doesn't print the "Lastlog:" and "End of Lastlog" messages.
-: 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.
@ -30,8 +30,8 @@
%9Examples:%9
/LASTLOG holiday
/LASTLOG "is on vacation"
/LASTLOG -file -force ~/mike.log "mike"
/LASTLOG 'is on vacation'
/LASTLOG -file -force ~/mike.log 'mike'
%9See also:%9 HILIGHT, SCROLLBACK

View File

@ -8,7 +8,7 @@
SAVE: Saves your layout to the configuration.
RESET: Removes the saved layout from the configuration.
%9Descripton:%9
%9Description:%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.

View File

@ -36,5 +36,5 @@
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".
'MSGLEVEL_'; for example 'CRAP' becomes 'MSGLEVEL_CRAP'.

View File

@ -5,7 +5,7 @@
%9Parameters:%9
-yes: Comfirms that you want to receive a large amount of data.
-yes: Confirms 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.
@ -21,5 +21,5 @@
/LIST -yes
/LIST -yes *ubuntu*
See also: QUOTE, STATS, WHOIS
%9See also:%9 QUOTE, STATS, WHOIS

View File

@ -3,7 +3,7 @@
@SYNTAX:load@
%9Parameters%9
%9Parameters:%9
The name of the module and submodule to load.

View File

@ -5,8 +5,8 @@
%9Parameters:%9
OPEN: Opens a logfile.
CLOSE: Closes a logfile.
OPEN: Opens a log file.
CLOSE: Closes a log file.
START: Starts logging a log entry.
STOP: Stops logging a log entry.
@ -16,7 +16,7 @@
-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.
-targets: Logs the specified nicknames 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,
@ -24,10 +24,10 @@
%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.
Opens a log file and stores the messages of the given targets into it; the
log files 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
You may use any of the date formats to create a log rotation; we strongly
recommend you to enable autolog if you are interested in keeping logs.
%9Examples:%9

View File

@ -5,7 +5,7 @@
%9Description:%9
Displays the network map of an IRC network; this command is usally
Displays the network map of an IRC network; this command is usually
reserved for IRC operators and does not work on all servers.
%9Examples:%9

View File

@ -13,7 +13,7 @@
After establishing a DCC CHAT connection that you initiated, you might
encounter some protocol issues if the target is using mIRC.
If you or your target sees some unexpected output or behaviour inside a DCC
If you or your target sees some unexpected output or behavior inside a DCC
CHAT session, use this command to enable mIRC compatibility mode.
When receiving a connection from an mIRC user, the compatibility mode will
@ -24,5 +24,5 @@
/MIRCDCC ON
/MIRCDCC OFF
%9See also:%9 ACTION, DCC, CTCP
%9See also:%9 ACTION, CTCP, DCC

View File

@ -16,17 +16,17 @@
Modifies the user or channel modes for which you are privileged to modify.
You can specify multiple modes in one command and prepend them by using the
"+" sign to set or "-" sign to unset; modes that require a parameter will be
'+' sign to set or '-' sign to unset; modes that require a parameter will be
retrieved from the argument list.
Some common channel modes are:
b <mask>: Adds or removes a ban; a ban will prevent a user who
matches the given mask from joining the channel unless
he or she is invited or in the excempt list.
he or she is invited or in the exempt list.
e <mask>: Adds or removes a ban exception; users who match a mask
on the excempt list are able to join a channel even if
they also match an entry on the banlist.
on the exempt list are able to join a channel even if
they also match an entry on the ban list.
i: When enabled, users need to be invited into the channel
or have a matching entry in the invite list.
I <mask>: Adds or removes an invite; users who match a mask on
@ -39,7 +39,7 @@
that may join the channel.
m: When enabled, users who are not opped or voiced cannot
send messages to the channel.
n: When enabled, users who are not on the channel cannnot
n: When enabled, users who are not on the channel cannot
send messages to it.
p: When enabled, the channel will not be displayed in your
WHOIS output.
@ -73,5 +73,5 @@
/MODE +impsnkl secret_hideout 100
/MODE mike +iw
%9See also:%9 BAN, DEOP, DEVOICE, UNBAN, OP, VOICE
%9See also:%9 BAN, DEOP, DEVOICE, OP, UNBAN, VOICE

View File

@ -1,5 +1,4 @@
%9Syntax:%9
@SYNTAX:motd@
@ -11,7 +10,7 @@
%9Description:%9
Displays the "Message of the Day" of an IRC server.
Displays the welcome message of an IRC server.
%9Examples:%9

View File

@ -16,7 +16,7 @@
%9Description:%9
Displays the users who are in a channel; you can provide multiple channels
by separating them with the comma "," character.
by separating them with a comma.
%9Examples:%9

View File

@ -10,7 +10,7 @@
%9Description:%9
Sends a CTCP reply to a nickname or channel; you can provide multiple
targets by separating them with the comma "," character.
targets by separating them with a comma.
%9Examples:%9

View File

@ -6,7 +6,7 @@
%9Description:%9
Displays some information about users who are currently lost in one or
more netsplits.
more net splits.
%9Examples:%9

View File

@ -14,8 +14,8 @@
-realname: Specifies the real name to use.
-host: Specifies the hostname to use.
-usermode: Specifies the user modes to set on yourself.
-autosendcmd: Specifies the commands, separated by the ";" character,
and enclosed within two '"' characters, to perform after
-autosendcmd: Specifies the commands, separated by the ';' character,
and enclosed within two "'" characters, to perform after
connecting.
-querychans: Specifies the maximum number of channels to put in one MODE
or WHO command when synchronizing.
@ -40,19 +40,19 @@
Displays, adds, modifies or removes the network configuration of IRC
networks.
When using the ADD parameter on a network that already exists, the
configuration will be merged with each other.
We recommend using "WAIT 2000" between the automated commands in order to
We recommend using 'WAIT 2000' between the automated commands in order to
prevent you from being kicked from the network due to flooding commands.
%9Examples:%9
/NETWORK ADD -usermode +giw EFnet
/NETWORK ADD -usermode +iw -nick mike -realname "The one and only mike!" -host staff.irssi.org Freenode
/NETWORK ADD -autosendcmd "^MSG NickServ identify WzerT8zq" Freenode
/NETWORK ADD -autosendcmd "^MSG Q@CServe.quakenet.org AUTH mike WzerT8zq; WAIT 2000; OPER mike WzerT8zq; WAIT 2000; MODE mike +kXP" Quakenet
/NETWORK ADD -usermode +iw -nick mike -realname 'The one and only mike!' -host staff.irssi.org Freenode
/NETWORK ADD -autosendcmd '^MSG NickServ identify WzerT8zq' Freenode
/NETWORK ADD -autosendcmd '^MSG Q@CServe.quakenet.org AUTH mike WzerT8zq; WAIT 2000; OPER mike WzerT8zq; WAIT 2000; MODE mike +kXP' Quakenet
/NETWORK REMOVE Freenode
%9See also:%9 CHANNEL, CONNECT, SERVER

View File

@ -11,9 +11,8 @@
Sends a notice to the target nickname or channel; these are often used in
automated bots or scripts.
You can provide multiple targets by separating them with the comma ","
character.
You can provide multiple targets by separating them with a comma.
%9Examples:%9

View File

@ -10,7 +10,7 @@
%9Description:%9
Grants the channel operator privileges to the given nicknames; you may use
the wildcard character "*" in a nickname.
the wildcard character '*' in a nickname.
%9Examples:%9

View File

@ -5,7 +5,7 @@
%9Parameters:%9
The nickname or channel to ping, you can use the asterisk "*" character to
The nickname or channel to ping, you can use the asterisk '*' character to
ping every user on a channel.
%9Description:%9

View File

@ -6,15 +6,15 @@
%9Parameters:%9
SAVE: Saves the raw server buffer into a file.
OPEN: Opens a logfile and start logging all raw data.
CLOSE: Closes the logfile
OPEN: Opens a log file and start logging all raw data.
CLOSE: Closes the log file
The filename to store the raw data into.
%9Description:%9
Saves all the raw data that is received from and transmitted to the active
server into a logfile.
server into a log file.
%9Examples:%9

View File

@ -17,7 +17,7 @@
into a specific charset.
To get a list of supported charsets on your system, you can generally use
the "iconv -l" command.
the 'iconv -l' command.
%9Examples:%9

View File

@ -20,5 +20,5 @@
/SAVE -formats
/SAVE ~/.irssi/config-new
%9See also:%9 SET, RELOAD
%9See also:%9 RELOAD, SET

View File

@ -26,7 +26,7 @@
/SCRIPT LOAD ~/.irssi/scripts/nickserv.pl
/SCRIPT UNLOAD nickserv
/SCRIPT RESET
/SCRIPT EXEC foreach my $channel (Irssi::channels()) { Irssi::print($channel->{name} . " @ " . $channel->{server}->{tag}); }
/SCRIPT EXEC foreach my $channel (Irssi::channels()) { Irssi::print($channel->{name} . ' @ ' . $channel->{server}->{tag}); }
%9See also:%9 LOAD, SAVE, UNLOAD

View File

@ -13,7 +13,7 @@
END: Go to the end of the buffer.
-all: Applies to all windows instead of only the active one.
-level: The levels, separated by a comman, to match.
-level: The levels, separated by a comma, to match.
The line number, timestamp to jump to or the window reference number to
clear.
@ -23,7 +23,7 @@
Manipulate the text in the window to go to a to the given line number, or
clear the buffers.
The timestamp format is format is "[dd[.mm] | -<days ago>] hh:mi[:ss]".
The timestamp format is format is '[dd[.mm] | -<days ago>] hh:mi[:ss]'.
%9Examples:%9

View File

@ -43,13 +43,13 @@
Displays, adds, modifies or removes the network configuration of IRC
servers.
When using the ADD parameter on a server that already exists, the
configuration will be merged with each other.
When using the command without any of the given parameters, it will
connect to the specified server; the server in the active window will be
disconnected unless you prepend the server with the "+" character; the same
disconnected unless you prepend the server with the '+' character; the same
method is applicable to the CONNECT parameter.
%9Examples:%9
@ -64,6 +64,6 @@
/SERVER REMOVE -network Freenode orwell.freenode.net
/SERVER PURGE
/SERVER PURGE orwell.freenode.net
%9See also:%9 CHANNEL, CONNECT, DISCONNECT, NETWORK, RECONNECT, RMRECONNS

View File

@ -16,7 +16,7 @@
Modifies the value of a setting; boolean settings accept only ON, OFF and
TOGGLE.
Please remember that you need to use the SAVE command to store the changes
into your configuration.
@ -25,7 +25,7 @@
/SET
/SET nick mike
/SET -clear nick
/SET log_timestamp %H:%H:%S
/SET log_timestamp %%H:%%H:%%S
/SET -default log_timestamp
/SET close

View File

@ -5,7 +5,7 @@
%9Parameters:%9
The nickname or hostname to silence; you must prepend it by the "+" or "-"
The nickname or hostname to silence; you must prepend it by the '+' or '-'
character to indicate whether the entry should be added or removed.
If no arguments are given, the list of silence entries will be displayed.

View File

@ -3,7 +3,7 @@
@SYNTAX:time@
%9Parameters%9
%9Parameters:%9
The channel or the nickname; if no argument is given, the active server
will be used.

View File

@ -3,9 +3,9 @@
@SYNTAX:toggle@
%9Parameters%9
%9Parameters:%9
The setting to modify and the new value; if no value is given, its oposite
The setting to modify and the new value; if no value is given, its opposite
will be used.
%9Description:%9

View File

@ -3,7 +3,7 @@
@SYNTAX:topic@
%9Parameters%9
%9Parameters:%9
-delete: Removes the topic.

View File

@ -3,7 +3,7 @@
@SYNTAX:trace@
%9Parameters%9
%9Parameters:%9
The channel or the nickname; if no argument is given, the active server
will be used.

View File

@ -3,7 +3,7 @@
@SYNTAX:unalias@
%9Parameters%9
%9Parameters:%9
The name of the alias.

View File

@ -26,7 +26,7 @@
%9Configuring the custom format:%9
You must set the custom ban_type to the format you would like to use. For
example, if you set the custom ban_type to "nick domain", it will generate
example, if you set the custom ban_type to 'nick domain', it will generate
a ban based on the nick!*@*.domain.tld format.
%9Examples:%9

View File

@ -1,12 +1,12 @@
%9Syntax:%9
@SYNTAX:unnotify@
@SYNTAX:unquery@
%9Parameters:%9
The nickname to close the query for; if no argument is given, the active
query is used.
query will be used.
%9Description:%9

View File

@ -6,7 +6,7 @@
%9Parameters:%9
The location of the new binary; if no arguments are given, the current
binary file is used.
binary file will be used.
%9Description:%9

View File

@ -5,7 +5,8 @@
%9Parameters:%9
A nickname or server; if no argument is given, the active server is used.
A nickname or server; if no argument is given, the active server will be
used.
%9Description:%9

View File

@ -10,7 +10,7 @@
%9Description:%9
Grants the channel voice privileges to the given nicknames; you may use
the wildcard character "*" in a nickname.
the wildcard character '*' in a nickname.
%9Examples:%9

View File

@ -11,7 +11,7 @@
%9Description:%9
Displays information about users in the specified channel. If you specify a
filter, all the users whos nick, userhost or realname matches the filter
filter, all the users whose nick, userhost or realname matches the filter
will be returned.
If the channel is secret and you are not on it, you will not receive any

View File

@ -6,7 +6,7 @@
%9Parameters:%9
LOG: Modifies the logging status.
LOGFILE: Modifies the location to the logfile.
LOGFILE: Modifies the location to the log file.
NEW: Creates a new window.
CLOSE: Closes a window.
REFNUM: Go to the window with the given number.
@ -27,7 +27,7 @@
MOVE PREV: Move the window down.
MOVE NEXT: Move the window up.
MOVE FIRST: Move the window to the first position.
MOVE LAST: Move the window to the last psotion.
MOVE LAST: Move the window to the last position.
MOVE: Move the window.
LIST: List all the windows.
THEME: Applies a theme to the windows.