path: root/bin/chio/chio.1

.\"	$OpenBSD: chio.1,v 1.19 2002/11/14 02:57:27 deraadt Exp $
.\"	$NetBSD: chio.1,v 1.1.1.1 1996/04/03 00:34:38 thorpej Exp $
.\"
.\" Copyright (c) 1996 Jason R. Thorpe <thorpej@and.com>
.\" All rights reserved.
.\"
.\" 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 acknowledgments:
.\"	This product includes software developed by Jason R. Thorpe
.\"	for And Communications, http://www.and.com/
.\" 4. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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 April 2, 1996
.Dt CHIO 1
.Os
.Sh NAME
.Nm chio
.Nd medium changer control utility
.Sh SYNOPSIS
.Nm chio
.Op Fl f Ar changer
.Ar command
.Ar arg1
.Ar arg2
.Oo
.Ar arg3 Oo Ar ...
.Oc
.Oc
.Sh DESCRIPTION
The
.Nm
utility is used to control the operation of medium changers, such as those
found in tape and optical disk jukeboxes.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl f Ar changer
Use the device
.Pa changer
rather than the default device
.Pa /dev/ch0 .
.El
.Pp
The default changer may be overridden by setting the environment variable
.Ev CHANGER
to the desired changer device.
.Pp
A medium changer apparatus is made up of
.Pa elements .
There are four element types:
.Pa picker
(medium transport),
.Pa slot
(storage),
.Pa portal
(import/export), and
.Pa drive
(data transfer).
In this command description, the shorthand
.Sq ET
will be used to represent an element type, and
.Sq EU
will be used to represent an element unit.
For example, to represent
the first robotic arm in the changer, the ET would be
.Dq picker
and the EU would be
.Dq 0 .
.Sh SUPPORTED COMMANDS
.Cm # chio move
.Aq Ar from ET
.Aq Ar from EU
.Aq Ar to ET
.Aq Ar to EU
.Op Ar inv
.Pp
Moves the media unit from
.Aq Ar from ET/EU
to
.Aq Ar to ET/EU .
If the optional modifier
.Pa inv
is specified, the media unit will be inverted before insertion.
.Pp
.Cm # chio exchange
.Aq Ar src ET
.Aq Ar src EU
.Aq Ar dst1 ET
.Aq Ar dst1 EU
.Oo
.Aq Ar dst2\& ET
.Aq Ar dst2\& EU
.Oc
.Op Ar inv1
.Op Ar inv2
.Pp
Performs a media unit exchange operation.
The media unit in
.Aq Ar src ET/EU
is moved to
.Aq Ar dst1 ET/EU
and the media unit previously in
.Aq Ar dst1 ET/EU
is moved to
.Aq Ar dst2 ET/EU .
In the case of a simple exchange,
.Aq Ar dst2 ET/EU
is omitted and the values
.Aq Ar src ET/EU
are used in their place.
The optional modifiers
.Ar inv1
and
.Ar inv2
specify whether the media units are to be inverted before insertion into
.Aq Ar dst1 ET/EU
and
.Aq Ar dst2 ET/EU
respectively.
.Pp
Note that not all medium changers support the
.Cm exchange
operation; the changer must have multiple free pickers or emulate
multiple free pickers with transient storage.
.Pp
.Cm # chio position
.Aq Ar to ET
.Aq Ar to EU
.Op Ar inv
.Pp
Position the picker in front of the element described by
.Aq Ar to ET/EU .
If the optional modifier
.Ar inv
is specified, the media unit will be inverted before insertion.
.Pp
Note that not all changers behave as expected when issued this command.
.Pp
.Cm # chio params
.Pp
Report the number of slots, drives, pickers, and portals in the changer,
and which picker unit the changer is currently configured to use.
.Pp
.Cm # chio getpicker
.Pp
Report which picker unit the changer is currently configured to use.
.Pp
.Cm # chio setpicker
.Aq Ar unit
.Pp
Configure the changer to use picker
.Aq Ar unit .
.Pp
.Cm # chio status
.Op Aq Ar type
.Pp
Report the status of all elements in the changer.
If
.Aq Ar type
is specified, report the status of all elements of type
.Aq Ar type .
.Pp
The status bits are defined as follows:
.Bl -tag -width indent
.It Dv FULL
Element contains a media unit.
.It Dv IMPEXP
Media was deposited into element by an outside human operator.
.It Dv EXCEPT
Element is in an abnormal state.
.It Dv ACCESS
Media in this element is accessible by a picker.
.It Dv EXENAB
Element supports passing media (exporting) to an outside human operator.
.It Dv INENAB
Element supports receiving media (importing) from an outside human operator.
.El
.Sh EXAMPLES
.Cm # chio move slot 3 drive 0
.Pp
Moves the media in slot 3 (fourth slot) to drive 0 (first drive).
.Pp
.Cm # chio setpicker 2
.Pp
Configures the changer to use picker 2 (third picker) for operations.
.Sh FILES
.Bl -tag -width /dev/ch0 -compact
.It Pa /dev/ch0
default changer device
.El
.Sh SEE ALSO
.Xr mt 1 ,
.Xr ch 4
.Sh AUTHORS
The
.Nm
program and
.Tn SCSI
changer driver were written by Jason R. Thorpe
<thorpej@and.com> for And Communications (http://www.and.com/).