path: root/doc/en/autogen/user/irc_commands.txt

• *`/admin`* `[target]`::

........................................
  find information about the administrator of the server

  target: server
........................................

• *`/allchan`* `[-current] [-exclude=channel[,channel...]] command [arguments]`::

........................................
  execute a command on all channels of all connected servers

   -current: execute command for channels of current server only
   -exclude: exclude some channels ('*' is allowed at beginning or end of channel name, to exclude many channels)
    command: command to execute
  arguments: arguments for command
  
  Examples:
    execute '/me is testing' on all channels:
      /allchan me is testing
    say 'hello' everywhere but not on #weechat:
      /allchan -exclude=#weechat msg * hello
    say 'hello' everywhere but not on #weechat and channels beginning with #linux:
      /allchan -exclude=#weechat,#linux* msg * hello
........................................

• *`/allserv`* `[-exclude=server[,server...]] command [arguments]`::

........................................
  execute a command on all connected servers

   -exclude: exclude some servers ('*' is allowed at beginning or end of server name, to exclude many servers)
    command: command to execute
  arguments: arguments for command
  
  Examples:
    change nick on all servers:
      /allserv nick newnick
    set away on all servers:
      /allserv away I'm away
........................................

• *`/ban`* `[channel] [nickname [nickname ...]]`::

........................................
  ban nicks or hosts

   channel: channel for ban
  nickname: user or host to ban
........................................

• *`/connect`* `[servername [servername ...] | hostname[/port] [-option[=value]] [-nooption] | -all | -open] [-nojoin] [-switch]`::

........................................
  connect to IRC server(s)

  servername: internal server name to connect (server must have been created by /server add)
    hostname: hostname (or IP) of a server (this will create a TEMPORARY server)
        port: port for server (6667 by default)
      option: set option for server (for boolean option, value can be omitted)
    nooption: set boolean option to 'off' (for example: -nossl)
        -all: connect to all servers defined in configuration
       -open: connect to all opened servers that are not currently connected
     -nojoin: do not join any channel (even if autojoin is enabled on server)
     -switch: switch to next server address
  
  Examples:
    /connect freenode
    /connect irc.oftc.net/6667
    /connect irc6.oftc.net/6667 -ipv6
    /connect irc6.oftc.net/6697 -ipv6 -ssl
    /connect my.server.org/6697 -ssl -password=test
    /connect -switch
........................................

• *`/ctcp`* `target type [arguments]`::

........................................
  send a CTCP message (Client-To-Client Protocol)

   target: nick or channel to send CTCP to
     type: CTCP type (examples: "version", "ping", ..)
  arguments: arguments for CTCP
........................................

• *`/cycle`* `[channel[,channel]] [part_message]`::

........................................
  leave and rejoin a channel

       channel: channel name for cycle
  part_message: part message (displayed to other users)
........................................

• *`/dcc`* `action [nickname [file]]`::

........................................
  start DCC (file or chat)

    action: 'send' (file) or 'chat'
  nickname: nickname to send file or chat
      file: filename (on local host)
  
  Examples:
    chat with nick "toto":
      /dcc chat toto
    send file "/home/foo/bar.txt" to nick "toto":
      /dcc send toto /home/foo/bar.txt
........................................

• *`/dehalfop`* `[nickname [nickname]]`::

........................................
  remove half channel operator status from nickname(s)
........................................

• *`/deop`* `[nickname [nickname]]`::

........................................
  remove channel operator status from nickname(s)
........................................

• *`/devoice`* `[nickname [nickname]]`::

........................................
  remove voice from nickname(s)
........................................

• *`/die`*::

........................................
  shutdown the server
........................................

• *`/disconnect`* `[-all | servername [servername ...]]`::

........................................
  disconnect from IRC server(s)

        -all: disconnect from all servers
  servername: server name to disconnect
........................................

• *`/halfop`* `[nickname [nickname]]`::

........................................
  give half channel operator status to nickname(s)
........................................

