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

Revision 867, 2.4 kB (checked in by jalet, 22 years ago)

Added warnpykota command synopsis

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1<!-- $Id$ -->
2
3<chapter>
4  <title>Warn users above print quota with warnpykota</title>
5  <para>Last modified on $Date$</para>
6 
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>
15 
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 in a <application>cron</application> job.
20  </para>
21 
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 solve the problem, by buying more
25    paper for example.
26  </para>
27 
28  <para>
29    The <application>warnpykota</application> 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 !
33  </para>
34 
35  <sect1>
36    <title>Command line parameters</title>
37    <para>
38      TODO : blah
39    </para>
40  </sect1>
41 
42  <sect1>
43    <title>Examples</title>
44    <para>
45      TODO : blah
46    </para>
47  </sect1>
48 
49  <sect1>
50    <title>Reference</title>
51    <para>
52      <cmdsynopsis>
53        <command>warnpykota</command>
54        <group choice="opt"><arg>-v</arg><arg>--version</arg></group>
55        <group choice="opt"><arg>-h</arg><arg>--help</arg></group>
56        <group choice="opt"><arg>-u</arg><arg>--users</arg></group>
57        <group choice="opt"><arg>-g</arg><arg>--groups</arg></group>
58        <group choice="opt">
59          <arg>-P <replaceable>printername</replaceable></arg>
60          <arg>--printer <replaceable>printername</replaceable></arg>
61        </group> 
62      </cmdsynopsis>
63    </para>
64    <para>
65      TODO
66    </para>
67  </sect1>
68</chapter>
69
70<!--
71
72$Log$
73Revision 1.3  2003/03/25 12:30:37  jalet
74Added warnpykota command synopsis
75
76Revision 1.2  2003/03/25 09:32:06  jalet
77Improved documentation.
78
79Revision 1.1  2003/02/08 00:03:35  jalet
80Documentation skeleton added
81
82
83-->
Note: See TracBrowser for help on using the browser.