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