diff options
Diffstat (limited to 'doc/en')
| -rw-r--r-- | doc/en/autogen/user/guile_options.adoc | 9 | ||||
| -rw-r--r-- | doc/en/autogen/user/javascript_options.adoc | 9 | ||||
| -rw-r--r-- | doc/en/autogen/user/lua_options.adoc | 9 | ||||
| -rw-r--r-- | doc/en/autogen/user/perl_options.adoc | 9 | ||||
| -rw-r--r-- | doc/en/autogen/user/php_options.adoc | 9 | ||||
| -rw-r--r-- | doc/en/autogen/user/python_options.adoc | 9 | ||||
| -rw-r--r-- | doc/en/autogen/user/ruby_options.adoc | 9 | ||||
| -rw-r--r-- | doc/en/autogen/user/tcl_options.adoc | 9 | ||||
| -rw-r--r-- | doc/en/weechat.1.en.adoc | 24 | ||||
| -rw-r--r-- | doc/en/weechat_dev.en.adoc | 1 | ||||
| -rw-r--r-- | doc/en/weechat_user.en.adoc | 164 |
11 files changed, 243 insertions, 18 deletions
diff --git a/doc/en/autogen/user/guile_options.adoc b/doc/en/autogen/user/guile_options.adoc new file mode 100644 index 000000000..e0ad87642 --- /dev/null +++ b/doc/en/autogen/user/guile_options.adoc @@ -0,0 +1,9 @@ +// +// This file is auto-generated by script docgen.py. +// DO NOT EDIT BY HAND! +// +* [[option_guile.look.check_license]] *guile.look.check_license* +** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] +** type: boolean +** values: on, off +** default value: `+off+` diff --git a/doc/en/autogen/user/javascript_options.adoc b/doc/en/autogen/user/javascript_options.adoc new file mode 100644 index 000000000..9b8e69c58 --- /dev/null +++ b/doc/en/autogen/user/javascript_options.adoc @@ -0,0 +1,9 @@ +// +// This file is auto-generated by script docgen.py. +// DO NOT EDIT BY HAND! +// +* [[option_javascript.look.check_license]] *javascript.look.check_license* +** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] +** type: boolean +** values: on, off +** default value: `+off+` diff --git a/doc/en/autogen/user/lua_options.adoc b/doc/en/autogen/user/lua_options.adoc new file mode 100644 index 000000000..7f2700edc --- /dev/null +++ b/doc/en/autogen/user/lua_options.adoc @@ -0,0 +1,9 @@ +// +// This file is auto-generated by script docgen.py. +// DO NOT EDIT BY HAND! +// +* [[option_lua.look.check_license]] *lua.look.check_license* +** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] +** type: boolean +** values: on, off +** default value: `+off+` diff --git a/doc/en/autogen/user/perl_options.adoc b/doc/en/autogen/user/perl_options.adoc new file mode 100644 index 000000000..97331f993 --- /dev/null +++ b/doc/en/autogen/user/perl_options.adoc @@ -0,0 +1,9 @@ +// +// This file is auto-generated by script docgen.py. +// DO NOT EDIT BY HAND! +// +* [[option_perl.look.check_license]] *perl.look.check_license* +** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] +** type: boolean +** values: on, off +** default value: `+off+` diff --git a/doc/en/autogen/user/php_options.adoc b/doc/en/autogen/user/php_options.adoc new file mode 100644 index 000000000..6a7828228 --- /dev/null +++ b/doc/en/autogen/user/php_options.adoc @@ -0,0 +1,9 @@ +// +// This file is auto-generated by script docgen.py. +// DO NOT EDIT BY HAND! +// +* [[option_php.look.check_license]] *php.look.check_license* +** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] +** type: boolean +** values: on, off +** default value: `+off+` diff --git a/doc/en/autogen/user/python_options.adoc b/doc/en/autogen/user/python_options.adoc new file mode 100644 index 000000000..6511fc0d3 --- /dev/null +++ b/doc/en/autogen/user/python_options.adoc @@ -0,0 +1,9 @@ +// +// This file is auto-generated by script docgen.py. +// DO NOT EDIT BY HAND! +// +* [[option_python.look.check_license]] *python.look.check_license* +** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] +** type: boolean +** values: on, off +** default value: `+off+` diff --git a/doc/en/autogen/user/ruby_options.adoc b/doc/en/autogen/user/ruby_options.adoc new file mode 100644 index 000000000..c769ecd0d --- /dev/null +++ b/doc/en/autogen/user/ruby_options.adoc @@ -0,0 +1,9 @@ +// +// This file is auto-generated by script docgen.py. +// DO NOT EDIT BY HAND! +// +* [[option_ruby.look.check_license]] *ruby.look.check_license* +** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] +** type: boolean +** values: on, off +** default value: `+off+` diff --git a/doc/en/autogen/user/tcl_options.adoc b/doc/en/autogen/user/tcl_options.adoc new file mode 100644 index 000000000..9ce96a0dd --- /dev/null +++ b/doc/en/autogen/user/tcl_options.adoc @@ -0,0 +1,9 @@ +// +// This file is auto-generated by script docgen.py. +// DO NOT EDIT BY HAND! +// +* [[option_tcl.look.check_license]] *tcl.look.check_license* +** description: pass:none[check the license of scripts when they are loaded: if the license is different from the plugin license, a warning is displayed] +** type: boolean +** values: on, off +** default value: `+off+` diff --git a/doc/en/weechat.1.en.adoc b/doc/en/weechat.1.en.adoc index 3a5b9dc62..ee4e5ab58 100644 --- a/doc/en/weechat.1.en.adoc +++ b/doc/en/weechat.1.en.adoc @@ -79,18 +79,42 @@ $HOME/.weechat/fifo.conf:: $HOME/.weechat/fset.conf:: configuration file for _fset_ plugin +$HOME/.weechat/guile.conf:: + configuration file for _guile_ plugin + $HOME/.weechat/irc.conf:: configuration file for _irc_ plugin +$HOME/.weechat/javascript.conf:: + configuration file for _javascript_ plugin + $HOME/.weechat/logger.conf:: configuration file for _logger_ plugin +$HOME/.weechat/lua.conf:: + configuration file for _lua_ plugin + +$HOME/.weechat/perl.conf:: + configuration file for _perl_ plugin + +$HOME/.weechat/php.conf:: + configuration file for _php_ plugin + +$HOME/.weechat/python.conf:: + configuration file for _python_ plugin + $HOME/.weechat/relay.conf:: configuration file for _relay_ plugin +$HOME/.weechat/ruby.conf:: + configuration file for _ruby_ plugin + $HOME/.weechat/script.conf:: configuration file for _script_ plugin +$HOME/.weechat/tcl.conf:: + configuration file for _tcl_ plugin + $HOME/.weechat/trigger.conf:: configuration file for _trigger_ plugin diff --git a/doc/en/weechat_dev.en.adoc b/doc/en/weechat_dev.en.adoc index 0afb8b614..ab8296e61 100644 --- a/doc/en/weechat_dev.en.adoc +++ b/doc/en/weechat_dev.en.adoc @@ -183,6 +183,7 @@ WeeChat "core" is located in following directories: | plugin-config.c | Plugin configuration options (file plugins.conf). | plugin-script.c | Common functions used by script plugins. | plugin-script-api.c | Script API functions: wrappers around some plugin API functions. +| plugin-script-config.c | Script plugin configuration options (files python.conf, perl.conf, ...). | weechat-plugin.h | Header designed to be distributed with WeeChat plugins, in order to compile them. | alias/ | Alias plugin. | alias.c | Main alias functions. diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc index 1cb7a8c0b..acff003e8 100644 --- a/doc/en/weechat_user.en.adoc +++ b/doc/en/weechat_user.en.adoc @@ -556,24 +556,32 @@ The files in the WeeChat home directory are: [width="100%",cols="1m,3,6",options="header"] |=== -| File | Description | Sensitive data -| weechat.conf | Main WeeChat configuration file | Possible (example: list of channels in a saved buffers layout). -| sec.conf | Configuration file with secured data | *Yes, highly sensitive*: this file must never be shared with anyone. -| plugins.conf | Plugins configuration file | Possible, depends on plugins/scripts. -| alias.conf | Configuration file for _alias_ plugin | Possible, depends on aliases. -| aspell.conf | Configuration file for _aspell_ plugin | No. -| buflist.conf | Configuration file for _buflist_ plugin | No. -| charset.conf | Configuration file for _charset_ plugin | No. -| exec.conf | Configuration file for _exec_ plugin | No. -| fifo.conf | Configuration file for _fifo_ plugin | No. -| fset.conf | Configuration file for _fset_ plugin | No. -| irc.conf | Configuration file for _irc_ plugin | *Yes*: it can contain passwords for servers, nickserv and channels (if not stored in `sec.conf`). -| logger.conf | Configuration file for _logger_ plugin | No. -| relay.conf | Configuration file for _relay_ plugin | No. -| script.conf | Configuration file for _script_ plugin | No. -| trigger.conf | Configuration file for _trigger_ plugin | Possible, depends on triggers. -| xfer.conf | Configuration file for _xfer_ plugin | No. -| weechat.log | WeeChat log file | No. +| File | Description | Sensitive data +| weechat.conf | Main WeeChat configuration file | Possible (example: list of channels in a saved buffers layout). +| sec.conf | Configuration file with secured data | *Yes, highly sensitive*: this file must never be shared with anyone. +| plugins.conf | Plugins configuration file | Possible, depends on plugins/scripts. +| alias.conf | Configuration file for _alias_ plugin | Possible, depends on aliases. +| aspell.conf | Configuration file for _aspell_ plugin | No. +| buflist.conf | Configuration file for _buflist_ plugin | No. +| charset.conf | Configuration file for _charset_ plugin | No. +| exec.conf | Configuration file for _exec_ plugin | No. +| fifo.conf | Configuration file for _fifo_ plugin | No. +| fset.conf | Configuration file for _fset_ plugin | No. +| guile.conf | Configuration file for _guile_ plugin | No. +| irc.conf | Configuration file for _irc_ plugin | *Yes*: it can contain passwords for servers, nickserv and channels (if not stored in `sec.conf`). +| javascript.conf | Configuration file for _javascript_ plugin | No. +| logger.conf | Configuration file for _logger_ plugin | No. +| lua.conf | Configuration file for _lua_ plugin | No. +| perl.conf | Configuration file for _perl_ plugin | No. +| php.conf | Configuration file for _php_ plugin | No. +| python.conf | Configuration file for _python_ plugin | No. +| relay.conf | Configuration file for _relay_ plugin | No. +| ruby.conf | Configuration file for _ruby_ plugin | No. +| script.conf | Configuration file for _script_ plugin | No. +| tcl.conf | Configuration file for _tcl_ plugin | No. +| trigger.conf | Configuration file for _trigger_ plugin | Possible, depends on triggers. +| xfer.conf | Configuration file for _xfer_ plugin | No. +| weechat.log | WeeChat log file | No. |=== [IMPORTANT] @@ -3346,6 +3354,126 @@ Options: include::autogen/user/script_options.adoc[] +[[python_options]] +==== Python options + +Sections in file _python.conf_: + +[width="100%",cols="3m,6m,16",options="header"] +|=== +| Section | Control command | Description +| look | /set python.look.* | Look and feel. +|=== + +Options: + +include::autogen/user/python_options.adoc[] + +[[perl_options]] +==== Perl options + +Sections in file _perl.conf_: + +[width="100%",cols="3m,6m,16",options="header"] +|=== +| Section | Control command | Description +| look | /set perl.look.* | Look and feel. +|=== + +Options: + +include::autogen/user/perl_options.adoc[] + +[[ruby_options]] +==== Ruby options + +Sections in file _ruby.conf_: + +[width="100%",cols="3m,6m,16",options="header"] +|=== +| Section | Control command | Description +| look | /set ruby.look.* | Look and feel. +|=== + +Options: + +include::autogen/user/ruby_options.adoc[] + +[[lua_options]] +==== Lua options + +Sections in file _lua.conf_: + +[width="100%",cols="3m,6m,16",options="header"] +|=== +| Section | Control command | Description +| look | /set lua.look.* | Look and feel. +|=== + +Options: + +include::autogen/user/lua_options.adoc[] + +[[tcl_options]] +==== Tcl options + +Sections in file _tcl.conf_: + +[width="100%",cols="3m,6m,16",options="header"] +|=== +| Section | Control command | Description +| look | /set tcl.look.* | Look and feel. +|=== + +Options: + +include::autogen/user/tcl_options.adoc[] + +[[guile_options]] +==== Guile options + +Sections in file _guile.conf_: + +[width="100%",cols="3m,6m,16",options="header"] +|=== +| Section | Control command | Description +| look | /set guile.look.* | Look and feel. +|=== + +Options: + +include::autogen/user/guile_options.adoc[] + +[[javascript_options]] +==== Javascript options + +Sections in file _javascript.conf_: + +[width="100%",cols="3m,6m,16",options="header"] +|=== +| Section | Control command | Description +| look | /set javascript.look.* | Look and feel. +|=== + +Options: + +include::autogen/user/javascript_options.adoc[] + +[[php_options]] +==== PHP options + +Sections in file _php.conf_: + +[width="100%",cols="3m,6m,16",options="header"] +|=== +| Section | Control command | Description +| look | /set php.look.* | Look and feel. +|=== + +Options: + +include::autogen/user/php_options.adoc[] + [[trigger_plugin]] === Trigger |