diff options
| -rw-r--r-- | sbin/raidctl/raidctl.8 | 123 |
1 files changed, 39 insertions, 84 deletions
diff --git a/sbin/raidctl/raidctl.8 b/sbin/raidctl/raidctl.8 index 75306db11c5..795ef13295b 100644 --- a/sbin/raidctl/raidctl.8 +++ b/sbin/raidctl/raidctl.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: raidctl.8,v 1.22 2002/02/17 20:23:36 tdeval Exp $ +.\" $OpenBSD: raidctl.8,v 1.23 2002/02/18 22:57:05 tdeval Exp $ .\" $NetBSD: raidctl.8,v 1.24 2001/07/10 01:30:52 lukem Exp $ .\" .\" Copyright (c) 1998 The NetBSD Foundation, Inc. @@ -70,59 +70,12 @@ .Sh SYNOPSIS .Nm raidctl .Op Fl v -.Fl a Ar component Ar dev -.Nm raidctl -.Op Fl v -.Fl A Op yes | no | root +.Op Fl afFgrR Ar component +.Op Fl BGipPsSu +.Op Fl cC Ar config_file +.Op Fl A Op yes | no | root +.Op Fl I Ar serial_number .Ar dev -.Nm raidctl -.Op Fl v -.Fl B Ar dev | Ic all -.Nm raidctl -.Op Fl v -.Fl c Ar config_file Ar dev -.Nm raidctl -.Op Fl v -.Fl C Ar config_file Ar dev -.Nm raidctl -.Op Fl v -.Fl f Ar component Ar dev -.Nm raidctl -.Op Fl v -.Fl F Ar component Ar dev -.Nm raidctl -.Op Fl v -.Fl g Ar component Ar dev -.Nm raidctl -.Op Fl v -.Fl G Ar dev | Ic all -.Nm raidctl -.Op Fl v -.Fl i Ar dev | Ic all -.Nm raidctl -.Op Fl v -.Fl I Ar serial_number Ar dev -.Nm raidctl -.Op Fl v -.Fl p Ar dev | Ic all -.Nm raidctl -.Op Fl v -.Fl P Ar dev | Ic all -.Nm raidctl -.Op Fl v -.Fl r Ar component Ar dev -.Nm raidctl -.Op Fl v -.Fl R Ar component Ar dev -.Nm raidctl -.Op Fl v -.Fl s Ar dev | Ic all -.Nm raidctl -.Op Fl v -.Fl S Ar dev | Ic all -.Nm raidctl -.Op Fl v -.Fl u Ar dev | Ic all .Sh DESCRIPTION .Nm is the user-land control program for @@ -136,6 +89,31 @@ devices. For more information about the RAIDframe disk device, see This document assumes the reader has at least rudimentary knowledge of RAID and RAID concepts. .Pp +The device used by +.Nm +is specified by +.Ar dev . +.Ar dev +may be either the full name of the device, e.g. /dev/rraid0c, +or just simply raid0 (for /dev/rraid0c). +.Pp +For several commands ( +.Fl BGipPsSu +), +.Nm +can accept the word +.Ic all +as the +.Ar dev +argument. +If +.Ic all +is used, +.Nm +will execute the requested action for all the configured +.Xr raid 4 +devices. +.Pp The command-line options for .Nm are as follows: @@ -162,7 +140,7 @@ will the use of the boot disk as the root device. All components of the set must be of type RAID in the disklabel. Note that the kernel being booted must currently reside on a non-RAID set. -.It Fl B Ar dev | Ic all +.It Fl B Ar dev Initiate a copyback of reconstructed data from a spare disk to its original disk. This is performed after a component has failed, and the failed drive has been reconstructed onto a spare drive. @@ -192,14 +170,14 @@ disk onto an available hot spare. This is one of the mechanisms used to start the reconstruction process if a component does have a hardware failure. .It Fl g Ar component Ar dev Get the component label for the specified component. -.It Fl G Ar dev | Ic all +.It Fl G Ar dev Generate the configuration of the RAIDframe device in a format suitable for use with .Nm .Fl c or .Fl C . -.It Fl i Ar dev | Ic all +.It Fl i Ar dev Initialize the RAID device. In particular, (re-write) the parity on the selected device. This .Ar MUST @@ -216,10 +194,10 @@ strictly enforced, different serial numbers should be used for different RAID sets. This step .Ar MUST be performed when a new RAID set is created. -.It Fl p Ar dev | Ic all +.It Fl p Ar dev Check the status of the parity on the RAID set. Displays a status message, and returns successfully if the parity is up-to-date. -.It Fl P Ar dev | Ic all +.It Fl P Ar dev Check the status of the parity on the RAID set, and initialize (re-write) the parity if the parity is not known to be up-to-date. This is normally used after a system crash (and before a @@ -236,43 +214,20 @@ if necessary, and immediately begins a reconstruction back to .Ar component . This is useful for reconstructing back onto a component after it has been replaced following a failure. -.It Fl s Ar dev | Ic all +.It Fl s Ar dev Display the status of the RAIDframe device for each of the components and spares. -.It Fl S Ar dev | Ic all +.It Fl S Ar dev Check the status of parity re-writing, component reconstruction, and component copyback. The output indicates the amount of progress achieved in each of these areas. -.It Fl u Ar dev | Ic all +.It Fl u Ar dev Unconfigure the RAIDframe device. .It Fl v Be more verbose. For operations such as reconstructions, parity re-writing, and copybacks, provide a progress indicator. .El .Pp -The device used by -.Nm -is specified by -.Ar dev . -.Ar dev -may be either the full name of the device, e.g. /dev/rraid0c, -or just simply raid0 (for /dev/rraid0c). -.Pp -For several commands, -.Nm -can accept the word -.Ic all -as the -.Ar dev -argument. -If -.Ic all -is used, -.Nm -will execute the requested action for all the configured -.Xr raid 4 -devices. -.Pp .Ss Configuration file The format of the configuration file is complex, and only an abbreviated treatment is given here. In the configuration |