syslogd: Update documentation, -m interval is in minutes

Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
This commit is contained in:
Joachim Nilsson 2019-12-01 15:34:13 +01:00
parent f4c01a3ba3
commit 4556901a2b
2 changed files with 13 additions and 16 deletions

View File

@ -19,7 +19,7 @@
.Op Fl b Ar addr[:port] .Op Fl b Ar addr[:port]
.Op Fl b Ar :port .Op Fl b Ar :port
.Op Fl f Ar file .Op Fl f Ar file
.Op Fl m Ar sec .Op Fl m Ar interval
.Op Fl P Ar file .Op Fl P Ar file
.Op Fl p Ar sock .Op Fl p Ar sock
.Op Fl r Ar size[:count] .Op Fl r Ar size[:count]
@ -189,18 +189,16 @@ facility is reserved for kernel log messages. When the
daemon runs alongside daemon runs alongside
.Nm , .Nm ,
this option is always set. this option is always set.
.It Fl m Ar seconds .It Fl m Ar interval
.Nm Specify interval in minutes between
logs a mark timestamp regularly. The default interval between two
.Ql -- MARK -- .Ql -- MARK --
lines is 20 minutes. This can be changed with this option. Setting log messages, default: 20 minutes. Setting this to zero disables log marks
this to zero disables log marks entirely. entirely.
.Pp .Pp
Depending on other log messages generated these lines may not be written Note, the
consecutively. The
.Ql -- MARK -- .Ql -- MARK --
message is only written if the log file hasn't been touched in messages are only written when a log file has been without activity in
.Ar (seconds * 60) / 2 .Ar interval / 2
minutes. minutes.
.It Fl n .It Fl n
Disable DNS query for every request. Disable DNS query for every request.
@ -288,9 +286,8 @@ the asterisk ('*') wildcard, the equation sign ('='), the exclamation
mark ('!'), and the minus sign ('-'). mark ('!'), and the minus sign ('-').
.Pp .Pp
The '*' specifies that all messages for the specified facility are to be The '*' specifies that all messages for the specified facility are to be
directed to the destination. Note that this behavior is degenerate with directed to the destination, this is the same as specifying a priority
specifying a priority level of debug. Users have indicated that the level of debug. Some users find the asterisk notation more intuitive.
asterisk notation is more intuitive.
.Pp .Pp
The '=' restricts logging to the specified priority class. This allows, The '=' restricts logging to the specified priority class. This allows,
for example, routing only debug messages to a particular logging source. for example, routing only debug messages to a particular logging source.

View File

@ -193,8 +193,8 @@ static int addpeer(struct peer *pe0)
int usage(int code) int usage(int code)
{ {
printf("Usage:\n" printf("Usage:\n"
" syslogd [-46AdFknsTv?] [-a PEER] [-b :PORT] [-b ADDR[:PORT]] [-f FILE]\n" " syslogd [-46AdFknsTv?] [-a PEER] [-b NAME] [-f FILE] [-m INTERVAL]\n"
" [-m SEC] [-P PID_FILE] [-p SOCK_PATH] [-R SIZE[:NUM]]\n" " [-P PID_FILE] [-p SOCK_PATH] [-R SIZE[:NUM]]\n"
"Options:\n" "Options:\n"
" -4 Force IPv4 only\n" " -4 Force IPv4 only\n"
" -6 Force IPv6 only\n" " -6 Force IPv6 only\n"
@ -223,7 +223,7 @@ int usage(int code)
" -F Run in foreground, required when run from a modern init/supervisor\n" " -F Run in foreground, required when run from a modern init/supervisor\n"
" -f FILE Alternate .conf file, default: /etc/syslog.conf\n" " -f FILE Alternate .conf file, default: /etc/syslog.conf\n"
" -k Allow logging with facility 'kernel', otherwise remapped to 'user'.\n" " -k Allow logging with facility 'kernel', otherwise remapped to 'user'.\n"
" -m SEC Interval between MARK messages in log, 0 to disable, default: 20 min\n" " -m MINS Interval between MARK messages in log, 0 to disable, default: 20 min\n"
" -n Disable DNS query for every request\n" " -n Disable DNS query for every request\n"
" -P FILE File to store the process ID, default: %s\n" " -P FILE File to store the process ID, default: %s\n"
" -p PATH Path to UNIX domain socket, multiple -p create multiple sockets. If\n" " -p PATH Path to UNIX domain socket, multiple -p create multiple sockets. If\n"