diff options
Diffstat (limited to 'doc/saned.man')
| -rw-r--r-- | doc/saned.man | 138 |
1 files changed, 79 insertions, 59 deletions
diff --git a/doc/saned.man b/doc/saned.man index 89484d5..d91f817 100644 --- a/doc/saned.man +++ b/doc/saned.man @@ -24,81 +24,99 @@ 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 -run in standalone daemon mode. In this mode, .B saned -will listen for incoming client connections; -.BR inetd (8) -is not required for +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 -operations in this mode. The -.B \-b -flag tells +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. The -.B \-p -flags tells +given. + +.TP +.BR \-p "\fI port\fR, " \-\-port=\fIport\fR +tells .B saned -to listen on the port given. A value of 0 tells +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). -The -.B \-u -flag requests that + +.TP +.BR \-l ", " \-\-listen +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 +run in standalone daemon mode. In this mode, +.B saned +will listen for incoming client connections; +.BR inetd (8) +is not required for +.B saned +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 \-B \-u -.I username -options. -.PP -The -.B \-d -flag sets the level of + +.TP +.BR \-o ", " \-\-once +requests that +.B saned +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. When compiled with debugging enabled, this flag may be +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 @@ -290,14 +309,15 @@ service sane\-port .SH SYSTEMD CONFIGURATION .B saned can be compiled with explicit -.BR systemd (1) support. This +.BR systemd (1) +support. This will allow logging debugging information to be forwarded to the .BR systemd (1) journal. The .BR systemd (1) support requires compilation with the systemd-devel package -installed on the system. this is the preferred option. +installed on the system. This is the preferred option. .B saned can be used with @@ -314,7 +334,7 @@ configuration is different for the 2 options, so both are described below. For .BR systemd (1) configuration we need to add 2 configuration files in -.I /etc/systemd/system. +.IR /etc/systemd/system . .PP The first file we need to add here is called .I saned.socket. @@ -372,7 +392,7 @@ You need to set an environment variable for pointing to the directory where .B saned can find its configuration files. -you will have to remove the # on the last line and set the variables +You will have to remove the # on the last line and set the variables for the desired debugging information if required. Multiple variables can be set by separating the assignments by spaces as shown in the example above. @@ -393,15 +413,15 @@ forwarded to the system log. This configuration will also work when .B saned is compiled WITH -.BR systemd (1) integration support, but it does not allow debugging -information to be logged. +.BR systemd (1) +integration support, but it does not allow debugging information to be logged. .PP For .BR systemd (1) configuration for .BR saned , we need to add 2 configuration files in -.I /etc/systemd/system. +.IR /etc/systemd/system . .PP The first file we need to add here is called .I saned.socket. @@ -428,7 +448,7 @@ WantedBy=sockets.target .RE .PP The second file to be added is -.I saned@.service +.IR saned@.service . This one differs from the version with .BR systemd (1) integration compiled in: @@ -480,7 +500,7 @@ if supported by the client. .TP .B SANE_CONFIG_DIR This environment variable specifies the list of directories that may -contain the configuration file. Under UNIX, the directories are +contain the configuration file. On *NIX systems, the directories are separated by a colon (`:'), under OS/2, they are separated by a semi-colon (`;'). If this variable is not set, the configuration file is searched in two default directories: first, the current working @@ -508,7 +528,7 @@ being searched (in this order). .BR sane\-"backendname" (5), .BR inetd (8), .BR xinetd (8), -.BR systemd (1), +.BR systemd (1) .br .I http://www.penguin-breeder.org/?page=sane\-net .SH AUTHOR |