- updated sane-umax_pp man page

ChangeLog

@@ -1,3 +1,7 @@
+2003-09-16  Stéphane Voltz <svoltz@wanadoo.fr>
+
+	* doc/sane-umax_pp_low.man: updated man page
+
 2003-09-15  Simon Munton <simon@munton.demon.co.uk>
 
 	* doc/sane-pie.man doc/descriptions/pie.desc: Updated status of ScanAce

doc/sane-umax_pp.man

@@ -1,10 +1,10 @@
-.TH sane-umax_pp 5 "15 February 2002" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
+.\" .IX sane-umax_pp
-.IX sane-umax_pp
+.TH "sane-umax_pp" "5" "16 September 2003" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
-.SH NAME
+.SH "NAME"
-sane-umax_pp \- SANE backend for Umax parallel port flatbed scanners
+sane\-umax_pp \- SANE backend for Umax Astra parallel port flatbed scanners
-.SH DESCRIPTION
+.SH "DESCRIPTION"
 The
-.B sane-umax_pp
+.B sane\-umax_pp
 library implements a SANE (Scanner Access Now Easy) backend that
 provides access to Umax parallel port flatbed scanners.  The
 following scanners work with this backend:
@@ -12,7 +12,7 @@ following scanners work with this backend:
 .RS
 Model:                
 .br 
--------------------- 
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 
 .br 
 Astra 1220P         
 .br 
@@ -60,33 +60,36 @@ This backend expects device names of the form:
 .RE
 .PP 
 Where
-.B value
+\fBvalue\fR
 is the base address, or the ppdev device name of the port your scanner is attached to. 
-Known ports are
+Known ports are \fB0x378\fR, \fB0x278\fR and \fB0x3BC\fR . Or the name of the
-.B 0x378
+parallel port character device user interface, such as /dev/parport0 for the linux ppdev,
-(lp1)
+or /dev/ppi0 for FreeBSD ppi.
-.B 0x278
+.br 
-(lp2) and
+Under linux, if you are not sure which
-.B 0x3BC
+port your scanner is connected to, may have a look at your /etc/modules.conf. Also typing
-(lp0). Note that if you are using a Kernel 2.2.x or better , the first
+dmesg|grep parport in a command shell should show you a line like: 
-parallel port is named lp0 regardless of the base address. However,
+.br 
-this backend requires the base address of your port. If you are not sure which
+parport0: PC\-style at 0x378 (0x778), irq 7, dma 3 [PCSPP,TRISTATE,COMPAT,ECP,DMA]
-port your scanner is connected to, have a look at your /etc/modules.conf.
+.br 
+telling you about port address and mode.
 .PP 
 If you are using the linux ppdev character device, you will have to specify
 the device name, which is /dev/parport0 for the first parallel port. Check 
 the permissions on /dev/paraport0, many linux distributions restrict them
 for root only access. Get sure they are like:
 .br 
-crw-rw-rw- 1 root root 99, 0 mai 20 2002 /dev/parport0
+crw\-rw\-rw\- 1 root root 99, 0 mai 20 2002 /dev/parport0
 .br 
-crw-rw-rw- 1 root root 99, 1 mai 20 2002 /dev/parport1
+crw\-rw\-rw\- 1 root root 99, 1 mai 20 2002 /dev/parport1
 .br 
-crw-rw-rw- 1 root root 99, 2 mai 20 2002 /dev/parport2
+crw\-rw\-rw\- 1 root root 99, 2 mai 20 2002 /dev/parport2
 .br 
-crw-rw-rw- 1 root root 99, 3 mai 20 2002 /dev/parport3
+crw\-rw\-rw\- 1 root root 99, 3 mai 20 2002 /dev/parport3
+.br 
+.br 
+The same apply with the /dev/ppi0 character device under FreeBSD.
 .br 
-
 
 You can rename any device using the
 .PP 
@@ -100,7 +103,7 @@ You can rename any device using the
 .PP 
 options. These options apply to the last port option. 
 
-.SH CONFIGURATION
+.SH "CONFIGURATION"
 Please make sure to edit umax_pp.conf
 .B before
 you use the backend.
