emo/sysklogd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

syslogd: Update usage text and man page for new -b flag, drop -r

Browse Source 
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
This commit is contained in:
Joachim Nilsson 2019-11-12 12:06:21 +01:00
parent 762e09d7e8
commit d607d6b845
2 changed files with 26 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
man/syslogd.8
View File

@ -14,11 +14,12 @@
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Op Fl ?46Adhnv .Op Fl ?46Adhnv
.Op Fl b Ar :SVC .Op Fl b Ar addr[:port]
.Op Fl f Ar FILE .Op Fl b Ar :port
.Op Fl m Ar SECONDS .Op Fl f Ar file
.Op Fl P Ar FILE .Op Fl m Ar sec
.Op Fl p Ar SOCK .Op Fl P Ar file
.Op Fl p Ar sock
.Op Fl R Ar size[:count] .Op Fl R Ar size[:count]
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
@ -70,7 +71,7 @@ When
starts up it reads its main configuration file starts up it reads its main configuration file
.Pa /etc/syslog.conf , .Pa /etc/syslog.conf ,
or an alternate file given with the or an alternate file given with the
.Fl f Ar FILE .Fl f Ar file
option. For details on how to configure syslog priority option. For details on how to configure syslog priority
(facility.severity) filtering, see (facility.severity) filtering, see
.Xr syslog.conf 5 . .Xr syslog.conf 5 .
@ -91,11 +92,18 @@ tries to send the message to only one address even if the host has
more than one A or AAAA record. If this option is specified, more than one A or AAAA record. If this option is specified,
.Nm .Nm
tries to send the message to all addresses. tries to send the message to all addresses.
.It Fl b Ar address[:service]
.It Fl b Ar :service .It Fl b Ar :service
Bind to a specific port. The port can be specified as a service name or Bind to a specific address and/or port. The address can be specified as
number. The default service is a hostname, and the port as a service name. If an IPv6 address is
specified, it should be enclosed with
.Sq \&[
and
.Sq \&] .
The default service is
.Ql syslog .Ql syslog
(514/udp). (514/udp). This option can be specified multiple times to bind to
multiple addresses and/or ports.
.It Fl d .It Fl d
Turns on debug mode. This implicitly enables Turns on debug mode. This implicitly enables
.Fl n .Fl n
@ -106,7 +114,7 @@ TTY. SIGUSR1 is required to confirm continued debug messages when the
daemon has finished started up. See the daemon has finished started up. See the
.Sx DEBUGGING .Sx DEBUGGING
section for more information. section for more information.
.It Fl f Ar FILE .It Fl f Ar file
Specify an alternative configuration file instead of the default Specify an alternative configuration file instead of the default
.Pa /etc/syslog.conf . .Pa /etc/syslog.conf .
.It Fl h .It Fl h
@ -115,7 +123,7 @@ hosts. Specifying this switch on the command line will cause the log
daemon to forward any remote messages it receives to forwarding hosts daemon to forward any remote messages it receives to forwarding hosts
which have been defined. This can cause syslog loops that fill up hard which have been defined. This can cause syslog loops that fill up hard
disks quite fast and thus needs to be used with caution. disks quite fast and thus needs to be used with caution.
.It Fl m Ar SECONDS .It Fl m Ar seconds
.Nm .Nm
logs a mark timestamp regularly. The default interval between two logs a mark timestamp regularly. The default interval between two
.Ql -- MARK -- .Ql -- MARK --
@ -133,11 +141,11 @@ Run in foreground, required when run from a modern init/supervisor. See
your system your system
.Xr init 1 .Xr init 1
for details. for details.
.It Fl P Ar FILE .It Fl P Ar file
Specify an alternate file in which to store the process ID. Specify an alternate file in which to store the process ID.
The default is The default is
.Pa /var/run/syslog.pid . .Pa /var/run/syslog.pid .
.It Fl p Ar SOCK .It Fl p Ar socket
Specify an alternate UNIX domain socket instead of the default Specify an alternate UNIX domain socket instead of the default
.Pa /dev/log . .Pa /dev/log .
When a single When a single

10
src/syslogd.c
View File

@ -191,14 +191,16 @@ static int addpeer(struct peer *pe0)
int usage(int code) int usage(int code)
{ {
printf("Usage:\n" printf("Usage:\n"
" syslogd [-46Adnrvh?] [-f FILE] [-l HOST] [-m SEC] [-P PID_FILE]\n" " syslogd [-46Adnrvh?] [-b :PORT] [-b ADDR[:PORT]] [-f FILE] [-m SEC]\n"
" [-p SOCK_PATH] [-R SIZE[:NUM]]\n" " [-P PID_FILE] [-p SOCK_PATH] [-R SIZE[:NUM]]\n"
"\n" "\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"
" -A Send to all addresses in DNS A, or AAAA record\n" " -A Send to all addresses in DNS A, or AAAA record\n"
" -b :SRV Bind to a specific internet port, default syslog/514, requires -r\n" " -b ADDR:SERVICE"
" -b :SRV Bind to a specific address and/or port. The address can be specifed\n"
" as a hostname ath the port as as ervice name, default syslog/514\n"
" -d Enable debug mode\n" " -d Enable debug mode\n"
" -f FILE Alternate .conf file, default: /etc/syslog.conf\n" " -f FILE Alternate .conf file, default: /etc/syslog.conf\n"
" -h Forward messages from other hosts also to remote syslog host(s)\n" " -h Forward messages from other hosts also to remote syslog host(s)\n"
@ -210,8 +212,6 @@ int usage(int code)
" -R S[:R] Enable log rotation. The size argument (S) takes k/M/G qualifiers,\n" " -R S[:R] Enable log rotation. The size argument (S) takes k/M/G qualifiers,\n"
" e.g. 2M for 2 MiB. The optional rotations argument default to 5.\n" " e.g. 2M for 2 MiB. The optional rotations argument default to 5.\n"
" Rotation can also be defined per log file in syslog.conf\n" " Rotation can also be defined per log file in syslog.conf\n"
" -r Act as remote syslog sink for other hosts, default is secure mode,\n"
" i.e., syslogd does not bind to any internet address:port by default\n"
"\n" "\n"
" -? Show this help text\n" " -? Show this help text\n"
" -v Show program version and exit\n" " -v Show program version and exit\n"