Add PCICAP_{ID,NEXTPTR} to avoid using magic number
[dragonfly.git] / usr.sbin / sgsc / sgsc.1
1 .\" sgsc(1) - manual page for the `gsc' scanner device driver utility
2 .\"
3 .\"
4 .\" Copyright (c) 1995 Gunther Schadow.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. All advertising materials mentioning features or use of this software
15 .\"    must display the following acknowledgement:
16 .\"     This product includes software developed by Gunther Schadow.
17 .\" 4. The name of the author may not be used to endorse or promote products
18 .\"    derived from this software without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 .\"
30 .\" $FreeBSD: src/usr.sbin/sgsc/sgsc.1,v 1.8.2.2 2001/03/06 14:21:43 ru Exp $
31 .\" $DragonFly: src/usr.sbin/sgsc/sgsc.1,v 1.3 2007/11/23 23:03:57 swildner Exp $
32 .\"
33 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 .Dd January 6, 1995
35 .Dt SGSC 1
36 .Os
37 .Sh NAME
38 .Nm sgsc
39 .Nd set the options of the gsc scanner device
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl sq
43 .Op Fl b Ar len
44 .Op Fl f Ar file
45 .Op Fl h Ar height
46 .Op Fl r Ar resolution
47 .Op Fl t Ar timeout
48 .Op Fl w Ar width
49 .Sh DESCRIPTION
50 The
51 .Nm
52 utility provides shell level access to the ioctl
53 requests served by the handy scanner device driver gsc.
54 Please see
55 .Xr gsc 4
56 for the exact meaning of the requests.  Generally they modify
57 the output and behaviour of the gsc scanner device.
58 When
59 .Nm
60 is called with no option only the current settings are reported.
61 .Pp
62 The following options are available:
63 .Bl -tag -width indent
64 .It Fl s Bq Dv GSC_SRESSW
65 Set the scanner with the values of the resolution selector switch.
66 .It Fl q
67 Operate in quiet mode, i.e. do not report any of the current settings.
68 Normally the parameters are shown after the modifications have been
69 performed.
70 .It Fl f Ar file
71 Operate on a different scanner device node given by filename.
72 Note
73 that even though there may exist more than one node of scanner device
74 several of them will refer the same device unit.
75 The modifications are
76 performed od the unit regardless of the device node by which it is
77 accessed.
78 .It Fl r Ar resolution Bq Dv GSC_SRES
79 Set the resolution in dpi.
80 .It Fl w Ar width Bq Dv GSC_SWIDTH
81 Set the width of the bitmap in pixels.
82 .It Fl h Ar height Bq Dv GSC_SHEIGHT
83 Set the height of the bitmap in lines of pixels.
84 .It Fl b Ar len Bq Dv GSC_SBLEN
85 Set the internal dma buffer to be
86 .Ar len
87 lines in size.
88 .It Fl t Ar timeout Bq Dv GSC_SBTIME
89 Set the timeout time for reading one dma buffer.
90 .El
91 .Sh FILES
92 .Bl -tag -width /dev/gsc0p -compact
93 .It Pa /dev/gsc0
94 device node for
95 .Em raw
96 output
97 .It Pa /dev/gsc0p
98 device node for output in
99 .Em pbm
100 file format
101 .El
102 .Sh SEE ALSO
103 .Xr gsc 4
104 .Sh AUTHORS
105 .An Gunther Schadow Aq gusw@fub46.zedat.fu-berlin.de