docs/98058: Edit of scanner portion of Handbook Multimedia chapter
Warren Block
wblock at wonkity.com
Sun May 28 17:10:20 UTC 2006
>Number: 98058
>Category: docs
>Synopsis: Edit of scanner portion of Handbook Multimedia chapter
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Sun May 28 17:10:08 GMT 2006
>Closed-Date:
>Last-Modified:
>Originator: Warren Block
>Release: FreeBSD 6.1-STABLE i386
>Organization:
>Environment:
System: FreeBSD speedy.wonkity.com 6.1-STABLE FreeBSD 6.1-STABLE #0: Tue May 23 09:28:34 MDT 2006 root at speedy.wonkity.com:/usr/obj/usr/src/sys/SPEEDY i386
>Description:
Some spelling and clarity errors, repetitive or defensive wording in
scanner section of Multimedia chapter of Handbook.
>How-To-Repeat:
Read scanner section of Multimedia chapter of Handbook.
>Fix:
--- chapter.sgml.old Sun May 28 09:44:53 2006
+++ chapter.sgml Sun May 28 10:50:07 2006
@@ -1549,13 +1549,13 @@
<sect2>
<title>Introduction</title>
- <para>&os;, like any modern operating system, allows the use of
- image scanners. Standardized access to scanners is provided
+ <para>In &os;,
+ access to image scanners is provided
by the <application>SANE</application> (Scanner Access Now
Easy) <acronym role="Application Programming
Interface">API</acronym> available through the &os; Ports
Collection. <application>SANE</application> will also use
- some &os; devices drivers to access to the scanner
+ some &os; device drivers to access the scanner
hardware.</para>
<para>&os; supports both SCSI and USB scanners. Be sure your
@@ -1581,8 +1581,8 @@
<para>The <filename>GENERIC</filename> kernel by default
includes the device drivers needed to support USB scanners.
- Should you decide to use a custom kernel, be sure that the
- following lines are present in your kernel configuration
+ If you use a custom kernel, these
+ lines should be present in your kernel configuration
file:</para>
<programlisting>device usb
@@ -1592,13 +1592,12 @@
<para>Depending upon the USB chipset on your motherboard, you
will only need either <literal>device uhci</literal> or
- <literal>device ohci</literal>, however having both in the
+ <literal>device ohci</literal>, but having both in the
kernel configuration file is harmless.</para>
- <para>If you do not want to rebuild your kernel and your
- kernel is not the <filename>GENERIC</filename> one, you can
+ <para>If you do not want to rebuild your custom kernel, you can
directly load the &man.uscanner.4; device driver module with
- the &man.kldload.8; command:</para>
+ &man.kldload.8;:</para>
<screen>&prompt.root; <userinput>kldload uscanner</userinput></screen>
@@ -1609,9 +1608,10 @@
<programlisting>uscanner_load="YES"</programlisting>
<para>After rebooting with the correct kernel, or after
- loading the required module, plug in your USB scanner. The
- scanner should appear in your system message buffer
- (&man.dmesg.8;) as something like:</para>
+ loading the required module, plug in your USB scanner. A
+ line showing the detection of your scanner should appear
+ in the system message buffer
+ (&man.dmesg.8;):</para>
<screen>uscanner0: EPSON EPSON Scanner, rev 1.10/3.02, addr 2</screen>
@@ -1645,8 +1645,8 @@
<programlisting>device scbus
device pass</programlisting>
- <para>Once your kernel has been properly compiled, you should
- be able to see the devices in your system message buffer,
+ <para>After building and installing the custom kernel,
+ the devices should be shown in the system message buffer
when booting:</para>
<screen>pass2 at aic0 bus 0 target 2 lun 0
@@ -1672,7 +1672,7 @@
<AGFA SNAPSCAN 600 1.10> at scbus1 target 2 lun 0 (pass3)
<PHILIPS CDD3610 CD-R/RW 1.00> at scbus2 target 0 lun 0 (pass2,cd0)</screen>
- <para>More details about SCSI devices, are available in the
+ <para>More details about SCSI devices are available in the
&man.scsi.4; and &man.camcontrol.8; manual pages.</para>
</sect3>
</sect2>
@@ -1680,48 +1680,45 @@
<sect2>
<title>SANE Configuration</title>
- <para>The <application>SANE</application> system has been
- splitted in two parts: the backends (<filename
+ <para>The <application>SANE</application> system is
+ split into two parts: the backends (<filename
role="package">graphics/sane-backends</filename>) and the
frontends (<filename
- role="package">graphics/sane-frontends</filename>). The
- backends part provides access to the scanner itself. The
+ role="package">graphics/sane-frontends</filename>). Backends
+ control the scanner, while frontends provide a user interface.
+ The
<application>SANE</application>'s <ulink
url="http://sane-project.org/sane-supported-devices.html">supported
devices</ulink> list specifies which backend will support your
- image scanner. It is mandatory to determine the correct
- backend for your scanner if you want to be able to use your
- device. The frontends part provides the graphical scanning
- interface (<application>xscanimage</application>).</para>
+ image scanner.</para>
- <para>The first thing to do is install the <filename
+ <para>The first step is to install the <filename
role="package">graphics/sane-backends</filename> port or
- package. Then, use the <command>sane-find-scanner</command>
- command to check the scanner detection by the
+ package. Then use <command>sane-find-scanner</command>
+ to check the scanner detection by the
<application>SANE</application> system:</para>
<screen>&prompt.root; <userinput>sane-find-scanner -q</userinput>
found SCSI scanner "AGFA SNAPSCAN 600 1.10" at /dev/pass3</screen>
- <para>The output will show the interface type of the scanner and
- the device node used to attach the scanner to the system. The
- vendor and the product model may not appear, it is not
- important.</para>
+ <para>The type of interface and
+ device node where the scanner is attached to the system are shown. The
+ scanner vendor and model may not appear.</para>
<note>
- <para>Some USB scanners require you to load a firmware, this
+ <para>Some USB scanners require an upload of firmware, which
is explained in the backend manual page. You should also read
&man.sane-find-scanner.1; and &man.sane.7; manual
pages.</para>
</note>
<para>Now we have to check if the scanner will be identified by
- a scanning frontend. By default, the
- <application>SANE</application> backends comes with a command
- line tool called &man.scanimage.1;. This command allows you
- to list the devices and to perform an image acquisition from
+ a scanning frontend. Included with the
+ <application>SANE</application> backends is
+ &man.scanimage.1;. This program allows you
+ to list the devices and scan images from
the command line. The <option>-L</option> option is used to
- list the scanner device:</para>
+ list the scanner devices:</para>
<screen>&prompt.root; <userinput>scanimage -L</userinput>
device `snapscan:/dev/pass3' is a AGFA SNAPSCAN 600 flatbed scanner</screen>
@@ -1733,7 +1730,7 @@
used. The <filename
class="directory">/usr/local/etc/sane.d/</filename> directory
contains all backends configuration files. This
- identification problem does appear with certain USB
+ identification problem appears with certain USB
scanners.</para>
<para>For example, with the USB scanner used in the <xref
@@ -1743,9 +1740,9 @@
<screen>&prompt.root; <userinput>sane-find-scanner -q</userinput>
found USB scanner (UNKNOWN vendor and product) at device /dev/uscanner0</screen>
- <para>The scanner is correctly detected, it uses the USB
- interface and is attached to the
- <filename>/dev/uscanner0</filename> device node. We can now
+ <para>The scanner is detected, it uses the USB
+ interface and is attached to
+ <filename>/dev/uscanner0</filename>. We can now
check if the scanner is correctly identified:</para>
<screen>&prompt.root; <userinput>scanimage -L</userinput>
@@ -1756,41 +1753,37 @@
which came with this software (README, FAQ, manpages).</screen>
<para>Since the scanner is not identified, we will need to edit
- the <filename>/usr/local/etc/sane.d/epson.conf</filename>
- file. The scanner model used was the &epson.perfection; 1650,
- so we know the scanner will use the <literal>epson</literal>
- backend. Be sure to read the help comments in the backends
- configuration files. Line changes are quite simple: comment
+ <filename>/usr/local/etc/sane.d/epson.conf</filename>.
+ The scanner used in this example was an &epson.perfection; 1650,
+ so we know it will use the <literal>epson</literal>
+ backend. Before making changes, read the comments in the backends
+ configuration files and manual pages. Comment
out all lines that have the wrong interface for your scanner
- (in our case, we will comment out all lines starting with the
- word <literal>scsi</literal> as our scanner uses the USB
- interface), then add at the end of the file a line specifying
- the interface and the device node used. In this case, we add
- the following line:</para>
+ (for this USB scanner, we will comment out all lines starting with the
+ word <literal>scsi</literal>),
+ Then, at the end of the file, add a line specifying
+ the interface and the device node used. In this case, we add:</para>
<programlisting>usb /dev/uscanner0</programlisting>
- <para>Please be sure to read the comments provided in the
- backend configuration file as well as the backend manual page
- for more details and correct syntax to use. We can now verify
- if the scanner is identified:</para>
+ <para>We can now verify if the scanner is identified:</para>
<screen>&prompt.root; <userinput>scanimage -L</userinput>
device `epson:/dev/uscanner0' is a Epson GT-8200 flatbed scanner</screen>
<para>Our USB scanner has been identified. It is not important
- if the brand and the model do not match. The key item to be
- concerned with is the
- <literal>`epson:/dev/uscanner0'</literal> field, which give us
+ if the brand and the model do not match the scanner. The key item
+ is the
+ <literal>`epson:/dev/uscanner0'</literal> field, which shows
the right backend name and the right device node.</para>
<para>Once the <command>scanimage -L</command> command is able
- to see the scanner, the configuration is complete. The device
+ to detect the scanner, configuration is complete. The device
is now ready to scan.</para>
<para>While &man.scanimage.1; does allow us to perform an
- image acquisition from the command line, it is preferable to
- use a graphical user interface to perform image scanning.
+ image acquisition from the command line,
+ graphical user interfaces are usually preferable for image scanning.
<application>SANE</application> offers a simple but efficient
graphical interface: <application>xscanimage</application>
(<filename
@@ -1798,19 +1791,19 @@
<para><application>Xsane</application> (<filename
role="package">graphics/xsane</filename>) is another popular
- graphical scanning frontend. This frontend offers advanced
- features such as various scanning mode (photocopy, fax, etc.),
- color correction, batch scans, etc. Both of these applications
- are useable as a <application>GIMP</application>
- plugin.</para>
+ graphical scanning frontend which offers
+ various scanning modes (photocopy, fax) and other advanced features.
+ Both of these applications
+ are useable as <application>GIMP</application>
+ plugins.</para>
</sect2>
<sect2>
- <title>Allowing Scanner Access to Other Users</title>
+ <title>Giving Other Users Access To The Scanner</title>
<para>All previous operations have been done with
- <username>root</username> privileges. You may however, need
- other users to have access
+ <username>root</username> privileges. However, you may wish to give
+ ordinary users access
to the scanner. The user will need read and write
permissions to the device node used by the scanner. As an
example, our USB scanner uses the device node
@@ -1826,13 +1819,13 @@
also have to set the correct write permissions (0660 or 0664)
on the <filename>/dev/uscanner0</filename> device node, by
default the <groupname>operator</groupname> group can only
- read the device node. This is done by adding the following
- lines to the <filename>/etc/devfs.rules</filename> file:</para>
+ read the device node. This is done by adding these
+ lines to <filename>/etc/devfs.rules</filename>:</para>
<programlisting>[system=5]
add path uscanner0 mode 660</programlisting>
- <para>Then add the following to
+ <para>Then add this line to
<filename>/etc/rc.conf</filename> and reboot the
machine:</para>
@@ -1845,7 +1838,7 @@
<filename>/dev/uscanner0</filename>.</para>
<note>
- <para>Of course, for security reasons, you should think twice
+ <para>For security reasons, you should think twice
before adding a user to any group, especially the
<groupname>operator</groupname> group.</para>
</note>
>Release-Note:
>Audit-Trail:
>Unformatted:
More information about the freebsd-doc
mailing list