@@ -112,34 +115,35 @@ scanners.  Empty lines and lines starting with a hash mark (#) are
 ignored.
 .PP 
 The height options supported are
-.BR red-brightness ,
+.BR red\-brightness ,
-.BR green-brightness ,
+.BR green\-brightness ,
-.BR blue-brightness ,
+.BR blue\-brightness ,
-.BR red-contrast ,
+.BR red\-contrast ,
-.BR green-contrast ,
+.BR green\-contrast ,
-.BR blue-contrast ,
+.BR blue\-contrast ,
 .BR astra ,
 and
 .BR buffer .
 
 Options
-.B red-brightness
+.B red\-brightness
 ,
-.B green-brightness
+.B green\-brightness
 and
-.B blue-brightness
+.B blue\-brightness
 allow you to adjust the sensitivy of your scanner for the given color. Values
-range from 0 (lowest brightness) to 15 (highest). The "Brightness" option isn't
+range from 0 (lowest brightness) to 15 (highest). If the advanced option "Brightness" isn't
-checked in the frontend, the backend does automatic brightness calibration.
+checked in the frontend, the backend does automatic brightness calibration, and do not use
+user provided values.
 
 .PP 
 
 Options
-.B red-contrast
+.B red\-contrast
 ,
-.B green-contrast
+.B green\-contrast
 and
-.B blue-contrast
+.B blue\-contrast
 allow you to adjust the contrast of your scanner for the given color. Values
 range from 0 (lowest contrast) to 15 (highest). 
 .PP 
@@ -149,7 +153,7 @@ Option
 allows you to change the model of your scanner. Current auto detection is based
 on side effects on scanning when using 1220P command set on other models, so
 it may fail on unkown hardware combination. Valid values are 1220, 1600 
-and 2000. It is usefull only autodetection fails to detect properly your scanner 
+and 2000. It is usefull only when autodetection fails to detect properly your scanner 
 model. If your scanner work properly but is reported wrongly, let it be that way. 
 The only valid case to change the model is when your scanner produces 'black' or 
  'inverted' scans.  In this case you can put the model. Be aware that it will 
@@ -166,7 +170,7 @@ progress status reporting in the frontend, but will stall the scan more often.
 
 
 
-.SH FILES
+.SH "FILES"
 .TP 
 .I @CONFIGDIR@/umax_pp.conf
 The backend configuration file (see also description of
@@ -180,13 +184,13 @@ The static library implementing this backend.
 The shared library implementing this backend (present on systems that
 support dynamic loading).
 
-.SH ENVIRONMENT
+.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
+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
@@ -206,7 +210,7 @@ levels reduce verbosity.
 .RS
 level   debug output
 .br 
-------- ------------------------------
+\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
 .br 
  0       nothing
 .br 
@@ -233,7 +237,7 @@ million lines of debug output.
 .RS
 level   debug output
 .br 
-------- -------------------------------
+\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
 .br 
  0       nothing
 .br 
@@ -257,25 +261,26 @@ sane(7), sane\-net(5), saned(1)
 For latest bug fixes and information see
 .I http://umax1220p.sourceforge.net/
 
-.SH AUTHOR
+.SH "AUTHOR"
 Stéphane VOLTZ <svoltz@wanadoo.fr>, man page derived from mustek_pp man page
 by Jochen Eisinger <jochen.eisinger@gmx.net>
 
 
 
-.SH BUG REPORTS
+.SH "BUG REPORTS"
 If something doesn't work, please contact me. But I need some information about
 your scanner to be able to help you...
 
 .TP 
 .I SANE version
-run "scanimage -V" to determine this
+run "scanimage \-V" to determine this
 .TP 
 .I the backend version and your scanner hardware
-run "SANE_DEBUG_UMAX=255 scanimage -L 2>log" as root. If you don't get any output
+run "SANE_DEBUG_UMAX=255 scanimage \-L 2>log" as root. If you don't get any output
 from the umax_pp backend, make sure a line "umax_pp" is included into
 your @CONFIGDIR@/dll.conf.
-If your scanner isn't detected, make sure you've defined the right port address
+If your scanner isn't detected, make sure you've defined the right port address, or the
+correct device 
 in your umax_pp.conf.
 .TP 
 .I the name of your scanner/vendor