man/man8/syslogd.8

   1 .\" Copyright 1994 Dr. Greg Wettstein, Enjellic Systems Development.
   2 .\" May be distributed under the GNU General Public License
   3 .\" Sun Aug 30 11:35:55 MET: Martin Schulze: Updates
   4 .\"
   5 .\" from SYSKLOGD 8 "13 December 1995" "Version 1.3" "Linux System Administration"
   6 .\" Modified for Minix porting by G. Falzoni <gfalzoni@inwind.it>
   7 .\"
   8 .\" Local macros
   9 .de Xr
  10 .BR \\$1 (\\$2)\\$3
  11 ..
  12 .de LB
  13 .TP \\$1
  14 \\fB\\$2\\fR
  15 \\$3
  16 ..
  17 .de LI
  18 .TP \\$1
  19 \\fI\\$2\\fR
  20 \\$3
  21 ..
  22 .de LR
  23 .TP \\$1
  24 \\fR\\$2\\fR
  25 \\$3
  26 ..
  27 .\" end local macros
  28 .TH SYSLOGD 8 "Jan. 23, 2000"
  29 .SH NAME
  30 .PP
  31 syslogd \- system logging daemon.
  32 .SH SYNOPSIS
  33 .PP
  34 .B syslogd
  35 .RB [ " \-d " ]
  36 .RB [ " \-f "
  37 .I config file
  38 ]
  39 .RB [ " \-m "
  40 .I interval
  41 ]
  42 .RB [ " \-p"
  43 .IB port
  44 ]
  45 .RB [ " \-v " ]
  46 .LP
  47 .SH DESCRIPTION
  48 .PP
  49 System logging is provided by a version of
  50 .BR syslogd (8)
  51 derived from the
  52 stock BSD sources.
  53 .B Syslogd
  54 provides the kind of logging that many modern programs use. Every logged
  55 message contains at least a time, a hostname field and a
  56 program name field, but that depends on how trusty the logging
  57 program is.
  58 .PP
  59 While the syslogd sources have been heavily modified a couple of notes
  60 are necessary.  First of all there has been a systematic attempt to
  61 insure that syslogd follows the default, standard BSD behavior.
  62 The second important concept to note is that this version of syslogd
  63 interacts transparently with the version of syslog found in the
  64 standard libraries, so you must insure that the correct versions are installed.
  65 .PP
  66 The main configuration file
  67 .I /etc/syslog.conf
  68 or an alternative file, given with the
  69 .B "\-f"
  70 option, is read at startup.  Any line that begins with the hash mark
  71 (``#'') and empty lines are ignored. If an error occurs during parsing
  72 the whole line is ignored.
  73 .SH OPTIONS
  74 .PP
  75 .LB 9 "-d" "Turns on debug mode.
  76 When using debug mode, the daemon will not proceed to
  77 .BR fork (2)
  78 to set itself in the background, but will stay in the
  79 foreground and write much debug information on the current tty. See the
  80 DEBUGGING section for more information.
  81 .LB 9 "\-f config file" "Specify an alternative configuration file instead of
  82 .IR /etc/syslog.conf ","
  83 which is the default.
  84 .LB 9 "\-m interval" "The syslogd logs a mark timestamp regularly. The default
  85 .I interval
  86 between two
  87 .I \-\- MARK \-\-
  88 lines is 20 minutes. This can be changed with this option.
  89 .LB 9 "\-p port" "You can specify an alternative port instead of
  90 .I syslog/udp
  91 default service.
  92 .LB 9 "\-v" "Print version and exit.
  93 .SH SIGNALS
  94 .PP
  95 .B Syslogd
  96 reacts to a set of signals. You may easily send a signal to it
  97 using the following:
  98 .IP
  99 kill -SIGNAL `cat /usr/run/syslogd.pid`
 100 .LB 9 SIGHUP "This lets syslogd perform a re-initialization.
 101 All open files are closed, the configuration file (default
 102 is '/etc/syslog.conf') will be reread.
 103 .LB 9 SIGTERM "The syslogd will die.
 104 .LB 9 "SIGINT SIGQUIT" "If debugging is enabled these are ignored, otherwise
 105 syslogd will die.
 106 .LB 9 SIGALRM "Every time syslogd receives this signal it will log
 107 the mark line.  Normally this is done by
 108 .Xr alarm 2 .
 109 .SH CONFIGURATION FILE SYNTAX DIFFERENCES
 110 .PP
 111 .B Syslogd
 112 uses a slightly different syntax for its configuration file than
 113 the original BSD sources. Originally all messages of a specific priority
 114 and above were forwarded to the log file.
 115 .PP
 116 For example see the following sample file
 117 .IP
 118 ## Sample syslog.conf
 119
 120 ##  Emergency messages (system may be unusable)
 121 .br
 122 *.emerg                                 *
 123 .br
 124 *.alert                                 /dev/log
 125
 126 ## High severity errors
 127 .br
 128 *.alert;*.crit                          /usr/adm/syslog
 129
 130 ## every other message (errors/warning and informational)
 131 .br
 132 *.info;*.notice;*.warning;*.err         /usr/adm/messages
 133 .br
 134 *.debug                                 /usr/adm/debug
 135
 136 .SH SUPPORT FOR REMOTE LOGGING
 137 .PP
 138 Not implemented.
 139 .SH OUTPUT TO NAMED PIPES (FIFOs)
 140 .PP
 141 Not implemented.
 142 .SH INSTALLATION CONCERNS
 143 .PP
 144 There is probably one important consideration when installing this
 145 version of syslogd.  This version of syslogd is dependent on proper
 146 formatting of messages by the syslog function.
 147 .PP
 148 .B Syslogd
 149 should be started by the rc sequence.
 150 .SH DEBUGGING
 151 .PP
 152 When debugging is turned on using
 153 .B "\-d"
 154 option and syslogd is compiled with debug=1 then syslogd
 155 will be very verbose by writing much of what it does on stdout.
 156 Whenever
 157 the configuration file is reread and re-parsed you'll see a tabular,
 158 corresponding to the internal data structure. This tabular consists of
 159 four fields:
 160 .TP
 161 .I number
 162 This field contains a serial number starting by zero. This number
 163 represents the position in the internal data structure (i.e. the
 164 array). If one number is left out then there might be an error in the
 165 corresponding line in
 166 .IR /etc/syslog.conf .
 167 .TP
 168 .I pattern
 169 This field is tricky and represents the internal structure
 170 exactly. Every column stands for a facility (refer to
 171 .BR syslog (3)).
 172 As you can see, there are still some facilities left free for former
 173 use, only the left most are used. Every field in a column represents
 174 the priorities (refer to
 175 .BR syslog (3)).
 176 .TP
 177 .I action
 178 This field describes the particular action that takes place whenever a
 179 message is received that matches the pattern. Refer to the
 180 .BR syslog.conf (5)
 181 manpage for all possible actions.
 182 .TP
 183 .I arguments
 184 This field shows additional arguments to the actions in the last
 185 field. For file-logging this is the filename for the logfile; for
 186 user-logging this is a list of users; for remote logging this is the
 187 hostname of the machine to log to; for console-logging this is the
 188 used console; for tty-logging this is the specified tty; wall has no
 189 additional arguments.
 190 .PP
 191 Note that if syslogd is compiled with debug=0 only a subset is printed.
 192 .SH FILES
 193 .PP
 194 .LR 28 /etc/syslog.conf "Configuration file for syslogd.  See
 195 .Xr syslog.conf 5
 196 for exact information.
 197 .LR 28 /dev/log "The log device (console) for Minix.
 198 .LR 28 /usr/run/syslogd.pid "The file containing the process id of syslogd.
 199 .SH BUGS
 200 .PP
 201 If an error occurs in one line the whole rule is ignored.
 202 .B Syslogd
 203 doesn't change the filemode of opened logfiles at any stage of
 204 process. If a file is created it is world readable. If you want to
 205 avoid this, you have to create it and change permissions on your own.
 206 .SH SEE ALSO
 207 .BR syslog.conf (5),
 208 .BR logger (1),
 209 .BR syslog (3).
 210 .\" .BR services (5),