source: general/sysutils/sg3_utils.xml@ 45c9cb8

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 45c9cb8 was 15445ab, checked in by Douglas R. Reno <renodr@…>, 17 months ago

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