// // This file is auto-generated by script docgen.py. // DO NOT EDIT BY HAND! // // tag::irc_commands[] [[command_irc_admin]] * `+admin+`: find information about the administrator of the server ---- /admin [] target: server name ---- [[command_irc_allchan]] * `+allchan+`: execute a command on all channels of all connected servers ---- /allchan [-current] [-parted] [-exclude=[,...]] [-current] [-parted] -include=[,...] -current: execute command for channels of current server only -parted: execute on parted channels only -exclude: exclude some channels (wildcard "*" is allowed) -include: include only some channels (wildcard "*" is allowed) command: command to execute (or text to send to buffer if command does not start with '/') Command and arguments are evaluated (see /help eval), the following variables are replaced: $server server name $channel channel name $nick nick on server ${irc_server.xxx} variable xxx in server ${irc_channel.xxx} variable xxx in channel Examples: execute '/me is testing' on all channels: /allchan /me is testing say 'hello' everywhere but not on #weechat: /allchan -exclude=#weechat hello say 'hello' everywhere but not on #weechat and channels beginning with #linux: /allchan -exclude=#weechat,#linux* hello say 'hello' on all channels beginning with #linux: /allchan -include=#linux* hello close all buffers with parted channels: /allchan -parted /close ---- [[command_irc_allpv]] * `+allpv+`: execute a command on all private buffers of all connected servers ---- /allpv [-current] [-exclude=[,...]] [-current] -include=[,...] -current: execute command for private buffers of current server only -exclude: exclude some nicks (wildcard "*" is allowed) -include: include only some nicks (wildcard "*" is allowed) command: command to execute (or text to send to buffer if command does not start with '/') Command and arguments are evaluated (see /help eval), the following variables are replaced: $server server name $channel channel name $nick nick on server ${irc_server.xxx} variable xxx in server ${irc_channel.xxx} variable xxx in channel Examples: execute '/me is testing' on all private buffers: /allpv /me is testing say 'hello' everywhere but not for nick foo: /allpv -exclude=foo hello say 'hello' everywhere but not for nick foo and nicks beginning with bar: /allpv -exclude=foo,bar* hello say 'hello' for all nicks beginning with bar: /allpv -include=bar* hello close all private buffers: /allpv /close ---- [[command_irc_allserv]] * `+allserv+`: execute a command on all connected servers ---- /allserv [-exclude=[,...]] -include=[,...] -exclude: exclude some servers (wildcard "*" is allowed) -include: include only some servers (wildcard "*" is allowed) command: command to execute (or text to send to buffer if command does not start with '/') Command and arguments are evaluated (see /help eval), the following variables are replaced: $server server name $nick nick on server ${irc_server.xxx} variable xxx in server Examples: change nick on all servers: /allserv /nick newnick set away on all servers: /allserv /away I'm away do a whois on my nick on all servers: /allserv /whois $nick ---- [[command_irc_auth]] * `+auth+`: authenticate with SASL ---- /auth [ ] username: SASL username (content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name) password: SASL password or path to file with private key (content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name) If username and password are not provided, the values from server options "sasl_username" and "sasl_password" (or "sasl_key") are used. Examples: authenticate with username/password defined in the server: /auth authenticate as a different user: /auth user2 password2 authenticate as a different user with mechanism ecdsa-nist256p-challenge: /auth user2 ${weechat_config_dir}/ecdsa2.pem ---- [[command_irc_autojoin]] * `+autojoin+`: configure the "autojoin" server option ---- /autojoin add [ [...]] addraw [,...] [[,...]] del [ [...]] apply join sort add: add current channel or a list of channels (with optional keys) to the autojoin option; if you are on the channel and the key is not provided, the key is read in the channel addraw: use the IRC raw format (same as /join command): all channels separated by commas, optional keys separated by commas del: delete current channel or a list of channels from the autojoin option channel: channel name key: key for the channel apply: set currently joined channels in the autojoin option join: join the channels in the autojoin option sort: sort alphabetically channels in the autojoin option Examples: /autojoin add /autojoin add #test /autojoin add #chan1 #chan2 /allchan /autojoin add /autojoin addraw #chan1,#chan2,#chan3 key1,key2 /autojoin del /autojoin del #chan1 /autojoin apply /autojoin join /autojoin sort ---- [[command_irc_ban]] * `+ban+`: ban nicks or hosts ---- /ban [] [ [...]] channel: channel name nick: nick or host Without argument, this command displays the ban list for current channel. ---- [[command_irc_cap]] * `+cap+`: client capability negotiation ---- /cap ls list req|ack [ [...]] end ls: list the capabilities supported by the server list: list the capabilities currently enabled req: request a new capability or remove a capability (if starting with "-", for example: "-multi-prefix") ack: acknowledge capabilities which require client-side acknowledgement end: end the capability negotiation Without argument, "ls" and "list" are sent. Capabilities supported by WeeChat are: account-notify, away-notify, cap-notify, chghost, extended-join, invite-notify, message-tags, multi-prefix, server-time, setname, userhost-in-names. The capabilities to automatically enable on servers can be set in option irc.server_default.capabilities (or by server in option irc.server.xxx.capabilities). Examples: display supported and enabled capabilities: /cap request capabilities multi-prefix and away-notify: /cap req multi-prefix away-notify request capability extended-join, remove capability multi-prefix: /cap req extended-join -multi-prefix remove capability away-notify: /cap req -away-notify ---- [[command_irc_connect]] * `+connect+`: connect to IRC server(s) ---- /connect [ [...]] [-