summaryrefslogtreecommitdiffstats
path: root/ubuntu/maverick_automake/kdelibs/debian/man/artsmessage-kde3.sgml
blob: 2d5d6dba8da892d79607677ca36c2140b45df74e (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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Chris</firstname>">
  <!ENTITY dhsurname   "<surname>Cheney</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>November  6, 2002</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>ccheney@debian.org</email>">
  <!ENTITY dhusername  "Chris Cheney">
  <!ENTITY dhucpackage "<refentrytitle>ARTSMESSAGE</refentrytitle>">
  <!ENTITY dhpackage   "artsmessage">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2002</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>Utility to display aRts error messages</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option><replaceable>Qt-options</replaceable></option></arg>
      <arg><option><replaceable>KDE-options</replaceable></option></arg>
      <arg><option>-eiw</option></arg>
      <arg><option><replaceable>message</replaceable></option></arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>

    <para><command>&dhpackage;</command> is a utility to display aRts error messages.</para>

  </refsect1>
  <refsect1>
    <title>GENERIC OPTIONS</title>

    <para>This program follows the usual GNU command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.</para>

    <variablelist>
      <varlistentry>
        <term><option>--author</option>
        </term>
        <listitem>
          <para>Show author information.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help</option>
        </term>
        <listitem>
          <para>Show help about options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help-all</option>
        </term>
        <listitem>
          <para>Show all options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help-kde</option>
        </term>
        <listitem>
          <para>Show KDE specific options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help-qt</option>
        </term>
        <listitem>
          <para>Show Qt specific options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--license</option>
        </term>
        <listitem>
          <para>Show license information.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>, <option>--version</option>
        </term>
        <listitem>
          <para>Show version information.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>QT OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>--bg</option>, <option>--background <replaceable>color</replaceable></option>
        </term>
        <listitem>
          <para>Sets the default background color and an application palette (light and dark shades are calculated).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--btn</option>, <option>--button <replaceable>color</replaceable></option>
        </term>
        <listitem>
          <para>Sets the default button color.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--cmap</option>
        </term>
        <listitem>
          <para>Causes the application to install a private color map on an 8-bit display.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--display <replaceable>displayname</replaceable></option>
        </term>
        <listitem>
          <para>Use the X-server display 'displayname'.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--dograb</option>
        </term>
        <listitem>
          <para>Running under a debugger can cause an implicit --nograb, use --dograb to override.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--fg</option>, <option>--foreground <replaceable>color</replaceable></option>
        </term>
        <listitem>
          <para>Sets the default foreground color.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--fn</option>, <option>--font <replaceable>fontname</replaceable></option>
        </term>
        <listitem>
          <para>Defines the application font.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--im <replaceable>XIMserver</replaceable></option>
        </term>
        <listitem>
          <para>Set XIM server.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--inputstyle <replaceable>inputstyle</replaceable></option>
        </term>
        <listitem>
          <para>Sets XIM (X Input Method) input style. Possible values are onthespot, overthespot, offthespot and root.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--name <replaceable>name</replaceable></option>
        </term>
        <listitem>
          <para>Sets the application name.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--ncols <replaceable>count</replaceable></option>
        </term>
        <listitem>
          <para>Limits the number of colors allocated in the color cube on an 8-bit display, if the application is using the QApplication::ManyColor color specification.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--nograb</option>
        </term>
        <listitem>
          <para>Tells Qt to never grab the mouse or the keyboard.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--noxim</option>
        </term>
        <listitem>
          <para>Disable XIM.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--reverse</option>
        </term>
        <listitem>
          <para>Mirrors the whole layout of widgets.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--session <replaceable>sessionId</replaceable></option>
        </term>
        <listitem>
          <para>Restore the application for the given 'sessionId'.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--sync</option>
        </term>
        <listitem>
          <para>Switches to synchronous mode for debugging.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--title <replaceable>title</replaceable></option>
        </term>
        <listitem>
          <para>Sets the application title (caption).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--visual TrueColor</option>
        </term>
        <listitem>
          <para>Forces the application to use a TrueColor visual on an 8-bit display.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>KDE OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>--caption <replaceable>caption</replaceable></option>
        </term>
        <listitem>
          <para>Use 'caption' as name in the titlebar.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--config <replaceable>filename</replaceable></option>
        </term>
        <listitem>
          <para>Use alternative configuration file.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--dcopserver <replaceable>server</replaceable></option>
        </term>
        <listitem>
          <para>Use the DCOP Server specified by 'server'.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--geometry <replaceable>geometry</replaceable></option>
        </term>
        <listitem>
          <para>Sets the client geometry of the main widget.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--icon <replaceable>icon</replaceable></option>
        </term>
        <listitem>
          <para>Use 'icon' as the application icon.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--miniicon <replaceable>icon</replaceable></option>
        </term>
        <listitem>
          <para>Use 'icon' as the icon in the titlebar.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--nocrashhandler</option>
        </term>
        <listitem>
          <para>Disable crash handler, to get core dumps.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--style <replaceable>style</replaceable></option>
        </term>
        <listitem>
          <para>Sets the application GUI style.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--waitforwm</option>
        </term>
        <listitem>
          <para>Waits for a WM_NET compatible windowmanager.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>APP OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>-e</option>, <option>--error</option>
        </term>
        <listitem>
          <para>Display error message (default).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-i</option>, <option>--info</option>
        </term>
        <listitem>
          <para>Display informational message.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-w</option>, <option>--warning</option>
        </term>
        <listitem>
          <para>Display warning message.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername;
      &lt;&dhemail;&gt; for the &debian; system (but may be used by
      others).  Permission is granted to copy, distribute and/or
      modify this document under the terms of the &gnu; General Public
      License, Version 2 or any later version published by the Free
      Software Foundation.
    </para>

    <para>On Debian systems, the complete text of the GNU General
      Public License can be found in /usr/share/common-licenses/GPL.
    </para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->