summaryrefslogtreecommitdiff
path: root/xdbedizzy.xml
blob: 6b95ace54ff4d2df68d107ded186353316ec32fb (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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 'http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd'>

<!-- Process this file with DocBook tools to generate the output format
(such as manual pages or HTML documents).

Note that strings like __appmansuffix__, __filemansuffix__, __libmansuffix__,
__miscmansuffix__ etc. have to be replaced first (in theory that's the
job of ENTITIES but some XML tools are highly allergic to such stuff... ;-().
A quick way to do that is to filter this document via
/usr/bin/sed "s/__appmansuffix__/${MANSUFFIX}/g;s/__filemansuffix__/${FILEMANSUFFIX}/g;s/__libmansuffix__/${LIBMANSUFFIX}/g;s/__miscmansuffix__/${MISCMANSUFFIX}/g"
assuming that env vars like MANSUFFIX etc. have been set to the matching
manual volume numbers.
  -->

<refentry>
  <refmeta>
    <refentrytitle>xdbedizzy</refentrytitle>
    <manvolnum>__appmansuffix__</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>xdbedizzy</refname>
    <refpurpose>demo of DBE creating a double buffered spinning scene</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <!-- video mode -->
    <cmdsynopsis>
      <command>xdbedizzy</command>

      <arg><option>-display <replaceable>host:dpy</replaceable></option></arg>

      <arg><option>-delta <replaceable>dlt</replaceable></option></arg>

      <arg><option>-class <replaceable>visclass</replaceable></option></arg>

      <arg><option>-depth <replaceable>visdepth</replaceable></option></arg>

      <arg><option>-visid <replaceable>visualid</replaceable></option></arg>

      <arg><option>-list</option></arg>

      <arg><option>-nodb</option></arg>

      <arg><option>-help</option></arg>

      <arg><option>-speed <replaceable>number</replaceable></option></arg>

      <arg><option>-sync</option></arg>

      <arg><option>-spokes <replaceable>n</replaceable></option></arg>

      <arg><option>-verbose</option></arg>

    </cmdsynopsis>

  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>

    <para>
      <command>xdbedizzy</command> is a demo of DBE creating a double
      buffered spinning scene.
    </para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>-display <replaceable>host:dpy</replaceable></option>
        </term>
        <listitem>
          <para>
            This option specifies the X server to contact.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-class <replaceable>visclass</replaceable></option>
        </term>
        <listitem>
          <para>
            Name of visual to choose. Valid values are
            <simplelist type="inline">
              <member>TrueColor</member>
              <member>DirectColor</member>
              <member>PseudoColor</member>
              <member>StaticColor</member>
              <member>Grayscale</member>
              <member>StaticGray</member>
            </simplelist>
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-depth <replaceable>depth</replaceable></option>
        </term>
        <listitem>
          <para>
            Depth of visual to use.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-visid <replaceable>visualid</replaceable></option>
        </term>
        <listitem>
          <para>
            Visual ID to use (ignore <option>-class</option>,
            <option>-depth</option>).
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-list</option>
        </term>
        <listitem>
          <para>
            List double buffer capable visuals.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-nodb</option>
        </term>
        <listitem>
          <para>
            Single buffer (ignore <option>-class</option>,
            <option>-depth</option>, <option>-visid</option>).
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-help</option>
        </term>
        <listitem>
          <para>
            Prints usage and exists.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-speed <replaceable>value</replaceable></option>
        </term>
        <listitem>
          <para>
            Defines the time to delay between frames as delay=2sec/speed.
            Default value is 20.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-sync</option>
        </term>
        <listitem>
          <para>
            Use synchronous X connection.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-spokes <replaceable>value</replaceable></option>
        </term>
        <listitem>
          <para>
            Specify number of spokes to draw. The default value is 12.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-verbose</option>
        </term>
        <listitem>
          <para>
            Print verbose output.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <simplelist type="inline">
        <member><citerefentry><refentrytitle>DBE</refentrytitle><manvolnum>__libmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>XdbeSwapBuffers</refentrytitle><manvolnum>__libmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>XdbeGetVisualInfo</refentrytitle><manvolnum>__libmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>XdbeAllocateBackBufferName</refentrytitle><manvolnum>__libmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>X</refentrytitle><manvolnum>__miscmansuffix__</manvolnum></citerefentry></member>
        <member><citerefentry><refentrytitle>Xserver</refentrytitle><manvolnum>__appmansuffix__</manvolnum></citerefentry></member>
      </simplelist>
    </para>
  </refsect1>

  <refsect1>
    <title>ENVIRONMENT</title>

    <variablelist>
      <varlistentry>
        <term><envar>DISPLAY</envar>
        </term>
        <listitem>
	    <para><envar>DISPLAY</envar> must be set to get the default host and display to use.
	  </para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

<!--
  <refsect1>
    <title>BUGS</title>

    <para>

    </para>
  </refsect1>
-->
  <refsect1>
    <title>AUTHOR</title>

    <para>
      <simplelist>
        <member><othercredit><firstname>Mark</firstname> <surname>Kilgard</surname></othercredit></member>
        <member><othercredit><firstname>Allen</firstname> <surname>Leinwand</surname></othercredit></member>
        <member><othercredit><firstname>Roland</firstname> <surname>Mainz</surname> <affiliation><orgname>University Giessen</orgname></affiliation></othercredit></member>
      </simplelist>
    </para>
  </refsect1>

</refentry>