share/man/man4/uscanner.4

   1 .\" Copyright (c) 2000, Jeroen Ruigrok van der Werven <asmodai@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Bill Paul.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"   without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY NICK HIBMA AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL NICK HIBMA OR THE VOICES IN HIS HEAD
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29 .\" THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd October 5, 2007
  34 .Dt USCANNER 4
  35 .Os
  36 .Sh NAME
  37 .Nm uscanner
  38 .Nd USB Scanners
  39 .Sh SYNOPSIS
  40 To compile this driver into the kernel,
  41 place the following line in your
  42 kernel configuration file:
  43 .Bd -ragged -offset indent
  44 .Cd "device uscanner"
  45 .Ed
  46 .Pp
  47 Alternatively, to load the driver as a
  48 module at boot time, place the following line in
  49 .Xr loader.conf 5 :
  50 .Bd -literal -offset indent
  51 uscanner_load="YES"
  52 .Ed
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 driver provides support for scanners that attach to the USB port.
  57 For each scanner attached it will provide an entry like
  58 .Pa /dev/uscanner0
  59 in
  60 .Pa /dev .
  61 User-space programs, e.g. SANE,
  62 can in turn use the device entry throgh a suitable
  63 backend driver (see
  64 .Nm ports/graphics/sane-backends )
  65 to control the scanner itself.
  66 .Pp
  67 In case of multifunction USB devices (e.g. scanner/printer/card reader),
  68 this driver only attaches to the USB interface that controls
  69 the scanner; for the other USB interface you need separate drivers, e.g.
  70 .Nm ulpt ,
  71 .Nm umass ,
  72 and so on.
  73 .Pp
  74 .Nm usb
  75 and one of
  76 .Nm uhci
  77 or
  78 .Nm ohci
  79 must be configured in the kernel as well.
  80 .Sh HARDWARE
  81 Because there is no standard device class for USB scanners, this driver
  82 will only recognise devices whose USB IDs are explicitly listed in the
  83 table in the driver itself.
  84 .Pp
  85 The following devices are supported to date:
  86 .Pp
  87 .Bl -bullet -compact
  88 .It
  89 Acer Acerscan: 320U, 620U, 640U, 640BT, 1240U, C310U;
  90 .It
  91 AGFA SnapScan: 1212U, 1236U, e20, e25, e26, e40, e50, e52, SnapScan Touch;
  92 .It
  93 Avision 1200U
  94 .It
  95 Canon CanoScan: D660U, N656U, N676U, N1220U, LIDE 20, LIDE 25, LIDE 30;
  96 .It
  97 Epson Perfection: 610, 636U / 636Photo, 640U, 1200U / 1200Photo,
  98 1240U / 1240Photo, 1250, 1260, 1270,
  99 1600, 1640SU, 1650, 1660, 1670,
 100 2480,
 101 3200, 3500, 3590,
 102 4200, 4990;
 103 .It
 104 Epson: GT-8400UF, GT-9300UF, GT-9700F;
 105 .It
 106 Epson Stylus: Photo RX425, CX3650, DX-5000, DX-5050, DX-6000, DX-6050
 107 (and possibly more in the CX-5000 and DX-3800..DX-7000 family);
 108 .It
 109 Hewlett Packard: Photosmart S20
 110 .It
 111 Hewlett Packard Scanjet: 2200C,
 112 3300C, 3400CSE,
 113 4100C, 4200C, 4300C,
 114 5200C, 5300C, 5400C,
 115 6200C, 6300C,
 116 8200C, 8250C, 8290C;
 117 .It
 118 KYE ColorPage Vivid-Pro
 119 .It
 120 Microtek Phantom: 336CX, C6;
 121 .It
 122 Microtek ScanMaker: V6UL V6USL, X6U;
 123 .It
 124 Minolta 5400
 125 .It
 126 Mustek: 600 CU, 1200 CU, 1200 UB, 1200 USB;
 127 .It
 128 Mustek BearPaw: 1200F, 1200TA;
 129 .It
 130 NatSemi BearPaw 1200
 131 .It
 132 Nikon CoolScan LS40 ED
 133 .It
 134 Primax 6200
 135 .It
 136 Primax Colorado: 1200u, 600u, USB 19200, USB 9600;
 137 .It
 138 Primax: G2-200, G2-300, G2-600, G2600, G2E-300, G2E-3002, G2E-600, G2E600,
 139 G2X-300,
 140 G600,
 141 ReadyScan 636i;
 142 .It
 143 Ultima 1200 UB Plus
 144 .It
 145 UMAX Astra: 1220U, 1236U, 2000U, 2100U, 2200U, 3400;
 146 .It
 147 Visioneer OneTouch: 3000, 5300, 7600, 6100, 6200, 8100, 8600;
 148 .El
 149 .Sh SEE ALSO
 150 .Xr ohci 4 ,
 151 .Xr uhci 4 ,
 152 .Xr usb 4
 153 .\".Sh HISTORY
 154 .Sh AUTHORS
 155 .An -nosplit
 156 The
 157 .Nm
 158 driver was written by
 159 .An Nick Hibma Aq n_hibma@FreeBSD.org .
 160 .Pp
 161 This manual page was written by
 162 .An Jeroen Ruigrok van der Werven Aq asmodai@FreeBSD.org .