From c25da7d4699ee4da9ce96ebf4b64998fc78f7a29 Mon Sep 17 00:00:00 2001 From: Greg Lehey Date: Wed, 20 Dec 2000 05:08:41 +0000 Subject: [PATCH] Cosmetics. Correct location of history file. Change references from /dev/wd to /dev/ad. Use more appropriate defaults for stripe size in examples. --- sbin/vinum/vinum.8 | 80 ++++++++++++++++++++++++---------------------- 1 file changed, 42 insertions(+), 38 deletions(-) diff --git a/sbin/vinum/vinum.8 b/sbin/vinum/vinum.8 index 9dac38eae962..41def15c32d3 100644 --- a/sbin/vinum/vinum.8 +++ b/sbin/vinum/vinum.8 @@ -37,7 +37,7 @@ .\" $Id: vinum.8,v 1.13 2000/01/03 03:12:56 grog Exp grog $ .\" $FreeBSD$ .\" -.Dd October 13, 1999 +.Dd 20 December 2000 .Dt vinum 8 .Os .Sh NAME @@ -258,7 +258,7 @@ Remove an object .in +1i Save .Nm -configuration to disk. +configuration to disk after configuration failures. .in .ig XXX @@ -315,7 +315,7 @@ is a utility program to communicate with the \fBVinum\fP\| logical volume manager. See .Xr vinum 4 for more information about the volume manager. -.Nm +.Xr vinum 8 is designed either for interactive use, when started without command line arguments, or to execute a single command if the command is supplied on the command line. In interactive mode, @@ -446,7 +446,9 @@ is specified, renames the object (and in the case of a plex, any subordinate subdisks) to fit in with the default .Nm -naming convention. +naming convention. To rename the object to any other name, use the +.Nm rename +command. .Pp A number of considerations apply to attaching subdisks: .Bl -bullet @@ -467,9 +469,9 @@ For concatenated plexes, the parameter specifies the offset in blocks from the beginning of the plex. For striped and RAID-5 plexes, it specifies the offset of the first block of the subdisk: in other words, the offset is the numerical position of the subdisk -multiplied by the stripe size. For example, in a plex of block size 256k, the -first subdisk will have offset 0, the second offset 256k, the third 512k, etc. -This calculation ignores parity blocks in RAID-5 plexes. +multiplied by the stripe size. For example, in a plex with stripe size 271k, +the first subdisk will have offset 0, the second offset 271k, the third 542k, +etc. This calculation ignores parity blocks in RAID-5 plexes. .El .It Nm checkparity .Ar plex @@ -578,8 +580,9 @@ command. .It Nm debug .Pp .Nm -.Ar debug -is used to enter the remote kernel debugger. It is only activated if +.Ar debug , +without any arguments, is used to enter the remote kernel debugger. It is only +activated if .Nm is built with the .Ar VINUMDEBUG @@ -905,7 +908,7 @@ This command is deprecated. .Ar list is used to show information about the specified object. If the argument is omitted, information is shown about all objects known to -.Nm . +.Nm vinum . The .Ar l command is a synonym for @@ -1010,6 +1013,7 @@ option is required for this function, since it currently does not preserve the data in the subdisk. This functionality will be added at a later date. In this form, however, it is suited to recovering a failed disk drive. .It Nm printconfig Op Pa file +.Pp Write a copy of the current configuration to .Pa file in a format that can be used to recreate the @@ -1191,10 +1195,15 @@ option, it will remove both the plexes and the subdisks which belong to the plexes. .It Nm saveconfig .Pp -Save the current configuration to disk. This is primarily a maintenance -function. For example, if an error occurs on startup, updates will be -disabled. When you reenable them, the configuration is not automatically saved -to disk. Use this command to save the configuration. +Save the current configuration to disk. Normally this is not necessary, since +.Nm +automatically saves any change in configuration. If an error occurs on startup, +updates will be disabled. When you reenable them with the +.Ar setdaemon +command, +.Nm +does not automatically save the configuration to disk. Use this command to save +the configuration. .ig .It Nm set .Op Fl f @@ -1355,7 +1364,7 @@ If no parameters are specified, removes the .Nm kld and stops -.Nm . +.Xr vinum 8 . This can only be done if no objects are active. In particular, the .Fl f option does not override this requirement. Normally, the @@ -1631,9 +1640,9 @@ Specify the device on which the drive resides. must be the name of a disk partition, for example .Pa /dev/da1e or -.Pa /dev/wd3s2h , +.Pa /dev/ad3s2h , and it must be of type -.Nm . +.Nm vinum . Do not use the .Nm c partition, which is reserved for the complete disk. @@ -1914,9 +1923,9 @@ the maximum size of a subdisk is 265 sectors smaller than the drive. .Sh LOG FILE .Nm maintains a log file, by default -.Pa /var/log/vinum_history , +.Pa /var/tmp/vinum_history , in which it keeps track of the commands issued to -.Nm . +.Nm vinum . You can override the name of this file by setting the environment variable .Ev VINUM_HISTORY to the name of the file. @@ -1935,19 +1944,19 @@ system. .Ss Where to put the data The first choice you need to make is where to put the data. You need dedicated disk partitions for -.Nm . +.Nm vinum . They should be partitions, not devices, and they should not be partition .Nm c . For example, good names are .Pa /dev/da0e or -.Pa /dev/wd3s4a . +.Pa /dev/ad3s4a . Bad names are .Pa /dev/da0 and .Pa /dev/da0s1 , both of which represent a device, not a partition, and -.Pa /dev/wd1c , +.Pa /dev/ad1c , which represents a complete disk and should be of type .Nm unused . See the example under DRIVE LAYOUT CONSIDERATIONS above. @@ -2313,7 +2322,7 @@ command. A number of misconceptions exist about how to set up a RAID array for best performance. In particular, most systems use far too small a stripe size. The following discussion applies to all RAID systems, not just to -.Nm . +.Nm vinum . .Pp The FreeBSD block I/O system issues requests of between .5kB and 128 kB; a typical mix is somewhere round 8 kB. You can't stop any striping system from @@ -2523,8 +2532,7 @@ you can easily overwrite a file system. will not permit this. .Pp For similar reasons, the -.Nm -.Ar start +.Nm vinum Ar start command will not accept a drive on partition .Ar c . Partition @@ -2563,8 +2571,7 @@ provides two ways to ensure that newly created plexes are .Bl -bullet .It Create the plexes and then synchronize them with -.Nm -.Ar start . +.Nm vinum start . .It Create the volume (not the plex) with the keyword .Ar setupstate , @@ -2603,7 +2610,7 @@ please report the situation. If you build the kernel module with the .Ar -DVINUMDEBUG option, you must also build -.Nm +.Nm vinum(8) with the .Ar -DVINUMDEBUG option, since the size of some data objects used by both components depends on @@ -2618,15 +2625,12 @@ vinumioctl: invalid ioctl from process 247 (vinum): c0e44642 This error may also occur if you use old versions of kld or userland program. .It The -.Nm -.Ar read +.Nm vinum Ar read command has a particularly emetic syntax. Once it was the only way to start -.Nm , +.Nm vinum , but now the preferred method is with -.Nm -.Ar start . -.Nm -.Ar read +.Nm vinum Ar start . +.Nm vinum Ar read should be used for maintenance purposes only. Note that its syntax has changed, and the arguments must be disk slices, such as .Pa /dev/da0 , @@ -2642,7 +2646,7 @@ objects. .br .Ar /dev/vinum/control - control device for -.Nm +.Nm vinum .br .Ar /dev/vinum/plex - directory containing device nodes for @@ -2668,8 +2672,8 @@ The name of the editor to use for editing configuration files, by default .Xr vinum 4 , .Xr disklabel 8 , .Xr newfs 8 , -.Pa http://www.lemis.com/vinum.html , -.Pa http://www.lemis.com/vinum-debugging.html . +.Pa http://www.vinumvm.org/vinum.html , +.Pa http://www.vinumvm.org/vinum-debugging.html . .Sh AUTHORS .An Greg Lehey Aq grog@lemis.com . .Sh HISTORY