ede596ff5567472c2776da51669d54e9c949c269
[dragonfly.git] / usr.sbin / fdcontrol / fdcontrol.8
1 .\"
2 .\" Copyright (C) 1994 by Joerg Wunsch, Dresden
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY
15 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
20 .\" OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
21 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
22 .\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
24 .\" USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
25 .\" DAMAGE.
26 .\"
27 .\" $FreeBSD: src/usr.sbin/fdcontrol/fdcontrol.8,v 1.9.2.4 2002/06/21 16:40:24 charnier Exp $
28 .\"
29 .Dd May 22, 1994
30 .Dt FDCONTROL 8
31 .Os
32 .Sh NAME
33 .Nm fdcontrol
34 .Nd modify floppy disk parameters
35 .Sh SYNOPSIS
36 .Nm
37 .Op Fl d Ar 0|1
38 .Ar device
39 .Nm
40 .Op Fl s
41 .Ar device
42 .Sh DESCRIPTION
43 The
44 .Nm
45 utility allows the modification of the run-time behavior of the floppy
46 disk device specified by
47 .Ar device .
48 .Ar Device
49 should be a character device.
50 .Pp
51 The
52 .Nm
53 utility currently supports the specification of device parameters for the
54 floppy disk drive
55 .Fl ( s ,
56 also default mode),
57 or it allows the modification of the driver debug level, in case the
58 floppy driver has been compiled into the kernel with the
59 .Em DEBUG
60 option set
61 .Pq Fl d .
62 .Pp
63 Since the implications of such actions are considered harmful, the
64 underlying
65 .Xr ioctl 2
66 command is restricted to the super-user.
67 .Pp
68 When requesting a new parameter specification, the command asks the
69 user for each individual tunable parameter, defaulting to the
70 currently used value.
71 .Sh DIAGNOSTICS
72 Error codes for the underlying
73 .Xr ioctl 2
74 commands are printed by the
75 .Xr warn 3
76 facility.
77 .Sh SEE ALSO
78 .Xr ioctl 2 ,
79 .Xr warn 3 ,
80 .Xr fdc 4
81 .Sh HISTORY
82 The
83 .Nm
84 utility is currently under development.
85 It's user interface and overall
86 functionality are subjects to future improvements and changes.
87 .Sh AUTHORS
88 The program has been contributed by
89 .An J\(:org Wunsch ,
90 Dresden.
91 .Sh BUGS
92 The
93 .Nm
94 utility is currently under development.
95 It's user interface is rather
96 silly and likely to change in future, options should be provided to
97 allow anything being modified from the command line.
98 .Pp
99 The driver does actually support only two debug levels
100 (0 and 1),
101 where debug level 1 will generate huge amounts of output.
102 It is likely
103 to overflow the syslog if not used with extreme care.