NetBSD/usr.bin/eject/eject.1

.\" $NetBSD: eject.1,v 1.10 2001/10/06 18:51:04 wiz Exp $
.\"
.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"        This product includes software developed by the NetBSD
.\"        Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\"    contributors may be used to endorse or promote products derived
.\"    from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd October 6, 2001
.Dt EJECT 1
.Os
.Sh NAME
.Nm eject
.Nd eject a floppy disk, cdrom or tape
.Sh SYNOPSIS
.Nm
.Op Fl fv
.Op Fl l | L | U
.Op Fl t Ar device-type
.Op Fl d
.Ar device
.Pp
.Nm
.Fl n
.Sh DESCRIPTION
The
.Nm
program ejects a medium from the specified device.
It can also load a cdrom
in the drive if this operation is supported by the hardware.
The
.Ar device
argument specifies a device either by its full path name
.Po identified by a \&
.Pa /dev/
prefix
.Pc ,
or by one of the built-in nicknames.
If the medium contains a filesystem that is currently mounted,
.Nm
will attempt to unmount the filesystem before ejecting.
.Pp
The following options are available:
.Bl -tag -width xxx
.It Fl d
Deprecated.
.It Fl f
Force the eject operation without attempting to unmount any filesystems first.
.It Fl l
Load media in the drive (only supported for the cdrom device type).
.It Fl L
Lock the media into the drive (but see
.Sx BUGS
below).
.It Fl U
Unlock the media from the drive.
.It Fl n
List the built-in nicknames on standard output.
.It Fl t Ar device-type
Specify the device type.
The argument must be one of
.Sy diskette ,
.Sy floppy ,
.Sy cdrom ,
.Sy disk ,
or
.Sy tape .
This option is necessary when ejecting a device for which no built-in
knowledge is available.
.It Fl v
Display some of the actions taken on standard output.
.El
.Sh BUGS
Most disk drivers automatically lock the media on the first open and
unlock it on the last close, making
.Ql Ic eject Fl L
almost useless, since when it closes the device, it gets unlocked
again.
Whitespace fixes and formatting improvements. 2001-10-06 22:51:04 +04:00			`.\" $NetBSD: eject.1,v 1.10 2001/10/06 18:51:04 wiz Exp $`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`.\"`
Assign my copyrights to TNF. 1998-09-05 21:31:44 +04:00			`.\" Copyright (c) 1998 The NetBSD Foundation, Inc.`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`.\" All rights reserved.`
			`.\"`
Assign my copyrights to TNF. 1998-09-05 21:31:44 +04:00			`.\" This code is derived from software contributed to The NetBSD Foundation`
Whitespace fixes and formatting improvements. 2001-10-06 22:51:04 +04:00			`.\" by`
Assign my copyrights to TNF. 1998-09-05 21:31:44 +04:00			`.\"`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
Assign my copyrights to TNF. 1998-09-05 21:31:44 +04:00			`.\" This product includes software developed by the NetBSD`
			`.\" Foundation, Inc. and its contributors.`
			`.\" 4. Neither the name of The NetBSD Foundation nor the names of its`
			`.\" contributors may be used to endorse or promote products derived`
			`.\" from this software without specific prior written permission.`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`.\"`
Assign my copyrights to TNF. 1998-09-05 21:31:44 +04:00			`.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS`
			.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
			`.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR`
			`.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS`
			`.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR`
			`.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF`
			`.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS`
			`.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN`
			`.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)`
			`.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE`
			`.\" POSSIBILITY OF SUCH DAMAGE.`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`.\"`
Add -L and -U options to eject(1) that call DIOCLOCK. Also generally clean stuff up, correct the usage message and update the manpage to match. Note that the new options aren't wonderfully useful, since cd(4) at least promptly unlocks the drawer when eject closes the device. 2001-10-06 19:43:33 +04:00			`.Dd October 6, 2001`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`.Dt EJECT 1`
adjust to more accurately reflect the use of the -t option, per PR#5443 1998-05-12 01:45:44 +04:00			`.Os`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`.Sh NAME`
			`.Nm eject`
			`.Nd eject a floppy disk, cdrom or tape`
			`.Sh SYNOPSIS`
			`.Nm`
Add -L and -U options to eject(1) that call DIOCLOCK. Also generally clean stuff up, correct the usage message and update the manpage to match. Note that the new options aren't wonderfully useful, since cd(4) at least promptly unlocks the drawer when eject closes the device. 2001-10-06 19:43:33 +04:00			`.Op Fl fv`
			`.Op Fl l \| L \| U`
adjust to more accurately reflect the use of the -t option, per PR#5443 1998-05-12 01:45:44 +04:00			`.Op Fl t Ar device-type`
Add -L and -U options to eject(1) that call DIOCLOCK. Also generally clean stuff up, correct the usage message and update the manpage to match. Note that the new options aren't wonderfully useful, since cd(4) at least promptly unlocks the drawer when eject closes the device. 2001-10-06 19:43:33 +04:00			`.Op Fl d`
			`.Ar device`
