diff options
author | Sébastien Helleu <flashcode@flashtux.org> | 2014-05-25 12:25:58 +0200 |
---|---|---|
committer | Sébastien Helleu <flashcode@flashtux.org> | 2014-05-25 12:47:24 +0200 |
commit | dc0229617ada67fd02815bbc94b245871248b9db (patch) | |
tree | 0af7418d7f3ebf8082408fa2ee9e73f5a572360f /doc/en/autogen/user/logger_options.asciidoc | |
parent | 76a066c9cca620e1204815f63abbfa8b09f162c6 (diff) | |
download | weechat-dc0229617ada67fd02815bbc94b245871248b9db.zip |
doc: use .asciidoc extension instead of .txt for doc files
Diffstat (limited to 'doc/en/autogen/user/logger_options.asciidoc')
-rw-r--r-- | doc/en/autogen/user/logger_options.asciidoc | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/en/autogen/user/logger_options.asciidoc b/doc/en/autogen/user/logger_options.asciidoc new file mode 100644 index 000000000..7378d57ab --- /dev/null +++ b/doc/en/autogen/user/logger_options.asciidoc @@ -0,0 +1,65 @@ +* [[option_logger.color.backlog_end]] *logger.color.backlog_end* +** description: `color for line ending the backlog` +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline (default value: `default`) + +* [[option_logger.color.backlog_line]] *logger.color.backlog_line* +** description: `color for backlog lines` +** type: color +** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "/" for italic, "_" for underline (default value: `default`) + +* [[option_logger.file.auto_log]] *logger.file.auto_log* +** description: `automatically save content of buffers to files (unless a buffer disables log)` +** type: boolean +** values: on, off (default value: `on`) + +* [[option_logger.file.flush_delay]] *logger.file.flush_delay* +** description: `number of seconds between flush of log files (0 = write in log files immediately for each line printed)` +** type: integer +** values: 0 .. 3600 (default value: `120`) + +* [[option_logger.file.info_lines]] *logger.file.info_lines* +** description: `write information line in log file when log starts or ends for a buffer` +** type: boolean +** values: on, off (default value: `off`) + +* [[option_logger.file.mask]] *logger.file.mask* +** 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; date specifiers are permitted (see man strftime)` +** type: string +** values: any string (default value: `"$plugin.$name.weechatlog"`) + +* [[option_logger.file.name_lower_case]] *logger.file.name_lower_case* +** description: `use only lower case for log filenames` +** type: boolean +** values: on, off (default value: `on`) + +* [[option_logger.file.nick_prefix]] *logger.file.nick_prefix* +** description: `text to write before nick in prefix of message, example: "<"` +** type: string +** values: any string (default value: `""`) + +* [[option_logger.file.nick_suffix]] *logger.file.nick_suffix* +** description: `text to write after nick in prefix of message, example: ">"` +** type: string +** values: any string (default value: `""`) + +* [[option_logger.file.path]] *logger.file.path* +** description: `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)` +** type: string +** values: any string (default value: `"%h/logs/"`) + +* [[option_logger.file.replacement_char]] *logger.file.replacement_char* +** description: `replacement char for special chars in filename built with mask (like directory delimiter)` +** type: string +** values: any string (default value: `"_"`) + +* [[option_logger.file.time_format]] *logger.file.time_format* +** description: `timestamp used in log files (see man strftime for date/time specifiers)` +** type: string +** values: any string (default value: `"%Y-%m-%d %H:%M:%S"`) + +* [[option_logger.look.backlog]] *logger.look.backlog* +** description: `maximum number of lines to display from log file when creating new buffer (0 = no backlog)` +** type: integer +** values: 0 .. 2147483647 (default value: `20`) + |