root / pykota / branches / specialauth / docs / pykosd.sgml @ 3179

Revision 2551, 1.8 kB (checked in by jerome, 19 years ago)

Replaced some 'filename' tags with 'command' tags.
Improved pkbcodes' documentation.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1<!-- $Id$ -->
2
3<chapter>
4  <title>Uses On Screen Display to show personal print quota information with pykosd</title>
5  <para>Last modified on $Date$</para>
6 
7  <para>
8    <command>pykosd</command> is a graphical <application>X Window</application> application which when launched
9    will display print quota information for the current user.
10  </para> 
11 
12  <para>
13    Whenever you launch <command>pykosd</command>, it will display the current user's print quota
14    information in the top-left corner of the screen, above all existing windows, and with
15    a transparent background.
16  </para>
17 
18  <para>
19    By default, the information will remain displayed during <literal>3</literal> seconds, and
20    will be refreshed every <literal>180</literal> seconds. The program will loop forever
21    until <keysym>Ctrl+C</keysym> is pressed, unless a specific number of iterations was
22    asked for.
23   
24    <tip>
25      <title>Tip</title>
26      <para>
27        Use command line options to change this behaviour.
28      </para>
29    </tip>
30  </para>
31 
32  <sect1>
33    <title>Reference</title>
34    <para>
35      <cmdsynopsis>
36        <command>pykosd</command>
37        <group choice="opt"><arg>-v</arg><arg>--version</arg></group>
38        <group choice="opt"><arg>-h</arg><arg>--help</arg></group>
39        <group choice="opt">
40          <arg>-d <replaceable>d</replaceable></arg>
41          <arg>--duration <replaceable>d</replaceable></arg>
42        </group>
43        <group choice="opt">
44          <arg>-l <replaceable>n</replaceable></arg>
45          <arg>--loop <replaceable>n</replaceable></arg>
46        </group>
47        <group choice="opt">
48          <arg>-s <replaceable>s</replaceable></arg>
49          <arg>--sleep <replaceable>s</replaceable></arg>
50        </group>
51      </cmdsynopsis>
52    </para>
53  </sect1>
54</chapter>
55
Note: See TracBrowser for help on using the browser.