tlog-rec(5)                   File Formats Manual                  tlog-rec(5)

NAME
       tlog-rec.conf - tlog-rec configuration file

DESCRIPTION
       tlog-rec.conf is a JSON-format configuration file for tlog-rec program.
       Contrary to the strict JSON specification, both C and  C++  style  com‐
       ments are allowed in the file.

       The  file must contain a single JSON object with the objects and fields
       described below.  Almost all of them are optional and assume a  default
       value.  However, those that do require a value can still be omitted and
       specified to tlog-rec in other ways: through environment  variables  or
       command line.

OBJECTS AND FIELDS
   Root object
       shell (string)
              The path to the shell executable that should be spawned.

              Default: "/bin/bash"

       notice (string)
              A  message  which  will be printed before starting recording and
              the user shell. Can be used to warn the user that the session is
              recorded.

              Default: "\nATTENTION! Your session is being recorded!\n\n"

       latency (integer)
              The  data  which does not exceed maximum payload stays in memory
              and is not logged until this number of seconds elapses.

              Minimum: 1
              Default: 10

       payload (integer)
              Maximum encoded data (payload) size per message, bytes.  As soon
              as  payload exceeds this number of bytes, it is formatted into a
              message and logged.

              Minimum: 32
              Default: 2048

       log (object)
              Logged data set object, see below.

       writer (string)
              The type of "log writer" to use for logging. The writer needs to
              be configured using its dedicated parameters.

              One of: "syslog", "file"
              Default: "syslog"

       file (object)
              File writer object, see below.

       syslog (object)
              Syslog writer object, see below.

   log - Logged data set object
       input (boolean)
              If specified as true, user input is logged.

              Default: true

       output (boolean)
              If specified as true, terminal output is logged.

              Default: true

       window (boolean)
              If specified as true, terminal window size changes are logged.

              Default: true

   file - File writer object
       path (string)
              The "file" writer log file path.

              No default.

   syslog - Syslog writer object
       facility (string)
              Syslog facility the "syslog" writer should use for the messages.

              One  of:  "auth",  "authpriv",  "cron", "daemon", "ftp", "kern",
              "local0",  "local1",  "local2",  "local3",  "local4",  "local5",
              "local6",  "local7",  "lpr",  "mail",  "news", "syslog", "user",
              "uucp"
              Default: "authpriv"

       priority (string)
              Syslog priority the "syslog" writer should use for the messages.

              One of: "emerg", "alert", "crit",  "err",  "warning",  "notice",
              "info", "debug"
              Default: "info"

EXAMPLES
       A config specifying only a shell:

              {
                  "shell": "/usr/bin/zsh"
              }

       A config disabling logging user input:

              {
                  "log": {
                      "input": false
                  }
              }

       A config specifying logging to a file:

              {
                  "writer": "file"
                  "file" : {
                      "path": "/var/log/tlog-rec.log"
                  }
              }

SEE ALSO
       tlog-rec(8), http://json.org/

AUTHOR
       Nikolai Kondrashov <spbnick@gmail.com>

Tlog                             February 2016                     tlog-rec(5)