• *`/ignore`* `[list] | [add [re:]nick/host [server [channel]]] | [del number|-all]`::

........................................
  ignore nicks/hosts from servers or channels

       list: list all ignores
        add: add an ignore
        del: delete an ignore
     number: number of ignore to delete (look at list to find it)
       -all: delete all ignores
  nick/host: nick or host to ignore: syntax is "re:regex" or "mask" (a mask is a string with some "*" to replace one or more chars)
     server: internal server name where ignore is working
    channel: channel name where ignore is working
  
  Examples:
    ignore nick "toto" everywhere:
      /ignore add toto
    ignore host "toto@domain.com" on freenode server:
      /ignore add toto@domain.com freenode
    ignore host "toto*@*.domain.com" on freenode/#weechat:
      /ignore add toto*@*.domain.com freenode #weechat
........................................

• *`/info`* `[target]`::

........................................
  get information describing the server

  target: server name
........................................

• *`/invite`* `nickname channel`::

........................................
  invite a nick on a channel

  nickname: nick to invite
   channel: channel to invite
........................................

• *`/ison`* `nickname [nickname ...]`::

........................................
  check if a nickname is currently on IRC

  nickname: nickname
........................................

• *`/join`* `[-server server] [channel1[,channel2[,channel3]] [key1[,key2]]]`::

........................................
  join a channel

   server: send to this server (internal name)
  channel: channel name to join
      key: key to join the channel (channels with a key must be the first in list)
  
  Examples:
    /join #weechat
    /join #protectedchan,#weechat key
    /join -server freenode #weechat
........................................

• *`/kick`* `[channel] nickname [comment]`::

........................................
  forcibly remove a user from a channel

   channel: channel where user is
  nickname: nickname to kick
   comment: comment for kick
........................................

• *`/kickban`* `[channel] nickname [comment]`::

........................................
  kicks and bans a nick from a channel

   channel: channel where user is
  nickname: nickname to kick and ban
   comment: comment for kick
  
  It is possible to kick/ban with a mask, nick will be extracted from mask and replaced by "*".
  
  Example:
    ban "*!*@host.com" and then kick "toto":
      /kickban toto!*@host.com
........................................

• *`/kill`* `nickname comment`::

........................................
  close client-server connection

  nickname: nickname
   comment: comment for kill
........................................

• *`/links`* `[[server] server_mask]`::

........................................
  list all servernames which are known by the server answering the query

       server: this server should answer the query
  server_mask: list of servers must match this mask
........................................

• *`/list`* `[channel[,channel] [server] [-re regexp]]`::

........................................
  list channels and their topic

  channel: channel to list
   server: server name
   regexp: regular expression used to filter results
  
  Examples:
    list all channels on server (can be very slow on large networks):
      /list
    list channel #weechat:
      /list #weechat
    list all channels beginning with "#weechat" (can be very slow on large networks):
      /list -re #weechat.*
........................................

• *`/lusers`* `[mask [target]]`::

........................................
  get statistics about the size of the IRC network

    mask: servers matching the mask only
  target: server for forwarding request
........................................

• *`/map`*::

........................................
  show a graphical map of the IRC network
........................................

• *`/me`* `message`::

........................................
  send a CTCP action to the current channel

  message: message to send
........................................

• *`/mode`* `{ [channel] {[+|-]|o|p|s|i|t|n|b|v} [limit] [user] [ban mask] } | { nickname {[+|-]|i|w|s|o} }`::

........................................
  change channel or user mode

  channel modes:
    channel: channel name to modify (default is current one)
    o: give/take channel operator privileges
    p: private channel flag
    s: secret channel flag
    i: invite-only channel flag
    t: topic settable by channel operator only flag
    n: no messages to channel from clients on the outside
    m: moderated channel
    l: set the user limit to channel
    b: set a ban mask to keep users out
    e: set exception mask
    v: give/take the ability to speak on a moderated channel
    k: set a channel key (password)
  user modes:
    nickname: nickname to modify
    i: mark a user as invisible
    s: mark a user for receive server notices
    w: user receives wallops
    o: operator flag
