xref: /netbsd/sbin/dkctl/dkctl.8 (revision bf9ec67e)
1.\"	$NetBSD: dkctl.8,v 1.2 2002/01/09 23:10:19 wiz Exp $
2.\"
3.\" Copyright 2002 Wasabi Systems, Inc.
4.\" All rights reserved.
5.\"
6.\" Written by Jason R. Thorpe for Wasabi Systems, Inc.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed for the NetBSD Project by
19.\"	Wasabi Systems, Inc.
20.\" 4. The name of Wasabi Systems, Inc. may not be used to endorse
21.\"    or promote products derived from this software without specific prior
22.\"    written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
26.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
27.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
28.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34.\" POSSIBILITY OF SUCH DAMAGE.
35.\"
36.Dd January 9, 2002
37.Dt DKCTL 8
38.Os
39.Sh NAME
40.Nm dkctl
41.Nd a program to manipulate disks
42.Sh SYNOPSIS
43.Nm
44.Ar device
45.Ar command
46.Oo
47.Ar arg Oo ...
48.Oc
49.Oc
50.Sh DESCRIPTION
51.Nm
52allows a user or system administrator to manipulate and configure disks
53in various ways.  It is used by specifying a disk to manipulate, the command
54to perform, and any arguments the command may require.
55.Sh COMMANDS
56The following commands are supported:
57.Pp
58.Nm getcache
59.Pp
60Get and display the cache enables for the specified device.
61.Pp
62.Nm setcache
63.Ar none | r | w | rw
64.Op Ar save
65.Pp
66Set the cache enables for the specified device.  The enables are
67as follows:
68.Bl -tag -width indent
69.It none
70Disable all caches on the disk.
71.It r
72Enable the read cache, and disable all other caches on the disk.
73.It w
74Enable the write cache, and disable all other caches on the disk.
75.It rw
76Enable both the read and write caches on the disk.
77.It save
78If specified, and the cache enables are savable, saves the cache
79enables in the disk's non-volatile parameter storage.
80.El
81.Pp
82.Nm synccache
83.Op Ar force
84.Pp
85Causes the cache on the disk to be synchronized, flushing all dirty
86write cache blocks to the media.  If
87.Ar force
88is specified, the cache synchronization command will be issued even
89if the kernel does not believe that there are any dirty cache blocks
90in the disk's cache.
91.Sh SEE ALSO
92.Xr ioctl 2 ,
93.Xr sd 4 ,
94.Xr wd 4
95.Sh HISTORY
96The
97.Nm
98command first appeared in
99.Nx 1.6 .
100.Sh AUTHORS
101The
102.Nm
103command was written by Jason R. Thorpe of Wasabi Systems, Inc.
104