Fixing documentation about default log destination

Author: gershnik

doc/wsddn.8

@@ -1,8 +1,8 @@
-.\" Automatically generated by Pandoc 3.1.12.3
+.\" Automatically generated by Pandoc 3.7.0.2
 .\"
-.TH "wsddn" "8" "" "WS\-Discovery Host Daemon" "System Manager\[cq]s Manual"
+.TH "wsddn" "8" "" "WS\-Discovery Host Daemon" "System Manager\(cqs Manual"
 .SH NAME
-\f[B]wsddn\f[R] \[em] WS\-Discovery Host Daemon
+\f[B]wsddn\f[R] \(em WS\-Discovery Host Daemon
 .SH SYNOPSIS
 .PP
 \f[CR]wsddn\f[R] \f[CR]\-\-help\f[R]
@@ -64,7 +64,7 @@ If it exists, the file is read and options specified in it are applied
 \f[I]if not already specified on command line\f[R].
 See CONFIG FILE below for information about its syntax and content.
 Content of the configuration file is re\-read upon SIGHUP signal.
-By default, if this option isn\[cq]t specified, no configuration file is
+By default, if this option isn\(cqt specified, no configuration file is
 read.
 .SS Daemon behavior options
 .TP
@@ -79,16 +79,16 @@ The equivalent config file option is \f[CR]log\-level\f[R]
 The path of the file to write the log output to.
 If not specified \f[CR]wsddn\f[R] outputs the log messages as follows
 .RS
-.IP \[bu] 2
+.IP \(bu 2
 If invoked without any daemon flags: to standard output
-.IP \[bu] 2
-If invoked with \[en]systemd: to standard output, with systemd severity
+.IP \(bu 2
+If invoked with \(ensystemd: to standard output, with systemd severity
 prefixes
-.IP \[bu] 2
-If invoked with \[en]unixd or \[en]launchd: to /var/log/wsddn.log
+.IP \(bu 2
+If invoked with \(enlaunchd: to standard output
+.IP \(bu 2
+If invoked with \(enunixd: to /dev/null (no logging)
 .PP
-If \[en]user option is used, the directory of the logfile must allow the
-specified user to create and delete files.
 The equivalent config file option is \f[CR]log\-file\f[R]
 .RE
 .TP
@@ -103,7 +103,7 @@ Set the path to PID file.
 If not specified no PID file is written.
 Send SIGHUP signal to the process ID in the PID file to reload
 configuration.
-If \[en]user option is used, the directory of the pidfile must allow the
+If \(enuser option is used, the directory of the pidfile must allow the
 specified user to create and delete files.
 The equivalent config file option is \f[CR]pid\-file\f[R]
 .TP
@@ -114,13 +114,13 @@ If group name is not specified, primary group of the username is used.
 .RS
 .PP
 If this option is not specified then the behavior is as follows:
-.IP \[bu] 2
+.IP \(bu 2
 If wsddn process is run under the root account it tries to use a special
 unprivileged account name (\f[CR]_wsddn\f[R]:\f[CR]_wsddn\f[R] on macOS,
 \f[CR]wsddn\f[R]:\f[CR]wsddn\f[R] otherwise) The user and group are
 created if they do not exist.
 Any failures in these steps stop the process.
-.IP \[bu] 2
+.IP \(bu 2
 Otherwise, wsddn uses the account it is run under.
 .PP
 The net effect of these rules is that wsddn under no circumstances will
@@ -134,12 +134,12 @@ communications should chroot into.
 This further limits any impact of potential network exploits into wsddn.
 If not specified the behavior is as follows
 .RS
-.IP \[bu] 2
+.IP \(bu 2
 If wsddn process is run under the root account: use
 \f[CR]/var/empty\f[R] on macOS and \f[CR]/var/run/wsddn\f[R] on other
 platforms.
 This directory will be created if it does not exist.
-.IP \[bu] 2
+.IP \(bu 2
 Otherwise: do not chroot
 .PP
 Note: do not use external methods to chroot wsddn process (e.g.\ using
@@ -192,13 +192,13 @@ WS\-Discovery protocol requires your machine to have a unique identifier
 that is stable across reboots or changes in networks.
 By default, \f[CR]wsddn\f[R] uses UUID version 5 with private namespace
 and the host name of the machine.
-This will remain stable as long as the hostname doesn\[cq]t change.
+This will remain stable as long as the hostname doesn\(cqt change.
 If desired, you can override this with a fixed UUID using this option.
 The equivalent config file option is \f[CR]uuid\f[R]
 .TP
 \f[CR]\-\-hostname\f[R] \f[I]name\f[R], \f[CR]\-H\f[R] \f[I]name\f[R]
 Override hostname to be reported to Windows machines.
-By default the local machine\[cq]s hostname (with domain part, if any,
+By default the local machine\(cqs hostname (with domain part, if any,
 removed) is used.
 If you set the name to \f[CR]:NETBIOS:\f[R] then Netbios hostname will
 be used.
@@ -259,12 +259,12 @@ gracefully stop network communications and exit.
 .SH FIREWALL SETUP
 Traffic for the following ports, directions and addresses must be
 allowed:
-.IP \[bu] 2
+.IP \(bu 2
 Incoming and outgoing traffic to udp/3702 with multicast destination:
 239.255.255.250 for IPv4 and ff02::c for IPv6
-.IP \[bu] 2
+.IP \(bu 2
 Outgoing unicast traffic from udp/3702
-.IP \[bu] 2
+.IP \(bu 2
 Incoming traffic to tcp/5357
 .PP
 You should further restrict the traffic to the (link\-)local subnet,
@@ -283,13 +283,13 @@ Most options are named and behave exactly the same as corresponding
 command line options.
 Exceptions are explained in\-depth below.
 .TP
-\f[CR]allowed\-address\-family\f[R] = \[lq]IPv4\[rq] | \[lq]IPv6\[rq]
+\f[CR]allowed\-address\-family\f[R] = \(lqIPv4\(rq | \(lqIPv6\(rq
 Restrict communications to the given address family.
-Valid values are \[lq]IPv4\[rq] or \[lq]IPv6\[rq] case\-insensitive.
+Valid values are \(lqIPv4\(rq or \(lqIPv6\(rq case\-insensitive.
 The equivalent command line options are \f[CR]\-\-ipv4only\f[R] and
 \f[CR]\-\-ipv6only\f[R]
 .TP
-\f[CR]chroot\f[R] = \[lq]path\[rq]
+\f[CR]chroot\f[R] = \(lqpath\(rq
 Same as \f[CR]\-\-chroot\f[R] command line option
 .TP
 \f[CR]hoplimit\f[R] = \f[I]number\f[R]
@@ -298,10 +298,10 @@ Same as \f[CR]\-\-hoplimit\f[R] command line option
 \f[CR]source\-port\f[R] = \f[I]number\f[R]
 Same as \f[CR]\-\-source\-port\f[R] command line option
 .TP
-\f[CR]hostname\f[R] = \[lq]\f[I]name\f[R]\[rq]
+\f[CR]hostname\f[R] = \(lq\f[I]name\f[R]\(rq
 Same as \f[CR]\-\-hostname\f[R] command line option
 .TP
-\f[CR]interfaces\f[R] = [ \[lq]\f[I]name\f[R]\[rq], \&... ]
+\f[CR]interfaces\f[R] = [ \(lq\f[I]name\f[R]\(rq, \&... ]
 Specify on which interfaces wsddn will be listening on.
 If no interfaces are specified, or the list is empty all suitable
 detected interfaces will be used.
@@ -313,19 +313,19 @@ The equivalent command line option is \f[CR]\-\-interface\f[R]
 \f[CR]log\-level\f[R] = \f[I]number\f[R]
 Same as \f[CR]\-\-log\-level\f[R] command line option
 .TP
-\f[CR]log\-file\f[R] = \[lq]path\[rq]
+\f[CR]log\-file\f[R] = \(lqpath\(rq
 Same as \f[CR]\-\-log\-file\f[R] command line option
 .TP
 \f[CR]log\-os\-log\f[R] = true/false
 This setting is only available on macOS.
 Setting it to \f[CR]true\f[R] is the same as \f[CR]\-\-log\-os\-log\f[R]
 command line option
 .TP
-\f[CR]member\-of\f[R] = \[lq]Workgroup/\f[I]name\f[R]\[rq] | \[lq]Domain/\f[I]name\f[R]\[rq]
+\f[CR]member\-of\f[R] = \(lqWorkgroup/\f[I]name\f[R]\(rq | \(lqDomain/\f[I]name\f[R]\(rq
 Report whether the host is a member of a given workgroup or domain.
-To specify a workgroup use \[lq]Workgroup/name\[rq] syntax.
-To specify a domain use \[lq]Domain/name\[rq].
-The \[lq]workgroup/\[rq] and \[lq]domain/\[rq] prefixes are not case
+To specify a workgroup use \(lqWorkgroup/name\(rq syntax.
+To specify a domain use \(lqDomain/name\(rq.
+The \(lqworkgroup/\(rq and \(lqdomain/\(rq prefixes are not case
 sensitive.
 If not specified workgroup/domain membership is detected from SMB
 configuration.
@@ -334,19 +334,19 @@ WORKGROUP.
 The equivalent command line options are \f[CR]\-\-domain\f[R] and
 \f[CR]\-\-workgroup\f[R].
 .TP
-\f[CR]pid\-file\f[R] = \[lq]path\[rq]
+\f[CR]pid\-file\f[R] = \(lqpath\(rq
 Same as \f[CR]\-\-pid\-file\f[R] command line option
 .TP
-\f[CR]smb\-conf\f[R] = \[lq]path\[rq]
+\f[CR]smb\-conf\f[R] = \(lqpath\(rq
 Same as \f[CR]\-\-smb\-conf\f[R] command line option
 .TP
-\f[CR]metadata\f[R] = \[lq]path\[rq]
+\f[CR]metadata\f[R] = \(lqpath\(rq
 Same as \f[CR]\-\-metadata\f[R] command line option
 .TP
-\f[CR]user\f[R] = \[lq]username[:groupname]\[rq]
+\f[CR]user\f[R] = \(lqusername[:groupname]\(rq
 Same as \f[CR]\-\-user\f[R] command line option
 .TP
-\f[CR]uuid\f[R] = \[lq]xxxxxxxx\-xxxx\-xxxx\-xxxx\-xxxxxxxxxxxx\[rq]
+\f[CR]uuid\f[R] = \(lqxxxxxxxx\-xxxx\-xxxx\-xxxx\-xxxxxxxxxxxx\(rq
 Same as \f[CR]\-\-uuid\f[R] command line option
 .SH EXAMPLES
 .SS Run as a traditional Unix daemon

doc/wsddn.8.html

@@ -49,9 +49,9 @@ Unless otherwise specified options cannot be repeated. The options are as follow
 
     * If invoked without any daemon flags: to standard output
     * If invoked with --systemd: to standard output, with systemd severity prefixes
-    * If invoked with --unixd or --launchd: to /var/log/wsddn.log 
+    * If invoked with --launchd: to standard output
+    * If invoked with --unixd: to /dev/null (no logging)
 
-    If --user option is used, the directory of the logfile must allow the specified user to create and delete files. 
     The equivalent config file option is `log-file`
 
 `--log-os-log`

doc/wsddn.8.md

@@ -103,7 +103,8 @@
 # - If invoked without any daemon flags: to standard output
 # - If invoked with --systemd: to standard output, with systemd severity 
 #   prefixes
-# - If invoked with --unixd or --launchd: to /var/log/wsddn.log
+# - If invoked with --launchd: to standard output
+# - If invoked with --unixd: to /dev/null (no logging)
 
 #log-file = "/path/to/log-file.log"