root / pykota / trunk / docs / pykosd.sgml @ 3413

<!-- $Id$ -->

<chapter>
  <title>Uses On Screen Display to show personal print quota information with pykosd</title>
  <para>Last modified on $Date$</para>

  <para>
    <command>pykosd</command> is a graphical <application>X Window</application> application which when launched
    will display print quota information for the current user.
  </para>

  <para>
    Whenever you launch <command>pykosd</command>, it will display the current user's print quota
    information in the top-left corner of the screen, above all existing windows, and with
    a transparent background.
  </para>

  <para>
    By default, the information will remain displayed during <literal>3</literal> seconds, and
    will be refreshed every <literal>180</literal> seconds. The program will loop forever
    until <keysym>Ctrl+C</keysym> is pressed, unless a specific number of iterations was
    asked for.

    <tip>
      <title>Tip</title>
      <para>
        Use command line options to change this behaviour.
      </para>
    </tip>
  </para>

  <sect1>
    <title>Reference</title>
    <para>
      <cmdsynopsis>
        <command>pykosd</command>
        <group choice="opt"><arg>-v</arg><arg>--version</arg></group>
        <group choice="opt"><arg>-h</arg><arg>--help</arg></group>
        <group choice="opt">
          <arg>-d <replaceable>d</replaceable></arg>
          <arg>--duration <replaceable>d</replaceable></arg>
        </group>
        <group choice="opt">
          <arg>-l <replaceable>n</replaceable></arg>
          <arg>--loop <replaceable>n</replaceable></arg>
        </group>
        <group choice="opt">
          <arg>-s <replaceable>s</replaceable></arg>
          <arg>--sleep <replaceable>s</replaceable></arg>
        </group>
      </cmdsynopsis>
    </para>
  </sect1>
</chapter>