Blame docs/reference/gobject/gobject-query.xml

Packit ae235b
<refentry id="gobject-query" lang="en">
Packit ae235b
Packit ae235b
<refentryinfo>
Packit ae235b
  <title>gobject-query</title>
Packit ae235b
  <productname>GObject</productname>
Packit ae235b
  <authorgroup>
Packit ae235b
    <author>
Packit ae235b
      <contrib>Developer</contrib>
Packit ae235b
      <firstname>Tim</firstname>
Packit ae235b
      <surname>Janik</surname>
Packit ae235b
    </author>
Packit ae235b
  </authorgroup>
Packit ae235b
</refentryinfo>
Packit ae235b
Packit ae235b
<refmeta>
Packit ae235b
<refentrytitle>gobject-query</refentrytitle>
Packit ae235b
<manvolnum>1</manvolnum>
Packit ae235b
<refmiscinfo class="manual">User Commands</refmiscinfo>
Packit ae235b
</refmeta>
Packit ae235b
Packit ae235b
<refnamediv>
Packit ae235b
<refname>gobject-query</refname>
Packit ae235b
<refpurpose>display a tree of types</refpurpose>
Packit ae235b
</refnamediv>
Packit ae235b
Packit ae235b
<refsynopsisdiv>
Packit ae235b
<cmdsynopsis>
Packit ae235b
<command>gobject-query</command>
Packit ae235b
<arg choice="plain">froots</arg>
Packit ae235b
<arg choice="opt" rep="repeat">OPTION</arg>
Packit ae235b
</cmdsynopsis>
Packit ae235b
<cmdsynopsis>
Packit ae235b
<command>gobject-query</command>
Packit ae235b
<arg choice="plain">tree</arg>
Packit ae235b
<arg choice="opt" rep="repeat">OPTION</arg>
Packit ae235b
</cmdsynopsis>
Packit ae235b
</refsynopsisdiv>
Packit ae235b
Packit ae235b
<refsect1><title>Description</title>
Packit ae235b
<para>
Packit ae235b
<command>gobject-query</command> is a small utility that draws a tree of
Packit ae235b
types.
Packit ae235b
</para>
Packit ae235b
Packit ae235b
<para>
Packit ae235b
<command>gobject-query</command> takes a mandatory argument that specifies
Packit ae235b
whether it should iterate over the fundamental types or print a type tree.
Packit ae235b
</para>
Packit ae235b
</refsect1>
Packit ae235b
Packit ae235b
<refsect1><title>Commands</title>
Packit ae235b
<variablelist>
Packit ae235b
<varlistentry>
Packit ae235b
<term><option>froots</option></term>
Packit ae235b
<listitem><para>
Packit ae235b
iterate over fundamental roots
Packit ae235b
</para></listitem>
Packit ae235b
</varlistentry>
Packit ae235b
<varlistentry>
Packit ae235b
<term><option>tree</option></term>
Packit ae235b
<listitem><para>
Packit ae235b
print type tree
Packit ae235b
</para></listitem>
Packit ae235b
</varlistentry>
Packit ae235b
</variablelist>
Packit ae235b
</refsect1>
Packit ae235b
Packit ae235b
<refsect1><title>Options</title>
Packit ae235b
<variablelist>
Packit ae235b
Packit ae235b
<varlistentry>
Packit ae235b
<term><option>-r</option> <replaceable>TYPE</replaceable></term>
Packit ae235b
<listitem><para>
Packit ae235b
specify the root type
Packit ae235b
</para></listitem>
Packit ae235b
</varlistentry>
Packit ae235b
Packit ae235b
<varlistentry>
Packit ae235b
<term><option>-n</option></term>
Packit ae235b
<listitem><para>
Packit ae235b
don't descend type tree
Packit ae235b
</para></listitem>
Packit ae235b
</varlistentry>
Packit ae235b
Packit ae235b
<varlistentry>
Packit ae235b
<term><option>-b</option> <replaceable>STRING</replaceable></term>
Packit ae235b
<listitem><para>
Packit ae235b
specify indent string
Packit ae235b
</para></listitem>
Packit ae235b
</varlistentry>
Packit ae235b
Packit ae235b
<varlistentry>
Packit ae235b
<term><option>-i</option> <replaceable>STRING</replaceable></term>
Packit ae235b
<listitem><para>
Packit ae235b
specify incremental indent string
Packit ae235b
</para></listitem>
Packit ae235b
</varlistentry>
Packit ae235b
Packit ae235b
Packit ae235b
<varlistentry>
Packit ae235b
<term><option>-s</option> <replaceable>NUMBER</replaceable></term>
Packit ae235b
<listitem><para>
Packit ae235b
specify line spacing
Packit ae235b
</para></listitem>
Packit ae235b
</varlistentry>
Packit ae235b
Packit ae235b
<varlistentry>
Packit ae235b
<term><option>-h</option>, <option>--help</option></term>
Packit ae235b
<listitem><para>
Packit ae235b
Print brief help and exit.
Packit ae235b
</para></listitem>
Packit ae235b
</varlistentry>
Packit ae235b
Packit ae235b
<varlistentry>
Packit ae235b
<term><option>-v</option>, <option>--version</option></term>
Packit ae235b
<listitem><para>
Packit ae235b
Print version and exit.
Packit ae235b
</para></listitem>
Packit ae235b
</varlistentry>
Packit ae235b
Packit ae235b
</variablelist>
Packit ae235b
</refsect1>
Packit ae235b
</refentry>