git.gag.com Git - debian/mtx/blob - scsieject.1

   1 .\" scsieject.1  Document Copyright 2007-2008 Robert Nelson
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" The GNU General Public License's references to "object code"
   9 .\" and "executables" are to be interpreted as the output of any
  10 .\" document formatting or typesetting system, including
  11 .\" intermediate and printed output.
  12 .\"
  13 .\" This manual is distributed in the hope that it will be useful,
  14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 .\" GNU General Public License for more details.
  17 .\"
  18 .\" You should have received a copy of the GNU General Public
  19 .\" License along with this manual; if not, write to the Free
  20 .\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
  21 .\" USA.
  22 .\"
  23 .TH scsieject 1 scsieject1.0
  24 .SH NAME
  25 scsieject \- control SCSI tape devices
  26 .SH SYNOPSIS
  27 scsieject [-f <scsi-generic-device>] commands
  28 .SH DESCRIPTION
  29 The
  30 .B scsieject
  31 command controls SCSI devices in a platform-independent
  32 manner. As long as 'mtx' works on the platform, so does 'scsieject'.
  33 .SH OPTIONS
  34 The first argument, given following
  35 .B -f
  36 , is the SCSI generic device corresponding to your tape drive.
  37 Consult your operating system's documentation for more information (for
  38 example, under Linux these are generally /dev/sg0 through /dev/sg15,
  39 under FreeBSD these are /dev/pass0 through /dev/passX. Under Solaris
  40 this is usually the same as your tape drive (Solaris has a SCSI passthrough
  41 ioctl). You can set the STAPE or TAPE environment variable rather
  42 than use -f.
  43 .P
  44 .SH COMMANDS
  45 .TP 10
  46 .B load
  47 Load the medium into the drive.  When this command is issued to a CD/DVD drive
  48 and the tray is extended the tray will be retracted if the drive is capable of it.
  49
  50 .TP 10
  51 .B unload
  52 Unload the medium from the drive (also known as eject).  When this command is issued
  53 to a CD/DVD drive or a tape drive the media will be ejected if the device supports it.
  54
  55 .TP 10
  56 .B start
  57 Start the device.  Some devices require a start command after a media changer has
  58 loaded new media into the device.
  59
  60 .TP 10
  61 .B stop
  62 Stop the device.  Some devices require a stop command prior to unloading the medium
  63 from the device when using a media changer.
  64
  65 .TP 10
  66 .B lock
  67 Lock the device.  Locks the device so that the medium cannot be removed manually.
  68
  69 .TP 10
  70 .B unlock
  71 Unlock the device.  Unlocks the device so that the medium can be removed manually.
  72
  73 .SH AUTHORS
  74 This program was written by Robert Nelson <robertnelson@users.sourceforge.net>
  75 based on the scsitape program written by Eric Lee Green <eric@badtux.org>.
  76 Major portions of the 'mtxl.c' library used herein were written by
  77 Leonard Zubkoff.
  78 .P
  79
  80 .SH HINTS
  81 Under Linux,
  82 .B cat /proc/scsi/scsi
  83 will tell you what SCSI devices you have.
  84 You can then refer to them as
  85 .B /dev/sga,
  86 .B /dev/sgb,
  87 etc. by the order they
  88 are reported.
  89 .P
  90 Under FreeBSD,
  91 .B camcontrol devlist
  92 will tell you what SCSI devices you
  93 have, along with which
  94 .B pass
  95 device controls them.
  96 .P
  97 Under Solaris 7 and 8,
  98 .B /usr/sbin/devfsadm -C
  99 will clean up your /devices directory. Then
 100 .B find /devices -name 'st@*' -print
 101 will return a list of all tape drives. /dev on Solaris is apparently only
 102 of historical interest.
 103
 104 .SH BUGS AND LIMITATIONS
 105 There are no known bugs or limitations.
 106
 107 .SH AVAILABILITY
 108 This version of
 109 .B scsieject
 110 is currently being maintained by Robert Nelson <robertnelson@users.sourceforge.net>
 111 as part of the 'mtx' suite of programs. The 'mtx' home page is
 112 http://mtx.sourceforge.net and the actual code is currently available there and via
 113 SVN from http://sourceforge.net/projects/mtx.
 114
 115 .SH SEE ALSO
 116 .BR loaderinfo (1), tapeinfo (1), mtx (1)