xref: /dragonfly/usr.sbin/fdcontrol/fdcontrol.8 (revision 333227be)
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.2 2003/06/17 04:29:53 dillon 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
44The
45.Nm
46utility allows the modification of the run-time behavior of the floppy
47disk device specified by
48.Ar device .
49.Ar Device
50should be a character device.
51.Pp
52The
53.Nm
54utility currently supports the specification of device parameters for the
55floppy disk drive
56.Fl ( s ,
57also default mode),
58or it allows the modification of the driver debug level, in case the
59floppy driver has been compiled into the kernel with the
60.Em DEBUG
61option set
62.Pq Fl d .
63.Pp
64Since the implications of such actions are considered harmful, the
65underlying
66.Xr ioctl 2
67command is restricted to the super-user.
68.Pp
69When requesting a new parameter specification, the command asks the
70user for each individual tunable parameter, defaulting to the
71currently used value.
72.Sh DIAGNOSTICS
73Error codes for the underlying
74.Xr ioctl 2
75commands are printed by the
76.Xr warn 3
77facility.
78.Sh BUGS
79The
80.Nm
81utility is currently under development.
82It's user interface is rather
83silly and likely to change in future, options should be provided to
84allow anything being modified from the command line.
85.Pp
86The driver does actually support only two debug levels
87(0 and 1),
88where debug level 1 will generate huge amounts of output.
89It is likely
90to overflow the syslog if not used with extreme care.
91.Sh SEE ALSO
92.Xr ioctl 2 ,
93.Xr warn 3 ,
94.Xr fdc 4
95.Sh HISTORY
96The
97.Nm
98utility is currently under development.
99It's user interface and overall
100functionality are subjects to future improvements and changes.
101.Sh AUTHORS
102The program has been contributed by
103.An J\(:org Wunsch ,
104Dresden.
105