OSDN Git Service

Import translated manuals from JM CVS Repository.
[linuxjm/jm.git] / manual / cdrecord / original / man1 / scgcheck.1
1 .\" @(#)scgcheck.1      1.4 01/04/16 Copyright 2000 J. Schilling
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 .if t .ds a \v'-0.55m'\h'0.00n'\z.\h'0.40n'\z.\v'0.55m'\h'-0.40n'a
24 .if t .ds o \v'-0.55m'\h'0.00n'\z.\h'0.45n'\z.\v'0.55m'\h'-0.45n'o
25 .if t .ds u \v'-0.55m'\h'0.00n'\z.\h'0.40n'\z.\v'0.55m'\h'-0.40n'u
26 .if t .ds A \v'-0.77m'\h'0.25n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.70n'A
27 .if t .ds O \v'-0.77m'\h'0.25n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.70n'O
28 .if t .ds U \v'-0.77m'\h'0.30n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.75n'U
29 .if t .ds s \\(*b
30 .if t .ds S SS
31 .if n .ds a ae
32 .if n .ds o oe
33 .if n .ds u ue
34 .if n .ds s sz
35 .TH SCGCHECK 1 "Version 1.10" "J\*org Schilling" "Schily\'s USER COMMANDS"
36 .SH NAME
37 scgcheck \- check and validate the ABI of libscg
38 .SH SYNOPSIS
39 .B scgcheck
40 [
41 .I options
42 ]
43
44 .SH DESCRIPTION
45 .B Scgcheck
46 is used to check and verify the Application Binary Interface of libscg.
47
48 .PP
49 The
50 .I device
51 refers to
52 .IR scsibus / target / lun
53 of the drive. Communication on 
54 .I SunOS
55 is done with the SCSI general driver
56 .B scg.
57 Other operating systems are using a library simulation of this driver.
58 Possible syntax is:
59 .B dev=
60 .IR scsibus , target , lun
61 or
62 .B dev=
63 .IR target , lun .
64 In the latter case, the drive has to be connected to the default 
65 SCSI bus of the machine.
66 .IR Scsibus ,
67 .I target 
68 and 
69 .I lun
70 are integer numbers. 
71 Some operating systems or SCSI transport implementations may require to
72 specify a filename in addition.
73 In this case the correct syntax for the device is:
74 .B dev=
75 .IR devicename : scsibus , target , lun
76 or
77 .B dev=
78 .IR devicename : target , lun .
79 If the name of the device node that has been specified on such a system
80 refers to exactly one SCSI device, a shorthand in the form
81 .B dev=
82 .IR devicename : @
83 or
84 .B dev=
85 .IR devicename : @ , lun
86 may be used instead of
87 .B dev=
88 .IR devicename : scsibus , target , lun .
89
90 .PP
91 To access remote SCSI devices, you need to prepend the SCSI device name by
92 a remote device indicator. The remote device indicator is either
93 .BI REMOTE: user@host:
94 or
95 .BR
96 .BI REMOTE: host:
97 .br
98 A valid remote SCSI device name may be:
99 .BI REMOTE: user@host:
100 to allow remote SCSI bus scanning or
101 .BI REMOTE: user@host:1,0,0
102 to access the SCSI device at 
103 .I host
104 connected to SCSI bus # 1,target 0 lun 0.
105
106 .PP
107 To make 
108 .B readcd
109 portable to all \s-2UNIX\s0 platforms, the syntax
110 .B dev=
111 .IR devicename : scsibus , target , lun
112 is preferred as is hides OS specific knowledge about device names from the user.
113 A specific OS must not necessarily support a way to specify a real device file name nor a
114 way to specify 
115 .IR scsibus , target , lun .
116
117 .PP
118 .I Scsibus 
119 0 is the default SCSI bus on the machine. Watch the boot messages for more 
120 information or look into 
121 .B /var/adm/messages 
122 for more information about the SCSI configuration of your machine.
123 If you have problems to figure out what values for 
124 .IR scsibus , target , lun
125 should be used, try the 
126 .B \-scanbus
127 option of 
128 .BR cdrecord .
129
130 .SH OPTIONS
131 .TP
132 .B \-version
133 Print version information and exit.
134 .TP
135 .BI dev= target
136 Sets the SCSI target default for SCSI Bus scanning test, see notes above.
137 This allows e.g. to specify to use Solaris USCSI or remote SCSI 
138 for the bus scanning case.
139
140 For the non bus scanning case, a typical device specification is
141 .BI dev= 6,0
142 \&.
143 If a filename must be provided together with the numerical target 
144 specification, the filename is implementation specific.
145 The correct filename in this case can be found in the system specific
146 manuals of the target operating system.
147 On a 
148 .I FreeBSD
149 system without 
150 .I CAM
151 support, you need to use the control device (e.g.
152 .IR /dev/rcd0.ctl ).
153 A correct device specification in this case may be
154 .BI dev= /dev/rcd0.ctl:@
155 \&.
156 .sp
157 On Linux, drives connected to a parallel port adapter are mapped
158 to a virtual SCSI bus. Different adapters are mapped to different
159 targets on this virtual SCSI bus.
160 .sp
161 If no 
162 .I dev
163 option is present, 
164 .B cdrecord
165 will try to get the device from the 
166 .B CDR_DEVICE
167 environment.
168 .sp
169 If the argument to the
170 .B dev=
171 option does not contain the characters ',', '/', '@' or ':',
172 it is interpreted as an label name that may be found in the file
173 /etc/default/cdrecord (see FILES section).
174 .TP
175 .BI timeout= #
176 Set the default SCSI command timeout value to 
177 .IR # " seconds.
178 The default SCSI command timeout is the minimum timeout used for sending
179 SCSI commands.
180 If a SCSI command fails due to a timeout, you may try to raise the
181 default SCSI command timeout above the timeout value of the failed command.
182 If the command runs correctly with a raised command timeout,
183 please report the better timeout value and the corresponding command to 
184 the author of the program.
185 If no 
186 .I timeout 
187 option is present, a default timeout of 40 seconds is used.
188 .TP
189 .BI debug= "#, " -d
190 Set the misc debug value to # (with debug=#) or increment
191 the misc debug level by one (with -d). If you specify
192 .I -dd,
193 this equals to 
194 .BI debug= 2.
195 This may help to find problems while opening a driver for libscg.
196 as well as with sector sizes and sector types.
197 Using
198 .B \-debug
199 slows down the process and may be the reason for a buffer underrun.
200 .TP
201 .BR kdebug= "#, " kd= #
202 Tell the 
203 .BR scg -driver
204 to modify the kernel debug value while SCSI commands are running.
205 .TP
206 .BR \-silent ", " \-s
207 Do not print out a status report for failed SCSI commands.
208 .TP
209 .B \-v
210 Increment the level of general verbosity by one.
211 This is used e.g. to display the progress of the process.
212 .TP
213 .B \-V
214 Increment the verbose level with respect of SCSI command transport by one.
215 This helps to debug problems
216 during the process, that occur in the CD-Recorder. 
217 If you get incomprehensible error messages you should use this flag
218 to get more detailed output.
219 .B \-VV
220 will show data buffer content in addition.
221 Using
222 .B \-V
223 or
224 .B \-VV
225 slows down the process.
226 .TP
227 .BI f= file
228 Specify the log file to be used instead of 
229 .IR check.log .
230
231 .SH EXAMPLES
232
233 .SH FILES
234 .SH SEE ALSO
235 .BR cdrecord (1),
236 .BR readcd (1),
237 .BR mkisofs (1),
238 .BR scg (7).
239
240 .SH NOTES
241 .PP
242 When using 
243 .B scgckeck
244 with the broken 
245 .B "Linux SCSI generic driver."
246 You should note that 
247 .B scgcheck
248 uses a hack, that tries to emulate the functionality of the scg driver.
249 Unfortunately, the sg driver on 
250 .B Linux
251 has several severe bugs:
252 .TP
253 \(bu
254 It cannot see if a SCSI command could not be sent at all.
255 .TP
256 \(bu
257 It cannot get the SCSI status byte. 
258 .B Scgcheck
259 for that reason cannot report failing SCSI commands in some
260 situations.
261 .TP
262 \(bu
263 It cannot get real DMA count of transfer. 
264 .B Scgcheck
265 cannot tell you if there is an DMA residual count.
266 .TP
267 \(bu
268 It cannot get number of bytes valid in auto sense data.
269 .B Scgcheck
270 cannot tell you if device transfers no sense data at all.
271 .TP
272 \(bu
273 It fetches to few data in auto request sense (CCS/SCSI-2/SCSI-3 needs >= 18).
274
275 .SH DIAGNOSTICS
276 .PP
277 .PP
278 A typical error message for a SCSI command looks like:
279 .sp
280 .RS
281 .nf
282 readcd: I/O error. test unit ready: scsi sendcmd: no error
283 CDB:  00 20 00 00 00 00
284 status: 0x2 (CHECK CONDITION)
285 Sense Bytes: 70 00 05 00 00 00 00 0A 00 00 00 00 25 00 00 00 00 00
286 Sense Key: 0x5 Illegal Request, Segment 0
287 Sense Code: 0x25 Qual 0x00 (logical unit not supported) Fru 0x0
288 Sense flags: Blk 0 (not valid)
289 cmd finished after 0.002s timeout 40s
290 .fi
291 .sp
292 .RE
293 The first line gives information about the transport of the command.
294 The text after the first colon gives the error text for the system call
295 from the view of the kernel. It usually is:
296 .B "I/O error
297 unless other problems happen. The next words contain a short description for
298 the SCSI command that fails. The rest of the line tells you if there were
299 any problems for the transport of the command over the SCSI bus.
300 .B "fatal error
301 means that it was not possible to transport the command (i.e. no device present
302 at the requested SCSI address).
303 .PP
304 The second line prints the SCSI command descriptor block for the failed command.
305 .PP
306 The third line gives information on the SCSI status code returned by the 
307 command, if the transport of the command succeeds. 
308 This is error information from the SCSI device.
309 .PP
310 The fourth line is a hex dump of the auto request sense information for the 
311 command.
312 .PP
313 The fifth line is the error text for the sense key if available, followed
314 by the segment number that is only valid if the command was a
315 .I copy
316 command. If the error message is not directly related to the current command,
317 the text
318 .I deferred error
319 is appended.
320 .PP
321 The sixth line is the error text for the sense code and the sense qualifier if available.
322 If the type of the device is known, the sense data is decoded from tables
323 in
324 .IR scsierrs.c " .
325 The text is followed by the error value for a field replaceable unit.
326 .PP
327 The seventh line prints the block number that is related to the failed command
328 and text for several error flags. The block number may not be valid.
329 .PP
330 The eight line reports the timeout set up for this commans and the time
331 that the command realy needed to be finished.
332
333 .SH BUGS
334
335 .SH CREDITS
336
337 .SH "MAILING LISTS
338
339 .SH AUTHOR
340 .nf
341 J\*org Schilling
342 Seestr. 110
343 D-13353 Berlin
344 Germany
345 .fi
346 .PP
347 Additional information can be found on:
348 .br
349 http://www.fokus.gmd.de/usr/schilling/cdrecord.html
350 .PP
351 If you have support questions, send them to:
352 .PP
353 .B
354 cdrecord-support@berlios.de
355 .br
356 or
357 .B
358 other-cdwrite@lists.debian.org
359 .PP
360 Of you definitly found a bug, send a mail to:
361 .PP
362 .B
363 cdrecord-developers@berlios.de
364 .br
365 or
366 .B
367 schilling@fokus.gmd.de
368 .PP
369 To subscribe, use:
370 .PP
371 .B
372 http://lists.berlios.de/mailman/listinfo/cdrecord-developers 
373 .br
374 or
375 .B
376 http://lists.berlios.de/mailman/listinfo/cdrecord-support