tntnet.properties(7)

1tntnet.properties(7)          Tntnet users guide          tntnet.properties(7)
2
3
4

NAME

6       tntnet.properties - configuration-file for tntnet (8)
7
8

DESCRIPTION

10       tntnet(8) uses cxxtools for logging and is configured in the configura‐
11       tion-file tntnet.properties.
12
13       Because cxxtools is a meta-logging-library, which can  be  compiled  to
14       use  different  logging-libraries,  the content of tntnet.properties is
15       dependend of the underlying logging-library.  Cxxtool  has  a  built-in
16       logging-library as default, which is documented here.
17
18
19   format
20       The  format  of  tntnet.properties is line-based.  A line consists of a
21       variable-name followed by a equals-symbol and a  value.   Lines,  which
22       does not follow this format and lines, which start with a hash (#), are
23       ignored.  It is recomended to prefix non-empty comments with a hash  to
24       make clear, that it is a comment.
25
26
27   level
28       The  logging-library has 5 levels for logging: fatal, error, warn, info
29       and debug.  Fatal has the highers priority and "debug" the lowest.
30
31
32   category
33       Each log-message has a category.  Categories are  hierarchical.   Names
34       of subcategories are devided by a dot.
35
36
37   log-message
38       Each  log-message has a level and a category.  If the level of the mes‐
39       sage is higher or equal to the level of the category,  the  message  is
40       logged.  To assign a level to a category put a line with the word "log‐
41       ger", a dot, the category, the symbol "=" and the  category  into  tnt‐
42       net.properties.  Only the first letter of the value is checked and case
43       is ignored, so e.g. info can be specified with INFO, info,  I  or  even
44       ixxxx.   If  no  level is specified for the current category, the upper
45       category is checked.  If nothing is found, the default level  is  used.
46       The  default  level  is  specified by the variable "rootLogger".  If no
47       rootLogger is specified, the level error is used.
48
49
50   destination
51       If nothing else is specified, log-messages are printed to standard-out‐
52       put.  To redirect output to a file, specify the filename with the vari‐
53       able file.
54
55       The cxxtools-logger can limit the size of the log-file by rolling  log-
56       files.  If the limit is reached, the current file is renamed by append‐
57       ing ".1" to it.  If there is already a file with that name,  this  file
58       is  renamed  to  "*.2" and so on, until the maximum backupfile limit is
59       reached.  The oldest file is deleted then.  To specify the maximum file
60       size,  set  the  variable maxfilesize.  The value specified here can be
61       postfixed with 'k' or 'M' to specify kBytes  or  MBytes.   The  maximum
62       fileindex backed up is set with maxbackupindex.
63
64       Log-messages can be sent to another host in the network with udp.  This
65       is done by specifying a hostname and a port  with  the  variable  host.
66       The  value must be a hostname, followed by a ':' and a port.  Each log-
67       message is sent in a single udp-message.
68
69

EXAMPLES

71   logging to standard-output:
72              rootLogger=INFO
73              logger.tntnet=WARN
74
75   logging to a file with rolling file and a background-flusher:
76              rootLogger=INFO
77              logger.tntnet=WARN
78              file=tntnet.log
79              maxfilesize=1MB
80              maxbackupindex=10
81
82   logging to another host
83              rootLogger=INFO
84              logger.tntnet=WARN
85              host=pluto.tntnet.org:1234
86
87

AUTHOR

89       This manual page was written by Tommi Mäkitalo <tommi@tntnet.org>.
90
91

NAME

DESCRIPTION

EXAMPLES

AUTHOR

SEE ALSO