gobject-query.1 revision 12050
10139N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
10139N/A<!--ArborText, Inc., 1988-1999, v.4002-->
10139N/A<!ENTITY cmd "gobject-query">
10139N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
10139N/A%commonents;
10139N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
10139N/A%booktitles;
10139N/A<!ENTITY suncopy "Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.">
10139N/A]>
10139N/A<?Pub UDT _bookmark _target>
10139N/A<?Pub Inc>
10139N/A<refentry id="gobject-query-1">
10139N/A<!-- %Z%%M% %I% %E% SMI; -->
10139N/A<refmeta><refentrytitle>gobject-query</refentrytitle><manvolnum>1</manvolnum>
10139N/A<refmiscinfo class="date">8 Apr 2003</refmiscinfo>
10139N/A<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
10139N/A<refmiscinfo class="software">&release;</refmiscinfo>
10139N/A<refmiscinfo class="arch">generic</refmiscinfo>
10139N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
10139N/A</refmeta>
10139N/A<indexterm><primary>gobject-query</primary></indexterm><indexterm><primary>
10139N/Adisplays information about gobject types</primary></indexterm><refnamediv
10139N/Aid="gobject-query-1-name"><refname>gobject-query</refname><refpurpose>displays information
10139N/Aabout <literal>gobject</literal> types</refpurpose></refnamediv>
10139N/A<refsynopsisdiv id="gobject-query-1-synp"><title>&synp-tt;</title>
10139N/A<cmdsynopsis><command>&cmd;</command>
10139N/A<arg choice="opt"><option>r <replaceable>type</replaceable></option></arg>
10139N/A<arg choice="opt">
10139N/A<group choice="plain">
10139N/A<arg choice="plain"><option>i <replaceable>string<replaceable></option></arg>
10139N/A<arg choice="plain"><option>b <replaceable>string</replaceable></option></arg></group></arg>
10139N/A<arg choice="opt"><option>s <replaceable>int</replaceable></option></arg><arg choice="opt"><option>n</option></arg>
10139N/A<arg choice="opt"><option>h</option></arg>
10139N/A<arg choice="plain"><replaceable>qualifier</replaceable></arg>
10139N/A</cmdsynopsis></refsynopsisdiv>
10139N/A<refsect1 id="gobject-query-1-desc"><title>&desc-tt;</title>
10139N/A<para><command>&cmd;</command> can be used to display the different types
10139N/Aof <literal>gobjects</literal> provided by the <filename>glib</filename> library
10139N/A</para>
10139N/A</refsect1>
10139N/A<refsect1 id="gobject-query-1-opts"><title>&opts-tt;</title>
10139N/A<para>The following options are supported:</para>
10139N/A<variablelist termlength="narrow">
10139N/A<varlistentry><term><option>b <replaceable>string</replaceable></option></term>
10139N/A<listitem><para>Specifies the indent <replaceable>string</replaceable>. This option only applies to the
10139N/Aoutput layout.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>h</option></term><listitem><para>Displays a help
10139N/Amessage about the <command>&cmd;</command> command, and the options that you
10139N/Acan use with the <command>&cmd;</command> command. </para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>i <replaceable>string</replaceable></option></term><listitem><para>Specifies an
10139N/Aincremental indent <replaceable>string</replaceable>. This option only applies to the output layout.
10139N/A</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>n</option></term><listitem><para>Specifies that <command>&cmd;</command>
10139N/Ashould not descend the type tree. This means that derived types are not displayed.
10139N/A</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>r <replaceable>type</replaceable></option></term><listitem><para>Specifies the
10139N/Aroot <replaceable>type</replaceable>, for example, <literal>GObject</literal>, <literal>GParam</literal>.
10139N/A</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>s <replaceable>int</replaceable></option></term><listitem><para>Specifies the
10139N/Aline spacing. This option only applies to the output layout.</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="gobject-query-1-oper"><title>&oper-tt;</title>
10139N/A<para>The following operands are supported:</para>
10139N/A<variablelist termlength="narrow"><varlistentry><term><option role="nodash"><replaceable>
10139N/Aqualifier</replaceable></option></term><listitem><para>The following qualifiers
11904N/Aare supported:<variablelist termlength="xtranarrow"><varlistentry>
10139N/A<term>froots</term><listitem><para>Iterates over the fundamental root</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term>tree</term><listitem><para>Prints the type tree</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="gobject-query-1-exam"><title>&exam-tt;</title>
10139N/A<example role="example"><title>Displaying All Types Provided by glib and Derived
10139N/Afrom GParam</title>
10139N/A<para><screen>example% <userinput>&cmd; tree GParam</userinput></screen></para>
10139N/A</example>
10139N/A<example role="example"><title>Changing the Output Layout</title>
12050N/A<para>
12050N/A<screen>example% <userinput>&cmd; froots</userinput>
12050N/A<computeroutput>
10139N/A|
10139N/A`void
10139N/A|
10139N/A`GInterface
10139N/A |
12050N/A `GTypePlugin
12050N/A&hellip;
12050N/A</computeroutput></screen>
12050N/A<screen>example% <userinput>&cmd; froots -b foo
10139N/A</userinput>
12050N/A<computeroutput>
10139N/Afoo|
10139N/Afoo`void
10139N/Afoo|
12050N/Afoo`GInterface
12050N/Afoo |
12050N/Afoo `GTypePlugin
12050N/A&hellip;
12050N/A</computeroutput>
12050N/A</screen><screen>example% <userinput>&cmd; froots -s 5
10139N/A</userinput>
12050N/A<computeroutput>
10139N/A|
10139N/A|
10139N/A|
10139N/A|
10139N/A|
10139N/A`void
10139N/A|
10139N/A|
10139N/A|
10139N/A|
10139N/A|
12050N/A`GInterface
10139N/A&hellip;
10139N/A</computeroutput></screen></para>
10139N/A</example>
10139N/A</refsect1>
10139N/A<refsect1 id="gobject-query-1-envr"><title>&envr-tt;</title>
10139N/A<para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>
10139N/A5</manvolnum></citerefentry> for descriptions of the following environment
10139N/Avariables that affect the execution of <command>&cmd;</command>: NLSPATH.
10139N/A</para>
10139N/A</refsect1>
10139N/A<refsect1 id="gobject-query-1-exit"><title>&exit-tt;</title>
10139N/A<para>The following exit values are returned:</para>
10139N/A<variablelist termlength="xtranarrow"><varlistentry><term><returnvalue>0</returnvalue></term>
10139N/A<listitem><para>Application exited successfully</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application
10139N/Aexited with failure</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="gobject-query-1-file"><title>&file-tt;</title>
10139N/A<para>The following files are used by this application:</para>
10139N/A<variablelist termlength="wide"><varlistentry><term><filename>/usr/bin/&cmd;</filename>
10139N/A</term><listitem><para>The command-line executable for the application.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><filename>/usr/share/gtk-doc/html/gobject</filename></term><listitem>
10139N/A<para>Location of developer documentation</para></listitem>
10139N/A</varlistentry>
10139N/A</variablelist></refsect1>
10139N/A<refsect1 id="gobject-query-1-attr"><title>&attr-tt;</title>
10139N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
10139N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
10139N/Afor descriptions of the following attributes:</para>
10139N/A<informaltable frame="all">
10139N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
10139N/A<colspec colname="COLSPEC1" colwidth="1*">
10139N/A<thead>
10139N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
10139N/Avalign="middle">ATTRIBUTE VALUE</entry></row>
10139N/A</thead>
10139N/A<tbody>
10139N/A<row><entry><para>Availability</para></entry><entry><para>SUNWgnome-base-libs-devel
10139N/A</para></entry></row>
10139N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
10139N/Acolname="COLSPEC1"><para>Committed</para></entry></row>
10139N/A</tbody>
10139N/A</tgroup>
10139N/A</informaltable>
10139N/A</refsect1>
10139N/A<refsect1 id="gobject-query-1-also"><title>&also-tt;</title>
10139N/A<!--Reference to another man page-->
10139N/A<!--Reference to a Help manual-->
10139N/A<!--Reference to a book.-->
10139N/A<para>
10139N/A<citerefentry><refentrytitle>gdk-pixbuf-csource</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
10139N/A<citerefentry><refentrytitle>gdk-pixbuf-query-loaders</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
10139N/A<citerefentry><refentrytitle>gdk-pixbuf-query-loaders</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
10139N/A<citerefentry><refentrytitle>glib-genmarshal</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
10139N/A<citerefentry><refentrytitle>glib-gettextize</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
10139N/A<citerefentry><refentrytitle>glib-mkenums</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
10139N/A<citerefentry><refentrytitle>gtk-query-immodules-2.0</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
10139N/A<citerefentry><refentrytitle>gtk-update-icon-cache</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
11904N/A<citerefentry><refentrytitle>libgdk_pixbuf-2.0</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
11904N/A<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
11904N/A<citerefentry><refentrytitle>environ</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
11904N/A<citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>
10139N/A</para></refsect1>
10139N/A<refsect1 id="gobject-query-1-note"><title>&note-tt;</title>
11933N/A<para>Written by Erwann Chenede, Sun Microsystems Inc., 2003.</para>
10139N/A</refsect1>
10139N/A</refentry>