weechat/doc/en/autogen/user/alias_commands.adoc

41 lines
1.5 KiB
Plaintext

//
// This file is auto-generated by script docgen.py.
// DO NOT EDIT BY HAND!
//
[[command_alias_alias]]
* `+alias+`: list, add or remove command aliases
----
/alias list [<alias>]
add <alias> [<command>[;<command>...]]
addcompletion <completion> <alias> [<command>[;<command>...]]
del <alias> [<alias>...]
list: list aliases (without argument, this list is displayed)
add: add an alias
addcompletion: add an alias with a custom completion
del: delete an alias
completion: completion for alias: by default completion is done with target command
note: you can use %%command to use completion of an existing command
alias: name of alias
command: command name with arguments (many commands can be separated by semicolons)
Note: in command, special variables are replaced:
$n: argument 'n' (between 1 and 9)
$-m: arguments from 1 to 'm'
$n-: arguments from 'n' to last
$n-m: arguments from 'n' to 'm'
$*: all arguments
$~: last argument
$var: where "var" is a local variable of buffer (see /buffer localvar)
examples: $nick, $channel, $server, $plugin, $name
Examples:
alias /split to split window horizontally:
/alias add split /window splith
alias /hello to say "hello" on all channels but not on #weechat:
/alias add hello /allchan -exclude=#weechat msg * hello
alias /forcejoin to send IRC command "forcejoin" with completion of /sajoin:
/alias addcompletion %%sajoin forcejoin /quote forcejoin
----