summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/gtk3-demo.xml
blob: d2eacb69b5e0d4521b67d495a6a222a3275184d2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
]>
<refentry id="gtk3-demo">

<refentryinfo>
  <title>gtk3-demo</title>
  <productname>GTK+</productname>
  <authorgroup>
    <author>
      <contrib>Developer</contrib>
      <firstname>Matthias</firstname>
      <surname>Clasen</surname>
    </author>
  </authorgroup>
</refentryinfo>

<refmeta>
  <refentrytitle>gtk3-demo</refentrytitle>
  <manvolnum>1</manvolnum>
  <refmiscinfo class="manual">User Commands</refmiscinfo>
</refmeta>

<refnamediv>
  <refname>gtk3-demo</refname>
  <refpurpose>Demonstrate GTK+ widgets</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
<command>gtk3-demo</command>
<arg choice="opt">--help</arg>
<arg choice="opt">--list</arg>
<arg choice="opt">--run <replaceable>EXAMPLE</replaceable></arg>
<arg choice="opt">--autoquit</arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1><title>Description</title>
<para>
<command>gtk3-demo</command> is a collection of examples.
Its purpose is to demonstrate many GTK+ widgets in a form
that is useful to application developers.
</para>
<para>
The application shows the source code for each example, as well as
other used resources, such as ui files and icons.
</para>
</refsect1>

<refsect1><title>Options</title>
  <para>The following options are understood:</para>
  <variablelist>
    <varlistentry>
    <term><option>-h</option>, <option>--help</option></term>
      <listitem><para>Show help options</para></listitem>
    </varlistentry>
    <varlistentry>
    <term><option>--list</option></term>
      <listitem><para>List available examples.</para></listitem>
    </varlistentry>
    <varlistentry>
    <term><option>-run <replaceable>EXAMPLE</replaceable></option></term>
      <listitem><para>Run the named example. Use <option>--list</option> to
        see the available examples.</para></listitem>
    </varlistentry>
    <varlistentry>
    <term><option>--autoquit</option></term>
      <listitem><para>Quit after a short timeout. This is intended for use
        with <option>--run</option>, e.g. when profiling.</para></listitem>
    </varlistentry>
  </variablelist>
</refsect1>

</refentry>