glfs/general/sysutils/sg3_utils.xml
2024-02-16 18:57:03 -06:00

1147 lines
36 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY sg3_utils-download-http "https://sg.danny.cz/sg/p/sg3_utils-&sg3_utils-version;.tar.xz">
<!ENTITY sg3_utils-download-ftp " ">
<!ENTITY sg3_utils-md5sum "0024393d2d2942cc081ce613d98db68a">
<!ENTITY sg3_utils-size "1.2 MB">
<!ENTITY sg3_utils-buildsize "27 MB">
<!ENTITY sg3_utils-time "0.2 SBU">
]>
<sect1 id="sg3_utils" xreflabel="sg3_utils-&sg3_utils-version;">
<?dbhtml filename="sg3_utils.html"?>
<title>sg3_utils-&sg3_utils-version;</title>
<indexterm zone="sg3_utils">
<primary sortas="a-sg3_utils">sg3_utils</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to sg3_utils</title>
<para>
The <application>sg3_utils</application> package contains low level
utilities for devices that use a SCSI command set. Apart from SCSI parallel
interface (SPI) devices, the SCSI command set is used by ATAPI devices
(CD/DVDs and tapes), USB mass storage devices, Fibre Channel disks, IEEE
1394 storage devices (that use the "SBP" protocol), SAS, iSCSI and FCoE
devices (amongst others).
</para>
&lfs121_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&sg3_utils-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&sg3_utils-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &sg3_utils-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &sg3_utils-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &sg3_utils-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &sg3_utils-time;
</para>
</listitem>
</itemizedlist>
<!-- No longer needed as 1.44 fixes the sysmacros.h use
<bridgehead renderas="sect3">Additional Downloads</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Required patch:
<ulink url="&patch-root;/sg3_utils-&sg3_utils-version;-glibc_2.28-fixes-1.patch"/>
</para>
</listitem>
</itemizedlist>
-->
</sect2>
<sect2 role="installation">
<title>Installation of sg3_utils</title>
<para>
Install <application>sg3_utils</application> by running the following
commands:
</para>
<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>
<para>
This package does not come with a test suite.
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>make install</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/static-libraries.xml"/>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Library</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>
rescan-scsi-bus.sh, scsi_logging_level, scsi_mandat, scsi_readcap,
scsi_ready, scsi_satl, scsi_start, scsi_stop, scsi_temperature,
sg_bg_ctl, sg_compare_and_write, sg_copy_results, sg_dd,
sg_decode_sense, sg_emc_trespass, sg_format,
sg_get_config, sg_get_lba_status, sg_ident, sg_inq, sg_logs, sg_luns,
sg_map, sg_map26, sg_modes, sg_opcodes, sg_persist, sg_prevent,
sg_raw, sg_rbuf, sg_rdac, sg_read, sg_read_attr, sg_read_block_limits,
sg_read_buffer, sg_read_long, sg_readcap, sg_reassign, sg_referrals,
sg_rep_pip, sg_rep_zones, sg_requests, sg_reset, sg_reset_wp,
sg_rmsn, sg_rtpg, sg_safte, sg_sanitize, sg_sat_identify,
sg_sat_phy_event, sg_sat_read_gplog, sg_sat_set_features, sg_scan,
sg_seek, sg_senddiag, sg_ses, sg_ses_microcode, sg_start, sg_stpg,
sg_stream_ctl, sg_sync, sg_test_rwbuf, sg_timestamp,
sg_turs, sg_unmap, sg_verify, sg_vpd, sg_wr_mode, sg_write_buffer,
sg_write_long, sg_write_same, sg_write_verify, sg_write_x, sg_xcopy, sg_zone,
sginfo, sgm_dd, and sgp_dd
</seg>
<seg>
libsgutils2.so
</seg>
<seg>
None
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="rescan-scsi-bus.sh">
<term><command>rescan-scsi-bus.sh</command></term>
<listitem>
<para>
adds or removes SCSI devices without having to reboot
</para>
<indexterm zone="sg3_utils rescan-scsi-bus.sh">
<primary sortas="b-rescan-scsi-bus.sh">rescan-scsi-bus.sh</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="scsi_logging_level">
<term><command>scsi_logging_level</command></term>
<listitem>
<para>
accesses Linux SCSI logging level information
</para>
<indexterm zone="sg3_utils scsi_logging_level">
<primary sortas="b-scsi_logging_level">scsi_logging_level</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="scsi_mandat">
<term><command>scsi_mandat</command></term>
<listitem>
<para>
checks SCSI device support for mandatory commands
</para>
<indexterm zone="sg3_utils scsi_mandat">
<primary sortas="b-scsi_mandat">scsi_mandat</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="scsi_readcap">
<term><command>scsi_readcap</command></term>
<listitem>
<para>
does the SCSI READ CAPACITY command on disks
</para>
<indexterm zone="sg3_utils scsi_readcap">
<primary sortas="b-scsi_readcap">scsi_readcap</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="scsi_ready">
<term><command>scsi_ready</command></term>
<listitem>
<para>
does the SCSI TEST UNIT READY on devices
</para>
<indexterm zone="sg3_utils scsi_ready">
<primary sortas="b-scsi_ready">scsi_ready</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="scsi_satl">
<term><command>scsi_satl</command></term>
<listitem>
<para>
checks for SCSI to ATA Translation (SAT) device support
</para>
<indexterm zone="sg3_utils scsi_satl">
<primary sortas="b-scsi_satl">scsi_satl</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="scsi_start">
<term><command>scsi_start</command></term>
<listitem>
<para>
starts one or more SCSI disks
</para>
<indexterm zone="sg3_utils scsi_start">
<primary sortas="b-scsi_start">scsi_start</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="scsi_stop">
<term><command>scsi_stop</command></term>
<listitem>
<para>
stops one or more SCSI disks
</para>
<indexterm zone="sg3_utils scsi_stop">
<primary sortas="b-scsi_stop">scsi_stop</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="scsi_temperature">
<term><command>scsi_temperature</command></term>
<listitem>
<para>
fetches the temperature of a SCSI device
</para>
<indexterm zone="sg3_utils scsi_temperature">
<primary sortas="b-scsi_temperature">scsi_temperature</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_bg_ctl">
<term><command>sg_bg_ctl</command></term>
<listitem>
<para>
performs a SCSI BACKGROUND CONTROL command on a device to perform
"advanced background operations"
</para>
<indexterm zone="sg3_utils sg_bg_ctl">
<primary sortas="b-sg_bg_ctl">sg_bg_ctl</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_compare_and_write">
<term><command>sg_compare_and_write</command></term>
<listitem>
<para>
sends the SCSI COMPARE AND WRITE command to device
</para>
<indexterm zone="sg3_utils sg_compare_and_write">
<primary sortas="b-sg_compare_and_write">sg_compare_and_write</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_copy_results">
<term><command>sg_copy_results</command></term>
<listitem>
<para>
sends the SCSI RECEIVE COPY RESULTS command (XCOPY related)
</para>
<indexterm zone="sg3_utils sg_copy_results">
<primary sortas="b-sg_copy_results">sg_copy_results</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_dd">
<term><command>sg_dd</command></term>
<listitem>
<para>
copies data to and from files and devices. Specialised for
devices that understand the SCSI command set
</para>
<indexterm zone="sg3_utils sg_dd">
<primary sortas="b-sg_dd">sg_dd</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_decode_sense">
<term><command>sg_decode_sense</command></term>
<listitem>
<para>
takes SCSI sense data in binary or as a sequence
of ASCII hexadecimal bytes and decodes it
</para>
<indexterm zone="sg3_utils sg_decode_sense">
<primary sortas="b-sg_decode_sense">sg_decode_sense</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_emc_trespass">
<term><command>sg_emc_trespass</command></term>
<listitem>
<para>
changes ownership of a LUN from another Service-Processor to
this one
</para>
<indexterm zone="sg3_utils sg_emc_trespass">
<primary sortas="b-sg_emc_trespass">sg_emc_trespass</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_format">
<term><command>sg_format</command></term>
<listitem>
<para>
formats or resizes a SCSI disk (perhaps changes its block size)
</para>
<indexterm zone="sg3_utils sg_format">
<primary sortas="b-sg_format">sg_format</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_get_config">
<term><command>sg_get_config</command></term>
<listitem>
<para>
sends a SCSI GET CONFIGURATION command (MMC-4 +)
</para>
<indexterm zone="sg3_utils sg_get_config">
<primary sortas="b-sg_get_config">sg_get_config</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_get_elem_status">
<term><command>sg_get_elem_status</command></term>
<listitem>
<para>
sends a SCSI GET PHYSICAL ELEMENT STATUS command to a device
</para>
<indexterm zone="sg3_utils sg_get_elem_status">
<primary sortas="b-sg_get_elem_status">sg_get_elem_status</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_get_lba_status">
<term><command>sg_get_lba_status</command></term>
<listitem>
<para>
sends the SCSI GET LBA STATUS command
</para>
<indexterm zone="sg3_utils sg_get_lba_status">
<primary sortas="b-sg_get_lba_status">sg_get_lba_status</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_ident">
<term><command>sg_ident</command></term>
<listitem>
<para>
sends a SCSI REPORT or SET IDENTIFYING INFORMATION command
</para>
<indexterm zone="sg3_utils sg_ident">
<primary sortas="b-sg_ident">sg_ident</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sginfo">
<term><command>sginfo</command></term>
<listitem>
<para>
access mode page information for a SCSI (or ATAPI) device
</para>
<indexterm zone="sg3_utils sginfo">
<primary sortas="b-sginfo">sginfo</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_inq">
<term><command>sg_inq</command></term>
<listitem>
<para>
sends a SCSI INQUIRY or ATA IDENTIFY (PACKET) DEVICE command and
outputs the response
</para>
<indexterm zone="sg3_utils sg_inq">
<primary sortas="b-sg_inq">sg_inq</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_logs">
<term><command>sg_logs</command></term>
<listitem>
<para>
access log pages with SCSI LOG SENSE command
</para>
<indexterm zone="sg3_utils sg_logs">
<primary sortas="b-sg_logs">sg_logs</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_luns">
<term><command>sg_luns</command></term>
<listitem>
<para>
sends the SCSI REPORT LUNS command
</para>
<indexterm zone="sg3_utils sg_luns">
<primary sortas="b-sg_luns">sg_luns</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_map">
<term><command>sg_map</command></term>
<listitem>
<para>
displays mapping between linux sg and other SCSI devices
</para>
<indexterm zone="sg3_utils sg_map">
<primary sortas="b-sg_map">sg_map</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_map26">
<term><command>sg_map26</command></term>
<listitem>
<para>
maps a special file to a SCSI generic (sg) device (or vice versa)
</para>
<indexterm zone="sg3_utils sg_map26">
<primary sortas="b-sg_map26">sg_map26</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sgm_dd">
<term><command>sgm_dd</command></term>
<listitem>
<para>
copies data to and from files and devices. Specialized for
devices that understand the SCSI command set and does memory mapped
transfers from sg devices
</para>
<indexterm zone="sg3_utils sgm_dd">
<primary sortas="b-sgm_dd">sgm_dd</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_modes">
<term><command>sg_modes</command></term>
<listitem>
<para>
reads mode pages with the SCSI MODE SENSE command
</para>
<indexterm zone="sg3_utils sg_modes">
<primary sortas="b-sg_modes">sg_modes</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_opcodes">
<term><command>sg_opcodes</command></term>
<listitem>
<para>
reports information on supported SCSI commands or task
management functions
</para>
<indexterm zone="sg3_utils sg_opcodes">
<primary sortas="b-sg_opcodes">sg_opcodes</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sgp_dd">
<term><command>sgp_dd</command></term>
<listitem>
<para>
copies data to and from files and devices. Specialized for
devices that understand the SCSI command set
</para>
<indexterm zone="sg3_utils sgp_dd">
<primary sortas="b-sgp_dd">sgp_dd</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_persist">
<term><command>sg_persist</command></term>
<listitem>
<para>
sends a SCSI PERSISTENT RESERVE (IN or OUT) command to
manipulate registrations and reservations
</para>
<indexterm zone="sg3_utils sg_persist">
<primary sortas="b-sg_persist">sg_persist</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_prevent">
<term><command>sg_prevent</command></term>
<listitem>
<para>
sends a SCSI PREVENT ALLOW MEDIUM REMOVAL command
</para>
<indexterm zone="sg3_utils sg_prevent">
<primary sortas="b-sg_prevent">sg_prevent</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_raw">
<term><command>sg_raw</command></term>
<listitem>
<para>
sends an arbitrary SCSI command to a device
</para>
<indexterm zone="sg3_utils sg_raw">
<primary sortas="b-sg_raw">sg_raw</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_rbuf">
<term><command>sg_rbuf</command></term>
<listitem>
<para>
reads data using the SCSI READ BUFFER command
</para>
<indexterm zone="sg3_utils sg_rbuf">
<primary sortas="b-sg_rbuf">sg_rbuf</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_rdac">
<term><command>sg_rdac</command></term>
<listitem>
<para>
displays or modifies the RDAC Redundant Controller Page
</para>
<indexterm zone="sg3_utils sg_rdac">
<primary sortas="b-sg_rdac">sg_rdac</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_read">
<term><command>sg_read</command></term>
<listitem>
<para>
reads blocks of data continually from the same offset
</para>
<indexterm zone="sg3_utils sg_read">
<primary sortas="b-sg_read">sg_read</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_read_attr">
<term><command>sg_read_attr</command></term>
<listitem>
<para>
performs a SCSI READ ATTRIBUTE command on a device
</para>
<indexterm zone="sg3_utils sg_read_attr">
<primary sortas="b-sg_read_attr">sg_read_attr</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_read_block_limits">
<term><command>sg_read_block_limits</command></term>
<listitem>
<para>
sends a SCSI READ BLOCK LIMITS command
</para>
<indexterm zone="sg3_utils sg_read_block_limits">
<primary sortas="b-sg_read_block_limits">sg_read_block_limits</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_read_buffer">
<term><command>sg_read_buffer</command></term>
<listitem>
<para>
sends a SCSI READ BUFFER command
</para>
<indexterm zone="sg3_utils sg_read_buffer">
<primary sortas="b-sg_read_buffer">sg_read_buffer</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_readcap">
<term><command>sg_readcap</command></term>
<listitem>
<para>
sends a SCSI READ CAPACITY command
</para>
<indexterm zone="sg3_utils sg_readcap">
<primary sortas="b-sg_readcap">sg_readcap</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_read_long">
<term><command>sg_read_long</command></term>
<listitem>
<para>
sends a SCSI READ LONG command
</para>
<indexterm zone="sg3_utils sg_read_long">
<primary sortas="b-sg_read_long">sg_read_long</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_reassign">
<term><command>sg_reassign</command></term>
<listitem>
<para>
sends a SCSI REASSIGN BLOCKS command
</para>
<indexterm zone="sg3_utils sg_reassign">
<primary sortas="b-sg_reassign">sg_reassign</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_referrals">
<term><command>sg_referrals</command></term>
<listitem>
<para>
sends a SCSI REPORT REFERRALS command
</para>
<indexterm zone="sg3_utils sg_referrals">
<primary sortas="b-sg_referrals">sg_referrals</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_rep_pip">
<term><command>sg_rep_pip</command></term>
<listitem>
<para>
sends a SCSI REPORT PROVISIONING INITIALIZATION PATTERN command
</para>
<indexterm zone="sg3_utils sg_rep_pip">
<primary sortas="b-sg_rep_pip">sg_rep_pip</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_rep_zones">
<term><command>sg_rep_zones</command></term>
<listitem>
<para>
sends a SCSI REPORT ZONES command
</para>
<indexterm zone="sg3_utils sg_rep_zones">
<primary sortas="b-sg_rep_zones">sg_rep_zones</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_requests">
<term><command>sg_requests</command></term>
<listitem>
<para>
sends one or more SCSI REQUEST SENSE commands
</para>
<indexterm zone="sg3_utils sg_requests">
<primary sortas="b-sg_requests">sg_requests</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_reset">
<term><command>sg_reset</command></term>
<listitem>
<para>
sends a SCSI device, target, bus or host reset; or checks reset state
</para>
<indexterm zone="sg3_utils sg_reset">
<primary sortas="b-sg_reset">sg_reset</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_reset_wp">
<term><command>sg_reset_wp</command></term>
<listitem>
<para>
sends a SCSI RESET WRITE POINTER command
</para>
<indexterm zone="sg3_utils sg_reset_wp">
<primary sortas="b-sg_reset_wp">sg_reset_wp</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_rmsn">
<term><command>sg_rmsn</command></term>
<listitem>
<para>
sends a SCSI READ MEDIA SERIAL NUMBER command
</para>
<indexterm zone="sg3_utils sg_rmsn">
<primary sortas="b-sg_rmsn">sg_rmsn</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_rtpg">
<term><command>sg_rtpg</command></term>
<listitem>
<para>
sends a SCSI REPORT TARGET PORT GROUPS command
</para>
<indexterm zone="sg3_utils sg_rtpg">
<primary sortas="b-sg_rtpg">sg_rtpg</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_safte">
<term><command>sg_safte</command></term>
<listitem>
<para>
fetches status information from a SCSI Accessed Fault-Tolerant
Enclosure (SAF-TE) device
</para>
<indexterm zone="sg3_utils sg_safte">
<primary sortas="b-sg_safte">sg_safte</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_sanitize">
<term><command>sg_sanitize</command></term>
<listitem>
<para>
sends a SCSI SANITIZE command
</para>
<indexterm zone="sg3_utils sg_sanitize">
<primary sortas="b-sg_sanitize">sg_sanitize</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_sat_identify">
<term><command>sg_sat_identify</command></term>
<listitem>
<para>
sends an ATA IDENTIFY (PACKET) DEVICE command via a SCSI to ATA
Translation (SAT) layer
</para>
<indexterm zone="sg3_utils sg_sat_identify">
<primary sortas="b-sg_sat_identify">sg_sat_identify</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_sat_phy_event">
<term><command>sg_sat_phy_event</command></term>
<listitem>
<para>
sends an ATA READ LOG EXT command via a SAT pass through to
fetch log page 11h which contains SATA phy event counters
</para>
<indexterm zone="sg3_utils sg_sat_phy_event">
<primary sortas="b-sg_sat_phy_event">sg_sat_phy_event</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_sat_read_gplog">
<term><command>sg_sat_read_gplog</command></term>
<listitem>
<para>
sends an ATA READ LOG EXT command via a SCSI to ATA Translation
(SAT) layer
</para>
<indexterm zone="sg3_utils sg_sat_read_gplog">
<primary sortas="b-sg_sat_read_gplog">sg_sat_read_gplog</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_sat_set_features">
<term><command>sg_sat_set_features</command></term>
<listitem>
<para>
sends an ATA SET FEATURES command via a SCSI to ATA Translation
(SAT) layer
</para>
<indexterm zone="sg3_utils sg_sat_set_features">
<primary sortas="b-sg_sat_set_features">sg_sat_set_features</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_scan">
<term><command>sg_scan</command></term>
<listitem>
<para>
does a scan of sg devices (or given SCSI/ATAPI/ATA devices) and
prints the results
</para>
<indexterm zone="sg3_utils sg_scan">
<primary sortas="b-sg_scan">sg_scan</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_seek">
<term><command>sg_seek</command></term>
<listitem>
<para>
performs a SCSI SEEK or PRE-FETCH command on a device and it's cache
</para>
<indexterm zone="sg3_utils sg_seek">
<primary sortas="b-sg_seek">sg_seek</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_senddiag">
<term><command>sg_senddiag</command></term>
<listitem>
<para>
performs a SCSI SEND DIAGNOSTIC command
</para>
<indexterm zone="sg3_utils sg_senddiag">
<primary sortas="b-sg_senddiag">sg_senddiag</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_ses">
<term><command>sg_ses</command></term>
<listitem>
<para>
sends controls and fetches the current status from a SCSI Enclosure
Services (SES) device
</para>
<indexterm zone="sg3_utils sg_ses">
<primary sortas="b-sg_ses">sg_ses</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_ses_microcode">
<term><command>sg_ses_microcode</command></term>
<listitem>
<para>
sends microcode to a SCSI enclosure
</para>
<indexterm zone="sg3_utils sg_ses_microcode">
<primary sortas="b-sg_ses_microcode">sg_ses_microcode</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_start">
<term><command>sg_start</command></term>
<listitem>
<para>
sends a SCSI START STOP UNIT command to start, stop, load or eject
medium
</para>
<indexterm zone="sg3_utils sg_start">
<primary sortas="b-sg_start">sg_start</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_stpg">
<term><command>sg_stpg</command></term>
<listitem>
<para>
sends a SCSI SET TARGET PORT GROUPS command
</para>
<indexterm zone="sg3_utils sg_stpg">
<primary sortas="b-sg_stpg">sg_stpg</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_stream_ctl">
<term><command>sg_stream_ctl</command></term>
<listitem>
<para>
performs a SCSI STREAM CONTROL or GET STREAM STATUS command on a device
to open or close an I/O stream
</para>
<indexterm zone="sg3_utils sg_stream_ctl">
<primary sortas="b-sg_stream_ctl">sg_stream_ctl</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_sync">
<term><command>sg_sync</command></term>
<listitem>
<para>
sends a SCSI command to synchronize the cache
</para>
<indexterm zone="sg3_utils sg_sync">
<primary sortas="b-sg_sync">sg_sync</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_test_rwbuf">
<term><command>sg_test_rwbuf</command></term>
<listitem>
<para>
tests the SCSI host adapter by issuing write and read operations
on a device's buffer and calculating checksums
</para>
<indexterm zone="sg3_utils sg_test_rwbuf">
<primary sortas="b-sg_test_rwbuf">sg_test_rwbuf</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_timestamp">
<term><command>sg_timestamp</command></term>
<listitem>
<para>
reports or sets the timestamp on a SCSI device
</para>
<indexterm zone="sg3_utils sg_timestamp">
<primary sortas="b-sg_timestamp">sg_timestamp</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_turs">
<term><command>sg_turs</command></term>
<listitem>
<para>
sends one or more SCSI TEST UNIT READY commands
</para>
<indexterm zone="sg3_utils sg_turs">
<primary sortas="b-sg_turs">sg_turs</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_unmap">
<term><command>sg_unmap</command></term>
<listitem>
<para>
sends a SCSI UNMAP command
</para>
<indexterm zone="sg3_utils sg_unmap">
<primary sortas="b-sg_unmap">sg_unmap</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_verify">
<term><command>sg_verify</command></term>
<listitem>
<para>
invokes SCSI VERIFY command(s) on a block device
</para>
<indexterm zone="sg3_utils sg_verify">
<primary sortas="b-sg_verify">sg_verify</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_vpd">
<term><command>sg_vpd</command></term>
<listitem>
<para>
fetches Vital Product Data (VPD) pages using a SCSI INQUIRY
command
</para>
<indexterm zone="sg3_utils sg_vpd">
<primary sortas="b-sg_vpd">sg_vpd</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_write_buffer">
<term><command>sg_write_buffer</command></term>
<listitem>
<para>
sends a SCSI WRITE BUFFER command
</para>
<indexterm zone="sg3_utils sg_write_buffer">
<primary sortas="b-sg_write_buffer">sg_write_buffer</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_write_long">
<term><command>sg_write_long</command></term>
<listitem>
<para>
sends a SCSI WRITE LONG command
</para>
<indexterm zone="sg3_utils sg_write_long">
<primary sortas="b-sg_write_long">sg_write_long</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_write_same">
<term><command>sg_write_same</command></term>
<listitem>
<para>
sends a SCSI WRITE SAME command
</para>
<indexterm zone="sg3_utils sg_write_same">
<primary sortas="b-sg_write_same">sg_write_same</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_write_verify">
<term><command>sg_write_verify</command></term>
<listitem>
<para>
sends a SCSI WRITE AND VERIFY command
</para>
<indexterm zone="sg3_utils sg_write_verify">
<primary sortas="b-sg_write_verify">sg_write_verify</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_write_x">
<term><command>sg_write_x</command></term>
<listitem>
<para>
performs SCSI WRITE commands on a device
</para>
<indexterm zone="sg3_utils sg_write_x">
<primary sortas="b-sg_write_x">sg_write_x</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_wr_mode">
<term><command>sg_wr_mode</command></term>
<listitem>
<para>
writes mode pages
</para>
<indexterm zone="sg3_utils sg_wr_mode">
<primary sortas="b-sg_wr_mode">sg_wr_mode</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_xcopy">
<term><command>sg_xcopy</command></term>
<listitem>
<para>
copies data to and from files and devices
using SCSI EXTENDED COPY (XCOPY)
</para>
<indexterm zone="sg3_utils sg_xcopy">
<primary sortas="b-sg_xcopy">sg_xcopy</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sg_zone">
<term><command>sg_zone</command></term>
<listitem>
<para>
performs SCSI ZONE commands on a device, such as OPEN, CLOSE, FINISH
or SEQUENTIALIZE
</para>
<indexterm zone="sg3_utils sg_zone">
<primary sortas="b-sg_zone">sg_zone</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libsgutils2">
<term><filename class="libraryfile">libsgutils2.so</filename></term>
<listitem>
<para>
contains the <application>sg3_utils</application> API functions
</para>
<indexterm zone="sg3_utils libsgutils2">
<primary sortas="c-libsgutils2">libsgutils2.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>