........................................

• *`/motd`* `[target]`::

........................................
  get the "Message Of The Day"

  target: server name
........................................

• *`/msg`* `[-server server] target[,target] text`::

........................................
  send message to a nick or channel

  server: send to this server (internal name)
  target: nick or channel (may be mask, '*' = current channel)
    text: text to send
........................................

• *`/names`* `[channel[,channel]]`::

........................................
  list nicknames on channels

  channel: channel name
........................................

• *`/nick`* `[-all] nickname`::

........................................
  change current nickname

      -all: set new nickname for all connected servers
  nickname: new nickname
........................................

• *`/notice`* `[-server server] target text`::

........................................
  send notice message to user

  server: send to this server (internal name)
  target: nick or channel
    text: text to send
........................................

• *`/notify`* `[add nick [server [-away]]] | [del nick|-all [server]]`::

........................................
  add a notification for presence or away status of nicks on servers

     add: add a notification
    nick: nickname
  server: internal server name (by default current server)
   -away: notify when away message is changed (by doing whois on nick)
     del: delete a notification
    -all: delete all notifications
  
  Without argument, this command displays notifications for current server (or all servers if command is issued on core buffer).
  
  Examples:
    notify when "toto" joins/quits current server:
      /notify add toto
    notify when "toto" joins/quits freenode server:
      /notify add toto freenode
    notify when "toto" is away or back on freenode server:
      /notify add toto freenode -away
........................................

• *`/op`* `nickname [nickname]`::

........................................
  give channel operator status to nickname(s)
........................................

• *`/oper`* `user password`::

........................................
  get operator privileges

  user/password: used to get privileges on current IRC server
........................................

• *`/part`* `[channel[,channel]] [part_message]`::

........................................
  leave a channel

       channel: channel name to leave
  part_message: part message (displayed to other users)
........................................

• *`/ping`* `server1 [server2]`::

........................................
  ping server

  server1: server to ping
  server2: forward ping to this server
........................................

• *`/pong`* `daemon [daemon2]`::

........................................
  answer to a ping message

   daemon: daemon who has responded to Ping message
  daemon2: forward message to this daemon
........................................

• *`/query`* `[-server server] nickname [text]`::

........................................
  send a private message to a nick

    server: send to this server (internal name)
  nickname: nickname for private conversation
      text: text to send
........................................

• *`/quote`* `[-server server] data`::

........................................
  send raw data to server without parsing

  server: send to this server (internal name)
    data: raw data to send
........................................

• *`/reconnect`* `[servername [servername ...] | -all] [-nojoin] [-switch]`::

........................................
  reconnect to server(s)

  servername: server name to reconnect
        -all: reconnect to all servers
     -nojoin: do not join any channel (even if autojoin is enabled on server)
     -switch: switch to next server address
........................................

• *`/rehash`* `[option]`::

........................................
  tell the server to reload its config file

  option: extra option, for some servers
........................................

• *`/restart`*::

........................................
  tell the server to restart itself
........................................

• *`/sajoin`* `nickname channel[,channel]`::

........................................
  forces a user to join channel(s)

  nickname: nickname
   channel: channel name
........................................

• *`/samode`* `channel mode`::

........................................
  change mode on channel, without having operator status

  channel: channel name
     mode: mode for channel
........................................

• *`/sanick`* `nickname new_nickname`::

........................................
  forces a user to use another nick

      nickname: nickname
  new_nickname: new nickname
........................................

• *`/sapart`* `nickname channel[,channel]`::

........................................
  forces a user to leave channel(s)

  nickname: nickname
   channel: channel name
........................................

• *`/saquit`* `nickname reason`::

........................................
  forces a user to quit server with a reason

  nickname: nickname
    reason: reason
........................................

• *`/server`* `[list [servername]] | [listfull [servername]] | [add servername hostname[/port] [-temp] [-option[=value]] [-nooption]] | [copy servername newservername] | [rename servername newservername] | [keep servername] | [del servername] | [deloutq] | [jump] | [raw]`::

