.\" Copyright (C) 1994-2005 Jeff Tranter (tranter@pobox.com)
-.\" Copyright (C) 2012 Karel Zak <kzak@redhat.com>
+.\" Copyright (C) 2012 Karel Zak <kzak@redhat.com>
.\"
.\" It may be distributed under the GNU Public License, version 2, or
.\" any higher version. See section COPYING of the GNU Public license
.PP
The device corresponding to \fIdevice\fP or \fImountpoint\fP is ejected. If no
name is specified, the default name \fB/dev/cdrom\fR is used. The device may be
-addressed by device name (e.g. 'sda'), device path (e.g. '/dev/sda'),
+addressed by device name (e.g., 'sda'), device path (e.g., '/dev/sda'),
UUID=\fIuuid\fR or LABEL=\fIlabel\fR tags.
.PP
There are four different methods of ejecting, depending on whether the device
is a CD-ROM, SCSI device, removable floppy, or tape. By default \fBeject\fR tries
all four methods in order until it succeeds.
.PP
-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.
+If a device partition is specified, the whole-disk device is used.
+.PP
+If the device or a device partition is currently mounted, it is unmounted
+before ejecting. The eject is processed on exclusive open block device
+file descriptor if \fB\-\-no\-unmount\fP or \fB\-\-force\fP are not specified.
+
.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"
+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.
+.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, don't open device with exclusive lock.
+The successful result may be false positive on non hot-pluggable devices.
+.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. If this option is not
+specified than
+.B eject
+opens the device with O_EXCL flag to be sure that the device is not used (since
+v2.35).
+.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
+argument is a number indicating the desired speed (e.g., 8 for 8X speed), or 0
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.
specified, it tries all four (this works fine in most cases).
.PP
.B eject
-may not always be able to determine if the device is mounted (e.g. if it has
+may not always be able to determine if the device is mounted (e.g., if it has
several names). If the device name is a symbolic link,
.B eject
will follow the link and use the device that it points to.
auto-eject mode. There is no way to find out the state of the auto-eject mode.
.PP
You need appropriate privileges to access the device files. Running as root is
-required to eject some devices (e.g. SCSI devices).
+required to eject some devices (e.g., SCSI devices).
.SH AUTHORS
.MT tranter@\:pobox.com
Jeff Tranter
.ME
- util-linux version.
.SH SEE ALSO
-.BR lsblk (8),
.BR findmnt (8),
+.BR lsblk (8),
.BR mount (8),
.BR umount (8)
.SH AVAILABILITY
The eject command is part of the util-linux package and is available from
-.UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
+.UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
Linux Kernel Archive
.UE .
projects / thirdparty / util-linux.git / blobdiff