Commit Graph

32 Commits

Author SHA1 Message Date
Greg Lehey
bfa5948701 Remove description of defunct DEBUG_NUMOUTPUT by commenting out.
Describe stop -f to stop when config updates are disabled.

Explain in more detail why Vinum needs its own partition type, and why
you can't make it the c partition.

Implicitly-sanctioned-by:	jkh
2000-03-01 07:22:10 +00:00
Greg Lehey
ee5a9cbce2 Describe 'move' function.
Submitted-by:	Marius Bendiksen <marius@marius.scancall.no>

Describe state transitions in more detail, in particular how to revive
subdisks.
2000-01-05 05:59:08 +00:00
Greg Lehey
6ed62da4d9 Describe the new options of start and init commands. 1999-10-13 03:30:29 +00:00
Greg Lehey
0212898e1c Add description of checkparity and rebuildparity.
Remove a half-started message.

Reported-by:	      "Jeffrey J. Mountin" <jeff@mountin.net>
1999-09-28 23:03:29 +00:00
Peter Wemm
7f3dea244c $Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00
Greg Lehey
05da76e022 Update and tidy descriptions of info -V.
Describe use of -w option with start.
Tidy up descriptions of scale factor suffixes.
1999-08-26 03:24:02 +00:00
Greg Lehey
a7bd84e6b1 Document the setstate command. 1999-08-24 02:36:23 +00:00
Mike Pritchard
348e4e6c73 Minor mdoc fix. 1999-08-15 12:16:59 +00:00
Mike Pritchard
aa7c9adaea Various man page cleanup:
- Sort xrefs
- FreeBSD.ORG -> FreeBSD.org
- Properly xref RFCs.
- Be consistent with section names as outlined in mdoc(7).
- Other misc mdoc cleanup.

PR:		doc/13144
Submitted by:	Alexey M. Zelkin <phantom@cris.net>
1999-08-15 08:06:12 +00:00
Greg Lehey
ff5bd28e70 Correct typo. 1999-08-14 09:15:43 +00:00
Greg Lehey
6017572204 Correct typo.
PR:	docs/13050
Reported-by:	Dan Langille<junkmale@xtra.co.nz>
1999-08-09 23:28:03 +00:00
Greg Lehey
b13c5ac72b Update to reflect recent changes. 1999-08-07 09:27:25 +00:00
Greg Lehey
738407d497 Document simplified configuration commands. 1999-07-02 07:58:54 +00:00
Greg Lehey
f3a65ee32e Document the -f flag to detach.
Document the dangers of adding subdisks to striped and RAID-5 plexes.
1999-06-22 05:55:32 +00:00
Greg Lehey
8fea704025 Arrange the "CONFIGURATION FILE" section in the order in which the
entries go into the config file.

Clarify what names can be used for Vinum drives, and what will happen
to you if you use other names.

Forcibly-demonstrated-by:  Thomas Stromberg <tstromberg@rtci.com>
			   Peter K Campbell <PCampbel@vtrlmel1.telstra.com.au>
			   George Cox <george.cox@sophos.com>
			   many others, but those were the only three today.
1999-05-07 07:11:01 +00:00
Greg Lehey
e2375c635f Update documentation of new functions.
Describe new scale letter for sizes: 's' (sector) instead of 'b'
(block).  Both mean 512 bytes, but 'b' is deprecated because it's
confusing.

Document log file and environment variables.
1999-05-02 08:03:30 +00:00
Greg Lehey
9690aae346 Document -w option for init command.
Reorganize OPTIONS section into alphabetical order.
1999-04-10 04:02:23 +00:00
Greg Lehey
8a465c4217 Add GOTCHAS entries warning against using partition c for vinum, and
explaining the syntax of the 'read' command.

Shot-in-foot-by:  Bob Gustwick <gustwick@oldzoom.bga.com>
1999-04-05 04:06:27 +00:00
Greg Lehey
60349886f9 Get date right.
Remove comments about not being able to unload from the command line.

