summaryrefslogtreecommitdiff
path: root/doc/en/autogen/user/logger_options.txt
blob: 57efc30a4d7e717f83fb490b82ebdea54c820d55 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
* [[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 underline (default value: `darkgray`)

* [[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 underline (default value: `darkgray`)

* [[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.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`)