Page MenuHomeFreeBSD
Differential D10457 Diff 27647 sbin/mdconfig/mdconfig.8

Changeset View

Standalone View

View Options

sbin/mdconfig/mdconfig.8

Show All 31 Lines
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.\" @(#)vnconfig.8 8.1 (Berkeley) 6/5/93 .\" @(#)vnconfig.8 8.1 (Berkeley) 6/5/93
.\" from: src/usr.sbin/vnconfig/vnconfig.8,v 1.19 2000/12/27 15:30:29 .\" from: src/usr.sbin/vnconfig/vnconfig.8,v 1.19 2000/12/27 15:30:29
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd October 10, 2015 .Dd October 10, 2015
wblockUnsubmitted
Not Done
Inline Actions

Remember to bump this on commit.

wblock: Remember to bump this on commit.
.Dt MDCONFIG 8 .Dt MDCONFIG 8
.Os .Os
.Sh NAME .Sh NAME
.Nm mdconfig .Nm mdconfig
.Nd create and control memory disks .Nd create and control memory disks
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Fl a .Fl a
.Fl t Ar type .Fl t Ar type
.Op Fl n .Op Fl n
.Oo Fl o Oo Cm no Oc Ns Ar option Oc ... .Oo Fl o Oo Cm no Oc Ns Ar option Oc ...
.Op Fl f Ar file .Op Fl f Ar file
.Op Fl s Ar size .Op Fl s Ar size
.Op Fl S Ar sectorsize .Op Fl S Ar sectorsize
.Op Fl u Ar unit .Op Fl u Ar unit
.Op Fl x Ar sectors/track .Op Fl x Ar sectors/track
.Op Fl y Ar heads/cylinder .Op Fl y Ar heads/cylinder
.Op Fl L Ar label
.Nm .Nm
.Fl d .Fl d
.Fl u Ar unit .Fl u Ar unit
.Op Fl o Oo Cm no Oc Ns Ar force .Op Fl o Oo Cm no Oc Ns Ar force
.Nm .Nm
.Fl r .Fl r
.Fl u Ar unit .Fl u Ar unit
.Fl s Ar size .Fl s Ar size
▲ Show 20 Lines • Show All 118 Lines • ▼ Show 20 Lines
.Cm vnode .Cm vnode
backed devices, the backed devices, the
.Fl x .Fl x
and and
.Fl y .Fl y
options can be used to specify a synthetic geometry. options can be used to specify a synthetic geometry.
This is useful for constructing bootable images for later download to This is useful for constructing bootable images for later download to
other devices. other devices.
.It Fl L Ar label
Associate a label (arbitrary string) with the new memory disk.
The label can then be inspected with
.Nm
.Fl l v .
rpokalaUnsubmitted
Done
Inline Actions

I believe the rule for manpages is that sentences start on a new line. Also, "can be then" should be "can then be". Finally, the second sentence is a fragment. I suggest this instead:

.It Fl L Ar label
Associate a label (arbitrary string) with the new memory disk.
The label can then be inspected with the
.Nm
.Fl l v
command.
rpokala: I believe the rule for manpages is that sentences start on a new line. Also, "can be then"…
bcrUnsubmitted
Done
Inline Actions

That's right. Use textproc/igor to check the man page for common errors.

bcr: That's right. Use textproc/igor to check the man page for common errors.
bjkUnsubmitted
Done
Inline Actions

I would prefer "can then be instpected with
.Nm
.Fl l v ."
to eliminate the not-really-needed "the" and "command".

bjk: I would prefer "can then be instpected with .Nm .Fl l v ." to eliminate the not-really-needed…
rpokalaUnsubmitted
Done
Inline Actions

Yeah, that's probably better way to phrase it.

rpokala: Yeah, that's probably better way to phrase it.
wblockUnsubmitted
Done
Inline Actions

I feel like this example command should be separated from the rest of the sentence. Maybe:

The label can then be inspected with
.Bd -literal -offset indent
.Nm
.Fl l v
.Ed

(Might need a .Pp after that.)

wblock: I feel like this example command should be separated from the rest of the sentence. Maybe…
sobomaxAuthorUnsubmitted
Not Done
Inline Actions

Done in the latest revision. I have had to merge Nm + Fl... into a single line, though otherwise it would wrap it up separating -l -v to the next line.

sobomax: Done in the latest revision. I have had to merge Nm + Fl... into a single line, though…
.It Fl o Oo Cm no Oc Ns Ar option .It Fl o Oo Cm no Oc Ns Ar option
Set or reset options. Set or reset options.
.Bl -tag -width indent .Bl -tag -width indent
.It Oo Cm no Oc Ns Cm async .It Oo Cm no Oc Ns Cm async
For For
.Cm vnode .Cm vnode
backed devices: avoid backed devices: avoid
.Dv IO_SYNC .Dv IO_SYNC
▲ Show 20 Lines • Show All 121 Lines • Show Last 20 Lines