gobject-query.1 revision 10139
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<!--ArborText, Inc., 1988-1999, v.4002-->
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<!ENTITY suncopy "Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.">
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<!-- %Z%%M% %I% %E% SMI; -->
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<refmeta><refentrytitle>gobject-query</refentrytitle><manvolnum>1</manvolnum>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<refmiscinfo class="date">8 Apr 2003</refmiscinfo>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<refmiscinfo class="software">&release;</refmiscinfo>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<indexterm><primary>gobject-query</primary></indexterm><indexterm><primary>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowedisplays information about gobject types</primary></indexterm><refnamediv
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Loweid="gobject-query-1-name"><refname>gobject-query</refname><refpurpose>displays information
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Loweabout <literal>gobject</literal> types</refpurpose></refnamediv>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<refsynopsisdiv id="gobject-query-1-synp"><title>&synp-tt;</title>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<arg choice="opt"><option>r <replaceable>type</replaceable></option></arg>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<arg choice="plain"><option>i <replaceable>string<replaceable></option></arg>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<arg choice="plain"><option>b <replaceable>string</replaceable></option></arg></group></arg>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<arg choice="opt"><option>s <replaceable>int</replaceable></option></arg><arg choice="opt"><option>n</option></arg>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<arg choice="plain"><replaceable>qualifier</replaceable></arg>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<refsect1 id="gobject-query-1-desc"><title>&desc-tt;</title>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<para><command>&cmd;</command> can be used to display the different types
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Loweof <literal>gobjects</literal> provided by the <filename>glib</filename> library
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<refsect1 id="gobject-query-1-opts"><title>&opts-tt;</title>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<para>The following options are supported:</para>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<varlistentry><term><option>b <replaceable>string</replaceable></option></term>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<listitem><para>Specifies the indent <replaceable>string</replaceable>. This option only applies to the
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Loweoutput layout.</para>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<varlistentry><term><option>h</option></term><listitem><para>Displays a help
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowemessage about the <command>&cmd;</command> command, and the options that you
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowecan use with the <command>&cmd;</command> command. </para>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<varlistentry><term><option>i <replaceable>string</replaceable></option></term><listitem><para>Specifies an
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Loweincremental indent <replaceable>string</replaceable>. This option only applies to the output layout.
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<varlistentry><term><option>n</option></term><listitem><para>Specifies that <command>&cmd;</command>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Loweshould not descend the type tree. This means that derived types are not displayed.
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<varlistentry><term><option>r <replaceable>type</replaceable></option></term><listitem><para>Specifies the
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Loweroot <replaceable>type</replaceable>, for example, <literal>GObject</literal>, <literal>GParam</literal>.
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<varlistentry><term><option>s <replaceable>int</replaceable></option></term><listitem><para>Specifies the
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Loweline spacing. This option only applies to the output layout.</para>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<refsect1 id="gobject-query-1-oper"><title>&oper-tt;</title>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<para>The following operands are supported:</para>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<variablelist termlength="narrow"><varlistentry><term><option role="nodash"><replaceable>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowequalifier</replaceable></option></term><listitem><para>The following qualifiers
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Loweare supported:<variablelist termlength="xtranarrow"><?Pub Caret><varlistentry>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<term>froots</term><listitem><para>Iterates over the fundamental root</para>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<varlistentry><term>tree</term><listitem><para>Prints the type tree</para>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<refsect1 id="gobject-query-1-exam"><title>&exam-tt;</title>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<example role="example"><title>Displaying All Types Provided by glib and Derived
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowefrom GParam</title>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<para><screen>example% <userinput>&cmd; tree GParam</userinput></screen></para>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<example role="example"><title>Changing the Output Layout</title>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<para><screen>example% <userinput>&cmd; froots</userinput>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<computeroutput>|
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe `GTypePlugin</computeroutput></screen><screen>example% <userinput>&cmd; froots -b foo
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<computeroutput>foo|
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowefoo`GInterface</computeroutput></screen><screen>example% <userinput>&cmd; froots -s 5
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<computeroutput>|
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<refsect1 id="gobject-query-1-envr"><title>&envr-tt;</title>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe5</manvolnum></citerefentry> for descriptions of the following environment
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowevariables that affect the execution of <command>&cmd;</command>: NLSPATH.
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<refsect1 id="gobject-query-1-exit"><title>&exit-tt;</title>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<para>The following exit values are returned:</para>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<variablelist termlength="xtranarrow"><varlistentry><term><returnvalue>0</returnvalue></term>
<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>gtk-query-immodules-2.0</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gtk-update-icon-cache</refentrytitle><manvolnum>1</manvolnum></citerefentry>,