From 7f21e4cac8c54147bd040b55660a03a8baa2bd9c Mon Sep 17 00:00:00 2001
From: Ralph Little <skelband@gmail.com>
Date: Fri, 7 May 2021 09:23:28 -0700
Subject: [PATCH] doc: updated saned manpage to reflect saned.

saned supports long options and some clarification was necessary for
correctness. Also I reformatted the options section to be more
standard and consistent with other pages.
---
 doc/saned.man | 123 +++++++++++++++++++++++++++++---------------------
 1 file changed, 71 insertions(+), 52 deletions(-)

diff --git a/doc/saned.man b/doc/saned.man
index fc4c5e72c..cedc7e23a 100644
--- a/doc/saned.man
+++ b/doc/saned.man
@@ -24,15 +24,56 @@ saned \- SANE network daemon
 .B ]
 .B [ \-e ]
 .B [ \-h ]
+
 .SH DESCRIPTION
 .B saned
 is the SANE (Scanner Access Now Easy) daemon that allows remote clients
 to access image acquisition devices available on the local host.
+
 .SH OPTIONS
 .PP
-The
-.B \-l
-flag requests that
+.B saned
+recognises the following options:
+
+.TP
+.BR \-a "\fI [username]\fR, " \-\-alone [=\fIusername]\fR
+is equivalent to the combination of
+.B \-l \-D \-u
+.I username
+options. However, 
+.I username
+is optional and running user will only be set when specified.
+
+.TP
+.BR \-u "\fI username\fR, " \-\-user =\fIusername\fR
+requests that
+.B saned
+drop root privileges and run as the user (and group) associated with
+.I username
+after binding.
+
+.TP
+.BR \-b "\fI address\fR, " \-\-bind =\fIaddress\fR
+tells
+.B saned
+to bind to the
+.I address
+given.
+
+.TP
+.BR \-p "\fI port\fR, " \-\-port=\fIport\fR
+tells
+.B saned
+to listen on the 
+.I port
+given.  A value of 0 tells
+.B saned
+to pick an unused port.  The default is the
+.B sane-port (6566).
+
+.TP
+.BR \-l ", " \-\-listen
+requests that
 .B saned
 run in standalone daemon mode.  In this mode,
 .B saned
@@ -40,65 +81,42 @@ will listen for incoming client connections;
 .BR inetd (8)
 is not required for
 .B saned
-operations in this mode. The
-.B \-b
-flag tells
-.B saned
-to bind to the
-.I address
-given.  The
-.B \-p
-flags tells
-.B saned
-to listen on the port given.  A value of 0 tells
-.B saned
-to pick an unused port.  The default is the
-.B sane-port (6566).
-The
-.B \-u
-flag requests that
-.B saned
-drop root privileges and run as the user (and group) associated with
-.I username
-after binding.
-The
-.B \-D
-flag will request
+operations in this mode.
+
+.TP
+.BR \-D ", " \-\-daemonize
+will request
 .B saned
 to detach from the console and run in the background.
-The flag
-.B \-a
-is equivalent to the combination of
-.B \-l \-D \-u
-.I username
-options.
-.PP
-The
-.B \-d
-flag sets the level of
+
+.TP
+.BR \-o ", " \-\-once
+requests that
 .B saned
-debug output.  When compiled with debugging enabled, this flag may be
+exits after the first client disconnects.  This is useful for debugging.
+
+.TP
+.BR \-d "\fI n\fR, " \-\-debug =\fIn\fR
+sets the level of
+.B saned
+debug output to
+.IR n .
+When compiled with debugging enabled, this flag may be
 followed by a number to request more or less debug info.  The larger
 the number, the more verbose the debug output.  E.g.,
 .B \-d128
 will request output of all debug info.  A level of 0 produces no
 output at all.  The default value is 2.
-.PP
-The
-.B \-e
-flag will divert
+
+.TP
+.BR \-e ", " \-\-stderr
+will divert
 .B saned
 debug output to stderr instead of the syslog default.
-.PP
-The
-.B \-o
-flag requests that
-.B saned
-exits after the first client disconnects.  This is useful for debugging.
-.PP
-The
-.B \-h
-flag displays a short help message.
+
+.TP
+.BR \-h ", " \-\-help
+displays a short help message.
 .PP
 If
 .B saned
@@ -108,6 +126,7 @@ is run from other programs such as
 and
 .BR systemd (1),
 check that program's documentation on how to pass command-line options.
+
 .SH CONFIGURATION
 First and foremost:
 .B saned