xref: /freebsd/bin/chio/chio.1 (revision 952d112864d8008aa87278a30a539d888a8493cd)
1.\"	$NetBSD: $
2.\"
3.\" Copyright (c) 1996 Jason R. Thorpe <thorpej@and.com>
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgements:
16.\"	This product includes software developed by Jason R. Thorpe
17.\"	for And Communications, http://www.and.com/
18.\" 4. The name of the author may not be used to endorse or promote products
19.\"    derived from this software without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31.\" SUCH DAMAGE.
32.\"
33.Dd April 2, 1996
34.Dt CHIO 1
35.Os
36.Sh NAME
37.Nm chio
38.Nd medium changer control utility
39.Sh SYNOPSIS
40.Nm chio
41.Op Fl f Ar changer
42.Ar command
43.Ar arg1
44.Ar arg2
45.Oo
46.Ar arg3 Oo ...
47.Oc
48.Oc
49.Sh DESCRIPTION
50.Nm Chio
51is used to control the operation of medium changers, such as those found
52in tape and optical disk jukeboxes.
53.Pp
54The options are as follows:
55.Bl -tag -width indent
56.It Fl f Ar changer
57Use the device
58.Pa changer
59rather than the default device
60.Pa /dev/ch0 .
61.El
62.Pp
63The default changer may be overridden by setting the environment variable
64.Nm CHANGER
65to the desired changer device.
66.Pp
67A medium changer apparatus is made up of
68.Pa elements .
69There are four element types:
70.Pa picker
71(medium transport),
72.Pa slot
73(storage),
74.Pa portal
75(import/export), and
76.Pa drive
77(data transfer).  In this command description, the shorthand
78.Nm ET
79will be used to represent an element type, and
80.Nm EU
81will be used to represent an element unit.  For example, to represent
82the first robotic arm in the changer, the ET would be
83.Dq picker
84and the EU would be
85.Dq 0 .
86.Pp
87.Sh SUPPORTED COMMANDS
88.Nm chio move
89.Ar <from ET> <from EU> <to ET> <to EU>
90.Op Ar inv
91.Pp
92Moves the media unit from
93.Pa <from ET/EU>
94to
95.Pa <to ET/EU> .
96If the optional modifier
97.Pa inv
98is specified, the media unit will be inverted before insertion.
99.Pp
100.Nm chio exchange
101.Ar <src ET> <src EU> <dst1 ET> <dst1 EU>
102.Op Ar <dst2 ET> <dst2 ET>
103.Op Ar inv1
104.Op Ar inv2
105.Pp
106Performs a media unit exchange operation.  The media unit in
107.Pa <src ET/EU>
108is moved to
109.Pa <dst1 ET/EU>
110and the media unit previously in
111.Pa <dst1 ET/EU>
112is moved to
113.Pa <dst2 ET/EU> .
114In the case of a simple exchange,
115.Pa <dst2 ET/EU>
116is omitted and the values
117.Pa <src ET/EU>
118are used in their place.
119The optional modifiers
120.Pa inv1
121and
122.Pa inv2
123specify whether the media units are to be inverted before insertion into
124.Pa <dst1 ET/EU>
125and
126.Pa <dst2 ET/EU>
127respecitively.
128.Pp
129Note that not all medium changers support the
130.Nm exchange
131operation; The changer must have multiple free pickers or emulate
132multiple free pickers with transient storage.
133.Pp
134.Nm chio position
135.Ar <to ET> <to EU>
136.Op Ar inv
137.Pp
138Position the picker in front of the element described by
139.Pa <to ET/EU> .
140If the optional modifier
141.Pa inv
142is specified, the media unit will be inverted before insertion.
143.Pp
144Note that not all changers behave as expected when issued this command.
145.Pp
146.Nm chio params
147.Pp
148Report the number of slots, drives, pickers, and portals in the changer,
149and which picker unit the changer is currently configured to use.
150.Pp
151.Nm chio getpicker
152.Pp
153Report which picker unit the changer is currently configured to use.
154.Pp
155.Nm chio setpicker
156.Ar <unit>
157.Pp
158Configure the changer to use picker
159.Pa <unit> .
160.Pp
161.Nm chio status
162.Op Ar <type>
163.Pp
164Report the status of all elements in the changer.  If
165.Pa <type>
166is specified, report the status of all elements of type
167.Pa <type> .
168.Pp
169The status bits are defined as follows:
170.Bl -tag -width indent
171.It Nm FULL
172Element contains a media unit.
173.It Nm IMPEXP
174Media was deposited into element by an outside human operator.
175.It Nm EXCEPT
176Element is in an abnormal state.
177.It Nm ACCESS
178Media in this element is accessible by a picker.
179.It Nm EXENAB
180Element supports passing media (exporting) to an outsite human operator.
181.It Nm INENAB
182Element supports receiving media (importing) from an outside human operator.
183.El
184.Pp
185.Sh EXAMPLES
186.Nm chio move slot 3 drive 0
187.Pp
188Moves the media in slot 3 (fourth slot) to drive 0 (first drive).
189.Pp
190.Nm chio setpicker 2
191Configures the changer to use picker 2 (third picker) for operations.
192.Pp
193.Sh FILES
194/dev/ch0 - default changer device
195.Sh SEE ALSO
196.Xr mt 1 ,
197.Xr mount 8 .
198.Sh AUTHOR
199The
200.Nm chio
201program and SCSI changer driver were written by Jason R. Thorpe
202<thorpej@and.com> for And Communications, http://www.and.com/
203