Changeset View
Changeset View
Standalone View
Standalone View
usr.sbin/syslogd/syslogd.8
Show All 22 Lines | |||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" @(#)syslogd.8 8.1 (Berkeley) 6/6/93 | .\" @(#)syslogd.8 8.1 (Berkeley) 6/6/93 | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd November 28, 2017 | .Dd April 9, 2018 | ||||
.Dt SYSLOGD 8 | .Dt SYSLOGD 8 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm syslogd | .Nm syslogd | ||||
.Nd log systems messages | .Nd log systems messages | ||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||
.Nm | .Nm | ||||
.Op Fl 468ACcdFHkNnosTuv | .Op Fl 468ACcdFHkNnosTuv | ||||
.Op Fl a Ar allowed_peer | .Op Fl a Ar allowed_peer | ||||
.Op Fl b Ar bind_address | .Op Fl b Ar bind_address | ||||
.Op Fl f Ar config_file | .Op Fl f Ar config_file | ||||
.Op Fl l Oo Ar mode Ns \&: Oc Ns Ar path | .Op Fl l Oo Ar mode Ns \&: Oc Ns Ar path | ||||
.Op Fl m Ar mark_interval | .Op Fl m Ar mark_interval | ||||
.Op Fl O Ar format | |||||
.Op Fl P Ar pid_file | .Op Fl P Ar pid_file | ||||
.Op Fl p Ar log_socket | .Op Fl p Ar log_socket | ||||
.Op Fl S Ar logpriv_socket | .Op Fl S Ar logpriv_socket | ||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
The | The | ||||
.Nm | .Nm | ||||
utility reads and logs messages to the system console, | utility reads and logs messages to the system console, | ||||
log files, | log files, | ||||
other | other | ||||
machines and/or users as specified by its configuration file. | machines and/or users as specified by its configuration file. | ||||
.Pp | .Pp | ||||
The options are as follows: | The options are as follows: | ||||
.Bl -tag -width indent | .Bl -tag -width indent | ||||
.It Fl 4 | .It Fl 4 | ||||
Force | Force | ||||
.Nm | .Nm | ||||
to use IPv4 addresses only. | to use IPv4 addresses only. | ||||
.It Fl 6 | .It Fl 6 | ||||
Force | Force | ||||
woodsb02: Rather than a binary -5 option, I think we should use a generic output modifier, which would be… | |||||
Not Done Inline ActionsConfiguring UDP vs TCP vs TLS is something that likely needs to be done in syslog.conf as opposed to using command line flags. Still, I've renamed the flag to -O, having values similar to NetBSD. Does that look all right? ed: Configuring UDP vs TCP vs TLS is something that likely needs to be done in `syslog.conf` as… | |||||
.Nm | .Nm | ||||
to use IPv6 addresses only. | to use IPv6 addresses only. | ||||
.It Fl 8 | .It Fl 8 | ||||
Tells | Tells | ||||
.Nm | .Nm | ||||
not to interfere with 8-bit data. | not to interfere with 8-bit data. | ||||
Normally | Normally | ||||
.Nm | .Nm | ||||
▲ Show 20 Lines • Show All 165 Lines • ▼ Show 20 Lines | |||||
messages received with facility | messages received with facility | ||||
.Dq kern | .Dq kern | ||||
to facility | to facility | ||||
.Dq user . | .Dq user . | ||||
Usually the | Usually the | ||||
.Dq kern | .Dq kern | ||||
facility is reserved for messages read directly from | facility is reserved for messages read directly from | ||||
.Pa /dev/klog . | .Pa /dev/klog . | ||||
.It Fl O Ar format | |||||
Select the output format of generated log messages. | |||||
The values | |||||
.Ar bsd | |||||
and | |||||
.Ar rfc3164 | |||||
are used to generate RFC 3164 log messages. | |||||
The values | |||||
.Ar syslog | |||||
and | |||||
.Ar rfc5424 | |||||
are used to generate RFC 5424 log messages, | |||||
having RFC 3339 timestamps with microsecond precision. | |||||
The default is to generate RFC 3164 log messages. | |||||
.It Fl m Ar mark_interval | .It Fl m Ar mark_interval | ||||
Select the number of minutes between | Select the number of minutes between | ||||
.Dq mark | .Dq mark | ||||
messages; | messages; | ||||
the default is 20 minutes. | the default is 20 minutes. | ||||
.It Fl N | .It Fl N | ||||
Disable binding on UDP sockets. | Disable binding on UDP sockets. | ||||
RFC 3164 recommends that outgoing | RFC 3164 recommends that outgoing | ||||
▲ Show 20 Lines • Show All 209 Lines • Show Last 20 Lines |
Rather than a binary -5 option, I think we should use a generic output modifier, which would be coupled with a string argument, to allow more than just 2 output options (as per NetBSD). Whilst we can’t use -o, another character could be used.
In the future, there may be new output formats (e.g. RFC5424 version 2).
We may also want to set the transport (e.g. UDP, TCP plaintext, TLS). This would probably be a separate flag, but could be combined.
E.g.
-o syslog_rfc5425
-o syslog_rfc5426