docs/reference/gobject/gobject-query.xml

   1 <refentry id="gobject-query" lang="en">
   2
   3 <refentryinfo>
   4   <title>gobject-query</title>
   5   <productname>GObject</productname>
   6   <authorgroup>
   7     <author>
   8       <contrib>Developer</contrib>
   9       <firstname>Tim</firstname>
  10       <surname>Janik</surname>
  11     </author>
  12   </authorgroup>
  13 </refentryinfo>
  14
  15 <refmeta>
  16 <refentrytitle>gobject-query</refentrytitle>
  17 <manvolnum>1</manvolnum>
  18 <refmiscinfo class="manual">User Commands</refmiscinfo>
  19 </refmeta>
  20
  21 <refnamediv>
  22 <refname>gobject-query</refname>
  23 <refpurpose>display a tree of types</refpurpose>
  24 </refnamediv>
  25
  26 <refsynopsisdiv>
  27 <cmdsynopsis>
  28 <command>gobject-query</command>
  29 <arg choice="plain">froots</arg>
  30 <arg choice="opt" rep="repeat">OPTION</arg>
  31 </cmdsynopsis>
  32 <cmdsynopsis>
  33 <command>gobject-query</command>
  34 <arg choice="plain">tree</arg>
  35 <arg choice="opt" rep="repeat">OPTION</arg>
  36 </cmdsynopsis>
  37 </refsynopsisdiv>
  38
  39 <refsect1><title>Description</title>
  40 <para>
  41 <command>gobject-query</command> is a small utility that draws a tree of
  42 types.
  43 </para>
  44
  45 <para>
  46 <command>gobject-query</command> takes a mandatory argument that specifies
  47 whether it should iterate over the fundamental types or print a type tree.
  48 </para>
  49 </refsect1>
  50
  51 <refsect1><title>Commands</title>
  52 <variablelist>
  53 <varlistentry>
  54 <term><option>froots</option></term>
  55 <listitem><para>
  56 iterate over fundamental roots
  57 </para></listitem>
  58 </varlistentry>
  59 <varlistentry>
  60 <term><option>tree</option></term>
  61 <listitem><para>
  62 print type tree
  63 </para></listitem>
  64 </varlistentry>
  65 </variablelist>
  66 </refsect1>
  67
  68 <refsect1><title>Options</title>
  69 <variablelist>
  70
  71 <varlistentry>
  72 <term><option>-r</option> <replaceable>TYPE</replaceable></term>
  73 <listitem><para>
  74 specify the root type
  75 </para></listitem>
  76 </varlistentry>
  77
  78 <varlistentry>
  79 <term><option>-n</option></term>
  80 <listitem><para>
  81 don't descend type tree
  82 </para></listitem>
  83 </varlistentry>
  84
  85 <varlistentry>
  86 <term><option>-b</option> <replaceable>STRING</replaceable></term>
  87 <listitem><para>
  88 specify indent string
  89 </para></listitem>
  90 </varlistentry>
  91
  92 <varlistentry>
  93 <term><option>-i</option> <replaceable>STRING</replaceable></term>
  94 <listitem><para>
  95 specify incremental indent string
  96 </para></listitem>
  97 </varlistentry>
  98
  99
 100 <varlistentry>
 101 <term><option>-s</option> <replaceable>NUMBER</replaceable></term>
 102 <listitem><para>
 103 specify line spacing
 104 </para></listitem>
 105 </varlistentry>
 106
 107 <varlistentry>
 108 <term><option>-h</option>, <option>--help</option></term>
 109 <listitem><para>
 110 Print brief help and exit.
 111 </para></listitem>
 112 </varlistentry>
 113
 114 <varlistentry>
 115 <term><option>-v</option>, <option>--version</option></term>
 116 <listitem><para>
 117 Print version and exit.
 118 </para></listitem>
 119 </varlistentry>
 120
 121 </variablelist>
 122 </refsect1>
 123 </refentry>