Skip to content

Latest commit

 

History

History
93 lines (79 loc) · 4.63 KB

logger_options.adoc

File metadata and controls

93 lines (79 loc) · 4.63 KB
  • 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

  • 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

  • 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

  • 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

  • logger.file.fsync

    • description: use fsync to synchronize the log file with the storage device after the flush (see man fsync); this is slower but should prevent any data loss in case of power failure during the save of log file

    • type: boolean

    • values: on, off

    • default value: off

  • 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

  • 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 (you should use only variables that are defined on all buffers, so for example you should NOT use $server nor $channel); date specifiers are permitted (see man strftime)

    • type: string

    • values: any string

    • default value: "$plugin.$name.weechatlog"

  • logger.file.name_lower_case

    • description: use only lower case for log filenames

    • type: boolean

    • values: on, off

    • default value: on

  • logger.file.nick_prefix

    • description: text to write before nick in prefix of message, example: "<"

    • type: string

    • values: any string

    • default value: ""

  • logger.file.nick_suffix

    • description: text to write after nick in prefix of message, example: ">"

    • type: string

    • values: any string

    • default value: ""

  • 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) (note: content is evaluated, see /help eval)

    • type: string

    • values: any string

    • default value: "%h/logs/"

  • 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: "_"

  • 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"

  • 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

  • logger.look.backlog_conditions

    • description: conditions to display the backlog (note: content is evaluated, see /help eval); empty value displays the backlog on all buffers; for example to display backlog on private buffers only: "${type} == private"

    • type: string

    • values: any string

    • default value: ""