Changeset 2833

Show
Ignore:
Timestamp:
04/05/06 21:17:51 (17 years ago)
Author:
jerome
Message:

Improved documentation a bit. More will follow.

Location:
pykota/trunk/docs
Files:
1 added
2 modified

Legend:

Unmodified
Added
Removed
  • pykota/trunk/docs/edpykota.sgml

    r2452 r2833  
    22 
    33<chapter> 
    4   <title id="edpykota">Manage the Print Quota DataBase with edpykota</title> 
     4  <title id="edpykota">Manage Print Quotas with edpykota</title> 
    55  <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> 
    116   
    127  <para> 
     
    1813    By default, before being allowed to print through <application>PyKota</application>, 
    1914    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 
     15    he should be allowed to use. As seen in the previous chapter, the simplest way to add an user named <literal>jerome</literal> to the database is 
    2116    to type : 
    2217<screen>     
    23 $ edpykota --add --noquota jerome 
     18$ pkusers --add jerome 
     19</screen> 
     20 
     21    But this is not sufficient to allow user <literal>jerome</literal> to print. You have to create a print quota entry for <literal>jerome</literal> on all printers 
     22    he is allowed to print to. The easiest way to do so is to type : 
     23<screen>     
     24$ edpykota --add jerome 
    2425</screen> 
    2526  </para> 
    2627   
    2728  <para> 
    28     The command above has created user <literal>jerome</literal> in the database, and has automatically 
     29    The commands above have created user <literal>jerome</literal> in the database, and have automatically 
    2930    created print quota entries with no limit for this user on all existing printers. This means 
    3031    that user <literal>jerome</literal> is allowed to print without limitation, but that full accounting 
    3132    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>   
    8533  </para> 
    8634   
     
    9139      <listitem> 
    9240        <para> 
    93           Add printers (it's preferable to use the <command>pkprinters</command> command for this though) ; 
     41          Add and delete users and groups print quota entries ; 
    9442        </para> 
    9543      </listitem> 
    9644      <listitem> 
    9745        <para> 
    98           Add and delete users and groups ; 
     46          Define, increase or decrease hard and soft page limits for users ou users groups, on a per printer basis ; 
    9947        </para> 
    10048      </listitem> 
    10149      <listitem> 
    10250        <para> 
    103           Set users' account balances ; 
     51          Reset or modify page counters for users or groups, on a per printer basis ; 
    10452        </para> 
    10553      </listitem> 
    10654      <listitem> 
    10755        <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... 
     56          List print quota entries ; 
    14057        </para> 
    14158      </listitem> 
  • pykota/trunk/docs/pykota.sgml

    r2622 r2833  
    1717  <!entity PKBANNER system "pkbanner.sgml"> 
    1818  <!entity PKMAIL system "pkmail.sgml"> 
     19  <!entity PKUSERS system "pkusers.sgml"> 
    1920  <!entity GNUGPL system "gnugpl.sgml"> 
    2021 
     
    121122   
    122123  &PKPRINTERS; 
     124   
     125  &PKUSERS; 
    123126 
    124127  &EDPYKOTA;