<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY cmd "gobject-query">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY suncopy "Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="gobject-query-1">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>gobject-query</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">8 Apr 2003</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&release;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
</refmeta>
<indexterm><primary>gobject-query</primary></indexterm>
<indexterm><primary>displays information about gobject types</primary></indexterm>
<refnamediv id="gobject-query-1-name">
<refname>gobject-query</refname>
<refpurpose>displays information about <literal>gobject</literal> types</refpurpose>
</refnamediv>
<refsynopsisdiv id="gobject-query-1-synp"><title>&synp-tt;</title>
<cmdsynopsis><command>&cmd;</command>
<arg choice="opt"><option>r <replaceable>type</replaceable></option></arg>
<arg choice="opt">
<group choice="plain">
<arg choice="plain"><option>i <replaceable>string<replaceable></option></arg>
<arg choice="plain"><option>b <replaceable>string</replaceable></option></arg></group></arg>
<arg choice="opt"><option>s <replaceable>int</replaceable></option></arg><arg choice="opt"><option>n</option></arg>
<arg choice="opt"><option>h</option></arg>
<arg choice="plain"><replaceable>qualifier</replaceable></arg>
</cmdsynopsis></refsynopsisdiv>

<refsect1 id="gobject-query-1-desc"><title>&desc-tt;</title>
<para>
<command>&cmd;</command> can be used to display the different types of 
<literal>gobjects</literal> provided by the <filename>glib</filename> library
</para>
</refsect1>

<refsect1 id="gobject-query-1-opts"><title>&opts-tt;</title>
<para>
The following options are supported:
</para>

<variablelist termlength="narrow">
<varlistentry>
<term><option>b <replaceable>string</replaceable></option></term>
<listitem><para>
Specifies the indent <replaceable>string</replaceable>. This option only
applies to the output layout.
</para></listitem></varlistentry>
<varlistentry>
<term><option>h</option></term>
<listitem><para>
Displays a help message about the <command>&cmd;</command> command, and the
options that you can use with the <command>&cmd;</command> command.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>i <replaceable>string</replaceable></option></term>
<listitem><para>
Specifies an incremental indent <replaceable>string</replaceable>. This option
only applies to the output layout.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>n</option></term>
<listitem><para>
Specifies that <command>&cmd;</command> should not descend the type tree. This
means that derived types are not displayed.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>r <replaceable>type</replaceable></option></term>
<listitem><para>
Specifies the root <replaceable>type</replaceable>, for example,
<literal>GObject</literal>, <literal>GParam</literal>.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>s <replaceable>int</replaceable></option></term>
<listitem><para>
Specifies the line spacing. This option only applies to the output layout.
</para>
</listitem></varlistentry>
</variablelist>
</refsect1>

<refsect1 id="gobject-query-1-oper"><title>&oper-tt;</title>
<para>
The following operands are supported:
</para>

<variablelist termlength="narrow"><varlistentry>
<term><option role="nodash"><replaceable>qualifier</replaceable></option></term>
<listitem><para>
The following qualifiers are supported:
</para>

<variablelist termlength="xtranarrow"><varlistentry>
<term>froots</term>
<listitem><para>
Iterates over the fundamental root
</para>
</listitem></varlistentry>
<varlistentry>
<term>tree</term>
<listitem><para>
Prints the type tree
</para>
</listitem></varlistentry>
</variablelist>

</listitem></varlistentry>
</variablelist>
</refsect1>

<refsect1 id="gobject-query-1-exam"><title>&exam-tt;</title>
<example role="example">
<title>Displaying All Types Provided by glib and Derived from GParam</title>
<para><screen>
example% <userinput>&cmd; tree GParam</userinput>
</screen></para>
</example>
<example role="example"><title>Changing the Output Layout</title>
<para><screen>
example% <userinput>&cmd; froots</userinput>
<computeroutput>
|
`void
|
`GInterface
  |
  `GTypePlugin
&hellip;
</computeroutput></screen>
<screen>
example% <userinput>&cmd; froots -b foo
</userinput>
<computeroutput>
foo|
foo`void
foo|
foo`GInterface
foo  |
foo  `GTypePlugin
&hellip;
</computeroutput>
</screen><screen>example% <userinput>&cmd; froots -s 5
</userinput>
<computeroutput>
|
|
|
|
|
`void
|
|
|
|
|
`GInterface
&hellip;

</computeroutput></screen></para></example>
</refsect1>

<refsect1 id="gobject-query-1-envr"><title>&envr-tt;</title>
<para>
See
<citerefentry><refentrytitle>environ</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>
for descriptions of the following environment variables that affect the
execution of <command>&cmd;</command>: NLSPATH.
</para>
</refsect1>

<refsect1 id="gobject-query-1-exit"><title>&exit-tt;</title>
<para>
The following exit values are returned:
</para>

<variablelist termlength="xtranarrow"><varlistentry>
<term><returnvalue>0</returnvalue></term>
<listitem><para>
Application exited successfully
</para>
</listitem></varlistentry>
<varlistentry>
<term><returnvalue>>0</returnvalue></term>
<listitem><para>
Application exited with failure
</para>
</listitem></varlistentry>
</variablelist>
</refsect1>

<refsect1 id="gobject-query-1-file"><title>&file-tt;</title>
<para>
The following files are used by this application:
</para>

<variablelist termlength="wide"><varlistentry>
<term><filename>/usr/bin/&cmd;</filename></term>
<listitem><para>
The command-line executable for the application.
</para>
</listitem></varlistentry>
<varlistentry>
<term><filename>/usr/share/gtk-doc/html/gobject</filename></term>
<listitem><para>
Location of developer documentation
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 id="gobject-query-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>SUNWglib2-devel</para></entry>
</row>
<row>
<entry colname="COLSPEC0"><para>Interface stability</para></entry>
<entry colname="COLSPEC1"><para>Committed</para></entry>
</row>
</tbody></tgroup></informaltable>
</refsect1>

<refsect1 id="gobject-query-1-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
<citerefentry><refentrytitle>gdk-pixbuf-csource</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gdk-pixbuf-query-loaders</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gdk-pixbuf-query-loaders</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>glib-genmarshal</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>glib-gettextize</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>glib-mkenums</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gtk-query-immodules-2.0</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gtk-update-icon-cache</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libgdk_pixbuf-2.0</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>environ</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para></refsect1>
<refsect1 id="gobject-query-1-note"><title>&note-tt;</title>
<para>
Written by Erwann Chenede, Sun Microsystems Inc., 2003.
</para>
</refsect1>
</refentry>
