source: general/sysutils/sg3_utils.xml@ 34d1c20

12.0 12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 34d1c20 was c8b719a, checked in by Douglas R. Reno <renodr@…>, 10 months ago

Tags
  • Property mode set to 100644
File size: 36.2 KB
RevLine 
[ab0972f]1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
[f3e940f7]7 <!ENTITY sg3_utils-download-http "https://sg.danny.cz/sg/p/sg3_utils-&sg3_utils-version;.tar.xz">
[ab0972f]8 <!ENTITY sg3_utils-download-ftp " ">
[3040325]9 <!ENTITY sg3_utils-md5sum "0024393d2d2942cc081ce613d98db68a">
10 <!ENTITY sg3_utils-size "1.2 MB">
11 <!ENTITY sg3_utils-buildsize "27 MB">
[c93612f2]12 <!ENTITY sg3_utils-time "0.2 SBU">
[ab0972f]13]>
14
15<sect1 id="sg3_utils" xreflabel="sg3_utils-&sg3_utils-version;">
16 <?dbhtml filename="sg3_utils.html"?>
17
18
19 <title>sg3_utils-&sg3_utils-version;</title>
20
21 <indexterm zone="sg3_utils">
22 <primary sortas="a-sg3_utils">sg3_utils</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to sg3_utils</title>
27
[e355d777]28 <para>
29 The <application>sg3_utils</application> package contains low level
30 utilities for devices that use a SCSI command set. Apart from SCSI parallel
31 interface (SPI) devices, the SCSI command set is used by ATAPI devices
32 (CD/DVDs and tapes), USB mass storage devices, Fibre Channel disks, IEEE
33 1394 storage devices (that use the "SBP" protocol), SAS, iSCSI and FCoE
34 devices (amongst others).
35 </para>
[ab0972f]36
[c8b719a]37 &lfs120_checked;
[47421bb8]38
[ab0972f]39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
[e355d777]42 <para>
43 Download (HTTP): <ulink url="&sg3_utils-download-http;"/>
44 </para>
[ab0972f]45 </listitem>
46 <listitem>
[e355d777]47 <para>
48 Download (FTP): <ulink url="&sg3_utils-download-ftp;"/>
49 </para>
[ab0972f]50 </listitem>
51 <listitem>
[e355d777]52 <para>
53 Download MD5 sum: &sg3_utils-md5sum;
54 </para>
[ab0972f]55 </listitem>
56 <listitem>
[e355d777]57 <para>
58 Download size: &sg3_utils-size;
59 </para>
[ab0972f]60 </listitem>
61 <listitem>
[e355d777]62 <para>
63 Estimated disk space required: &sg3_utils-buildsize;
64 </para>
[ab0972f]65 </listitem>
66 <listitem>
[e355d777]67 <para>
68 Estimated build time: &sg3_utils-time;
69 </para>
[ab0972f]70 </listitem>
71 </itemizedlist>
72
[8ef150f]73<!-- No longer needed as 1.44 fixes the sysmacros.h use
[afd2e883]74 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
75 <itemizedlist spacing="compact">
76 <listitem>
77 <para>
78 Required patch:
79 <ulink url="&patch-root;/sg3_utils-&sg3_utils-version;-glibc_2.28-fixes-1.patch"/>
80 </para>
81 </listitem>
82 </itemizedlist>
[8ef150f]83-->
[afd2e883]84
[ab0972f]85 </sect2>
86
87 <sect2 role="installation">
88 <title>Installation of sg3_utils</title>
89
[e355d777]90 <para>
91 Install <application>sg3_utils</application> by running the following
92 commands:
93 </para>
[ab0972f]94
[8ef150f]95<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
[ab0972f]96make</userinput></screen>
97
[e355d777]98 <para>
99 This package does not come with a test suite.
100 </para>
[ab0972f]101
[e355d777]102 <para>
103 Now, as the <systemitem class="username">root</systemitem> user:
104 </para>
[ab0972f]105
106<screen role="root"><userinput>make install</userinput></screen>
107
108 </sect2>
109
[47421bb8]110 <sect2 role="commands">
111 <title>Command Explanations</title>
112
[e355d777]113 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
114 href="../../xincludes/static-libraries.xml"/>
[47421bb8]115
116 </sect2>
117
[ab0972f]118 <sect2 role="content">
119 <title>Contents</title>
120
121 <segmentedlist>
122 <segtitle>Installed Programs</segtitle>
123 <segtitle>Installed Library</segtitle>
[c3c56b2]124 <segtitle>Installed Directories</segtitle>
[ab0972f]125
126 <seglistitem>
[e355d777]127 <seg>
[8558044]128 rescan-scsi-bus.sh, scsi_logging_level, scsi_mandat, scsi_readcap,
[511f7c8f]129 scsi_ready, scsi_satl, scsi_start, scsi_stop, scsi_temperature,
130 sg_bg_ctl, sg_compare_and_write, sg_copy_results, sg_dd,
131 sg_decode_sense, sg_emc_trespass, sg_format,
[c93612f2]132 sg_get_config, sg_get_lba_status, sg_ident, sg_inq, sg_logs, sg_luns,
133 sg_map, sg_map26, sg_modes, sg_opcodes, sg_persist, sg_prevent,
[8ef150f]134 sg_raw, sg_rbuf, sg_rdac, sg_read, sg_read_attr, sg_read_block_limits,
[c93612f2]135 sg_read_buffer, sg_read_long, sg_readcap, sg_reassign, sg_referrals,
[511f7c8f]136 sg_rep_pip, sg_rep_zones, sg_requests, sg_reset, sg_reset_wp,
137 sg_rmsn, sg_rtpg, sg_safte, sg_sanitize, sg_sat_identify,
138 sg_sat_phy_event, sg_sat_read_gplog, sg_sat_set_features, sg_scan,
139 sg_seek, sg_senddiag, sg_ses, sg_ses_microcode, sg_start, sg_stpg,
[8558044]140 sg_stream_ctl, sg_sync, sg_test_rwbuf, sg_timestamp,
[8ef150f]141 sg_turs, sg_unmap, sg_verify, sg_vpd, sg_wr_mode, sg_write_buffer,
[8558044]142 sg_write_long, sg_write_same, sg_write_verify, sg_write_x, sg_xcopy, sg_zone,
[8ef150f]143 sginfo, sgm_dd, and sgp_dd
[e355d777]144 </seg>
145 <seg>
146 libsgutils2.so
147 </seg>
[c3c56b2]148 <seg>
149 None
150 </seg>
[ab0972f]151 </seglistitem>
152 </segmentedlist>
153
154 <variablelist>
155 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
156 <?dbfo list-presentation="list"?>
157 <?dbhtml list-presentation="table"?>
158
[511f7c8f]159 <varlistentry id="rescan-scsi-bus.sh">
160 <term><command>rescan-scsi-bus.sh</command></term>
161 <listitem>
162 <para>
163 adds or removes SCSI devices without having to reboot
164 </para>
165 <indexterm zone="sg3_utils rescan-scsi-bus.sh">
166 <primary sortas="b-rescan-scsi-bus.sh">rescan-scsi-bus.sh</primary>
167 </indexterm>
168 </listitem>
169 </varlistentry>
170
[af5248e2]171 <varlistentry id="scsi_logging_level">
172 <term><command>scsi_logging_level</command></term>
173 <listitem>
174 <para>
[4c24eb0a]175 accesses Linux SCSI logging level information
[af5248e2]176 </para>
177 <indexterm zone="sg3_utils scsi_logging_level">
178 <primary sortas="b-scsi_logging_level">scsi_logging_level</primary>
179 </indexterm>
180 </listitem>
181 </varlistentry>
182
183 <varlistentry id="scsi_mandat">
184 <term><command>scsi_mandat</command></term>
185 <listitem>
186 <para>
[4c24eb0a]187 checks SCSI device support for mandatory commands
[af5248e2]188 </para>
189 <indexterm zone="sg3_utils scsi_mandat">
190 <primary sortas="b-scsi_mandat">scsi_mandat</primary>
191 </indexterm>
192 </listitem>
193 </varlistentry>
194
195 <varlistentry id="scsi_readcap">
196 <term><command>scsi_readcap</command></term>
197 <listitem>
198 <para>
[4c24eb0a]199 does the SCSI READ CAPACITY command on disks
[af5248e2]200 </para>
201 <indexterm zone="sg3_utils scsi_readcap">
202 <primary sortas="b-scsi_readcap">scsi_readcap</primary>
203 </indexterm>
204 </listitem>
205 </varlistentry>
206
207 <varlistentry id="scsi_ready">
208 <term><command>scsi_ready</command></term>
209 <listitem>
210 <para>
[4c24eb0a]211 does the SCSI TEST UNIT READY on devices
[af5248e2]212 </para>
213 <indexterm zone="sg3_utils scsi_ready">
214 <primary sortas="b-scsi_ready">scsi_ready</primary>
215 </indexterm>
216 </listitem>
217 </varlistentry>
218
219 <varlistentry id="scsi_satl">
220 <term><command>scsi_satl</command></term>
221 <listitem>
222 <para>
[4c24eb0a]223 checks for SCSI to ATA Translation (SAT) device support
[af5248e2]224 </para>
225 <indexterm zone="sg3_utils scsi_satl">
226 <primary sortas="b-scsi_satl">scsi_satl</primary>
227 </indexterm>
228 </listitem>
229 </varlistentry>
230
231 <varlistentry id="scsi_start">
232 <term><command>scsi_start</command></term>
233 <listitem>
234 <para>
[4c24eb0a]235 starts one or more SCSI disks
[af5248e2]236 </para>
237 <indexterm zone="sg3_utils scsi_start">
238 <primary sortas="b-scsi_start">scsi_start</primary>
239 </indexterm>
240 </listitem>
241 </varlistentry>
242
243 <varlistentry id="scsi_stop">
244 <term><command>scsi_stop</command></term>
245 <listitem>
246 <para>
[4c24eb0a]247 stops one or more SCSI disks
[af5248e2]248 </para>
249 <indexterm zone="sg3_utils scsi_stop">
250 <primary sortas="b-scsi_stop">scsi_stop</primary>
251 </indexterm>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry id="scsi_temperature">
256 <term><command>scsi_temperature</command></term>
257 <listitem>
258 <para>
[4c24eb0a]259 fetches the temperature of a SCSI device
[af5248e2]260 </para>
261 <indexterm zone="sg3_utils scsi_temperature">
262 <primary sortas="b-scsi_temperature">scsi_temperature</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
[8ef150f]267 <varlistentry id="sg_bg_ctl">
268 <term><command>sg_bg_ctl</command></term>
269 <listitem>
270 <para>
271 performs a SCSI BACKGROUND CONTROL command on a device to perform
[4c24eb0a]272 "advanced background operations"
[8ef150f]273 </para>
274 <indexterm zone="sg3_utils sg_bg_ctl">
275 <primary sortas="b-sg_bg_ctl">sg_bg_ctl</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
[5b38e37]280 <varlistentry id="sg_compare_and_write">
281 <term><command>sg_compare_and_write</command></term>
282 <listitem>
283 <para>
[4c24eb0a]284 sends the SCSI COMPARE AND WRITE command to device
[5b38e37]285 </para>
286 <indexterm zone="sg3_utils sg_compare_and_write">
287 <primary sortas="b-sg_compare_and_write">sg_compare_and_write</primary>
288 </indexterm>
289 </listitem>
290 </varlistentry>
291
292 <varlistentry id="sg_copy_results">
293 <term><command>sg_copy_results</command></term>
294 <listitem>
295 <para>
[4c24eb0a]296 sends the SCSI RECEIVE COPY RESULTS command (XCOPY related)
[5b38e37]297 </para>
298 <indexterm zone="sg3_utils sg_copy_results">
299 <primary sortas="b-sg_copy_results">sg_copy_results</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
[ab0972f]304 <varlistentry id="sg_dd">
305 <term><command>sg_dd</command></term>
306 <listitem>
[e355d777]307 <para>
308 copies data to and from files and devices. Specialised for
[4c24eb0a]309 devices that understand the SCSI command set
[e355d777]310 </para>
[ab0972f]311 <indexterm zone="sg3_utils sg_dd">
312 <primary sortas="b-sg_dd">sg_dd</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
[e355d777]317 <varlistentry id="sg_decode_sense">
318 <term><command>sg_decode_sense</command></term>
319 <listitem>
320 <para>
321 takes SCSI sense data in binary or as a sequence
[4c24eb0a]322 of ASCII hexadecimal bytes and decodes it
[e355d777]323 </para>
324 <indexterm zone="sg3_utils sg_decode_sense">
325 <primary sortas="b-sg_decode_sense">sg_decode_sense</primary>
326 </indexterm>
327 </listitem>
328 </varlistentry>
329
[ab0972f]330 <varlistentry id="sg_emc_trespass">
331 <term><command>sg_emc_trespass</command></term>
332 <listitem>
[e355d777]333 <para>
334 changes ownership of a LUN from another Service-Processor to
[4c24eb0a]335 this one
[e355d777]336 </para>
[ab0972f]337 <indexterm zone="sg3_utils sg_emc_trespass">
338 <primary sortas="b-sg_emc_trespass">sg_emc_trespass</primary>
339 </indexterm>
340 </listitem>
341 </varlistentry>
342
343 <varlistentry id="sg_format">
344 <term><command>sg_format</command></term>
345 <listitem>
[e355d777]346 <para>
[4c24eb0a]347 formats or resizes a SCSI disk (perhaps changes its block size)
[e355d777]348 </para>
[ab0972f]349 <indexterm zone="sg3_utils sg_format">
350 <primary sortas="b-sg_format">sg_format</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="sg_get_config">
356 <term><command>sg_get_config</command></term>
357 <listitem>
[e355d777]358 <para>
[4c24eb0a]359 sends a SCSI GET CONFIGURATION command (MMC-4 +)
[e355d777]360 </para>
[ab0972f]361 <indexterm zone="sg3_utils sg_get_config">
362 <primary sortas="b-sg_get_config">sg_get_config</primary>
363 </indexterm>
364 </listitem>
365 </varlistentry>
366
[ba718791]367 <varlistentry id="sg_get_elem_status">
368 <term><command>sg_get_elem_status</command></term>
369 <listitem>
370 <para>
[4c24eb0a]371 sends a SCSI GET PHYSICAL ELEMENT STATUS command to a device
[ba718791]372 </para>
373 <indexterm zone="sg3_utils sg_get_elem_status">
374 <primary sortas="b-sg_get_elem_status">sg_get_elem_status</primary>
375 </indexterm>
376 </listitem>
377 </varlistentry>
378
[ab0972f]379 <varlistentry id="sg_get_lba_status">
380 <term><command>sg_get_lba_status</command></term>
381 <listitem>
[e355d777]382 <para>
[4c24eb0a]383 sends the SCSI GET LBA STATUS command
[e355d777]384 </para>
[ab0972f]385 <indexterm zone="sg3_utils sg_get_lba_status">
386 <primary sortas="b-sg_get_lba_status">sg_get_lba_status</primary>
387 </indexterm>
388 </listitem>
389 </varlistentry>
390
391 <varlistentry id="sg_ident">
392 <term><command>sg_ident</command></term>
393 <listitem>
[e355d777]394 <para>
[4c24eb0a]395 sends a SCSI REPORT or SET IDENTIFYING INFORMATION command
[e355d777]396 </para>
[ab0972f]397 <indexterm zone="sg3_utils sg_ident">
398 <primary sortas="b-sg_ident">sg_ident</primary>
399 </indexterm>
400 </listitem>
401 </varlistentry>
402
403 <varlistentry id="sginfo">
404 <term><command>sginfo</command></term>
405 <listitem>
[e355d777]406 <para>
[4c24eb0a]407 access mode page information for a SCSI (or ATAPI) device
[e355d777]408 </para>
[ab0972f]409 <indexterm zone="sg3_utils sginfo">
410 <primary sortas="b-sginfo">sginfo</primary>
411 </indexterm>
412 </listitem>
413 </varlistentry>
414
415 <varlistentry id="sg_inq">
416 <term><command>sg_inq</command></term>
417 <listitem>
[e355d777]418 <para>
419 sends a SCSI INQUIRY or ATA IDENTIFY (PACKET) DEVICE command and
[4c24eb0a]420 outputs the response
[e355d777]421 </para>
[ab0972f]422 <indexterm zone="sg3_utils sg_inq">
423 <primary sortas="b-sg_inq">sg_inq</primary>
424 </indexterm>
425 </listitem>
426 </varlistentry>
427
428 <varlistentry id="sg_logs">
429 <term><command>sg_logs</command></term>
430 <listitem>
[e355d777]431 <para>
[4c24eb0a]432 access log pages with SCSI LOG SENSE command
[e355d777]433 </para>
[ab0972f]434 <indexterm zone="sg3_utils sg_logs">
435 <primary sortas="b-sg_logs">sg_logs</primary>
436 </indexterm>
437 </listitem>
438 </varlistentry>
439
440 <varlistentry id="sg_luns">
441 <term><command>sg_luns</command></term>
442 <listitem>
[e355d777]443 <para>
[4c24eb0a]444 sends the SCSI REPORT LUNS command
[e355d777]445 </para>
[ab0972f]446 <indexterm zone="sg3_utils sg_luns">
447 <primary sortas="b-sg_luns">sg_luns</primary>
448 </indexterm>
449 </listitem>
450 </varlistentry>
451
452 <varlistentry id="sg_map">
453 <term><command>sg_map</command></term>
454 <listitem>
[e355d777]455 <para>
[4c24eb0a]456 displays mapping between linux sg and other SCSI devices
[e355d777]457 </para>
[ab0972f]458 <indexterm zone="sg3_utils sg_map">
459 <primary sortas="b-sg_map">sg_map</primary>
460 </indexterm>
461 </listitem>
462 </varlistentry>
463
464 <varlistentry id="sg_map26">
465 <term><command>sg_map26</command></term>
466 <listitem>
[e355d777]467 <para>
[4c24eb0a]468 maps a special file to a SCSI generic (sg) device (or vice versa)
[e355d777]469 </para>
[ab0972f]470 <indexterm zone="sg3_utils sg_map26">
471 <primary sortas="b-sg_map26">sg_map26</primary>
472 </indexterm>
473 </listitem>
474 </varlistentry>
475
476 <varlistentry id="sgm_dd">
477 <term><command>sgm_dd</command></term>
478 <listitem>
[e355d777]479 <para>
480 copies data to and from files and devices. Specialized for
481 devices that understand the SCSI command set and does memory mapped
[4c24eb0a]482 transfers from sg devices
[e355d777]483 </para>
[ab0972f]484 <indexterm zone="sg3_utils sgm_dd">
485 <primary sortas="b-sgm_dd">sgm_dd</primary>
486 </indexterm>
487 </listitem>
488 </varlistentry>
489
490 <varlistentry id="sg_modes">
491 <term><command>sg_modes</command></term>
492 <listitem>
[e355d777]493 <para>
[511f7c8f]494 reads mode pages with the SCSI MODE SENSE command
[e355d777]495 </para>
[ab0972f]496 <indexterm zone="sg3_utils sg_modes">
497 <primary sortas="b-sg_modes">sg_modes</primary>
498 </indexterm>
499 </listitem>
500 </varlistentry>
501
502 <varlistentry id="sg_opcodes">
503 <term><command>sg_opcodes</command></term>
504 <listitem>
[e355d777]505 <para>
506 reports information on supported SCSI commands or task
[4c24eb0a]507 management functions
[e355d777]508 </para>
[ab0972f]509 <indexterm zone="sg3_utils sg_opcodes">
510 <primary sortas="b-sg_opcodes">sg_opcodes</primary>
511 </indexterm>
512 </listitem>
513 </varlistentry>
514
515 <varlistentry id="sgp_dd">
516 <term><command>sgp_dd</command></term>
517 <listitem>
[e355d777]518 <para>
519 copies data to and from files and devices. Specialized for
[4c24eb0a]520 devices that understand the SCSI command set
[e355d777]521 </para>
[ab0972f]522 <indexterm zone="sg3_utils sgp_dd">
523 <primary sortas="b-sgp_dd">sgp_dd</primary>
524 </indexterm>
525 </listitem>
526 </varlistentry>
527
528 <varlistentry id="sg_persist">
529 <term><command>sg_persist</command></term>
530 <listitem>
[e355d777]531 <para>
532 sends a SCSI PERSISTENT RESERVE (IN or OUT) command to
[4c24eb0a]533 manipulate registrations and reservations
[e355d777]534 </para>
[ab0972f]535 <indexterm zone="sg3_utils sg_persist">
536 <primary sortas="b-sg_persist">sg_persist</primary>
537 </indexterm>
538 </listitem>
539 </varlistentry>
540
541 <varlistentry id="sg_prevent">
542 <term><command>sg_prevent</command></term>
543 <listitem>
[e355d777]544 <para>
[4c24eb0a]545 sends a SCSI PREVENT ALLOW MEDIUM REMOVAL command
[e355d777]546 </para>
[ab0972f]547 <indexterm zone="sg3_utils sg_prevent">
548 <primary sortas="b-sg_prevent">sg_prevent</primary>
549 </indexterm>
550 </listitem>
551 </varlistentry>
552
553 <varlistentry id="sg_raw">
554 <term><command>sg_raw</command></term>
555 <listitem>
[e355d777]556 <para>
[4c24eb0a]557 sends an arbitrary SCSI command to a device
[e355d777]558 </para>
[ab0972f]559 <indexterm zone="sg3_utils sg_raw">
560 <primary sortas="b-sg_raw">sg_raw</primary>
561 </indexterm>
562 </listitem>
563 </varlistentry>
564
565 <varlistentry id="sg_rbuf">
566 <term><command>sg_rbuf</command></term>
567 <listitem>
[e355d777]568 <para>
[511f7c8f]569 reads data using the SCSI READ BUFFER command
[e355d777]570 </para>
[ab0972f]571 <indexterm zone="sg3_utils sg_rbuf">
572 <primary sortas="b-sg_rbuf">sg_rbuf</primary>
573 </indexterm>
574 </listitem>
575 </varlistentry>
576
577 <varlistentry id="sg_rdac">
578 <term><command>sg_rdac</command></term>
579 <listitem>
[e355d777]580 <para>
[511f7c8f]581 displays or modifies the RDAC Redundant Controller Page
[e355d777]582 </para>
[ab0972f]583 <indexterm zone="sg3_utils sg_rdac">
584 <primary sortas="b-sg_rdac">sg_rdac</primary>
585 </indexterm>
586 </listitem>
587 </varlistentry>
588
589 <varlistentry id="sg_read">
590 <term><command>sg_read</command></term>
591 <listitem>
[e355d777]592 <para>
[4c24eb0a]593 reads blocks of data continually from the same offset
[e355d777]594 </para>
[ab0972f]595 <indexterm zone="sg3_utils sg_read">
596 <primary sortas="b-sg_read">sg_read</primary>
597 </indexterm>
598 </listitem>
599 </varlistentry>
600
[8ef150f]601 <varlistentry id="sg_read_attr">
602 <term><command>sg_read_attr</command></term>
603 <listitem>
604 <para>
[4c24eb0a]605 performs a SCSI READ ATTRIBUTE command on a device
[8ef150f]606 </para>
607 <indexterm zone="sg3_utils sg_read_attr">
608 <primary sortas="b-sg_read_attr">sg_read_attr</primary>
609 </indexterm>
610 </listitem>
611 </varlistentry>
612
[ab0972f]613 <varlistentry id="sg_read_block_limits">
614 <term><command>sg_read_block_limits</command></term>
615 <listitem>
[e355d777]616 <para>
[4c24eb0a]617 sends a SCSI READ BLOCK LIMITS command
[e355d777]618 </para>
[ab0972f]619 <indexterm zone="sg3_utils sg_read_block_limits">
620 <primary sortas="b-sg_read_block_limits">sg_read_block_limits</primary>
621 </indexterm>
622 </listitem>
623 </varlistentry>
624
625 <varlistentry id="sg_read_buffer">
626 <term><command>sg_read_buffer</command></term>
627 <listitem>
[e355d777]628 <para>
[4c24eb0a]629 sends a SCSI READ BUFFER command
[e355d777]630 </para>
[ab0972f]631 <indexterm zone="sg3_utils sg_read_buffer">
632 <primary sortas="b-sg_read_buffer">sg_read_buffer</primary>
633 </indexterm>
634 </listitem>
635 </varlistentry>
636
637 <varlistentry id="sg_readcap">
638 <term><command>sg_readcap</command></term>
639 <listitem>
[e355d777]640 <para>
[4c24eb0a]641 sends a SCSI READ CAPACITY command
[e355d777]642 </para>
[ab0972f]643 <indexterm zone="sg3_utils sg_readcap">
644 <primary sortas="b-sg_readcap">sg_readcap</primary>
645 </indexterm>
646 </listitem>
647 </varlistentry>
648
649 <varlistentry id="sg_read_long">
650 <term><command>sg_read_long</command></term>
651 <listitem>
[e355d777]652 <para>
[4c24eb0a]653 sends a SCSI READ LONG command
[e355d777]654 </para>
[ab0972f]655 <indexterm zone="sg3_utils sg_read_long">
656 <primary sortas="b-sg_read_long">sg_read_long</primary>
657 </indexterm>
658 </listitem>
659 </varlistentry>
660
661 <varlistentry id="sg_reassign">
662 <term><command>sg_reassign</command></term>
663 <listitem>
[e355d777]664 <para>
[4c24eb0a]665 sends a SCSI REASSIGN BLOCKS command
[e355d777]666 </para>
[ab0972f]667 <indexterm zone="sg3_utils sg_reassign">
668 <primary sortas="b-sg_reassign">sg_reassign</primary>
669 </indexterm>
670 </listitem>
671 </varlistentry>
672
[e355d777]673 <varlistentry id="sg_referrals">
674 <term><command>sg_referrals</command></term>
675 <listitem>
676 <para>
[511f7c8f]677 sends a SCSI REPORT REFERRALS command
[e355d777]678 </para>
679 <indexterm zone="sg3_utils sg_referrals">
680 <primary sortas="b-sg_referrals">sg_referrals</primary>
681 </indexterm>
682 </listitem>
683 </varlistentry>
684
[511f7c8f]685 <varlistentry id="sg_rep_pip">
686 <term><command>sg_rep_pip</command></term>
687 <listitem>
688 <para>
689 sends a SCSI REPORT PROVISIONING INITIALIZATION PATTERN command
690 </para>
691 <indexterm zone="sg3_utils sg_rep_pip">
692 <primary sortas="b-sg_rep_pip">sg_rep_pip</primary>
693 </indexterm>
694 </listitem>
695 </varlistentry>
696
[c93612f2]697 <varlistentry id="sg_rep_zones">
698 <term><command>sg_rep_zones</command></term>
699 <listitem>
700 <para>
[4c24eb0a]701 sends a SCSI REPORT ZONES command
[c93612f2]702 </para>
703 <indexterm zone="sg3_utils sg_rep_zones">
704 <primary sortas="b-sg_rep_zones">sg_rep_zones</primary>
705 </indexterm>
706 </listitem>
707 </varlistentry>
708
[ab0972f]709 <varlistentry id="sg_requests">
710 <term><command>sg_requests</command></term>
711 <listitem>
[e355d777]712 <para>
[4c24eb0a]713 sends one or more SCSI REQUEST SENSE commands
[e355d777]714 </para>
[ab0972f]715 <indexterm zone="sg3_utils sg_requests">
716 <primary sortas="b-sg_requests">sg_requests</primary>
717 </indexterm>
718 </listitem>
719 </varlistentry>
720
721 <varlistentry id="sg_reset">
722 <term><command>sg_reset</command></term>
723 <listitem>
[e355d777]724 <para>
[511f7c8f]725 sends a SCSI device, target, bus or host reset; or checks reset state
[e355d777]726 </para>
[ab0972f]727 <indexterm zone="sg3_utils sg_reset">
728 <primary sortas="b-sg_reset">sg_reset</primary>
729 </indexterm>
730 </listitem>
731 </varlistentry>
732
[c93612f2]733 <varlistentry id="sg_reset_wp">
734 <term><command>sg_reset_wp</command></term>
735 <listitem>
736 <para>
[4c24eb0a]737 sends a SCSI RESET WRITE POINTER command
[c93612f2]738 </para>
739 <indexterm zone="sg3_utils sg_reset_wp">
740 <primary sortas="b-sg_reset_wp">sg_reset_wp</primary>
741 </indexterm>
742 </listitem>
743 </varlistentry>
744
[ab0972f]745 <varlistentry id="sg_rmsn">
746 <term><command>sg_rmsn</command></term>
747 <listitem>
[e355d777]748 <para>
[4c24eb0a]749 sends a SCSI READ MEDIA SERIAL NUMBER command
[e355d777]750 </para>
[ab0972f]751 <indexterm zone="sg3_utils sg_rmsn">
752 <primary sortas="b-sg_rmsn">sg_rmsn</primary>
753 </indexterm>
754 </listitem>
755 </varlistentry>
756
757 <varlistentry id="sg_rtpg">
758 <term><command>sg_rtpg</command></term>
759 <listitem>
[e355d777]760 <para>
[4c24eb0a]761 sends a SCSI REPORT TARGET PORT GROUPS command
[e355d777]762 </para>
[ab0972f]763 <indexterm zone="sg3_utils sg_rtpg">
764 <primary sortas="b-sg_rtpg">sg_rtpg</primary>
765 </indexterm>
766 </listitem>
767 </varlistentry>
768
769 <varlistentry id="sg_safte">
770 <term><command>sg_safte</command></term>
771 <listitem>
[e355d777]772 <para>
[511f7c8f]773 fetches status information from a SCSI Accessed Fault-Tolerant
774 Enclosure (SAF-TE) device
[e355d777]775 </para>
[ab0972f]776 <indexterm zone="sg3_utils sg_safte">
777 <primary sortas="b-sg_safte">sg_safte</primary>
778 </indexterm>
779 </listitem>
780 </varlistentry>
781
[e355d777]782 <varlistentry id="sg_sanitize">
783 <term><command>sg_sanitize</command></term>
784 <listitem>
785 <para>
[4c24eb0a]786 sends a SCSI SANITIZE command
[e355d777]787 </para>
788 <indexterm zone="sg3_utils sg_sanitize">
789 <primary sortas="b-sg_sanitize">sg_sanitize</primary>
790 </indexterm>
791 </listitem>
792 </varlistentry>
793
[ab0972f]794 <varlistentry id="sg_sat_identify">
795 <term><command>sg_sat_identify</command></term>
796 <listitem>
[e355d777]797 <para>
[b69a5a5]798 sends an ATA IDENTIFY (PACKET) DEVICE command via a SCSI to ATA
[4c24eb0a]799 Translation (SAT) layer
[e355d777]800 </para>
[ab0972f]801 <indexterm zone="sg3_utils sg_sat_identify">
802 <primary sortas="b-sg_sat_identify">sg_sat_identify</primary>
803 </indexterm>
804 </listitem>
805 </varlistentry>
806
807 <varlistentry id="sg_sat_phy_event">
808 <term><command>sg_sat_phy_event</command></term>
809 <listitem>
[e355d777]810 <para>
811 sends an ATA READ LOG EXT command via a SAT pass through to
[4c24eb0a]812 fetch log page 11h which contains SATA phy event counters
[e355d777]813 </para>
[ab0972f]814 <indexterm zone="sg3_utils sg_sat_phy_event">
815 <primary sortas="b-sg_sat_phy_event">sg_sat_phy_event</primary>
816 </indexterm>
817 </listitem>
818 </varlistentry>
819
[c93612f2]820
821 <varlistentry id="sg_sat_read_gplog">
822 <term><command>sg_sat_read_gplog</command></term>
823 <listitem>
824 <para>
[511f7c8f]825 sends an ATA READ LOG EXT command via a SCSI to ATA Translation
[4c24eb0a]826 (SAT) layer
[c93612f2]827 </para>
828 <indexterm zone="sg3_utils sg_sat_read_gplog">
829 <primary sortas="b-sg_sat_read_gplog">sg_sat_read_gplog</primary>
830 </indexterm>
831 </listitem>
832 </varlistentry>
[ab0972f]833 <varlistentry id="sg_sat_set_features">
834 <term><command>sg_sat_set_features</command></term>
835 <listitem>
[e355d777]836 <para>
[b69a5a5]837 sends an ATA SET FEATURES command via a SCSI to ATA Translation
[4c24eb0a]838 (SAT) layer
[e355d777]839 </para>
[ab0972f]840 <indexterm zone="sg3_utils sg_sat_set_features">
841 <primary sortas="b-sg_sat_set_features">sg_sat_set_features</primary>
842 </indexterm>
843 </listitem>
844 </varlistentry>
845
846 <varlistentry id="sg_scan">
847 <term><command>sg_scan</command></term>
848 <listitem>
[e355d777]849 <para>
850 does a scan of sg devices (or given SCSI/ATAPI/ATA devices) and
[4c24eb0a]851 prints the results
[e355d777]852 </para>
[ab0972f]853 <indexterm zone="sg3_utils sg_scan">
854 <primary sortas="b-sg_scan">sg_scan</primary>
855 </indexterm>
856 </listitem>
857 </varlistentry>
858
[8ef150f]859 <varlistentry id="sg_seek">
860 <term><command>sg_seek</command></term>
861 <listitem>
862 <para>
[4c24eb0a]863 performs a SCSI SEEK or PRE-FETCH command on a device and it's cache
[8ef150f]864 </para>
865 <indexterm zone="sg3_utils sg_seek">
866 <primary sortas="b-sg_seek">sg_seek</primary>
867 </indexterm>
868 </listitem>
869 </varlistentry>
870
[ab0972f]871 <varlistentry id="sg_senddiag">
872 <term><command>sg_senddiag</command></term>
873 <listitem>
[e355d777]874 <para>
[4c24eb0a]875 performs a SCSI SEND DIAGNOSTIC command
[e355d777]876 </para>
[ab0972f]877 <indexterm zone="sg3_utils sg_senddiag">
878 <primary sortas="b-sg_senddiag">sg_senddiag</primary>
879 </indexterm>
880 </listitem>
881 </varlistentry>
882
883 <varlistentry id="sg_ses">
884 <term><command>sg_ses</command></term>
885 <listitem>
[e355d777]886 <para>
[511f7c8f]887 sends controls and fetches the current status from a SCSI Enclosure
888 Services (SES) device
[e355d777]889 </para>
[ab0972f]890 <indexterm zone="sg3_utils sg_ses">
891 <primary sortas="b-sg_ses">sg_ses</primary>
892 </indexterm>
893 </listitem>
894 </varlistentry>
895
[c93612f2]896 <varlistentry id="sg_ses_microcode">
897 <term><command>sg_ses_microcode</command></term>
898 <listitem>
899 <para>
[4c24eb0a]900 sends microcode to a SCSI enclosure
[c93612f2]901 </para>
902 <indexterm zone="sg3_utils sg_ses_microcode">
903 <primary sortas="b-sg_ses_microcode">sg_ses_microcode</primary>
904 </indexterm>
905 </listitem>
906 </varlistentry>
907
[ab0972f]908 <varlistentry id="sg_start">
909 <term><command>sg_start</command></term>
910 <listitem>
[e355d777]911 <para>
[b69a5a5]912 sends a SCSI START STOP UNIT command to start, stop, load or eject
[4c24eb0a]913 medium
[e355d777]914 </para>
[ab0972f]915 <indexterm zone="sg3_utils sg_start">
916 <primary sortas="b-sg_start">sg_start</primary>
917 </indexterm>
918 </listitem>
919 </varlistentry>
920
921 <varlistentry id="sg_stpg">
922 <term><command>sg_stpg</command></term>
923 <listitem>
[e355d777]924 <para>
[4c24eb0a]925 sends a SCSI SET TARGET PORT GROUPS command
[e355d777]926 </para>
[ab0972f]927 <indexterm zone="sg3_utils sg_stpg">
928 <primary sortas="b-sg_stpg">sg_stpg</primary>
929 </indexterm>
930 </listitem>
931 </varlistentry>
932
[8ef150f]933 <varlistentry id="sg_stream_ctl">
934 <term><command>sg_stream_ctl</command></term>
935 <listitem>
936 <para>
937 performs a SCSI STREAM CONTROL or GET STREAM STATUS command on a device
[4c24eb0a]938 to open or close an I/O stream
[8ef150f]939 </para>
940 <indexterm zone="sg3_utils sg_stream_ctl">
[36b17b5]941 <primary sortas="b-sg_stream_ctl">sg_stream_ctl</primary>
[8ef150f]942 </indexterm>
943 </listitem>
944 </varlistentry>
945
[ab0972f]946 <varlistentry id="sg_sync">
947 <term><command>sg_sync</command></term>
948 <listitem>
[e355d777]949 <para>
[511f7c8f]950 sends a SCSI command to synchronize the cache
[e355d777]951 </para>
[ab0972f]952 <indexterm zone="sg3_utils sg_sync">
953 <primary sortas="b-sg_sync">sg_sync</primary>
954 </indexterm>
955 </listitem>
956 </varlistentry>
957
958 <varlistentry id="sg_test_rwbuf">
959 <term><command>sg_test_rwbuf</command></term>
960 <listitem>
[e355d777]961 <para>
962 tests the SCSI host adapter by issuing write and read operations
[4c24eb0a]963 on a device's buffer and calculating checksums
[e355d777]964 </para>
[ab0972f]965 <indexterm zone="sg3_utils sg_test_rwbuf">
966 <primary sortas="b-sg_test_rwbuf">sg_test_rwbuf</primary>
967 </indexterm>
968 </listitem>
969 </varlistentry>
970
[511f7c8f]971 <varlistentry id="sg_timestamp">
972 <term><command>sg_timestamp</command></term>
973 <listitem>
974 <para>
975 reports or sets the timestamp on a SCSI device
976 </para>
977 <indexterm zone="sg3_utils sg_timestamp">
978 <primary sortas="b-sg_timestamp">sg_timestamp</primary>
979 </indexterm>
980 </listitem>
981 </varlistentry>
982
[ab0972f]983 <varlistentry id="sg_turs">
984 <term><command>sg_turs</command></term>
985 <listitem>
[e355d777]986 <para>
[4c24eb0a]987 sends one or more SCSI TEST UNIT READY commands
[e355d777]988 </para>
[ab0972f]989 <indexterm zone="sg3_utils sg_turs">
990 <primary sortas="b-sg_turs">sg_turs</primary>
991 </indexterm>
992 </listitem>
993 </varlistentry>
994
995 <varlistentry id="sg_unmap">
996 <term><command>sg_unmap</command></term>
997 <listitem>
[e355d777]998 <para>
[4c24eb0a]999 sends a SCSI UNMAP command
[e355d777]1000 </para>
[ab0972f]1001 <indexterm zone="sg3_utils sg_unmap">
1002 <primary sortas="b-sg_unmap">sg_unmap</primary>
1003 </indexterm>
1004 </listitem>
1005 </varlistentry>
1006
1007 <varlistentry id="sg_verify">
1008 <term><command>sg_verify</command></term>
1009 <listitem>
[e355d777]1010 <para>
[4c24eb0a]1011 invokes SCSI VERIFY command(s) on a block device
[e355d777]1012 </para>
[ab0972f]1013 <indexterm zone="sg3_utils sg_verify">
1014 <primary sortas="b-sg_verify">sg_verify</primary>
1015 </indexterm>
1016 </listitem>
1017 </varlistentry>
1018
1019 <varlistentry id="sg_vpd">
1020 <term><command>sg_vpd</command></term>
1021 <listitem>
[e355d777]1022 <para>
1023 fetches Vital Product Data (VPD) pages using a SCSI INQUIRY
[4c24eb0a]1024 command
[e355d777]1025 </para>
[ab0972f]1026 <indexterm zone="sg3_utils sg_vpd">
1027 <primary sortas="b-sg_vpd">sg_vpd</primary>
1028 </indexterm>
1029 </listitem>
1030 </varlistentry>
1031
1032 <varlistentry id="sg_write_buffer">
1033 <term><command>sg_write_buffer</command></term>
1034 <listitem>
[e355d777]1035 <para>
[4c24eb0a]1036 sends a SCSI WRITE BUFFER command
[e355d777]1037 </para>
[ab0972f]1038 <indexterm zone="sg3_utils sg_write_buffer">
1039 <primary sortas="b-sg_write_buffer">sg_write_buffer</primary>
1040 </indexterm>
1041 </listitem>
1042 </varlistentry>
1043
1044 <varlistentry id="sg_write_long">
1045 <term><command>sg_write_long</command></term>
1046 <listitem>
[e355d777]1047 <para>
[511f7c8f]1048 sends a SCSI WRITE LONG command
[e355d777]1049 </para>
[ab0972f]1050 <indexterm zone="sg3_utils sg_write_long">
1051 <primary sortas="b-sg_write_long">sg_write_long</primary>
1052 </indexterm>
1053 </listitem>
1054 </varlistentry>
1055
1056 <varlistentry id="sg_write_same">
1057 <term><command>sg_write_same</command></term>
1058 <listitem>
[e355d777]1059 <para>
[511f7c8f]1060 sends a SCSI WRITE SAME command
[e355d777]1061 </para>
[ab0972f]1062 <indexterm zone="sg3_utils sg_write_same">
1063 <primary sortas="b-sg_write_same">sg_write_same</primary>
1064 </indexterm>
1065 </listitem>
1066 </varlistentry>
1067
[c93612f2]1068 <varlistentry id="sg_write_verify">
1069 <term><command>sg_write_verify</command></term>
1070 <listitem>
1071 <para>
[511f7c8f]1072 sends a SCSI WRITE AND VERIFY command
[c93612f2]1073 </para>
[8ef150f]1074 <indexterm zone="sg3_utils sg_write_verify">
1075 <primary sortas="b-sg_write_verify">sg_write_verify</primary>
1076 </indexterm>
1077 </listitem>
1078 </varlistentry>
1079
1080 <varlistentry id="sg_write_x">
1081 <term><command>sg_write_x</command></term>
1082 <listitem>
1083 <para>
[4c24eb0a]1084 performs SCSI WRITE commands on a device
[8ef150f]1085 </para>
1086 <indexterm zone="sg3_utils sg_write_x">
1087 <primary sortas="b-sg_write_x">sg_write_x</primary>
[c93612f2]1088 </indexterm>
1089 </listitem>
1090 </varlistentry>
1091
[ab0972f]1092 <varlistentry id="sg_wr_mode">
1093 <term><command>sg_wr_mode</command></term>
1094 <listitem>
[e355d777]1095 <para>
[511f7c8f]1096 writes mode pages
[e355d777]1097 </para>
[ab0972f]1098 <indexterm zone="sg3_utils sg_wr_mode">
1099 <primary sortas="b-sg_wr_mode">sg_wr_mode</primary>
1100 </indexterm>
1101 </listitem>
1102 </varlistentry>
1103
[5b38e37]1104 <varlistentry id="sg_xcopy">
1105 <term><command>sg_xcopy</command></term>
1106 <listitem>
1107 <para>
1108 copies data to and from files and devices
[4c24eb0a]1109 using SCSI EXTENDED COPY (XCOPY)
[5b38e37]1110 </para>
1111 <indexterm zone="sg3_utils sg_xcopy">
1112 <primary sortas="b-sg_xcopy">sg_xcopy</primary>
1113 </indexterm>
1114 </listitem>
1115 </varlistentry>
1116
[8ef150f]1117 <varlistentry id="sg_zone">
1118 <term><command>sg_zone</command></term>
1119 <listitem>
1120 <para>
1121 performs SCSI ZONE commands on a device, such as OPEN, CLOSE, FINISH
[4c24eb0a]1122 or SEQUENTIALIZE
[8ef150f]1123 </para>
1124 <indexterm zone="sg3_utils sg_zone">
1125 <primary sortas="b-sg_zone">sg_zone</primary>
1126 </indexterm>
1127 </listitem>
1128 </varlistentry>
1129
[ab0972f]1130 <varlistentry id="libsgutils2">
[5b38e37]1131 <term><filename class="libraryfile">libsgutils2.so</filename></term>
[ab0972f]1132 <listitem>
[e355d777]1133 <para>
[4c24eb0a]1134 contains the <application>sg3_utils</application> API functions
[e355d777]1135 </para>
[ab0972f]1136 <indexterm zone="sg3_utils libsgutils2">
[e355d777]1137 <primary sortas="c-libsgutils2">libsgutils2.so</primary>
[ab0972f]1138 </indexterm>
1139 </listitem>
1140 </varlistentry>
1141
1142 </variablelist>
1143
1144 </sect2>
1145
1146</sect1>
Note: See TracBrowser for help on using the repository browser.