diff options
Diffstat (limited to 'doc/en/includes')
| -rw-r--r-- | doc/en/includes/autogen_api_infos.en.adoc | 10 | ||||
| -rw-r--r-- | doc/en/includes/autogen_user_commands.en.adoc | 10 | ||||
| -rw-r--r-- | doc/en/includes/autogen_user_options.en.adoc | 32 |
3 files changed, 30 insertions, 22 deletions
diff --git a/doc/en/includes/autogen_api_infos.en.adoc b/doc/en/includes/autogen_api_infos.en.adoc index e2038de17..d5a231d07 100644 --- a/doc/en/includes/autogen_api_infos.en.adoc +++ b/doc/en/includes/autogen_api_infos.en.adoc @@ -134,9 +134,15 @@ | weechat | version_number | WeeChat version (as number) | - +| weechat | weechat_cache_dir | WeeChat cache directory | - + +| weechat | weechat_config_dir | WeeChat config directory | - + | weechat | weechat_daemon | 1 if WeeChat is running in daemon mode (headless, in background) | - -| weechat | weechat_dir | WeeChat directory | - +| weechat | weechat_data_dir | WeeChat data directory | - + +| weechat | weechat_dir | WeeChat directory (*deprecated* since version 3.2, replaced by "weechat_config_dir", "weechat_data_dir", "weechat_cache_dir" and "weechat_runtime_dir") | - | weechat | weechat_headless | 1 if WeeChat is running headless | - @@ -144,6 +150,8 @@ | weechat | weechat_localedir | WeeChat "locale" directory | - +| weechat | weechat_runtime_dir | WeeChat runtime directory | - + | weechat | weechat_sharedir | WeeChat "share" directory | - | weechat | weechat_site | WeeChat site | - diff --git a/doc/en/includes/autogen_user_commands.en.adoc b/doc/en/includes/autogen_user_commands.en.adoc index 8eefbdbdc..2c72f5a5c 100644 --- a/doc/en/includes/autogen_user_commands.en.adoc +++ b/doc/en/includes/autogen_user_commands.en.adoc @@ -1981,7 +1981,7 @@ With option "-quit", the process is slightly different: 5. quit WeeChat Then later you can restore session with command: weechat --upgrade IMPORTANT: you must restore the session with exactly same configuration (files *.conf). -It is possible to restore WeeChat session on another machine if you copy the content of directory "~/.weechat". +It is possible to restore WeeChat session on another machine if you copy the content of WeeChat home directories (see /debug dirs). ---- [[command_weechat_uptime]] @@ -2272,14 +2272,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 +By default the FIFO pipe is called weechat_fifo_xxx (where xxx is the WeeChat process id) and located in the WeeChat runtime directory (see /debug dirs). 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 + echo 'irc.server.freenode */nick newnick' >/run/user/1000/weechat/weechat_fifo_12345 Please read the user's guide for more info and examples. @@ -2716,7 +2716,7 @@ Without argument, this command lists all loaded scripts. stop: close the server socket (clients remain connected) name: relay name (see format below) port: port used for relay - path: path used for relay (for UNIX domain socket only); "%h" at beginning of string is replaced by WeeChat home ("~/.weechat" by default), content is evaluated (see /help eval) + path: path used for relay (for UNIX domain socket only); path is evaluated (see function string_eval_path_home in plugin API reference) raw: open buffer with raw Relay data sslcertkey: set SSL certificate/key using path in option relay.network.ssl_cert_key @@ -2752,7 +2752,7 @@ Examples: weechat protocol with SSL, using IPv4 + IPv6: /relay add ipv4.ipv6.ssl.weechat 9001 weechat protocol over UNIX domain socket: - /relay add unix.weechat %h/relay_socket + /relay add unix.weechat ${weechat_runtime_dir}/relay_socket ---- // end::relay_commands[] diff --git a/doc/en/includes/autogen_user_options.en.adoc b/doc/en/includes/autogen_user_options.en.adoc index 20f2978a9..ec443d0b4 100644 --- a/doc/en/includes/autogen_user_options.en.adoc +++ b/doc/en/includes/autogen_user_options.en.adoc @@ -1261,7 +1261,7 @@ ** default value: `+60+` * [[option_weechat.network.gnutls_ca_file]] *weechat.network.gnutls_ca_file* -** description: pass:none[file containing the certificate authorities ("%h" will be replaced by WeeChat home, "~/.weechat" by default)] +** description: pass:none[file containing the certificate authorities (path is evaluated, see function string_eval_path_home in plugin API reference)] ** type: string ** values: any string ** default value: `+"/etc/ssl/certs/ca-certificates.crt"+` @@ -1297,10 +1297,10 @@ ** default value: `+".so,.dll"+` * [[option_weechat.plugin.path]] *weechat.plugin.path* -** description: pass:none[path for searching plugins ("%h" will be replaced by WeeChat home, "~/.weechat" by default)] +** description: pass:none[path for searching plugins (path is evaluated, see function string_eval_path_home in plugin API reference)] ** type: string ** values: any string -** default value: `+"%h/plugins"+` +** default value: `+"${weechat_data_dir}/plugins"+` * [[option_weechat.plugin.save_config_on_unload]] *weechat.plugin.save_config_on_unload* ** description: pass:none[save configuration files when unloading plugins] @@ -1451,10 +1451,10 @@ ** default value: `+""+` * [[option_logger.file.path]] *logger.file.path* -** description: pass:none[path for WeeChat log files; "%h" at beginning of string is replaced by WeeChat home ("~/.weechat" by default); date specifiers are permitted (see man strftime) (note: content is evaluated, see /help eval)] +** description: pass:none[path for WeeChat log files; date specifiers are permitted (see man strftime) (path is evaluated, see function string_eval_path_home in plugin API reference)] ** type: string ** values: any string -** default value: `+"%h/logs/"+` +** default value: `+"${weechat_data_dir}/logs"+` * [[option_logger.file.replacement_char]] *logger.file.replacement_char* ** description: pass:none[replacement char for special chars in filename built with mask (like directory delimiter)] @@ -1827,10 +1827,10 @@ ** 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)] +** description: pass:none[path for FIFO file; WeeChat PID can be used in path with ${info:pid} (path is evaluated, see function string_eval_path_home in plugin API reference)] ** type: string ** values: any string -** default value: `+"%h/weechat_fifo"+` +** default value: `+"${weechat_runtime_dir}/weechat_fifo_${info:pid}"+` // end::fifo_options[] // tag::xfer_options[] @@ -1931,10 +1931,10 @@ ** default value: `+on+` * [[option_xfer.file.download_path]] *xfer.file.download_path* -** description: pass:none[path for writing incoming files: "%h" at beginning of string is replaced by WeeChat home ("~/.weechat" by default) (note: content is evaluated, see /help eval)] +** description: pass:none[path for writing incoming files (path is evaluated, see function string_eval_path_home in plugin API reference)] ** type: string ** values: any string -** default value: `+"%h/xfer"+` +** default value: `+"${weechat_data_dir}/xfer"+` * [[option_xfer.file.download_temporary_suffix]] *xfer.file.download_temporary_suffix* ** description: pass:none[temporary filename suffix used during the transfer for a file received, it is removed after successful transfer; if empty string, no filename suffix is used during the transfer] @@ -1943,7 +1943,7 @@ ** default value: `+".part"+` * [[option_xfer.file.upload_path]] *xfer.file.upload_path* -** description: pass:none[path for reading files when sending (when no path is specified by user): "%h" at beginning of string is replaced by WeeChat home ("~/.weechat" by default) (note: content is evaluated, see /help eval)] +** description: pass:none[path for reading files when sending (path is evaluated, see function string_eval_path_home in plugin API reference)] ** type: string ** values: any string ** default value: `+"~"+` @@ -2743,7 +2743,7 @@ ** default value: `+continue+` * [[option_irc.server_default.sasl_key]] *irc.server_default.sasl_key* -** description: pass:none[file with ECC private key for mechanism "ecdsa-nist256p-challenge" ("%h" will be replaced by WeeChat home, "~/.weechat" by default)] +** description: pass:none[file with ECC private key for mechanism "ecdsa-nist256p-challenge" (path is evaluated, see function string_eval_path_home in plugin API reference)] ** type: string ** values: any string ** default value: `+""+` @@ -2785,7 +2785,7 @@ ** default value: `+off+` * [[option_irc.server_default.ssl_cert]] *irc.server_default.ssl_cert* -** description: pass:none[SSL certificate file used to automatically identify your nick ("%h" will be replaced by WeeChat home, "~/.weechat" by default)] +** description: pass:none[SSL certificate file used to automatically identify your nick (path is evaluated, see function string_eval_path_home in plugin API reference)] ** type: string ** values: any string ** default value: `+""+` @@ -3009,10 +3009,10 @@ ** default value: `+100000+` * [[option_relay.network.ssl_cert_key]] *relay.network.ssl_cert_key* -** description: pass:none[file with SSL certificate and private key (for serving clients with SSL)] +** description: pass:none[file with SSL certificate and private key (for serving clients with SSL) (path is evaluated, see function string_eval_path_home in plugin API reference)] ** type: string ** values: any string -** default value: `+"%h/ssl/relay.pem"+` +** default value: `+"${weechat_config_dir}/ssl/relay.pem"+` * [[option_relay.network.ssl_priorities]] *relay.network.ssl_priorities* ** description: pass:none[string with priorities for gnutls (for syntax, see documentation of function gnutls_priority_init in gnutls manual, common strings are: "PERFORMANCE", "NORMAL", "SECURE128", "SECURE256", "EXPORT", "NONE")] @@ -3393,10 +3393,10 @@ ** default value: `+""+` * [[option_script.scripts.path]] *script.scripts.path* -** description: pass:none[local cache directory for scripts; "%h" at beginning of string is replaced by WeeChat home ("~/.weechat" by default) (note: content is evaluated, see /help eval)] +** description: pass:none[local cache directory for scripts (path is evaluated, see function string_eval_path_home in plugin API reference)] ** type: string ** values: any string -** default value: `+"%h/script"+` +** default value: `+"${weechat_cache_dir}/script"+` * [[option_script.scripts.url]] *script.scripts.url* ** description: pass:none[URL for file with list of scripts] |