summaryrefslogtreecommitdiffstats
path: root/upstream/debian-bookworm/man8/scanbd.8
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-bookworm/man8/scanbd.8')
-rw-r--r--upstream/debian-bookworm/man8/scanbd.8101
1 files changed, 101 insertions, 0 deletions
diff --git a/upstream/debian-bookworm/man8/scanbd.8 b/upstream/debian-bookworm/man8/scanbd.8
new file mode 100644
index 00000000..017722d8
--- /dev/null
+++ b/upstream/debian-bookworm/man8/scanbd.8
@@ -0,0 +1,101 @@
+.\" $Id: scanbd.man 201 2014-12-12 07:35:03Z wimalopaan $
+.TH scanbd 8 "02 Jan 2013" "scanbd 1.92" "Scanner button daemon"
+.IX scanbd
+.SH NAME
+scanbd\- Scanner button monitoring daemon
+.SH SYNOPSIS
+.I Polling mode:
+.PP
+.B scanbd
+.B [\-c
+.I configfile
+.B ] [\-f]
+.BI [\-d [debuglevel]
+.B ]
+.PP
+.I Manager-mode
+.PP
+The manager mode of
+.B scanbd
+that can be triggered by the
+.B \-m
+option is not documented in this man-page but in
+.BR scanbm (8)
+.
+.SH DESCRIPTION
+.B scanbd
+is a scanner button monitoring daemon that can trigger execution of scripts when
+a button on a scanner is pressed.
+scanbd (the scanner button daemon) opens and polls the scanner
+and therefore locks the device. So no other application can access the device
+directly (open the /dev/..., or via libusb, etc).
+.PP
+To enable scanning from applications, we use scanbm as a "proxy" for
+saned to access the scanner from an application. scanbm
+listens for requests on the saned network port for scanning requests.
+If a scan request arrives, scanbm
+requests the scanbd daemon to release the scanner.
+Then it starts the real saned which scans and sends the data back
+to the requesting application. When the scanning is done and saned exits, the
+scanbm daemon tells scanbd to resume polling the scanner.
+.PP
+scanbd polls the scanner regularly (the interval can be set in
+.B scanbd.conf
+) and monitors for any scanner button to be pressed. If it detects a button press
+it triggers execution of the appropriate script as defined in
+.B scanbd.conf
+.
+.SH OPTIONS
+.TP
+.BI \-c " configfile" " \-\-config" =configfile
+Use
+.I configfile
+instead of the default /etc/scanbd/scanbd.conf configuration file.
+.TP
+.BI \-d [debuglevel] " \-\-debug" [=debuglevel]
+turn debug mode on. If specified, set the debug level to
+.I debuglevel
+.br
+1 = error
+.br
+2 = warn
+.br
+3 = info
+.br
+4 - 7 = debug)
+.TP
+.B \-f \-\-foreground
+Run scanbd in the foreground
+.SH SIGNALS
+.TP
+.B SIGUSR1
+Stop polling and relase the scanner (used by
+.B scanbm
+)
+.TP
+.B SIGUSR1
+Resume polling (used by
+.B scanbm
+)
+.TP
+.B SIGHUP
+Rescan for available devices (useful when no automatic detection is available (HAL, UDEV) )
+.SH MAIN SCANBD CONFIGURATION
+scanbd and scanbm are configured trough scanbd.conf (/etc/scanbd/scanbd.conf).
+The distributed scanbd.conf
+contains a detailed explantion of the configuration options.
+.PP
+The
+.B \-c
+option can be used to override the default configuration file.
+.SH "SEE ALSO"
+.BR scanbm (8),
+.BR sane (7),
+.BR saned (8),
+.BR sane\-dll (5),
+.BR sane\-net (5)
+.BR /etc/scanbd/scanbd.conf
+.br
+.I http://scanbd.sourceforge.net
+.SH AUTHOR
+Louis Lagendijk