Whitespace fixes and formatting improvements. 2001-10-06 22:51:04 +04:00			`.Pp`
			`.Nm`
Add -L and -U options to eject(1) that call DIOCLOCK. Also generally clean stuff up, correct the usage message and update the manpage to match. Note that the new options aren't wonderfully useful, since cd(4) at least promptly unlocks the drawer when eject closes the device. 2001-10-06 19:43:33 +04:00			`.Fl n`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`.Sh DESCRIPTION`
adjust to more accurately reflect the use of the -t option, per PR#5443 1998-05-12 01:45:44 +04:00			`The`
WARNSify, fix .Nm usage, getopt returns -1 not EOF 1997-10-18 17:38:09 +04:00			`.Nm`
Whitespace fixes and formatting improvements. 2001-10-06 22:51:04 +04:00			`program ejects a medium from the specified device.`
			`It can also load a cdrom`
Take advantage of the recent changes to sd/cd and DIOCEJECT: open the raw character device for nicknames (so that eject will open the CD even without medias). Implement the raw_to_blk pathname conversion in umount_mounted(). Create a new 'cdrom' type, add a '-l' switch which will cause a media load on cdrom devices type. Add 'sd0, sd1, sd2' nicknames to allow easy use with removable rewritable disks (ZIP, jazz, MO, ...). 1999-02-08 19:35:33 +03:00			`in the drive if this operation is supported by the hardware.`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`The`
			`.Ar device`
			`argument specifies a device either by its full path name`
			`.Po identified by a \&`
adjust to more accurately reflect the use of the -t option, per PR#5443 1998-05-12 01:45:44 +04:00			`.Pa /dev/`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`prefix`
			`.Pc ,`
adjust to more accurately reflect the use of the -t option, per PR#5443 1998-05-12 01:45:44 +04:00			`or by one of the built-in nicknames.`
			`If the medium contains a filesystem that is currently mounted,`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`.Nm`
			`will attempt to unmount the filesystem before ejecting.`
			`.Pp`
			`The following options are available:`
			`.Bl -tag -width xxx`
New improved "eject" command contributed by Chris Jones in PR bin/6988. 1999-02-18 01:59:14 +03:00			`.It Fl d`
			`Deprecated.`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`.It Fl f`
			`Force the eject operation without attempting to unmount any filesystems first.`
Take advantage of the recent changes to sd/cd and DIOCEJECT: open the raw character device for nicknames (so that eject will open the CD even without medias). Implement the raw_to_blk pathname conversion in umount_mounted(). Create a new 'cdrom' type, add a '-l' switch which will cause a media load on cdrom devices type. Add 'sd0, sd1, sd2' nicknames to allow easy use with removable rewritable disks (ZIP, jazz, MO, ...). 1999-02-08 19:35:33 +03:00			`.It Fl l`
Whitespace fixes and formatting improvements. 2001-10-06 22:51:04 +04:00			`Load media in the drive (only supported for the cdrom device type).`
Add -L and -U options to eject(1) that call DIOCLOCK. Also generally clean stuff up, correct the usage message and update the manpage to match. Note that the new options aren't wonderfully useful, since cd(4) at least promptly unlocks the drawer when eject closes the device. 2001-10-06 19:43:33 +04:00			`.It Fl L`
			`Lock the media into the drive (but see`
			`.Sx BUGS`
			`below).`
			`.It Fl U`
			`Unlock the media from the drive.`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`.It Fl n`
			`List the built-in nicknames on standard output.`
adjust to more accurately reflect the use of the -t option, per PR#5443 1998-05-12 01:45:44 +04:00			`.It Fl t Ar device-type`
			`Specify the device type.`
			`The argument must be one of`
			`.Sy diskette ,`
			`.Sy floppy ,`
			`.Sy cdrom ,`
			`.Sy disk ,`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`or`
			`.Sy tape .`
adjust to more accurately reflect the use of the -t option, per PR#5443 1998-05-12 01:45:44 +04:00			`This option is necessary when ejecting a device for which no built-in`
			`knowledge is available.`
Download from `netbsd-1-1' branch. 1995-10-22 19:48:52 +03:00			`.It Fl v`
			`Display some of the actions taken on standard output.`
			`.El`
Add -L and -U options to eject(1) that call DIOCLOCK. Also generally clean stuff up, correct the usage message and update the manpage to match. Note that the new options aren't wonderfully useful, since cd(4) at least promptly unlocks the drawer when eject closes the device. 2001-10-06 19:43:33 +04:00			`.Sh BUGS`
			`Most disk drivers automatically lock the media on the first open and`
			`unlock it on the last close, making`
Whitespace fixes and formatting improvements. 2001-10-06 22:51:04 +04:00			`.Ql Ic eject Fl L`
Add -L and -U options to eject(1) that call DIOCLOCK. Also generally clean stuff up, correct the usage message and update the manpage to match. Note that the new options aren't wonderfully useful, since cd(4) at least promptly unlocks the drawer when eject closes the device. 2001-10-06 19:43:33 +04:00			`almost useless, since when it closes the device, it gets unlocked`
			`again.`