Sweep-fix man page section order to match mdoc(7), part 5/5.
[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 .\" $DragonFly: src/usr.sbin/fdcontrol/fdcontrol.8,v 1.3 2006/02/17 19:40:14 swildner Exp $
29 .\"
30 .Dd May 22, 1994
31 .Os
32 .Dt FDCONTROL 8
33 .Sh NAME
34 .Nm fdcontrol
35 .Nd modify floppy disk parameters
36 .Sh SYNOPSIS
37 .Nm
38 .Op Fl d Ar 0|1
39 .Ar device
40 .Nm
41 .Op Fl s
42 .Ar device
43 .Sh DESCRIPTION
44 The
45 .Nm
46 utility allows the modification of the run-time behavior of the floppy
47 disk device specified by
48 .Ar device .
49 .Ar Device
50 should be a character device.
51 .Pp
52 The
53 .Nm
54 utility currently supports the specification of device parameters for the
55 floppy disk drive
56 .Fl ( s ,
57 also default mode),
58 or it allows the modification of the driver debug level, in case the
59 floppy driver has been compiled into the kernel with the
60 .Em DEBUG
61 option set
62 .Pq Fl d .
63 .Pp
64 Since the implications of such actions are considered harmful, the
65 underlying
66 .Xr ioctl 2
67 command is restricted to the super-user.
68 .Pp
69 When requesting a new parameter specification, the command asks the
70 user for each individual tunable parameter, defaulting to the
71 currently used value.
72 .Sh DIAGNOSTICS
73 Error codes for the underlying
74 .Xr ioctl 2
75 commands are printed by the
76 .Xr warn 3
77 facility.
78 .Sh SEE ALSO
79 .Xr ioctl 2 ,
80 .Xr warn 3 ,
81 .Xr fdc 4
82 .Sh HISTORY
83 The
84 .Nm
85 utility is currently under development.
86 It's user interface and overall
87 functionality are subjects to future improvements and changes.
88 .Sh AUTHORS
89 The program has been contributed by
90 .An J\(:org Wunsch ,
91 Dresden.
92 .Sh BUGS
93 The
94 .Nm
95 utility is currently under development.
96 It's user interface is rather
97 silly and likely to change in future, options should be provided to
98 allow anything being modified from the command line.
99 .Pp
100 The driver does actually support only two debug levels
101 (0 and 1),
102 where debug level 1 will generate huge amounts of output.
103 It is likely
104 to overflow the syslog if not used with extreme care.