]> git.ipfire.org Git - thirdparty/util-linux.git/blobdiff - sys-utils/eject.1
docs: update year in libs docs
[thirdparty/util-linux.git] / sys-utils / eject.1
index edc6a2ac995a3937098ee6f2d277db676d7d7457..313f9fd1801286c46ff96685f371e2a4045c72a4 100644 (file)
@@ -20,15 +20,19 @@ and close the disc tray of some CD-ROM drives.
 .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
 .TP
 .BR \-a , " \-\-auto on" | off
@@ -37,15 +41,16 @@ enabled, the drive automatically ejects when the device is closed.
 .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.
+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.
 .TP
 .BR \-F , " \-\-force"
-Force eject, don't check device type.
+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
@@ -67,7 +72,11 @@ to eject the media.  It will attempt to unmount only the device or mountpoint
 given on the command line.
 .TP
 .BR \-m , " \-\-no\-unmount"
-The option tells eject to not try to unmount at all.
+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.
@@ -113,7 +122,7 @@ correctly report the speed and therefore this option does not work with them.
 .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
@@ -140,7 +149,7 @@ eject.  More than one method can be specified.  If none of these options are
 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.
@@ -160,7 +169,7 @@ after running this command.  Not all Linux kernel CD-ROM drivers support the
 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
@@ -176,12 +185,12 @@ Michal Luscon
 .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 .