summaryrefslogtreecommitdiffstats
path: root/sys-utils/eject.1
diff options
context:
space:
mode:
authorBenno Schulenberg2014-07-25 14:55:01 +0200
committerKarel Zak2014-07-28 11:16:53 +0200
commit5e43af7e345310f734cbfb5a0bd6ee040cf178a7 (patch)
tree66ebfcc75105d5cba715f2526b1f528c14b9aba8 /sys-utils/eject.1
parentcfdisk: reenable cursor when quitting (diff)
downloadkernel-qcow2-util-linux-5e43af7e345310f734cbfb5a0bd6ee040cf178a7.tar.gz
kernel-qcow2-util-linux-5e43af7e345310f734cbfb5a0bd6ee040cf178a7.tar.xz
kernel-qcow2-util-linux-5e43af7e345310f734cbfb5a0bd6ee040cf178a7.zip
docs: fix some things that were overlooked during the first pass
Mainly more option sorting, some formatting adjustments, and the adding of a missing --version here and there. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
Diffstat (limited to 'sys-utils/eject.1')
-rw-r--r--sys-utils/eject.194
1 files changed, 57 insertions, 37 deletions
diff --git a/sys-utils/eject.1 b/sys-utils/eject.1
index c307c25c2..8e0d92c28 100644
--- a/sys-utils/eject.1
+++ b/sys-utils/eject.1
@@ -30,61 +30,87 @@ all four methods in order until it succeeds.
If a device partition is specified, the whole-disk device is used. If the device
or a device partition is currently mounted, it is unmounted before ejecting.
.SH OPTIONS
-.IP "\fB\-a\fR, \fB\-\-auto on\fR|\fBoff\fR"
+.TP
+.BR \-a , " \-\-auto on" | off
This option controls the auto-eject mode, supported by some devices. When
enabled, the drive automatically ejects when the device is closed.
-.IP "\fB\-c, \-\-changerslot \fIslot\fP"
+.TP
+.BR \-c , " \-\-changerslot " \fIslot
With this option a CD slot can be selected from an ATAPI/IDE CD-ROM changer.
Linux 2.0 or higher is required to use this feature. The CD-ROM drive cannot
be in use (mounted data CD or playing a music CD) for a change request to work.
Please also note that the first slot of the changer is referred to as 0, not 1.
-.IP "\fB\-d, \-\-default\fP"
+.TP
+.BR \-d , " \-\-default"
List the default device name.
-.IP "\fB\-f, \-\-floppy\fP"
+.TP
+.BR \-F , " \-\-force"
+Force eject, don't check device type.
+.TP
+.BR \-f , " \-\-floppy"
This option specifies that the drive should be ejected using a removable floppy
disk eject command.
-.IP "\fB\-F, \-\-force\fP"
-Force eject, don't check device type.
-.IP "\fB\-h, \-\-help\fP"
+.TP
+.BR \-h , " \-\-help"
Display help text and exit.
-.IP "\fB\-i\fR, \fB\-\-manualeject on\fR|\fBoff\fR"
+.TP
+.BR \-i , " \-\-manualeject on" | off
This option controls locking of the hardware eject button. When enabled, the
drive will not be ejected when the button is pressed. This is useful when you
are carrying a laptop in a bag or case and don't want it to eject if the button
is inadvertently pressed.
-.IP "\fB\-p, \-\-proc\fP"
-This option allows you to use /proc/mounts instead /etc/mtab. It also passes the
-\fB\-n\fR option to \fBumount\fR(1).
-.IP "\fB\-q, \-\-tape\fP"
-This option specifies that the drive should be ejected using a tape drive
-offline command.
-.IP "\fB\-m, \-\-no-unmount\fP"
-The option tells eject to not try to unmount at all.
-.IP "\fB\-M, \-\-no-partitions-unmount\fP"
+.TP
+.BR \-M , " \-\-no-partitions-unmount"
The option tells eject to not try to unmount other partitions on partitioned
devices. If another partition is still mounted, the program will not attempt
to eject the media. It will attempt to unmount only the device or mountpoint
given on the command line.
-.IP "\fB\-n, \-\-noop\fP"
+.TP
+.BR \-m , " \-\-no-unmount"
+The option tells eject to not try to unmount at all.
+.TP
+.BR \-n , " \-\-noop"
With this option the selected device is displayed but no action is performed.
-.IP "\fB\-t, \-\-trayclose\fP"
-With this option the drive is given a CD-ROM tray close command. Not all
-devices support this command.
-.IP "\fB\-T, \-\-traytoggle\fP"
-With this option the drive is given a CD-ROM tray close command if it's opened,
-and a CD-ROM tray eject command if it's closed. Not all devices support this
-command, because it uses the above CD-ROM tray close command.
-.IP "\fB\-r, \-\-cdrom\fP"
+.TP
+.BR \-p , " \-\-proc"
+This option allows you to use /proc/mounts instead /etc/mtab. It also passes the
+\fB\-n\fR option to \fBumount\fR(8).
+.TP
+.BR \-q , " \-\-tape"
+This option specifies that the drive should be ejected using a tape drive
+offline command.
+.TP
+.BR \-r , " \-\-cdrom"
This option specifies that the drive should be ejected using a CDROM eject
command.
-.IP "\fB\-s, \-\-scsi\fP"
+.TP
+.BR \-s , " \-\-scsi"
This option specifies that the drive should be ejected using SCSI commands.
-.IP "\fB\-v, \-\-verbose\fP"
+.TP
+.BR \-T , " \-\-traytoggle"
+With this option the drive is given a CD-ROM tray close command if it's opened,
+and a CD-ROM tray eject command if it's closed. Not all devices support this
+command, because it uses the above CD-ROM tray close command.
+.TP
+.BR \-t , " \-\-trayclose"
+With this option the drive is given a CD-ROM tray close command. Not all
+devices support this command.
+.TP
+.BR \-V , " \-\-version"
+Display version information and exit.
+.TP
+.BR \-v , " \-\-verbose"
Run in verbose mode; more information is displayed about what the command is
doing.
-.IP "\fB\-V, \-\-version\fP"
-Display version information and exit.
-.IP "\fB\-x, \-\-cdspeed \fIspeed\fP"
+.TP
+.BR \-X , " \-\-listspeed"
+With this option the CD-ROM drive will be probed to detect the available
+speeds. The output is a list of speeds which can be used as an argument of the
+\fB\-x\fR option. This only works with Linux 2.6.13 or higher, on previous versions
+solely the maximum speed will be reported. Also note that some drives may not
+correctly report the speed and therefore this option does not work with them.
+.TP
+.BR \-x , " \-\-cdspeed " \fIspeed
With this option the drive is given a CD-ROM select speed command. The
.I speed
argument is a number indicating the desired speed (e.g. 8 for 8X speed), or 0
@@ -92,12 +118,6 @@ for maximum data rate. Not all devices support this command and you can only
specify speeds that the drive is capable of. Every time the media is changed
this option is cleared. This option can be used alone, or with the
\fB\-t\fR and \fB\-c\fR options.
-.IP "\fB\-X, \-\-listspeed\fP"
-With this option the CD-ROM drive will be probed to detect the available
-speeds. The output is a list of speeds which can be used as an argument of the
-\fB\-x\fR option. This only works with Linux 2.6.13 or higher, on previous versions
-solely the maximum speed will be reported. Also note that some drives may not
-correctly report the speed and therefore this option does not work with them.
.SH EXIT STATUS
Returns 0 if operation was successful, 1 if operation failed or command syntax
was not valid.