d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Cosmetics.

Browse Source 
Correct location of history file.

Change references from /dev/wd to /dev/ad.

Use more appropriate defaults for stripe size in examples.
This commit is contained in:
Greg Lehey 2000-12-20 05:08:41 +00:00
parent 5e104ad0dd
commit c25da7d469
1 changed files with 42 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
sbin/vinum/vinum.8
View File

@ -37,7 +37,7 @@
.\" $Id: vinum.8,v 1.13 2000/01/03 03:12:56 grog Exp grog $ .\" $Id: vinum.8,v 1.13 2000/01/03 03:12:56 grog Exp grog $
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd October 13, 1999 .Dd 20 December 2000
.Dt vinum 8 .Dt vinum 8
.Os .Os
.Sh NAME .Sh NAME
@ -258,7 +258,7 @@ Remove an object
.in +1i .in +1i
Save Save
.Nm .Nm
configuration to disk. configuration to disk after configuration failures.
.in .in
.ig .ig
XXX XXX
@ -315,7 +315,7 @@ is a utility program to communicate with the \fBVinum\fP\| logical volume
manager. See manager. See
.Xr vinum 4 .Xr vinum 4
for more information about the volume manager. for more information about the volume manager.
.Nm .Xr vinum 8
is designed either for interactive use, when started without command line 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 arguments, or to execute a single command if the command is supplied on the
command line. In interactive mode, 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 renames the object (and in the case of a plex, any subordinate subdisks) to fit
in with the default in with the default
.Nm .Nm
naming convention. naming convention. To rename the object to any other name, use the
.Nm rename
command.
.Pp .Pp
A number of considerations apply to attaching subdisks: A number of considerations apply to attaching subdisks:
.Bl -bullet .Bl -bullet
@ -467,9 +469,9 @@ For concatenated plexes, the
parameter specifies the offset in blocks from the beginning of the plex. For 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 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 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 multiplied by the stripe size. For example, in a plex with stripe size 271k,
first subdisk will have offset 0, the second offset 256k, the third 512k, etc. the first subdisk will have offset 0, the second offset 271k, the third 542k,
This calculation ignores parity blocks in RAID-5 plexes. etc. This calculation ignores parity blocks in RAID-5 plexes.
.El .El
.It Nm checkparity .It Nm checkparity
.Ar plex .Ar plex
@ -578,8 +580,9 @@ command.
.It Nm debug .It Nm debug
.Pp .Pp
.Nm .Nm
.Ar debug .Ar debug ,
is used to enter the remote kernel debugger. It is only activated if without any arguments, is used to enter the remote kernel debugger. It is only
activated if
.Nm .Nm
is built with the is built with the
.Ar VINUMDEBUG .Ar VINUMDEBUG
@ -905,7 +908,7 @@ This command is deprecated.
.Ar list .Ar list
is used to show information about the specified object. If the argument is is used to show information about the specified object. If the argument is
omitted, information is shown about all objects known to omitted, information is shown about all objects known to
.Nm . .Nm vinum .
The The
.Ar l .Ar l
command is a synonym for 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 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. form, however, it is suited to recovering a failed disk drive.
.It Nm printconfig Op Pa file .It Nm printconfig Op Pa file
.Pp
Write a copy of the current configuration to Write a copy of the current configuration to
.Pa file .Pa file
in a format that can be used to recreate the 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. plexes.
.It Nm saveconfig .It Nm saveconfig
.Pp .Pp
Save the current configuration to disk. This is primarily a maintenance Save the current configuration to disk. Normally this is not necessary, since
function. For example, if an error occurs on startup, updates will be .Nm
disabled. When you reenable them, the configuration is not automatically saved automatically saves any change in configuration. If an error occurs on startup,
to disk. Use this command to save the configuration. 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 .ig
.It Nm set .It Nm set
.Op Fl f .Op Fl f
@ -1355,7 +1364,7 @@ If no parameters are specified,
removes the removes the
.Nm .Nm
kld and stops kld and stops
.Nm . .Xr vinum 8 .
This can only be done if no objects are active. In particular, the This can only be done if no objects are active. In particular, the
.Fl f .Fl f
option does not override this requirement. Normally, the 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 must be the name of a disk partition, for example
.Pa /dev/da1e .Pa /dev/da1e
or or
.Pa /dev/wd3s2h , .Pa /dev/ad3s2h ,
and it must be of type and it must be of type
.Nm . .Nm vinum .
Do not use the Do not use the
.Nm c .Nm c
partition, which is reserved for the complete disk. 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 .Sh LOG FILE
.Nm .Nm
maintains a log file, by default 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 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 You can override the name of this file by setting the environment variable
.Ev VINUM_HISTORY .Ev VINUM_HISTORY
to the name of the file. to the name of the file.
@ -1935,19 +1944,19 @@ system.
.Ss Where to put the data .Ss Where to put the data
The first choice you need to make is where to put the data. You need dedicated The first choice you need to make is where to put the data. You need dedicated
disk partitions for disk partitions for
.Nm . .Nm vinum .
They should be partitions, not devices, and they should not be partition They should be partitions, not devices, and they should not be partition
.Nm c . .Nm c .
For example, good names are For example, good names are
.Pa /dev/da0e .Pa /dev/da0e
or or
.Pa /dev/wd3s4a . .Pa /dev/ad3s4a .
Bad names are Bad names are
.Pa /dev/da0 .Pa /dev/da0
and and
.Pa /dev/da0s1 , .Pa /dev/da0s1 ,
both of which represent a device, not a partition, and 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 which represents a complete disk and should be of type
.Nm unused . .Nm unused .
See the example under DRIVE LAYOUT CONSIDERATIONS above. 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 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 performance. In particular, most systems use far too small a stripe size. The
following discussion applies to all RAID systems, not just to following discussion applies to all RAID systems, not just to
.Nm . .Nm vinum .
.Pp .Pp
The FreeBSD block I/O system issues requests of between .5kB and 128 kB; a 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 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. will not permit this.
.Pp .Pp
For similar reasons, the For similar reasons, the
.Nm .Nm vinum Ar start
.Ar start
command will not accept a drive on partition command will not accept a drive on partition
.Ar c . .Ar c .
Partition Partition
@ -2563,8 +2571,7 @@ provides two ways to ensure that newly created plexes are
.Bl -bullet .Bl -bullet
.It .It
Create the plexes and then synchronize them with Create the plexes and then synchronize them with
.Nm .Nm vinum start .
.Ar start .
.It .It
Create the volume (not the plex) with the keyword Create the volume (not the plex) with the keyword
.Ar setupstate , .Ar setupstate ,
@ -2603,7 +2610,7 @@ please report the situation.
If you build the kernel module with the If you build the kernel module with the
.Ar -DVINUMDEBUG .Ar -DVINUMDEBUG
option, you must also build option, you must also build
.Nm .Nm vinum(8)
with the with the
.Ar -DVINUMDEBUG .Ar -DVINUMDEBUG
option, since the size of some data objects used by both components depends on 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. This error may also occur if you use old versions of kld or userland program.
.It .It
The The
.Nm .Nm vinum Ar read
.Ar read
command has a particularly emetic syntax. Once it was the only way to start command has a particularly emetic syntax. Once it was the only way to start
.Nm , .Nm vinum ,
but now the preferred method is with but now the preferred method is with
.Nm .Nm vinum Ar start .
.Ar start . .Nm vinum Ar read
.Nm
.Ar read
should be used for maintenance purposes only. Note that its syntax has changed, should be used for maintenance purposes only. Note that its syntax has changed,
and the arguments must be disk slices, such as and the arguments must be disk slices, such as
.Pa /dev/da0 , .Pa /dev/da0 ,
@ -2642,7 +2646,7 @@ objects.
.br .br
.Ar /dev/vinum/control .Ar /dev/vinum/control
- control device for - control device for
.Nm .Nm vinum
.br .br
.Ar /dev/vinum/plex .Ar /dev/vinum/plex
- directory containing device nodes for - 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 vinum 4 ,
.Xr disklabel 8 , .Xr disklabel 8 ,
.Xr newfs 8 , .Xr newfs 8 ,
.Pa http://www.lemis.com/vinum.html , .Pa http://www.vinumvm.org/vinum.html ,
.Pa http://www.lemis.com/vinum-debugging.html . .Pa http://www.vinumvm.org/vinum-debugging.html .
.Sh AUTHORS .Sh AUTHORS
.An Greg Lehey Aq grog@lemis.com . .An Greg Lehey Aq grog@lemis.com .
.Sh HISTORY .Sh HISTORY