diff options
author | Sebastien Helleu <flashcode@flashtux.org> | 2008-11-06 18:55:43 +0100 |
---|---|---|
committer | Sebastien Helleu <flashcode@flashtux.org> | 2008-11-06 18:55:43 +0100 |
commit | 9498a777ad557261f0ebdf94467d4cfe2b033b07 (patch) | |
tree | 0760e42b02af337e4b8b231f570aecfde6bc6144 /doc/en/autogen/logger_options.xml | |
parent | 2204935f3e1962a11c5e7cf3d1c56261c2d63d06 (diff) | |
download | weechat-9498a777ad557261f0ebdf94467d4cfe2b033b07.zip |
Add doc for default plugins in user guide
Diffstat (limited to 'doc/en/autogen/logger_options.xml')
-rw-r--r-- | doc/en/autogen/logger_options.xml | 70 |
1 files changed, 14 insertions, 56 deletions
diff --git a/doc/en/autogen/logger_options.xml b/doc/en/autogen/logger_options.xml index b97418293..3c9d39793 100644 --- a/doc/en/autogen/logger_options.xml +++ b/doc/en/autogen/logger_options.xml @@ -6,115 +6,73 @@ docgen.pl builds XML doc files to include in many languages --> -<command>logger.file.auto_log</command> +<command>logger.file.auto_log</command>: automatically save content of buffers to files (unless a buffer disables log) <itemizedlist> <listitem> - <para>description: automatically save content of buffers to files (unless a buffer disables log)</para> - </listitem> - <listitem> <para>type: boolean</para> </listitem> <listitem> - <para>values: on, off</para> - </listitem> - <listitem> - <para>default value: on</para> + <para>values: on, off (default value: on)</para> </listitem> </itemizedlist> -<command>logger.file.info_lines</command> +<command>logger.file.info_lines</command>: write information line in log file when log starts or ends for a buffer <itemizedlist> <listitem> - <para>description: write information line in log file when log starts or ends for a buffer</para> - </listitem> - <listitem> <para>type: boolean</para> </listitem> <listitem> - <para>values: on, off</para> - </listitem> - <listitem> - <para>default value: off</para> + <para>values: on, off (default value: off)</para> </listitem> </itemizedlist> -<command>logger.file.mask</command> +<command>logger.file.mask</command>: default file name mask for log files (format is 'directory/to/file' or 'file', without first '/' because 'path' option is used to build complete path to file); local buffer variables are permitted <itemizedlist> <listitem> - <para>description: default file name mask for log files (format is 'directory/to/file' or 'file', without first '/' because 'path' option is used to build complete path to file); local buffer variables are permitted</para> - </listitem> - <listitem> <para>type: string</para> </listitem> <listitem> - <para>values: any string</para> - </listitem> - <listitem> - <para>default value: '$plugin.$name.weechatlog'</para> + <para>values: any string (default value: '$plugin.$name.weechatlog')</para> </listitem> </itemizedlist> -<command>logger.file.name_lower_case</command> +<command>logger.file.name_lower_case</command>: use only lower case for log filenames <itemizedlist> <listitem> - <para>description: use only lower case for log filenames</para> - </listitem> - <listitem> <para>type: boolean</para> </listitem> <listitem> - <para>values: on, off</para> - </listitem> - <listitem> - <para>default value: on</para> + <para>values: on, off (default value: on)</para> </listitem> </itemizedlist> -<command>logger.file.path</command> +<command>logger.file.path</command>: path for WeeChat log files ('%h' will be replaced by WeeChat home, ~/.weechat by default) <itemizedlist> <listitem> - <para>description: path for WeeChat log files ('%h' will be replaced by WeeChat home, ~/.weechat by default)</para> - </listitem> - <listitem> <para>type: string</para> </listitem> <listitem> - <para>values: any string</para> - </listitem> - <listitem> - <para>default value: '%h/logs/'</para> + <para>values: any string (default value: '%h/logs/')</para> </listitem> </itemizedlist> -<command>logger.file.time_format</command> +<command>logger.file.time_format</command>: timestamp used in log files (see man strftime for date/time specifiers) <itemizedlist> <listitem> - <para>description: timestamp used in log files (see man strftime for date/time specifiers)</para> - </listitem> - <listitem> <para>type: string</para> </listitem> <listitem> - <para>values: any string</para> - </listitem> - <listitem> - <para>default value: '%Y-%m-%d %H:%M:%S'</para> + <para>values: any string (default value: '%Y-%m-%d %H:%M:%S')</para> </listitem> </itemizedlist> -<command>logger.look.backlog</command> +<command>logger.look.backlog</command>: maximum number of lines to display from log file when creating new buffer (0 = no backlog) <itemizedlist> <listitem> - <para>description: maximum number of lines to display from log file when creating new buffer (0 = no backlog)</para> - </listitem> - <listitem> <para>type: integer</para> </listitem> <listitem> - <para>values: 0 .. 2147483647</para> - </listitem> - <listitem> - <para>default value: 20</para> + <para>values: 0 .. 2147483647 (default value: 20)</para> </listitem> </itemizedlist> |