Skip site navigation (1)Skip section navigation (2)
Date:      23 Jan 2002 21:20:10 -0800
From:      "Gary W. Swearingen" <swear@blarg.net>
To:        FreeBSD-gnats-submit@freebsd.org
Subject:   docs/34220: eject(1) man page needs cleanup
Message-ID:  <z4n0z49vg5.0z4@localhost.localdomain>

index | next in thread | raw e-mail


>Number:         34220
>Category:       docs
>Synopsis:       eject(1) man page needs cleanup
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Jan 23 21:20:01 PST 2002
>Closed-Date:
>Last-Modified:
>Originator:     Gary W. Swearingen
>Release:        FreeBSD 4.5-PRERELEASE i386
>Organization:
none
>Environment:
n/a
================
>Description:

The eject man page has several minor problems that should be cleaned up.

-- Has "brefore" for "before".
-- Has "Not" for "Do not" in -n option description.
-- The "ENVIRONMENT" section has an unneeded and obvious explanation.
-- The "DESCRIPTION" is wordy.
-- The option descriptions are not as clear as they should be.
-- Has a "FILES" section which is not appropriate or at least unneeded.
================
>How-To-Repeat:
n/a
================
>Fix:

patch -d "unknown uncompressed man directory" < this-PR
--- /tmp/eject..orig.1	Wed Jan 23 19:49:58 2002
+++ /tmp/eject.1	Wed Jan 23 21:02:57 2002
@@ -36,39 +36,23 @@
 .Ar device
 .Sh DESCRIPTION
 .Nm eject
-is a program to eject removable media from drive.
-The
+causes removable media to ejected from the drive named by
 .Ar device
-is a removable drive name such as cd0, matcd0, mcd0, scd0, wcd0 or od0. 
-.Nm eject
-unmounts the
-.Ar device
-if it was mounted brefore ejecting.
+(eg, cd0, matcd0, mcd0, scd0, wcd0, or od0), which if mounted on a
+filesystem, is first dismounted.
 .Pp
 The following options are available:
 .Bl -tag -width Ds
 .It Fl f
-Force unmounts the device if it was mounted.
+Forcibly unmounts the device if it was mounted (as in umount(8)).
 .It Fl n
-Not execute operation but print it.
+Do not eject, but verbosely output what would be done.
 .It Fl v
-Verbose mode.
+Verbosely output what is done.
 .Sh ENVIRONMENT
-If the following environment variable exists, it is used by
-.Nm eject :
 .Bl -tag -width Ds
 .It Ev EJECT
-Specifies default device.
-.El
-.Sh FILES
-.Bl -tag -width /dev/rmatcd0c -compact
-.It Pa /dev/rcd0c
-.It Pa /dev/rmatcd0c
-.It Pa /dev/rmcd0c
-.It Pa /dev/rscd0c
-.It Pa /dev/rwcd0c
-.It Pa /dev/rod0c
-.El
+Specifies the default device.
 .Sh AUTHOR
 Shunsuke Akiyama <akiyama@jp.FreeBSD.org>
 .Sh HISTORY
>Release-Note:
>Audit-Trail:
>Unformatted:

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message



help

Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?z4n0z49vg5.0z4>