<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!--ARC : LSARC 2005/734 GNOME For Nevada -->
<!ENTITY cmd "gst-inspect">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY suncopy "Copyright (c) 2004,2006,2009 Sun Microsystems, Inc. All Rights Reserved.">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="gst-inspect-1">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>gst-inspect</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">26 Feb 2009</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&release;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
</refmeta>
<indexterm><primary>gst-inspect</primary></indexterm><indexterm><primary>
print information about a GStreamer element or plugin</primary></indexterm>
<refnamediv id="gst-inspect-1-name"><refname>gst-inspect</refname>
<refpurpose>print information about a GStreamer
element or plugin</refpurpose></refnamediv>
<refsynopsisdiv id="gst-inspect-1-synp"><title>&synp-tt;</title>
<cmdsynopsis><command>&cmd;</command>
<arg choice="opt"><option>-plugin</option></arg>
<arg choice="opt"><option>-print-all</option></arg>
<arg choice="opt"><option>-print-plugin-auto-install-info</option></arg>
<arg choice="opt"><option>-uri-handlers</option></arg>
<arg choice="opt"><option>-version</option></arg>
<arg choice="opt"><option role="nodash"><replaceable>gst-std-options</replaceable></option></arg>
<arg choice="opt"><option role="nodash"><replaceable>element</replaceable> | <replaceable>plugin</replaceable></option></arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1 id="gst-inspect-1-desc"><title>&desc-tt;</title>
<para><command>&cmd;</command> prints information about available GStreamer
plugins, information about a particular plugin, or information about a particular
element.</para>
<para>If no <replaceable>element</replaceable> or <replaceable>plugin</replaceable>
argument is specified, <command>&cmd;</command> prints a list of all plugins
and elements. If an <replaceable>element</replaceable> or <replaceable>plugin
</replaceable> argument is specified, <command>&cmd;</command> prints information
about that element or plug-in. If a given argument is valid as either an element
or a plugin, <command>&cmd;</command> treats the argument as an element, by
default.</para>
</refsect1>
<refsect1 id="gst-inspect-1-opts"><title>&opts-tt;</title>
<para>The following options are supported by <command>&cmd;</command>:</para>
<variablelist termlength="wholeline">
<varlistentry>
<term><option>-plugin</option></term>
<listitem><para>
List the plugin contents.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>a</option>, <option>-print-all</option></term>
<listitem><para>
Print all elements.</para>
</listitem></varlistentry>
<varlistentry>
<term><option>-print-plugin-auto-install-info</option></term>
<listitem><para>
Prints a machine-parsable list of features the specified plugin provides.</para>
</listitem></varlistentry>
<varlistentry>
<term><option>u</option>, <option>-uri-handlers</option></term>
<listitem><para>
Print supported URI schemes, with the elements that implement them.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>-version</option></term>
<listitem><para>
Print GStreamer version number.</para>
</listitem></varlistentry>
<varlistentry>
<term><option role="nodash"><replaceable>gst-std-options</replaceable></option></term>
<listitem><para>
Standard options available for use with most GStreamer applications.  See
<citerefentry><refentrytitle>gst-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for more information.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="gst-inspect-1-oper"><title>&oper-tt;</title>
<para>The following operands are supported:</para>
<variablelist termlength="narrow">
<varlistentry><term><option role="nodash"><replaceable>element</replaceable></option></term>
<listitem><para>Name of an element.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash"><replaceable>plugin</replaceable></option></term>
<listitem><para>Name of a plugin.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="gst-inspect-1-exam"><title>&exam-tt;</title>
<example role="example">
<title>Displaying Information About a Plugin:</title>
<para><screen>example% <userinput>&cmd; alaw</userinput>
<computeroutput>Plugin Details:
 Name:                 alaw
 Description:          ALaw audio conversion routines
 Filename:             /usr/lib/gstreamer-0.10/libgstalaw.so
 Version:              0.10.3
 License:              LGPL
 Source module:        gst-plugins-good
 Binary package:       GStreamer Good Plug-ins source release
 Origin URL:           Unknown package origin

 alawdec: A Law audio decoder
 alawenc: A Law audio encoder

 2 features:
 +-- 2 elements

</computeroutput></screen></para>
</example>
</refsect1>
<refsect1 id="gst-inspect-1-file"><title>&file-tt;</title>
<para>The following files are used by this application:</para>
<variablelist termlength="wholeline">
<varlistentry>
<term><filename>/usr/bin/&cmd;</filename></term>
<listitem><para>
Print information about a GStreamer element or plugin
</para> </listitem></varlistentry>

<varlistentry>
<term><filename>/usr/lib/gstreamer-0.10/</filename></term>
<listitem><para>
GStreamer system plugin directory.
</para></listitem></varlistentry>

<varlistentry>
<term><filename>~/gstreamer-0.10/plugins</filename></term>
<listitem><para>
GStreamer user-specific plugin directory.
</para></listitem></varlistentry>

<varlistentry>
<term><filename>~/gstreamer-0.10/registry-*.xml</filename></term>
<listitem><para>
GStreamer plugin registry for user.
</para></listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="gst-inspect-1-attr"><title>&attr-tt;</title>
<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
for descriptions of the following attributes:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
<colspec colname="COLSPEC1" colwidth="1*">
<thead>
<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
valign="middle">ATTRIBUTE VALUE</entry></row>
</thead>
<tbody>
<row><entry><para>Availability</para></entry><entry><para>library/audio/gstreamer
</para></entry></row>
<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
colname="COLSPEC1"><para>Volatile</para></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="gst-inspect-1-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
<citerefentry><refentrytitle>gst-feedback</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gst-launch</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gst-typefind</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gst-xmlinspect</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gst-xmllaunch</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gstreamer-properties</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libgstreamer-0.10</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gst-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
<refsect1 id="gst-inspect-1-note"><title>&note-tt;</title>
<para>Original man page written by the GStreamer team at <literal>http://www.gstreamer.net/</literal>.
</para>
<para>Updated by Brian Cameron, Sun Microsystems Inc., 2004, 2006.</para>
</refsect1>
</refentry>
