Improve formatting.

This commit is contained in:
wiz 2004-09-25 12:44:25 +00:00
parent 2e988c7c99
commit 76b7f3faf9
1 changed files with 23 additions and 48 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: dkctl.8,v 1.14 2004/09/25 04:00:49 snj Exp $ .\" $NetBSD: dkctl.8,v 1.15 2004/09/25 12:44:25 wiz Exp $
.\" .\"
.\" Copyright 2002 Wasabi Systems, Inc. .\" Copyright 2002 Wasabi Systems, Inc.
.\" All rights reserved. .\" All rights reserved.
@ -38,15 +38,12 @@
.Os .Os
.Sh NAME .Sh NAME
.Nm dkctl .Nm dkctl
.Nd a program to manipulate disks .Nd program to manipulate disks
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Ar device .Ar device
.Ar command .Ar command
.Oo .Op Ar arg Op ...
.Ar arg Oo ...
.Oc
.Oc
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
allows a user or system administrator to manipulate and configure disks allows a user or system administrator to manipulate and configure disks
@ -55,18 +52,13 @@ It is used by specifying a disk to manipulate, the command
to perform, and any arguments the command may require. to perform, and any arguments the command may require.
.Sh COMMANDS .Sh COMMANDS
The following commands are supported: The following commands are supported:
.Pp .Bl -tag -width XgetwedgeinfoX
.Nm getcache .It Ic getcache
.Pp
Get and display the cache enables for the specified device. Get and display the cache enables for the specified device.
.Pp .It Ic setcache Ar none | r | w | rw Op Ar save
.Nm setcache
.Ar none | r | w | rw
.Op Ar save
.Pp
Set the cache enables for the specified device. Set the cache enables for the specified device.
The enables are as follows: The enables are as follows:
.Bl -tag -width indent .Bl -tag -offset indent -width XsaveX
.It none .It none
Disable all caches on the disk. Disable all caches on the disk.
.It r .It r
@ -79,10 +71,7 @@ Enable both the read and write caches on the disk.
If specified, and the cache enables are savable, saves the cache If specified, and the cache enables are savable, saves the cache
enables in the disk's non-volatile parameter storage. enables in the disk's non-volatile parameter storage.
.El .El
.Pp .It Ic synccache Op Ar force
.Nm synccache
.Op Ar force
.Pp
Causes the cache on the disk to be synchronized, flushing all dirty Causes the cache on the disk to be synchronized, flushing all dirty
write cache blocks to the media. write cache blocks to the media.
If If
@ -90,10 +79,7 @@ If
is specified, the cache synchronization command will be issued even is specified, the cache synchronization command will be issued even
if the kernel does not believe that there are any dirty cache blocks if the kernel does not believe that there are any dirty cache blocks
in the disk's cache. in the disk's cache.
.Pp .It Ic keeplabel Op Ar yes | no
.Nm keeplabel
.Op Ar yes | no
.Pp
Specify to keep or drop the in-core disklabel on the last close of Specify to keep or drop the in-core disklabel on the last close of
the disk device. the disk device.
(Keep if (Keep if
@ -101,15 +87,14 @@ the disk device.
is specified, drop if is specified, drop if
.Ar no .Ar no
is specified.) is specified.)
.Pp .It Ic badsector Ar flush | list | retry
.Nm badsector Used for managing the kernel's bad sector list for
.Ar flush | list | retry .Xr wd 4
.Pp devices.
Used for managing the kernel's bad sector list for wd* devices.
The software bad sector list is only maintained if the option The software bad sector list is only maintained if the option
.Dq WD_SOFTBADSECT .Dq WD_SOFTBADSECT
was specified on kernel configuration. was specified on kernel configuration.
.Bl -tag -width indent .Bl -tag -width XflushX -offset indent
.It flush .It flush
Clears the in kernel list of bad sectors. Clears the in kernel list of bad sectors.
.It list .It list
@ -121,15 +106,9 @@ This option
.Em can only .Em can only
be used with character devices. be used with character devices.
.El .El
.Pp .It Ic addwedge Ar name Ar startblk Ar blkcnt Ar ptype
.Nm addwedge
.Ar name
.Ar startblk
.Ar blkcnt
.Ar ptype
.Pp
Define a Define a
.Sq wedge .Dq wedge
on the specified disk starting at block number on the specified disk starting at block number
.Ar startblk .Ar startblk
and spanning and spanning
@ -144,21 +123,15 @@ displayed after the wedge has been successfully created.
See See
.Xr dk 4 .Xr dk 4
for more information about disk wedges. for more information about disk wedges.
.Pp .It Ic delwedge Ar dk
.Nm delwedge
.Ar dk
.Pp
Delete the wedge specified by its device name Delete the wedge specified by its device name
.Ar dk .Ar dk
from the specified disk. from the specified disk.
.Pp .It Ic getwedgeinfo
.Nm getwedgeinfo
.Pp
Display information about the specified disk wedge. Display information about the specified disk wedge.
.Pp .It Ic listwedges
.Nm listwedges
.Pp
List all of the wedges configured on the specified disk. List all of the wedges configured on the specified disk.
.El
.Sh SEE ALSO .Sh SEE ALSO
.Xr ioctl 2 , .Xr ioctl 2 ,
.Xr dk 4 , .Xr dk 4 ,
@ -175,4 +148,6 @@ command first appeared in
.Sh AUTHORS .Sh AUTHORS
The The
.Nm .Nm
command was written by Jason R. Thorpe of Wasabi Systems, Inc. command was written by
.An Jason R. Thorpe
of Wasabi Systems, Inc.