root / pykota / trunk / docs / edpykota.sgml @ 2553

Revision 2452, 5.1 kB (checked in by jerome, 19 years ago)

Upgraded database schema.
Added -i | --ingroups command line option to repykota.
Added -C | --comment command line option to edpykota.
Added 'noquota', 'noprint', and 'nochange' as switches for edpykota's
-l | --limitby command line option.
Severity : entirely new features, in need of testers :-)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1<!-- $Id$ -->
2
3<chapter>
4  <title id="edpykota">Manage the Print Quota DataBase with edpykota</title>
5  <para>Last modified on $Date$</para>
6 
7  <para>
8    <command>edpykota</command> is the main command line tool with which you will
9    maintain your print quota database.
10  </para>
11 
12  <para>
13    You'll use this tool to create, manage or delete print quota entries for users
14    or users groups on printers or printers groups.
15  </para>
16 
17  <para>
18    By default, before being allowed to print through <application>PyKota</application>,
19    an user must exist in the database and have a print quota entry on every printer
20    he should be allowed to use. The simplest way to add an user named <literal>jerome</literal> to the database is
21    to type :
22<screen>    
23$ edpykota --add --noquota jerome
24</screen>
25  </para>
26 
27  <para>
28    The command above has created user <literal>jerome</literal> in the database, and has automatically
29    created print quota entries with no limit for this user on all existing printers. This means
30    that user <literal>jerome</literal> is allowed to print without limitation, but that full accounting
31    will still be done for this user : you'll know whenever he prints and how much.
32  </para>
33 
34  <para>
35    You can apply two sorts of print quotas to users : page quotas, and account balance quotas.
36    <itemizedlist>
37      <listitem>
38        <para>
39          Page quotas are defined for each user on each printer. This means that an user can be
40          limited to print more than 20 pages on printer <literal>HP2100</literal> while still
41          being allowed to print 500 pages on printer <literal>TekTro</literal>.
42        </para>
43      </listitem> 
44      <listitem>
45        <para>
46          Account balance quotas are defined once for each user. You give a number of credits
47          to an user, and whenever he prints on any printer, his number of credits diminishes
48          by the cost of the current print job, until his balance reaches 0.
49          In other terms, while page quotas are specific to a particular printer for a particular
50          user, account balance quotas are shared between all printers for a particular user.
51        </para>
52      </listitem> 
53    </itemizedlist> 
54    This means that you have to choose which type of quota you want for each user.
55    The default mode is page quotas, but if you pass <literal>--limitby balance</literal>
56    as command line options to <command>edpykota</command>, the users onto which the command
57    will apply will be limited by the value of their account instead of by a number of
58    pages.
59  </para>
60 
61  <para>
62    In addition to <literal>balance</literal> and <literal>quota</literal>, several other values
63    are allowed for the <literal>--limitby</literal> command line option :
64    <itemizedlist>
65      <listitem>
66        <para>
67          <literal>noquota</literal> : the user or group can print without any limitation, but
68          accounting continues to be done.
69        </para>
70      </listitem> 
71      <listitem>
72        <para>
73          <literal>nochange</literal> : the user can print without any limitation, but
74          accounting is not done.
75          This value is not supported for users groups.
76        </para>
77      </listitem> 
78      <listitem>
79        <para>
80          <literal>noprint</literal> : the user can not print.
81          This value is not supported for users groups.
82        </para>
83      </listitem> 
84    </itemizedlist> 
85  </para>
86 
87  <para>
88    Here's an incomplete list of features :
89   
90    <itemizedlist>
91      <listitem>
92        <para>
93          Add printers (it's preferable to use the <command>pkprinters</command> command for this though) ;
94        </para>
95      </listitem>
96      <listitem>
97        <para>
98          Add and delete users and groups ;
99        </para>
100      </listitem>
101      <listitem>
102        <para>
103          Set users' account balances ;
104        </para>
105      </listitem>
106      <listitem>
107        <para>
108          Set users and groups print quotas on printers, eventually by using another user
109          or group as a template ;
110        </para>
111      </listitem>
112      <listitem>
113        <para>
114          Set price per page and price per job for printers (it's preferable to use the <command>pkprinters</command> command for this though) ;
115        </para>
116      </listitem>
117      <listitem>
118        <para>
119          Switch users or groups to or from <quote>account only</quote> mode (no quota enforcement) ;
120        </para>
121      </listitem>
122      <listitem>
123        <para>
124          Define hard and soft limits for users ou groups quotas, on a per printer basis ;
125        </para>
126      </listitem>
127      <listitem>
128        <para>
129          Choose the way you will limit printing ;
130        </para>
131      </listitem>
132      <listitem>
133        <para>
134          Reset page counters ;
135        </para>
136      </listitem>
137      <listitem>
138        <para>
139          Etc...
140        </para>
141      </listitem>
142    </itemizedlist>
143  </para>
144 
145  <para>
146    For more details on the use of <command>edpykota</command>, please see this command's manual
147    page or help.
148  </para>
149 
150</chapter>
151
Note: See TracBrowser for help on using the browser.