Checking commit emails.
[dragonfly.git] / bin / chio / chio.1
1 .\"     $NetBSD: chio.1,v 1.4 1997/10/02 00:41:25 hubertf Exp $
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 .\" $FreeBSD: src/bin/chio/chio.1,v 1.10.2.8 2003/05/16 22:43:15 keramida Exp $
34 .\" $DragonFly: src/bin/chio/chio.1,v 1.3 2006/02/17 19:33:30 swildner Exp $
35 .\"
36 .Dd May 14, 1998
37 .Dt CHIO 1
38 .Os
39 .Sh NAME
40 .Nm chio
41 .Nd medium changer control utility
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl f Ar changer
45 .Ar command
46 .Op Fl <flags>
47 .Ar arg1
48 .Ar arg2
49 .Op Ar arg3 Op ...
50 .Sh DESCRIPTION
51 The
52 .Nm
53 utility is used to control the operation of medium changers, such as those
54 found in tape and optical disk jukeboxes.
55 .Pp
56 The options are as follows:
57 .Bl -tag -width indent
58 .It Fl f Ar changer
59 Use the device
60 .Ar changer
61 rather than the default device
62 .Pa /dev/ch0 .
63 .El
64 .Pp
65 The default changer may be overridden by setting the environment variable
66 .Ev CHANGER
67 to the desired changer device.
68 .Pp
69 A medium changer apparatus is made up of
70 .Em elements .
71 There are five element types:
72 .Em picker
73 (medium transport),
74 .Em slot
75 (storage),
76 .Em portal
77 (import/export),
78 .Em drive
79 (data transfer), and
80 .Em voltag
81 (select by volume identifier).  The
82 .Em voltag
83 pseudo-element type allows the selection of tapes by their volume tag
84 (typically a barcode on the tape).
85 .Pp
86 In this command description, the shorthand
87 .Em ET
88 will be used to represent an element type, and
89 .Em EU
90 will be used to represent an element unit.
91 For example, to represent the first robotic arm in the changer, the
92 .Em ET
93 would be
94 .Dq picker
95 and the
96 .Em EU
97 would be
98 .Dq 0 .
99 .Sh SUPPORTED COMMANDS
100 .Bl -tag -width indent
101 .It Ic move Xo
102 .Ar <from ET> <from EU> <to ET> <to EU>
103 .Op Cm inv
104 .Xc
105 Move the media unit from
106 .Ar <from ET/EU>
107 to
108 .Ar <to ET/EU> .
109 If the optional modifier
110 .Cm inv
111 is specified, the media unit will be inverted before insertion.
112 .It Ic exchange Xo
113 .Ar <src ET> <src EU> <dst1 ET> <dst1 EU>
114 .Op Ar <dst2 ET> <dst2 ET>
115 .Op Cm inv1
116 .Op Cm inv2
117 .Xc
118 Perform a media unit exchange operation.  The media unit in
119 .Ar <src ET/EU>
120 is moved to
121 .Ar <dst1 ET/EU>
122 and the media unit previously in
123 .Ar <dst1 ET/EU>
124 is moved to
125 .Ar <dst2 ET/EU> .
126 In the case of a simple exchange,
127 .Ar <dst2 ET/EU>
128 is omitted and the values
129 .Ar <src ET/EU>
130 are used in their place.
131 The optional modifiers
132 .Cm inv1
133 and
134 .Cm inv2
135 specify whether the media units are to be inverted before insertion into
136 .Ar <dst1 ET/EU>
137 and
138 .Ar <dst2 ET/EU>
139 respectively.
140 .Pp
141 Note that not all medium changers support the
142 .Ic exchange
143 operation; the changer must have multiple free pickers or emulate
144 multiple free pickers with transient storage.
145 .It Ic return Xo
146 .Ar <from ET> <from EU>
147 .Xc
148 Return the media unit to its source element.
149 This command will query the status of the specified media unit, and
150 will move it to the element specified in its source attribute.
151 This is a convenient way to return media from a drive or portal
152 to its previous element in the changer.
153 .Pp
154 .It Ic position Xo
155 .Ar <to ET> <to EU>
156 .Op Cm inv
157 .Xc
158 Position the picker in front of the element described by
159 .Ar <to ET/EU> .
160 If the optional modifier
161 .Cm inv
162 is specified, the media unit will be inverted before insertion.
163 .Pp
164 Note that not all changers behave as expected when issued this command.
165 .It Ic params
166 Report the number of slots, drives, pickers, and portals in the changer,
167 and which picker unit the changer is currently configured to use.
168 .It Ic getpicker
169 Report which picker unit the changer is currently configured to use.
170 .It Ic setpicker Xo
171 .Ar <unit>
172 .Xc
173 Configure the changer to use picker
174 .Ar <unit> .
175 .Pp
176 .It Ic ielem Xo
177 .Op Ar <timeout>
178 .Xc
179 Perform an
180 .Em INITIALIZE ELEMENT STATUS
181 operation on the changer.  The optional
182 .Ar <timeout>
183 parameter may be given to specify a timeout in seconds for the
184 operations.  This may be used if the operation takes unusually long
185 because of buggy firmware or the like.
186 .It Ic voltag Xo
187 .Op Fl fca
188 .Ar <ET>
189 .Ar <EU>
190 .Op Ar <label>
191 .Op Ar <serial>
192 .Xc
193 Change volume tag for an element in the media changer.  This command
194 is only supported by few media changers.  If it is not supported by a
195 device, using this command will usually result in an "Invalid Field in
196 CDB" error message on the console.
197 .Pp
198 If the
199 .Fl c
200 flag is specified, the volume tag of the specified element is
201 cleared.  If the
202 .Fl f
203 flag is specified, the volume tag is superseded with the specified
204 volume tag even if a volume tag is already defined for the element.
205 It is an error to not specify the
206 .Fl f
207 flag when trying to set a label for an element which already has
208 volume tag information defined.
209 .Pp
210 The command works with the primary volume tag or, if the
211 .Fl a
212 flag is given, with the alternate volume tag.
213 .It Ic status Xo
214 .Op Fl vVsSbIa
215 .Op Ar <type>
216 .Xc
217 Report the status of all elements in the changer.  If
218 .Ar <type>
219 is specified, report the status of all elements of type
220 .Ar <type> .
221 .It Fl v
222 Print the primary volume tag for each loaded medium, if any.  The volume
223 tag is printed as
224 .Dq <LABEL:SERIAL> .
225 .It Fl V
226 Print the alternate volume tag for each loaded medium, if any.
227 .It Fl s
228 Print the additional sense code and additional sense code qualifier for
229 each element.
230 .It Fl S
231 Print the element source address for each element.
232 .It Fl b
233 Print SCSI bus information for each element.  Note that this information
234 is valid only for drives.
235 .It Fl I
236 Print the internal element addresses for each element.  The internal
237 element address is not normally used with this driver.  It is reported
238 for diagnostic purposes only.
239 .It Fl a
240 Print all additional information (as in
241 .Fl vVsSba ) .
242 .El
243 .Pp
244 The status bits are defined as follows:
245 .Bl -tag -width indent
246 .It FULL
247 Element contains a media unit.
248 .It IMPEXP
249 Media was deposited into element by an outside human operator.
250 .It EXCEPT
251 Element is in an abnormal state.
252 .It ACCESS
253 Media in this element is accessible by a picker.
254 .It EXENAB
255 Element supports passing media (exporting) to an outside human operator.
256 .It INENAB
257 Element supports receiving media (importing) from an outside human operator.
258 .El
259 .Sh FILES
260 .Bl -tag -width /dev/ch0 -compact
261 .It Pa /dev/ch0
262 default changer device
263 .El
264 .Sh EXAMPLES
265 .Bl -tag -width indent
266 .It Li chio move slot 3 drive 0
267 Move the media in slot 3 (fourth slot) to drive 0 (first drive).
268 .It Li chio move voltag VOLUME01 drive 0
269 Move the media with the barcode VOLUME01 to drive 0 (first drive).
270 .It Li chio return drive 0
271 Remove the tape from drive 0 (first drive) and return it to its original
272 location in the rack.
273 .It Li chio setpicker 2
274 Configure the changer to use picker 2 (third picker) for operations.
275 .El
276 .Sh SEE ALSO
277 .Xr mt 1 ,
278 .Xr mount 8
279 .Sh AUTHORS
280 .An -nosplit
281 The
282 .Nm
283 program and SCSI changer driver were written by
284 .An Jason R. Thorpe Aq thorpej@and.com
285 for And Communications,
286 .Pa http://www.and.com/ .
287 .Pp
288 Additional work by
289 .An Hans Huebner
290 .Aq hans@artcom.de
291 and
292 .An Steve Gunn
293 .Aq csg@waterspout.com .