docs/reference/gobject/gobject-query.xml

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