share/man/man1/eject.1

   1 '\" te
   2 .\" Copyright (c) 2009, Sun Microsystems, Inc.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH EJECT 1 "Sep 8, 2009"
   7 .SH NAME
   8 eject \- eject media such as CD-ROM and floppy from drive
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBeject\fR [\fB-dflqt\fR] [ [\fIdevice\fR | \fInickname\fR]]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBeject\fR utility is used for those removable media devices that do not
  19 have a manual eject button, or for those that might be locked due to, for
  20 instance, being mounted. The device may be specified by its name or by a
  21 nickname. If no device is specified, the default device is used.
  22 .sp
  23 .LP
  24 Only devices that support \fBeject\fR under program control respond to this
  25 command.
  26 .sp
  27 .LP
  28 When \fBeject\fR is used on media that can only be ejected manually, it does
  29 everything except remove the media, including unmounting the file system if it
  30 is mounted. In this case, \fBeject\fR displays a message that the media can now
  31 be manually ejected.
  32 .sp
  33 .LP
  34 Do not physically eject media from a device that contains mounted file systems.
  35 \fBeject\fR automatically searches for any mounted file systems that reside on
  36 the device, and attempts to umount them prior to ejecting the media. See
  37 \fBmount\fR(8). If the unmount operation fails, \fBeject\fR prints a warning
  38 message and exits. The \fB-f\fR option can be used to specify an eject even if
  39 the device contains mounted partitions.
  40 .sp
  41 .LP
  42 If you have inserted a floppy diskette, you might need to use \fBvolcheck\fR(1)
  43 before ejecting the media to inform the system the floppy's presence.
  44 .sp
  45 .LP
  46 Pressing the physical media eject button located on some drives' front panel
  47 has the same effect as invoking \fBeject\fR for the respective drive. Not all
  48 drives have this capability.
  49 .SH OPTIONS
  50 .sp
  51 .LP
  52 The following options are supported:
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fB-d\fR\fR
  57 .ad
  58 .RS 6n
  59 Display the name of the default device to be ejected.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fB-f\fR\fR
  66 .ad
  67 .RS 6n
  68 Force the device to eject even if it is busy.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fB-l\fR\fR
  75 .ad
  76 .RS 6n
  77 Display paths and nicknames of ejectable devices.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB-q\fR\fR
  84 .ad
  85 .RS 6n
  86 Query to see if the media is present.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB-t\fR\fR
  93 .ad
  94 .RS 6n
  95 Issues the drive a CD-ROM tray close command.
  96 .sp
  97 Not all devices support this command.
  98 .RE
  99
 100 .SH OPERANDS
 101 .sp
 102 .LP
 103 The following operands are supported:
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fIdevice\fR\fR
 108 .ad
 109 .RS 12n
 110 Specifies which device to \fBeject\fR, by the name it appears in the directory
 111 \fB/dev\fR.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fInickname\fR\fR
 118 .ad
 119 .RS 12n
 120 Specifies which device to \fBeject\fR, by its nickname as known to this
 121 command.
 122 .sp
 123 Volume label or device type (for example, cdrom or floppy0) can be used as a
 124 nickname.
 125 .RE
 126
 127 .SH EXAMPLES
 128 .LP
 129 \fBExample 1 \fREjecting Media
 130 .sp
 131 .LP
 132 The following example ejects media by its volume label:
 133
 134 .sp
 135 .in +2
 136 .nf
 137 example> \fBeject \&'My Pictures\&'\fR
 138 .fi
 139 .in -2
 140 .sp
 141
 142 .LP
 143 \fBExample 2 \fREjecting a Floppy Disk
 144 .sp
 145 .LP
 146 The following example ejects a floppy disk from the first floppy drive:
 147
 148 .sp
 149 .in +2
 150 .nf
 151 example> \fBeject floppy0\fR
 152 .fi
 153 .in -2
 154 .sp
 155
 156 .SH EXIT STATUS
 157 .sp
 158 .LP
 159 The following exit codes are returned:
 160 .sp
 161 .ne 2
 162 .na
 163 \fB\fB0\fR\fR
 164 .ad
 165 .RS 5n
 166 The operation was successful or, with the \fB-q\fR option, the media \fIis\fR
 167 in the drive.
 168 .RE
 169
 170 .sp
 171 .ne 2
 172 .na
 173 \fB\fB1\fR\fR
 174 .ad
 175 .RS 5n
 176 The operation was unsuccessful or, with the \fB-q\fR option, the media is
 177 \fInot\fR in the drive.
 178 .RE
 179
 180 .sp
 181 .ne 2
 182 .na
 183 \fB\fB2\fR\fR
 184 .ad
 185 .RS 5n
 186 Invalid options were specified.
 187 .RE
 188
 189 .sp
 190 .ne 2
 191 .na
 192 \fB\fB3\fR\fR
 193 .ad
 194 .RS 5n
 195 An \fBioctl()\fR request failed.
 196 .RE
 197
 198 .sp
 199 .ne 2
 200 .na
 201 \fB\fB4\fR\fR
 202 .ad
 203 .RS 5n
 204 Manually ejectable media is now okay to remove.
 205 .RE
 206
 207 .SH FILES
 208 .sp
 209 .ne 2
 210 .na
 211 \fB\fB/dev/diskette0\fR\fR
 212 .ad
 213 .RS 18n
 214 default diskette file
 215 .RE
 216
 217 .sp
 218 .ne 2
 219 .na
 220 \fB\fB/dev/sr0\fR\fR
 221 .ad
 222 .RS 18n
 223 default \fBCD-ROM\fR file (deprecated)
 224 .RE
 225
 226 .SH SEE ALSO
 227 .sp
 228 .LP
 229 \fBvolcheck\fR(1), \fBmount\fR(8), \fBrmmount\fR(8), \fBioctl\fR(2),
 230 \fBattributes\fR(5)