Initial import from FreeBSD RELENG_4:
[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 .\"
32 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 .Dd January 6, 1995
34 .Dt SGSC 1
35 .Os
36 .Sh NAME
37 .Nm sgsc
38 .Nd set the options of the gsc scanner device
39 .Sh SYNOPSIS
40 .Nm
41 .Op Fl sq
42 .Op Fl b Ar len
43 .Op Fl f Ar file
44 .Op Fl h Ar height
45 .Op Fl r Ar resolution
46 .Op Fl t Ar timeout
47 .Op Fl w Ar width
48 .Sh DESCRIPTION
49 The
50 .Nm
51 utility provides shell level access to the ioctl
52 requests served by the handy scanner device driver gsc.
53 Please see
54 .Xr gsc 4
55 for the exact meaning of the requests.  Generally they modify
56 the output and behaviour of the gsc scanner device.
57 When
58 .Nm
59 is called with no option only the current settings are reported.
60 .Pp
61 The following options are available:
62 .Bl -tag -width indent
63 .It Fl s Bq Dv GSC_SRESSW
64 Set the scanner with the values of the resolution selector switch.
65 .It Fl q
66 Operate in quiet mode, i.e. do not report any of the current settings.
67 Normally the parameters are shown after the modifications have been
68 performed.
69 .It Fl f Ar file
70 Operate on a different scanner device node given by filename.
71 Note
72 that even though there may exist more than one node of scanner device
73 several of them will refer the same device unit.
74 The modifications are
75 performed od the unit regardless of the device node by which it is
76 accessed.
77 .It Fl r Ar resolution Bq Dv GSC_SRES
78 Set the resolution in dpi.
79 .It Fl w Ar width Bq Dv GSC_SWIDHT
80 Set the width of the bitmap in pixels.
81 .It Fl h Ar height Bq Dv GSC_SHEIGHT
82 Set the height of the bitmap in lines of pixels.
83 .It Fl b Ar len Bq Dv GSC_SBLEN
84 Set the internal dma buffer to be
85 .Ar len
86 lines in size.
87 .It Fl t Ar timeout Bq Dv GSC_SBTIME
88 Set the timeout time for reading one dma buffer.
89 .El
90 .Sh FILES
91 .Bl -tag -width /dev/gsc0p -compact
92 .It Pa /dev/gsc0
93 device node for
94 .Em raw
95 output
96 .It Pa /dev/gsc0p
97 device node for output in
98 .Em pbm
99 file format
100 .El
101 .Sh SEE ALSO
102 .Xr gsc 4
103 .Sh AUTHORS
104 .An Gunther Schadow Aq gusw@fub46.zedat.fu-berlin.de