mirror of
https://github.com/irssi/irssi.git
synced 2024-09-01 04:14:16 -04:00
New syntax documentation for NETWORK and SERVER
Rewrote the syntax documentation for NETWORK and SERVER
This commit is contained in:
parent
120508c14f
commit
074735db08
@ -25,14 +25,22 @@
|
||||
Adds, removes or displays the configuration of channels; this method is
|
||||
used to automate and simplify your workflow.
|
||||
|
||||
You can use the ADDALLCHANS command, which is a default alias, to add all
|
||||
the channels you are present on into the configuration.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/CHANNEL
|
||||
/CHANNEL LIST
|
||||
/CHANNEL ADD -auto #irssi Freenode
|
||||
/CHANNEL ADD -auto #google Quakenet secret_lair
|
||||
/CHANNEL ADD -auto -bots "*!@*.google.com *!bot@google.com" -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
|
||||
|
||||
/ADDALLCHANS
|
||||
|
||||
%9See also:%9 JOIN, TS
|
||||
|
||||
|
@ -20,6 +20,9 @@
|
||||
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.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/COMPLETION w/h without
|
||||
|
@ -9,7 +9,8 @@
|
||||
-6: Connects using IPv6.
|
||||
-ssl: Connects using SSL encryption.
|
||||
-ssl_cert: The SSL client certificate file.
|
||||
-ssl_pkey: The SSL client private key, if not included in the certificate file.
|
||||
-ssl_pkey: The SSL client private key, if not included in the
|
||||
certificate file.
|
||||
-ssl_verify: Verifies the SSL certificate of the server.
|
||||
-ssl_cafile: The file with the list of CA certificates.
|
||||
-ssl_capath: The directory which contains the CA certificates.
|
||||
|
@ -1,24 +1,59 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:network@
|
||||
|
||||
-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 cmds_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
|
||||
-usermode: Specify what usermode to use on this network
|
||||
-autosendcmd: Command to send after connecting to a server
|
||||
%9Parameters:%9
|
||||
|
||||
With -autosendcmd argument you can automatically run any commands
|
||||
after connecting to the network. This is useful for automatically
|
||||
identifying yourself to NickServ, for example
|
||||
LIST: Displays the list of configured networks.
|
||||
ADD: Adds a network to your configuration.
|
||||
REMOVE: Removes a network from your configuration.
|
||||
|
||||
/NETWORK ADD -autosendcmd "/^msg NickServ identify secret" freenode
|
||||
-nick: Specifies the nickname to use.
|
||||
-user: Specifies the user identity to use.
|
||||
-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
|
||||
connecting.
|
||||
-querychans: Specifies the maximum number of channels to put in one MODE
|
||||
or WHO command when synchronizing.
|
||||
-whois: Specifies the maximum number of nicknames in one WHOIS
|
||||
command.
|
||||
-msgs: Specifies the maximum number of nicknames in one PRIVMSG
|
||||
command.
|
||||
-kicks: Specifies the maximum number of nicknames in one KICK
|
||||
command.
|
||||
-modes: Specifies the maximum number of nicknames in one MODE
|
||||
command.
|
||||
-cmdspeed: Specifies the minimum amount of time, expressed in
|
||||
milliseconds, that the client must wait before sending
|
||||
additional commands to the server.
|
||||
-cmxmax: Specifies the maximum number of commands to perform before
|
||||
starting the internal flood protection.
|
||||
|
||||
Shows and changes the settings of defined IRC networks.
|
||||
The name of the network to add, edit or remove; if no parameter is given,
|
||||
the list of networks will be displayed.
|
||||
|
||||
See also: CONNECT
|
||||
%9Description:%9
|
||||
|
||||
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
|
||||
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 office.google.com 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
|
||||
|
||||
|
@ -1,44 +1,68 @@
|
||||
|
||||
%9Syntax:%9
|
||||
|
||||
@SYNTAX:server@
|
||||
|
||||
-4, -6: specify explicitly whether to use IPv4 or IPv6 address
|
||||
-ssl: use SSL when connecting
|
||||
-ssl_cert: The SSL client certificate file (implies -ssl)
|
||||
-ssl_pkey: The SSL client private key (if not included in the certificate file)
|
||||
-ssl_pass: The password for the SSL client private key or certificate.
|
||||
-ssl_verify: Verify servers SSL certificate
|
||||
-ssl_cafile: File with list of CA certificates (implies -ssl_verify)
|
||||
-ssl_capath: Directory with CA certificates (implies -ssl_verify)
|
||||
-noproxy: Ignore the global proxy configuration for this server
|
||||
-auto: Automatically connect to server at startup
|
||||
-noauto: Don't connect to server at startup (default)
|
||||
-network: Specify what IRC network this server belongs to
|
||||
-ircnet: Same as -network. Deprecated. Do not use
|
||||
-host: Specify what host name to use, if you have multiple
|
||||
-!: don't autojoin channels
|
||||
-noautosendcmd: don't execute autosendcmd
|
||||
-cmdspeed: Same as /SET cmd_queue_speed, see section 3.1
|
||||
-cmdmax: Same as /SET cmds_max_at_once, see section 3.1
|
||||
-port: Use this only to edit the port number of an existing server,
|
||||
for new servers use the <port> argument
|
||||
%9Parameters:%9
|
||||
|
||||
/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)
|
||||
LIST: Displays the list of servers you are connected to.
|
||||
CONNECT: Connects to the given server.
|
||||
ADD: Adds a server to your configuration.
|
||||
REMOVE: Removes a server from your configuration.
|
||||
PURGE: Purges the commands queued to be sent to the server.
|
||||
|
||||
/SERVER without any arguments displays the list of connected
|
||||
servers.
|
||||
-!: Doesn't autojoin the channels.
|
||||
-4: Connects using IPv4.
|
||||
-6: Connects using IPv6.
|
||||
-ssl: Connects using SSL encryption.
|
||||
-ssl_cert: The SSL client certificate file.
|
||||
-ssl_pkey: The SSL client private key, if not included in the
|
||||
certificate file.
|
||||
-ssl_pass: Verifies the SSL certificate of the server.
|
||||
-ssl_verify: Verifies the SSL certificate of the server.
|
||||
-ssl_cafile: The file with the list of CA certificates.
|
||||
-ssl_capath: The directory which contains the CA certificates.
|
||||
-auto: Automatically connects to the server on startup.
|
||||
-noauto: Doesn't connect to the server on startup.
|
||||
-network: The network the server belongs to.
|
||||
-host: The hostname you would like to connect from.
|
||||
-cmdspeed: Specifies the minimum amount of time, expressed in
|
||||
milliseconds, that the client must wait before sending
|
||||
additional commands to the server.
|
||||
-cmxmax: Specifies the maximum number of commands to perform
|
||||
before starting the internal flood protection.
|
||||
-port: Specifies the port to connect to the server.
|
||||
-noproxy: Ignores the global proxy configuration.
|
||||
-rawlog: Immediately open rawlog after connecting.
|
||||
|
||||
/SERVER REMOVE <address> [<port>] [<network>]
|
||||
The server, port and network to add, modify or remove; if no argument is
|
||||
given, the list of servers you are connected to will be returned.
|
||||
|
||||
/SERVER LIST
|
||||
%9Description:%9
|
||||
|
||||
/SERVER PURGE [<target>]
|
||||
Displays, adds, modifies or removes the network configuration of IRC
|
||||
servers.
|
||||
|
||||
Clears the server send queue. Useful if, for example, you accidentally paste lots of text to a channel.
|
||||
When using the ADD parameter on a server that already exists, the
|
||||
configuration will be merged with each other.
|
||||
|
||||
See also: CONNECT, DISCONNECT, RECONNECT, RMRECONNS
|
||||
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
|
||||
method is applicable to the CONNECT parameter.
|
||||
|
||||
%9Examples:%9
|
||||
|
||||
/SERVER
|
||||
/SERVER chat.freenode.net
|
||||
/SERVER +chat.freenode.net
|
||||
/SERVER CONNECT chat.freenode.net
|
||||
/SERVER CONNECT +chat.freenode.net
|
||||
/SERVER ADD -network Freenode orwell.freenode.net
|
||||
/SERVER ADD -! -auto -host office.google.com -port 6667 -4 -network Freenode -noproxy orwell.freenode.net
|
||||
/SERVER REMOVE -network Freenode orwell.freenode.net
|
||||
/SERVER PURGE
|
||||
/SERVER PURGE orwell.freenode.net
|
||||
|
||||
%9See also:%9 CHANNEL, CONNECT, DISCONNECT, NETWORK, RECONNECT, RMRECONNS
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user