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.
saned_man_option_update
Ralph Little 2021-05-07 09:23:28 -07:00
rodzic 28f7bbfb87
commit 7f21e4cac8
1 zmienionych plików z 71 dodań i 52 usunięć

Wyświetl plik

@ -24,15 +24,56 @@ saned \- SANE network daemon
.B ] .B ]
.B [ \-e ] .B [ \-e ]
.B [ \-h ] .B [ \-h ]
.SH DESCRIPTION .SH DESCRIPTION
.B saned .B saned
is the SANE (Scanner Access Now Easy) daemon that allows remote clients is the SANE (Scanner Access Now Easy) daemon that allows remote clients
to access image acquisition devices available on the local host. to access image acquisition devices available on the local host.
.SH OPTIONS .SH OPTIONS
.PP .PP
The .B saned
.B \-l recognises the following options:
flag requests that
.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 .B saned
run in standalone daemon mode. In this mode, run in standalone daemon mode. In this mode,
.B saned .B saned
@ -40,65 +81,42 @@ will listen for incoming client connections;
.BR inetd (8) .BR inetd (8)
is not required for is not required for
.B saned .B saned
operations in this mode. The operations in this mode.
.B \-b
flag tells .TP
.B saned .BR \-D ", " \-\-daemonize
to bind to the will request
.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
.B saned .B saned
to detach from the console and run in the background. to detach from the console and run in the background.
The flag
.B \-a .TP
is equivalent to the combination of .BR \-o ", " \-\-once
.B \-l \-D \-u requests that
.I username
options.
.PP
The
.B \-d
flag sets the level of
.B saned .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 followed by a number to request more or less debug info. The larger
the number, the more verbose the debug output. E.g., the number, the more verbose the debug output. E.g.,
.B \-d128 .B \-d128
will request output of all debug info. A level of 0 produces no will request output of all debug info. A level of 0 produces no
output at all. The default value is 2. output at all. The default value is 2.
.PP
The .TP
.B \-e .BR \-e ", " \-\-stderr
flag will divert will divert
.B saned .B saned
debug output to stderr instead of the syslog default. debug output to stderr instead of the syslog default.
.PP
The .TP
.B \-o .BR \-h ", " \-\-help
flag requests that displays a short help message.
.B saned
exits after the first client disconnects. This is useful for debugging.
.PP
The
.B \-h
flag displays a short help message.
.PP .PP
If If
.B saned .B saned
@ -108,6 +126,7 @@ is run from other programs such as
and and
.BR systemd (1), .BR systemd (1),
check that program's documentation on how to pass command-line options. check that program's documentation on how to pass command-line options.
.SH CONFIGURATION .SH CONFIGURATION
First and foremost: First and foremost:
.B saned .B saned