Fix a couple of style issues. Tweak grammar and markup while here.

Approved by:	hrs (mentor)
This commit is contained in:
Benjamin Kaduk 2012-04-09 01:20:50 +00:00
parent 2885c2e4bb
commit ac5b109f31
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=234047

View File

@ -41,7 +41,7 @@
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd June 21, 2008 .Dd March 21, 2012
.Dt MDCONFIG 8 .Dt MDCONFIG 8
.Os .Os
.Sh NAME .Sh NAME
@ -87,7 +87,7 @@ parameters specified and attach it to the system.
Detach a memory disk from the system and release all resources. Detach a memory disk from the system and release all resources.
.It Fl t Ar type .It Fl t Ar type
Select the type of the memory disk. Select the type of the memory disk.
.Bl -tag -width "preload" .Bl -tag -width "malloc"
.It Cm malloc .It Cm malloc
Storage for this type of memory disk is allocated with Storage for this type of memory disk is allocated with
.Xr malloc 9 . .Xr malloc 9 .
@ -104,31 +104,35 @@ becomes the backing store for this memory disk.
.It Cm swap .It Cm swap
Storage for this type of memory disk is allocated from buffer Storage for this type of memory disk is allocated from buffer
memory. memory.
Pages get pushed out to the swap when the system is under memory Pages get pushed out to swap when the system is under memory
pressure, otherwise they stay in the operating memory. pressure, otherwise they stay in the operating memory.
Using Using
.Cm swap .Cm swap
backing is generally preferable over backing is generally preferred instead of using
.Cm malloc .Cm malloc
backing. backing.
.El .El
.It Fl f Ar file .It Fl f Ar file
Filename to use for the vnode type memory disk. Options Filename to use for the vnode type memory disk.
The
.Fl a .Fl a
and and
.Fl t Ar vnode .Fl t Ar vnode
are implied if not specified. options are implied if not specified.
.It Fl l .It Fl l
List configured devices. List configured devices.
If given with If given with
.Fl u , .Fl u ,
display details about that particular device. display details about that particular device.
If If the
.Fl v .Fl v
option specified, show all details. option is specified, show all details.
.It Fl n .It Fl n
When printing md device names, print only the unit number without the When printing
md prefix. .Xr md 4
device names, print only the unit number without the
.Xr md 4
prefix.
.It Fl s Ar size .It Fl s Ar size
Size of the memory disk. Size of the memory disk.
.Ar Size .Ar Size
@ -137,11 +141,12 @@ is the number of 512 byte sectors unless suffixed with a
or or
.Cm t .Cm t
which which
denotes byte, kilobyte, megabyte, gigabyte and terabyte respectively. Options denotes byte, kilobyte, megabyte, gigabyte and terabyte respectively.
The
.Fl a .Fl a
and and
.Fl t Ar swap .Fl t Ar swap
are implied if not specified. options are implied if not specified.
.It Fl S Ar sectorsize .It Fl S Ar sectorsize
Sectorsize to use for malloc backed device. Sectorsize to use for malloc backed device.
.It Fl x Ar sectors/track .It Fl x Ar sectors/track
@ -175,12 +180,12 @@ Allocate and reserve all needed storage from the start, rather than as needed.
.It Oo Cm no Oc Ns Cm cluster .It Oo Cm no Oc Ns Cm cluster
Enable clustering on this disk. Enable clustering on this disk.
.It Oo Cm no Oc Ns Cm compress .It Oo Cm no Oc Ns Cm compress
Enable/Disable compression features to reduce memory usage. Enable/disable compression features to reduce memory usage.
.It Oo Cm no Oc Ns Cm force .It Oo Cm no Oc Ns Cm force
Disable/Enable extra sanity checks to prevent the user from doing something Disable/enable extra sanity checks to prevent the user from doing something
that might adversely affect the system. that might adversely affect the system.
.It Oo Cm no Oc Ns Cm readonly .It Oo Cm no Oc Ns Cm readonly
Enable/Disable readonly mode. Enable/disable readonly mode.
.El .El
.It Fl u Ar unit .It Fl u Ar unit
Request a specific unit number for the Request a specific unit number for the
@ -197,15 +202,15 @@ is provided for convenience as an abbreviation of
.Fl t Ar vnode .Fl t Ar vnode
.Fl f Ar file . .Fl f Ar file .
.Sh EXAMPLES .Sh EXAMPLES
To create a 4 megabyte Create a 4 megabyte
.Xr malloc 9 .Xr malloc 9
backed memory disk. backed memory disk.
The name of the allocated unit will be output on stdout like The name of the allocated unit will be printed on stdout, such as
.Dq Li md3 : .Dq Li md3 :
.Pp .Pp
.Dl mdconfig -a -t malloc -s 4m .Dl mdconfig -a -t malloc -s 4m
.Pp .Pp
To create a disk named Create a disk named
.Pa /dev/md4 .Pa /dev/md4
with with
.Pa /tmp/boot.flp .Pa /tmp/boot.flp
@ -213,12 +218,12 @@ as backing storage:
.Pp .Pp
.Dl mdconfig -a -t vnode -f /tmp/boot.flp -u 4 .Dl mdconfig -a -t vnode -f /tmp/boot.flp -u 4
.Pp .Pp
To detach and free all resources used by Detach and free all resources used by
.Pa /dev/md4 : .Pa /dev/md4 :
.Pp .Pp
.Dl mdconfig -d -u 4 .Dl mdconfig -d -u 4
.Pp .Pp
To create a 128MByte swap backed disk, initialize an Create a 128MByte swap backed disk, initialize an
.Xr ffs 7 .Xr ffs 7
file system on it, and mount it on file system on it, and mount it on
.Pa /tmp : .Pa /tmp :
@ -229,7 +234,7 @@ mount /dev/md10 /tmp
chmod 1777 /tmp chmod 1777 /tmp
.Ed .Ed
.Pp .Pp
To create a 5MB file-backed disk Create a 5MB file-backed disk
.Ns ( Fl a .Ns ( Fl a
and and
.Fl t Ar vnode .Fl t Ar vnode
@ -242,7 +247,7 @@ newfs md0c
mount /dev/md0c /mnt mount /dev/md0c /mnt
.Ed .Ed
.Pp .Pp
To create an Create an
.Xr md 4 .Xr md 4
device out of an ISO 9660 CD image file device out of an ISO 9660 CD image file
.Ns ( Fl a .Ns ( Fl a