summaryrefslogtreecommitdiff
path: root/doc/en/autogen/user
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2016-11-22 19:24:40 +0100
committerSébastien Helleu <flashcode@flashtux.org>2016-11-22 19:24:40 +0100
commit0cec295a41e47e4fcaa3dea39933f7d082f93c7b (patch)
tree475b4dd2988b2637e80f081b7ba406aba3a7e34e /doc/en/autogen/user
parentfe95a1c8a86e1e1741a2769d7570f88a818e9b3e (diff)
downloadweechat-0cec295a41e47e4fcaa3dea39933f7d082f93c7b.zip
fifo: add file fifo.conf and option fifo.file.path to customize FIFO pipe path/filename (closes #850)
Diffstat (limited to 'doc/en/autogen/user')
-rw-r--r--doc/en/autogen/user/fifo_commands.adoc4
-rw-r--r--doc/en/autogen/user/fifo_options.adoc13
2 files changed, 15 insertions, 2 deletions
diff --git a/doc/en/autogen/user/fifo_commands.adoc b/doc/en/autogen/user/fifo_commands.adoc
index f0835cdba..eee8b2526 100644
--- a/doc/en/autogen/user/fifo_commands.adoc
+++ b/doc/en/autogen/user/fifo_commands.adoc
@@ -13,14 +13,14 @@ disable: disable FIFO pipe
toggle: toggle FIFO pipe
FIFO pipe is used as remote control of WeeChat: you can send commands or text to the FIFO pipe from your shell.
-By default the FIFO pipe is in ~/.weechat/weechat_fifo_xxx ("xxx" is the WeeChat PID).
+By default the FIFO pipe is in ~/.weechat/weechat_fifo
The expected format is one of:
plugin.buffer *text or command here
*text or command here
For example to change your freenode nick:
- echo 'irc.server.freenode */nick newnick' >~/.weechat/weechat_fifo_12345
+ echo 'irc.server.freenode */nick newnick' >~/.weechat/weechat_fifo
Please read the user's guide for more info and examples.
diff --git a/doc/en/autogen/user/fifo_options.adoc b/doc/en/autogen/user/fifo_options.adoc
new file mode 100644
index 000000000..6bb87ef17
--- /dev/null
+++ b/doc/en/autogen/user/fifo_options.adoc
@@ -0,0 +1,13 @@
+//
+// This file is auto-generated by script docgen.py.
+// DO NOT EDIT BY HAND!
+//
+* [[option_fifo.file.enabled]] *fifo.file.enabled*
+** description: pass:none[enable FIFO pipe]
+** type: boolean
+** values: on, off (default value: `+on+`)
+
+* [[option_fifo.file.path]] *fifo.file.path*
+** description: pass:none[path for FIFO file; "%h" at beginning of string is replaced by WeeChat home ("~/.weechat" by default); WeeChat PID can be used in path with ${info:pid} (note: content is evaluated, see /help eval)]
+** type: string
+** values: any string (default value: `+"%h/weechat_fifo"+`)