Add another example configuration output.

Clarify when to use 'vinum start' and when to use 'vinum read'.
1999-03-28 08:51:51 +00:00
Greg Lehey
35755b9f51 Add a tutorial-like section "How to set up Vinum" 1999-03-24 09:18:33 +00:00
Greg Lehey
240b9c4449 Describe the new semantics of 'create':
When creating a new drive, if the drive already has a vinum label,
  and name doesn't match the specified drive, do it anyway if the
  'force' flag is specified.

Continually-tripped-over-by:  Karl Pielorz <kpielorz@tdx.co.uk>

Update information about partition type for Vinum drives.  They
*should* be of type 'vinum', but currently we still accept (and
complain about) partitions of type 'unused'.  At a later date, only
'vinum' will be accepted.

Threatened-since: over a year
1999-03-23 04:55:50 +00:00
Greg Lehey
a542207223 Clarify the synchronization options in additional plexes to a volume. 1999-03-18 23:17:05 +00:00
Greg Lehey
5b76055cb5 Clarify that the stop command only works in interactive mode. 1999-03-14 04:06:49 +00:00
Greg Lehey
6128bd0ff7 Describe the new debug flags DEBUG_EOFINFO and DEBUG_MEMFREE.
Fix a confusion between slices and partitions.

Clarify the problems of small stripe sizes (< 128 kB).
1999-03-13 07:45:52 +00:00
Greg Lehey
6cecf4e4b2 Document "stop" command with no parameters.
Document "printconfig" and "saveconfig" commands.

Add warning about running "create" multiple times.
1999-03-02 07:02:29 +00:00
Greg Lehey
3628210aa7 Modify example configuration file to show more optimum stripe size of
256 kB instead of 16 kB.

Pointed-out-by: Steve Taylor <staylor@cybernet.com>

Modify description of start command to include 'start' with no
parameters, which reads the config from all drives found on the
system.
1999-02-11 06:14:49 +00:00
Greg Lehey
959c9a97a9 Fix broken command tables (change formatting from tbl to .Bl/.El)
Move the BUGS section to vinum.4: the only bug in vinum.8 was the man
page, fixed with this commit.
1999-01-27 03:12:23 +00:00
Greg Lehey
52e80fad69 Update to reflect major changes in vinum kernel module 1999-01-21 00:45:11 +00:00
Greg Lehey
a5d5588506 - Format corrections for troff output
- Comment out the description of the unimplemented replace command
- Explain in even stronger language that resetconfig is not for
  everyday use

  Motivated by:  Marko Schütz <marko@ki.informatik.uni-frankfurt.de>

- Correct the description of the start command (no longer used to
  start vinum, just specific objects)

  Motivated by: dg

- Remove .TH N commands, which conflict badly with the doc macros,
  causing strange headings in nroff output and endless loops in troff.
  The current version produces warning messages with some screen
  sizes, and will be fixed when I have time.

  Bug-report: docs/9328 (nroff)
  Reported-by: joerg (troff)

- Add gotcha info for the setupstate keyword and the use of label and
  resetconfig.

- Add bug entry for the warning messages introduced by fixing
  docs/9328.

- Add references to web pages on Vinum
1999-01-09 03:00:01 +00:00
Greg Lehey
ef57f97a9d - Correct alphabetical order of commands
- Describe subdisk attachment in more detail
- Describe new 'makedev' command
- Correct use of 'partition' and 'slice'
- Describe 'setupstate' keyword
- Include performance guidelines for striped plexes
- Correct numerical values in examples
- Add examples for disklabel(8)
- Clarify problems creating Vinum drives on inappropriate partitions

Prodded by: NAGANUMA Yasuhiro <y_naga@carat.rim.or.jp> (slices and
            partitions)
1998-12-27 03:47:15 +00:00
Greg Lehey
8814fd974a Bring man page up to date 1998-09-29 10:26:02 +00:00
Greg Lehey
8644f7188f Import base vinum userland sources 1998-09-16 05:57:36 +00:00