summaryrefslogtreecommitdiff
path: root/doc/it/autogen/user/exec_commands.adoc
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2020-05-03 14:03:50 +0200
committerSébastien Helleu <flashcode@flashtux.org>2020-05-03 14:05:18 +0200
commit505a91c6003058adf531255dc9a41efea5c7d1f8 (patch)
tree8cbf78be1fa3b9fde46b95e91f90425a63eb6a80 /doc/it/autogen/user/exec_commands.adoc
parent7bcb8ff0d8bfd05657a78096d5dd12c2d44fbf02 (diff)
downloadweechat-505a91c6003058adf531255dc9a41efea5c7d1f8.zip
doc: merge 53 autogen files into 11 files, move them to includes directory
Diffstat (limited to 'doc/it/autogen/user/exec_commands.adoc')
-rw-r--r--doc/it/autogen/user/exec_commands.adoc76
1 files changed, 0 insertions, 76 deletions
diff --git a/doc/it/autogen/user/exec_commands.adoc b/doc/it/autogen/user/exec_commands.adoc
deleted file mode 100644
index d36def7eb..000000000
--- a/doc/it/autogen/user/exec_commands.adoc
+++ /dev/null
@@ -1,76 +0,0 @@
-//
-// This file is auto-generated by script docgen.py.
-// DO NOT EDIT BY HAND!
-//
-[[command_exec_exec]]
-* `+exec+`: execute external commands
-
-----
-/exec -list
- [-sh|-nosh] [-bg|-nobg] [-stdin|-nostdin] [-buffer <name>] [-l|-o|-n|-nf] [-cl|-nocl] [-sw|-nosw] [-ln|-noln] [-flush|-noflush] [-color ansi|auto|irc|weechat|strip] [-rc|-norc] [-timeout <timeout>] [-name <name>] [-pipe <command>] [-hsignal <name>] <command>
- -in <id> <text>
- -inclose <id> [<text>]
- -signal <id> <signal>
- -kill <id>
- -killall
- -set <id> <property> <value>
- -del <id>|-all [<id>...]
-
- -list: list commands
- -sh: use the shell to execute the command, many commands can be piped (WARNING: use this option ONLY if all arguments are safe, see option -nosh)
- -nosh: do not use the shell to execute the command (required if the command has some unsafe data, for example the content of a message from another user) (default)
- -bg: run process in background: do not display process output neither return code (not compatible with options -o/-oc/-n/-nf/-pipe/-hsignal)
- -nobg: catch process output and display return code (default)
- -stdin: create a pipe for sending data to the process (with /exec -in/-inclose)
--nostdin: do not create a pipe for stdin (default)
- -buffer: display/send output of command on this buffer (if the buffer is not found, a new buffer with name "exec.exec.xxx" is created)
- -l: display locally output of command on buffer (default)
- -o: send output of command to the buffer without executing commands (not compatible with options -bg/-pipe/-hsignal)
- -oc: send output of command to the buffer and execute commands (lines starting with "/" or another custom command char) (not compatible with options -bg/-pipe/-hsignal)
- -n: display output of command in a new buffer (not compatible with options -bg/-pipe/-hsignal)
- -nf: display output of command in a new buffer with free content (no word-wrap, no limit on number of lines) (not compatible with options -bg/-pipe/-hsignal)
- -cl: clear the new buffer before displaying output
- -nocl: append to the new buffer without clear (default)
- -sw: switch to the output buffer (default)
- -nosw: don't switch to the output buffer
- -ln: display line numbers (default in new buffer only)
- -noln: don't display line numbers
- -flush: display output of command in real time (default)
--noflush: display output of command after its end
- -color: action on ANSI colors in output:
- ansi: keep ANSI codes as-is
- auto: convert ANSI colors to WeeChat/IRC (default)
- irc: convert ANSI colors to IRC colors
- weechat: convert ANSI colors to WeeChat colors
- strip: remove ANSI colors
- -rc: display return code (default)
- -norc: don't display return code
--timeout: set a timeout for the command (in seconds)
- -name: set a name for the command (to name it later with /exec)
- -pipe: send the output to a WeeChat/plugin command (line by line); if there are spaces in command/arguments, enclose them with double quotes; variable $line is replaced by the line (by default the line is added after the command, separated by a space) (not compatible with options -bg/-o/-oc/-n/-nf)
--hsignal: send the output as a hsignal (to be used for example in a trigger) (not compatible with options -bg/-o/-oc/-n/-nf)
- command: the command to execute; if beginning with "url:", the shell is disabled and the content of URL is downloaded and sent as output
- id: command identifier: either its number or name (if set with "-name xxx")
- -in: send text on standard input of process
--inclose: same as -in, but stdin is closed after (and text is optional: without text, the stdin is just closed)
- -signal: send a signal to the process; the signal can be an integer or one of these names: hup, int, quit, kill, term, usr1, usr2
- -kill: alias of "-signal <id> kill"
--killall: kill all running processes
- -set: set a hook property (see function hook_set in plugin API reference)
-property: hook property
- value: new value for hook property
- -del: delete a terminated command
- -all: delete all terminated commands
-
-Default options can be set in the option exec.command.default_options.
-
-Examples:
- /exec -n ls -l /tmp
- /exec -sh -n ps xu | grep weechat
- /exec -n -norc url:https://pastebin.com/raw.php?i=xxxxxxxx
- /exec -nf -noln links -dump https://weechat.org/files/doc/devel/weechat_user.en.html
- /exec -o uptime
- /exec -pipe "/print Machine uptime:" uptime
- /exec -n tail -f /var/log/messages
- /exec -kill 0
-----