Added sane-test manual page.

Henning Meier-Geinitz <henning@meier-geinitz.de>

doc/sane-test.man

@@ -0,0 +1,85 @@
+.TH sane-test 5 "9 Apr 2002"
+.IX sane-test
+.SH NAME
+sane-test - SANE backend for testing frontends
+.SH DESCRIPTION
+The
+.B sane-test
+library implements a SANE (Scanner Access Now Easy) backend that allows
+testing the SANE installation and SANE frontends.  It provides access to a
+(nearly) unlimited number of virtual devices. There is no support for
+real scanners or cameras. However, the backend simulates scanning and setting
+options.
+.PP
+The idea is not only to find bugs in frontends but also to show all
+capabilities of SANE. Therefore 
+.B sane-test
+implements functions and options that are not (or seldomly) found in other
+backends. 
+.PP
+The backend is commented out in @CONFIGDIR@/dll.conf, so either the comment
+sign must be removed or the backend must be called explicitely. E.g. 
+`scanimage -d test' or `xscanimage test'.
+
+.SH SANE OPTIONS
+The options should be self-explanatory. Have a look at their descriptions.
+If a description is too vague, please contact me. Just some comments: The
+combination of color and 1-bit mode is quite obscure (8 colors) but allowed
+in the SANE standard. However, the meaning of bits is not defined. Currently
+1 = high intensity and 0 = low intensity is used.
+
+.SH FILES
+.TP
+.I @CONFIGDIR@/test.conf
+The backend configuration file (see also description of
+.B SANE_CONFIG_DIR
+below). The initial values of most of the basic SANE options can be configured
+in this file. A template containing all the default values is provided
+together with this backend. One of the more interesting values may be
+.BR number_of_devices . 
+It can be used to check the frontend's ability to show a long list of devices.
+The config values concerning resolution and geometry can be usefull to test
+the handling of big file sizes.
+
+.TP
+.I @LIBDIR@/libsane-test.a
+The static library implementing this backend.
+.TP
+.I @LIBDIR@/libsane-test.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_TEST
+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_TEST=4
+
+.SH "SEE ALSO"
+sane(7), 
+.IR http://www.meier-geinitz.de/sane/test-backend/
+
+
+.SH AUTHOR
+Henning Meier-Geinitz <henning@meier-geinitz.de>
+
+.SH BUGS
+- config file values aren't tested for correctness
+- man page hasn't been completed yet

doc/sane.man

@@ -1,4 +1,4 @@
-.TH sane 7 "7 Apr 2002"
+.TH sane 7 "13 Apr 2002"
 .IX sane
 
 .SH NAME
@@ -252,7 +252,8 @@ The SANE tamarack backend supports Tamarack Artiscan flatbed scanners. See
 sane-tamarack(5) for details.
 .TP
 .B teco1
-The SANE teco1 backend supports some TECO scanners, usually sold under the RELISYS name. See sane-teco1(5) for details.
+The SANE teco1 backend supports some TECO scanners, usually sold under the
+RELISYS name. See sane-teco1(5) for details.
 .TP
 .B umax
 The sane-umax backend provides access to several UMAX-SCSI-scanners and some
@@ -273,19 +274,19 @@ http://www.mostang.com/sane/sane-backends.html and the list of projects in
 
 .SH BACKENDS FOR DIGITAL CAMERAS
 .TP 2
-.B sane-dc210
+.B dc210
 Backend for Kodak DC210 Digital Camera. See sane-dc210(5).
 .TP
-.B sane-dc240
+.B dc240
 Backend for Kodak DC240 Digital Camera. See sane-dc240(5).
 .TP
-.B sane-dc25
+.B dc25
 Backend for Kodak DC20/DC25 Digital Cameras. See sane-dc25(5).
 .TP
-.B sane-dmc
+.B dmc
 Backend for the Polaroid Digital Microscope Camera. See sane-dmc(5).
 .TP
-.B sane-gphoto2
+.B gphoto2
 Backend for digital cameras supported by the gphoto2 library package.  (See
 http://www.gphoto.org for more information and a list of supported
 cameras.)   Gphoto2 supports over 140 different camera models.
@@ -293,7 +294,7 @@ However, please note that more development and testing is needed before
 all of these cameras will be supported by SANE backend.  See
 sane-gphoto2(5).
 .TP
-.B sane-qcam
+.B qcam
 Backend for Connectix QuickCam cameras. See sane-qcam(5).
 .P
 Also, have a look at the backend information page at
@@ -302,26 +303,30 @@ http://www.mostang.com/sane/sane-backends.html and the list of projects in
 
 .SH MISCELLANEOUS BACKENDS
 .TP 2
-.B sane-dll
+.B dll
 The sane-dll library implements a SANE backend that provides access to an
 arbitrary number of other SANE backends by dynamic loading. See sane-dll(5).
 .TP
-.B sane-net
+.B net
 The 
 .B SANE
 network daemon saned provides access to scanners located on different
 computers in connection with the net backend. See sane-net(5) and saned(1).
 .TP
-.B sane-pnm
+.B pnm
 PNM image reader pseudo-backend. The purpose of this backend is primarily to
 aid in debugging of SANE frontends. See sane-pnm(5).
 .TP
-.B sane-pint
+.B pint
 Backend for scanners that use the PINT (Pint Is Not Twain) device driver.  The
 PINT driver is being actively developed on the OpenBSD platform, and has been
-ported to a few other *nix-like operating systems. See sane-pint(5),
+ported to a few other *nix-like operating systems. See sane-pint(5).
 .TP
-.B sane-v4l
+.B test
+The SANE test backend is for testing frontends and the SANE installation.
+It provides test pictures and various test options. See sane-test(5).
+.TP
+.B v4l
 The sane-v4l library implements a
 .B SANE
 backend that provides generic access to video cameras and similar equipment