summaryrefslogtreecommitdiff
path: root/doc/sane-hp5400.man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sane-hp5400.man')
-rw-r--r--doc/sane-hp5400.man102
1 files changed, 102 insertions, 0 deletions
diff --git a/doc/sane-hp5400.man b/doc/sane-hp5400.man
new file mode 100644
index 0000000..d789215
--- /dev/null
+++ b/doc/sane-hp5400.man
@@ -0,0 +1,102 @@
+.TH sane\-hp5400 5 "13 Jul 2008" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
+.IX sane\-hp5400
+.SH NAME
+sane\-hp5400 \- SANE backend for Hewlett-Packard 54XX scanners
+.SH DESCRIPTION
+The
+.B sane\-hp5400
+library implements a SANE (Scanner Access Now Easy) backend that provides
+access to the following Hewlett-Packard USB flatbed scanners:
+.PP
+.RS
+ScanJet 5400C
+.br
+ScanJet 5470C
+.br
+ScanJet 5490C
+.RE
+.PP
+More details can be found on the hp5400 backend homepage
+.IR http://hp5400backend.sourceforge.net/ .
+.PP
+This is ALPHA software. Keep your hand at the scanner's plug and unplug it, if
+the head bumps at the end of the scan area. See also the BUGS section.
+.PP
+If you own a scanner other than the ones listed above that works with this
+backend, please let us know this by sending the scanner's exact model name and
+the USB vendor and device ids (e.g. from
+.IR /proc/bus/usb/devices ,
+.I sane\-find\-scanner
+or syslog) to us. Even if the scanner's name is only slightly different from
+the models mentioned above, please let us know.
+.PP
+
+.SH CONFIGURATION
+The contents of the
+.I hp5400.conf
+file is a list of usb lines containing vendor and product ids that correspond
+to USB scanners. The file can also contain the names of device files that
+correspond to an HP 54XX scanner. Empty lines and lines starting with a hash
+mark (#) are ignored. The scanners are autodetected by
+.B usb vendor_id product_id
+statements which are already included into
+.IR hp5400.conf .
+"vendor_id" and "product_id" are hexadecimal numbers that identify the
+scanner. If autodetection does not work, add the device name of your scanner
+to the configuration file, e.g.
+.IR /dev/usb/scanner0 .
+.PP
+
+.SH FILES
+.TP
+.I @CONFIGDIR@/hp5400.conf
+The backend configuration file (see also description of
+.B SANE_CONFIG_DIR
+below).
+.TP
+.I @LIBDIR@/libsane\-hp5400.a
+The static library implementing this backend.
+.TP
+.I @LIBDIR@/libsane\-hp5400.so
+The shared library implementing this backend (present on systems that
+support dynamic loading).
+.SH ENVIRONMENT
+.TP
+.B SANE_CONFIG_DIR
+This environment variable specifies the list of directories that may
+contain the configuration file. Under UNIX, 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
+directory (".") and then in @CONFIGDIR@. If the value of the
+environment variable ends with the directory separator character, then
+the default directories are searched after the explicitly specified
+directories. For example, setting
+.B SANE_CONFIG_DIR
+to "/tmp/config:" would result in directories "tmp/config", ".", and
+"@CONFIGDIR@" being searched (in this order).
+.TP
+.B SANE_DEBUG_HP5400
+If the library was compiled with debug support enabled, this
+environment variable controls the debug level for this backend. Higher
+debug levels increase the verbosity of the output.
+
+Example:
+export SANE_DEBUG_HP5400=4
+
+.SH "SEE ALSO"
+.BR sane (7),
+.BR sane\-usb (5),
+.br
+.I http://hp5400backend.sourceforge.net/
+
+.SH AUTHOR
+Martijn van Oosterhout <kleptog@svana.org>, Thomas Soumarmon
+<soumarmt@nerim.net>. Manpage by Henning Meier-Geinitz
+<henning@meier\-geinitz.de>.
+
+.SH BUGS
+Scanning is only tested with Linux/ix86/gcc. Be careful when testing on other
+operating systems and especially on big-endian platforms. The scanner may get
+wrong data.
+