root / pykota / trunk / docs / warnpykota.sgml @ 2844

Revision 2844, 3.1 kB (checked in by jerome, 18 years ago)

Added some stuff about MySQL.
Removed confusing vocabulary.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
1<!-- $Id$ -->
4  <title>Warn users above print quota with warnpykota</title>
5  <para>Last modified on $Date$</para>
7  <para>
8    Whenever a user tries to print a document, if he is over his print quota,
9    then the job is refused. Depending on <application>PyKota</application>'s
10    configuration, especially the <literal>mailto</literal> option, he and/or
11    the administrator may eventually receive an email message which explains
12    the situation and invites him to solve the problem before being allowed
13    to print again.
14  </para>
16  <para>
17    However this may not be sufficient, and you may want to warn users who
18    have reached their print quota at
19    regular intervals, like every day, for example from a <application>cron</application> job.
20  </para>
22  <para>
23    This may be useful if the user has reached his print quota, and have received an email message telling him so,
24    but then he doesn't print for some days and may forget to fix the problem, by buying more
25    paper for example.
26  </para>
28  <para>
29    The <command>warnpykota</command> command was written with this in mind.
30    If you put this command in your <filename>crontab</filename>, launching it for example
31    every day, then you'll be sure that all your users who are above their print quota
32    will not forget it ! Of course they may delete the messages without having read them,
33    but at least they won't be able to say that they didn't receive them ;-)
34  </para>
36  <para>
37    When an user who is not a <application>PyKota</application> administrator launches this command, only him can receive a warning
38    message. He can specify a printer name's filter to check his quota only
39    on specific printers. If a normal user uses the <literal>--groups</literal> command line
40    argument, then for each group he is a member of in the print quota database, each
41    group member may receive a warning message. You can take care of this if this
42    becomes annoying by forbidding normal users to launch the <command>warnpykota</command>
43    command.
44  </para>
46  <para>
47    <application>PyKota</application> administrators can pass additionnal user or group names
48    (or wildcard filters) to only check the users or groups whose name matches.
49  </para> 
51  <sect1>
52    <title>Reference</title>
53    <para>
54      <cmdsynopsis>
55        <command>warnpykota</command>
56        <group choice="opt"><arg>-v</arg><arg>--version</arg></group>
57        <group choice="opt"><arg>-h</arg><arg>--help</arg></group>
58        <group choice="opt"><arg>-u</arg><arg>--users</arg></group>
59        <group choice="opt"><arg>-g</arg><arg>--groups</arg></group>
60        <group choice="opt">
61          <arg>-P <replaceable>printername</replaceable></arg>
62          <arg>--printer <replaceable>printername</replaceable></arg>
63        </group> 
64        <group choice="opt">
65          <arg><replaceable>name1</replaceable></arg>
66          <arg><replaceable>name2</replaceable></arg>
67          <arg><replaceable>...</replaceable></arg>
68          <arg><replaceable>nameN</replaceable></arg>
69        </group> 
70      </cmdsynopsis>
71    </para>
72  </sect1>
Note: See TracBrowser for help on using the browser.