........................................
  list, add or remove IRC servers

        list: list servers (without argument, this list is displayed)
    listfull: list servers with detailed info for each server
         add: create a new server
  servername: server name, for internal and display use
    hostname: name or IP address of server, with optional port (default: 6667), many addresses can be separated by a comma
        temp: create temporary server (not saved)
      option: set option for server (for boolean option, value can be omitted)
    nooption: set boolean option to 'off' (for example: -nossl)
        copy: duplicate a server
      rename: rename a server
        keep: keep server in config file (for temporary servers only)
         del: delete a server
     deloutq: delete messages out queue for all servers (all messages WeeChat is currently sending)
        jump: jump to server buffer
         raw: open buffer with raw IRC data
  
  Examples:
    /server listfull
    /server add oftc irc.oftc.net/6697 -ssl -autoconnect
    /server add oftc6 irc6.oftc.net/6697 -ipv6 -ssl
    /server add freenode2 chat.eu.freenode.net/6667,chat.us.freenode.net/6667
    /server add freenode3 irc.freenode.net -password=mypass
    /server copy oftc oftcbis
    /server rename oftc newoftc
    /server del freenode
    /server deloutq
........................................

• *`/service`* `nickname reserved distribution type reserved info`::

........................................
  register a new service

  distribution: visibility of service
          type: reserved for future usage
........................................

• *`/servlist`* `[mask [type]]`::

........................................
  list services currently connected to the network

  mask: list only services matching this mask
  type: list only services of this type
........................................

• *`/squery`* `service text`::

........................................
  deliver a message to a service

  service: name of service
  text: text to send
........................................

• *`/squit`* `server comment`::

........................................
  disconnect server links

  server: server name
  comment: comment for quit
........................................

• *`/stats`* `[query [server]]`::

........................................
  query statistics about server

   query: c/h/i/k/l/m/o/y/u (see RFC1459)
  server: server name
........................................

• *`/summon`* `user [target [channel]]`::

........................................
  give users who are on a host running an IRC server a message asking them to please join IRC

     user: username
  target: server name
  channel: channel name
........................................

• *`/time`* `[target]`::

........................................
  query local time from server

  target: query time from specified server
........................................

• *`/topic`* `[channel] [topic]`::

........................................
  get/set channel topic

  channel: channel name
  topic: new topic for channel (if topic is "-delete" then topic is deleted)
........................................

• *`/trace`* `[target]`::

........................................
  find the route to specific server

  target: server
........................................

• *`/unban`* `[channel] nickname [nickname ...]`::

........................................
  unban nicks or hosts

   channel: channel for unban
  nickname: user or host to unban
........................................

• *`/userhost`* `nickname [nickname ...]`::

........................................
  return a list of information about nicknames

  nickname: nickname
........................................

• *`/users`* `[target]`::

........................................
  list of users logged into the server

  target: server
........................................

• *`/version`* `[server | nickname]`::

........................................
  give the version info of nick or server (current or specified)

    server: server name
  nickname: nickname
........................................

• *`/voice`* `[nickname [nickname]]`::

........................................
  give voice to nickname(s)
........................................

• *`/wallchops`* `[channel] text`::

........................................
  send a notice to channel ops

  channel: channel name
     text: text to send
........................................

• *`/wallops`* `text`::

........................................
  send a message to all currently connected users who have set the 'w' user mode for themselves

  text to send
........................................

• *`/who`* `[mask ["o"]]`::

........................................
  generate a query which returns a list of information

  mask: only information which match this mask
     o: only operators are returned according to the mask supplied
........................................

• *`/whois`* `[server] nickname[,nickname]`::

........................................
  query information about user(s)

    server: server name
  nickname: nickname (may be a mask)
........................................

• *`/whowas`* `nickname [,nickname [,nickname ...]] [count [target]]`::

........................................
  ask for information about a nickname which no longer exists

  nickname: nickname to search
     count: number of replies to return (full search if negative number)
    target: reply should match this mask
........................................