]>
Commit | Line | Data |
---|---|---|
312111c2 | 1 | .\" Copyright (C) 1994-2005 Jeff Tranter (tranter@pobox.com) |
3a60b1c2 | 2 | .\" Copyright (C) 2012 Karel Zak <kzak@redhat.com> |
312111c2 | 3 | .\" |
539feec1 ML |
4 | .\" It may be distributed under the GNU Public License, version 2, or |
5 | .\" any higher version. See section COPYING of the GNU Public license | |
6 | .\" for conditions under which this file may be redistributed. | |
312111c2 | 7 | .TH EJECT 1 "April 2012" "Linux" "User Commands" |
539feec1 ML |
8 | .SH NAME |
9 | eject \- eject removable media | |
10 | .SH SYNOPSIS | |
312111c2 | 11 | .B eject |
e33ee284 | 12 | [options] |
312111c2 | 13 | .IR device | mountpoint |
539feec1 | 14 | .SH DESCRIPTION |
e33ee284 | 15 | .B eject |
312111c2 | 16 | allows removable media (typically a CD-ROM, floppy disk, tape, JAZ, ZIP or USB |
0b66315a | 17 | disk) to be ejected under software control. The command can also control some |
312111c2 KZ |
18 | multi-disc CD-ROM changers, the auto-eject feature supported by some devices, |
19 | and close the disc tray of some CD-ROM drives. | |
0b66315a SK |
20 | .PP |
21 | The device corresponding to \fIdevice\fP or \fImountpoint\fP is ejected. If no | |
e33ee284 | 22 | name is specified, the default name \fB/dev/cdrom\fR is used. The device may be |
28094b1e | 23 | addressed by device name (e.g. 'sda'), device path (e.g. '/dev/sda'), |
e33ee284 | 24 | UUID=\fIuuid\fR or LABEL=\fIlabel\fR tags. |
0b66315a | 25 | .PP |
312111c2 | 26 | There are four different methods of ejecting, depending on whether the device |
e33ee284 | 27 | is a CD-ROM, SCSI device, removable floppy, or tape. By default \fBeject\fR tries |
0b66315a SK |
28 | all four methods in order until it succeeds. |
29 | .PP | |
e33ee284 | 30 | If a device partition is specified, the whole-disk device is used. If the device |
312111c2 | 31 | or a device partition is currently mounted, it is unmounted before ejecting. |
312111c2 | 32 | .SH OPTIONS |
5e43af7e BS |
33 | .TP |
34 | .BR \-a , " \-\-auto on" | off | |
0b66315a | 35 | This option controls the auto-eject mode, supported by some devices. When |
312111c2 | 36 | enabled, the drive automatically ejects when the device is closed. |
5e43af7e BS |
37 | .TP |
38 | .BR \-c , " \-\-changerslot " \fIslot | |
312111c2 | 39 | With this option a CD slot can be selected from an ATAPI/IDE CD-ROM changer. |
9f3d0fce RM |
40 | The CD-ROM drive cannot be in use (mounted data CD or playing a music CD) for |
41 | a change request to work. Please also note that the first slot of the changer | |
42 | is referred to as 0, not 1. | |
5e43af7e BS |
43 | .TP |
44 | .BR \-d , " \-\-default" | |
312111c2 | 45 | List the default device name. |
5e43af7e BS |
46 | .TP |
47 | .BR \-F , " \-\-force" | |
48 | Force eject, don't check device type. | |
49 | .TP | |
50 | .BR \-f , " \-\-floppy" | |
312111c2 KZ |
51 | This option specifies that the drive should be ejected using a removable floppy |
52 | disk eject command. | |
5e43af7e BS |
53 | .TP |
54 | .BR \-h , " \-\-help" | |
b4362b6f | 55 | Display help text and exit. |
5e43af7e BS |
56 | .TP |
57 | .BR \-i , " \-\-manualeject on" | off | |
0b66315a | 58 | This option controls locking of the hardware eject button. When enabled, the |
312111c2 KZ |
59 | drive will not be ejected when the button is pressed. This is useful when you |
60 | are carrying a laptop in a bag or case and don't want it to eject if the button | |
61 | is inadvertently pressed. | |
5e43af7e | 62 | .TP |
b06c1ca6 | 63 | .BR \-M , " \-\-no\-partitions\-unmount" |
e33ee284 BS |
64 | The option tells eject to not try to unmount other partitions on partitioned |
65 | devices. If another partition is still mounted, the program will not attempt | |
66 | to eject the media. It will attempt to unmount only the device or mountpoint | |
67 | given on the command line. | |
5e43af7e | 68 | .TP |
b06c1ca6 | 69 | .BR \-m , " \-\-no\-unmount" |
5e43af7e BS |
70 | The option tells eject to not try to unmount at all. |
71 | .TP | |
72 | .BR \-n , " \-\-noop" | |
312111c2 | 73 | With this option the selected device is displayed but no action is performed. |
5e43af7e BS |
74 | .TP |
75 | .BR \-p , " \-\-proc" | |
76 | This option allows you to use /proc/mounts instead /etc/mtab. It also passes the | |
77 | \fB\-n\fR option to \fBumount\fR(8). | |
78 | .TP | |
79 | .BR \-q , " \-\-tape" | |
80 | This option specifies that the drive should be ejected using a tape drive | |
81 | offline command. | |
82 | .TP | |
83 | .BR \-r , " \-\-cdrom" | |
312111c2 KZ |
84 | This option specifies that the drive should be ejected using a CDROM eject |
85 | command. | |
5e43af7e BS |
86 | .TP |
87 | .BR \-s , " \-\-scsi" | |
312111c2 | 88 | This option specifies that the drive should be ejected using SCSI commands. |
5e43af7e BS |
89 | .TP |
90 | .BR \-T , " \-\-traytoggle" | |
91 | With this option the drive is given a CD-ROM tray close command if it's opened, | |
92 | and a CD-ROM tray eject command if it's closed. Not all devices support this | |
93 | command, because it uses the above CD-ROM tray close command. | |
94 | .TP | |
95 | .BR \-t , " \-\-trayclose" | |
96 | With this option the drive is given a CD-ROM tray close command. Not all | |
97 | devices support this command. | |
98 | .TP | |
99 | .BR \-V , " \-\-version" | |
100 | Display version information and exit. | |
101 | .TP | |
102 | .BR \-v , " \-\-verbose" | |
312111c2 KZ |
103 | Run in verbose mode; more information is displayed about what the command is |
104 | doing. | |
5e43af7e BS |
105 | .TP |
106 | .BR \-X , " \-\-listspeed" | |
107 | With this option the CD-ROM drive will be probed to detect the available | |
108 | speeds. The output is a list of speeds which can be used as an argument of the | |
109 | \fB\-x\fR option. This only works with Linux 2.6.13 or higher, on previous versions | |
110 | solely the maximum speed will be reported. Also note that some drives may not | |
111 | correctly report the speed and therefore this option does not work with them. | |
112 | .TP | |
113 | .BR \-x , " \-\-cdspeed " \fIspeed | |
e33ee284 BS |
114 | With this option the drive is given a CD-ROM select speed command. The |
115 | .I speed | |
312111c2 | 116 | argument is a number indicating the desired speed (e.g. 8 for 8X speed), or 0 |
0b66315a SK |
117 | for maximum data rate. Not all devices support this command and you can only |
118 | specify speeds that the drive is capable of. Every time the media is changed | |
e33ee284 BS |
119 | this option is cleared. This option can be used alone, or with the |
120 | \fB\-t\fR and \fB\-c\fR options. | |
539feec1 | 121 | .SH EXIT STATUS |
312111c2 KZ |
122 | Returns 0 if operation was successful, 1 if operation failed or command syntax |
123 | was not valid. | |
539feec1 | 124 | .SH NOTES |
e33ee284 | 125 | .B eject |
312111c2 | 126 | only works with devices that support one or more of the four methods of |
0b66315a | 127 | ejecting. This includes most CD-ROM drives (IDE, SCSI, and proprietary), some |
312111c2 | 128 | SCSI tape drives, JAZ drives, ZIP drives (parallel port, SCSI, and IDE |
0b66315a SK |
129 | versions), and LS120 removable floppies. Users have also reported success with |
130 | floppy drives on Sun SPARC and Apple Macintosh systems. If | |
539feec1 | 131 | .B eject |
312111c2 KZ |
132 | does not work, it is most likely a limitation of the kernel driver for the |
133 | device and not the | |
539feec1 ML |
134 | .B eject |
135 | program itself. | |
0b66315a | 136 | .PP |
e33ee284 BS |
137 | The \fB\-r\fR, \fB\-s\fR, \fB\-f\fR, and \fB\-q\fR options allow controlling |
138 | which methods are used to | |
0b66315a | 139 | eject. More than one method can be specified. If none of these options are |
312111c2 | 140 | specified, it tries all four (this works fine in most cases). |
0b66315a | 141 | .PP |
e33ee284 | 142 | .B eject |
312111c2 | 143 | may not always be able to determine if the device is mounted (e.g. if it has |
0b66315a | 144 | several names). If the device name is a symbolic link, |
539feec1 ML |
145 | .B eject |
146 | will follow the link and use the device that it points to. | |
0b66315a | 147 | .PP |
539feec1 ML |
148 | If |
149 | .B eject | |
312111c2 | 150 | determines that the device can have multiple partitions, it will attempt to |
e33ee284 BS |
151 | unmount all mounted partitions of the device before ejecting (see also |
152 | \fB--no-partitions-unmount\fR). If an unmount fails, the program will not | |
153 | attempt to eject the media. | |
0b66315a SK |
154 | .PP |
155 | You can eject an audio CD. Some CD-ROM drives will refuse to open the tray if | |
156 | the drive is empty. Some devices do not support the tray close command. | |
157 | .PP | |
312111c2 | 158 | If the auto-eject feature is enabled, then the drive will always be ejected |
0b66315a SK |
159 | after running this command. Not all Linux kernel CD-ROM drivers support the |
160 | auto-eject mode. There is no way to find out the state of the auto-eject mode. | |
161 | .PP | |
162 | You need appropriate privileges to access the device files. Running as root is | |
312111c2 | 163 | required to eject some devices (e.g. SCSI devices). |
312111c2 | 164 | .SH AUTHORS |
0b66315a SK |
165 | .MT tranter@\:pobox.com |
166 | Jeff Tranter | |
167 | .ME | |
168 | - original author. | |
169 | .br | |
170 | .MT kzak@\:redhat.com | |
171 | Karel Zak | |
172 | .ME | |
173 | and | |
174 | .MT mluscon@\:redhat.com | |
175 | Michal Luscon | |
176 | .ME | |
177 | - util-linux version. | |
539feec1 | 178 | .SH SEE ALSO |
312111c2 | 179 | .BR findmnt (8), |
f053ff1e | 180 | .BR lsblk (8), |
312111c2 KZ |
181 | .BR mount (8), |
182 | .BR umount (8) | |
183 | .SH AVAILABILITY | |
0b66315a | 184 | The eject command is part of the util-linux package and is available from |
d673b74e | 185 | .UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/ |
0b66315a SK |
186 | Linux Kernel Archive |
187 | .UE . |