Changeset 1101 for pykota/trunk/docs

Show
Ignore:
Timestamp:
07/25/03 15:10:58 (21 years ago)
Author:
jalet
Message:

Improved documentation

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

Legend:

Unmodified
Added
Removed

  • pykota/trunk/docs/filterpykota.sgml

    r1099 r1101  
    77   
    88  <para> 
    9     To account for pages or eventually ink usage, you must plug your accounting 
     9    To account for pages or eventually ink usage  
     10    <footnote> 
     11      <para> 
     12        PyKota doesn't currently account for ink usage, it only accounts 
     13        pages. To account for ink usage, you should use PrintBill instead. 
     14      </para>   
     15    </footnote>   
     16    , you must plug your accounting 
    1017    system somewhere into the printing system you use, be it either <application>CUPS</application> 
    1118    or <application>LPRng</application>. One way to do this without having 
    … …  
    5461    When used with an <application>LPRng</application> backend, the accounting filter is not defined the same way  
    5562    input filters are, so the problem described above doesn't exist, and <application>PyKota</application> 
    56     may work with non-postscript printers, provided they can report their page counter and you know how to do 
    57     this. 
     63    may work with non-postscript printers, provided they can report their page counter and you know how to retrieve 
     64    it. 
    5865  </para> 
    5966   
    … …  
    7178    page counter for this printer when the previous job was launched, computes the difference, and report it as the  
    7279    previous job's size in the Quota DataBase. It then updates the last user's print quota and account balance, and 
    73     warn him if he is over quota or his account balance below 0. Finally it checks if the user who launched the  
     80    warn him if he is over quota or if his account balance is below 0. Finally it checks if the user who launched the  
    7481    current job is below or above his print quota, and either allow or deny the job's datas to pass to the underlying  
    7582    layer (the printer itself). 
    … …  
    8390    pages on a single line on its standard output. This number is then 
    8491    read by PyKota and used to update the current user's quota information. 
     92    Of course checks are also done like with the <literal>querying</literal> 
     93    accounting method, to see if the current job is allowed to be printed or not. 
    8594  </para> 
    8695   
    … …  
    97106 
    98107$Log$ 
     108Revision 1.6  2003/07/25 13:10:58  jalet 
     109Improved documentation 
     110 
    99111Revision 1.5  2003/07/25 10:41:29  jalet 
    100112Better documentation. 

  • pykota/trunk/docs/pykota.sgml

    r1099 r1101  
    1616  <bookinfo> 
    1717    <title>PyKota Documentation</title> 
    18     <subtitle>A full featured Print Quota Solution for CUPS</subtitle> 
     18    <subtitle>A full featured Print Quota Solution for CUPS and LPRng</subtitle> 
    1919    <copyright> 
    2020      <year>2003</year> 
    … …  
    4545      <para> 
    4646        This document will describe the setup of the PyKota Print Quota system 
    47         for the Common UNIX Printing Environment, and its day-to-day use. 
     47        for the Common UNIX Printing Environment and LPRng, and its day-to-day use. 
    4848      </para> 
    4949    </abstract> 
    … …  
    9898 
    9999$Log$ 
     100Revision 1.6  2003/07/25 13:10:58  jalet 
     101Improved documentation 
     102 
    100103Revision 1.5  2003/07/25 10:41:29  jalet 
    101104Better documentation. 

  • pykota/trunk/docs/pykotme.sgml

    r1099 r1101  
    6363    </para> 
    6464  </sect1> 
     65   
     66  <sect1> 
     67    <title>Reference</title> 
     68    <para> 
     69      <cmdsynopsis> 
     70        <command>pykotme</command> 
     71        <group choice="opt"><arg>-v</arg><arg>--version</arg></group> 
     72        <group choice="opt"><arg>-h</arg><arg>--help</arg></group> 
     73        <group choice="opt"> 
     74          <arg>-P <replaceable>printername</replaceable></arg> 
     75          <arg>--printer <replaceable>printername</replaceable></arg> 
     76        </group>   
     77        <group choice="opt"> 
     78          <arg><replaceable>filename1</replaceable></arg> 
     79          <arg><replaceable>filename2</replaceable></arg> 
     80          <arg><replaceable>...</replaceable></arg> 
     81          <arg><replaceable>filenameN</replaceable></arg> 
     82        </group>   
     83      </cmdsynopsis> 
     84    </para> 
     85  </sect1> 
    6586</chapter> 
    6687 
    … …  
    6889 
    6990$Log$ 
     91Revision 1.2  2003/07/25 13:10:58  jalet 
     92Improved documentation 
     93 
    7094Revision 1.1  2003/07/25 10:41:30  jalet 
    7195Better documentation. 

  • pykota/trunk/docs/repykota.sgml

    r959 r1101  
    1111  </para> 
    1212   
    13   <para> 
    14     PyKota features a quota report generator, named <application>repykota</application>, 
    15     with which you can print the current state of the quota database. 
    16   </para> 
     13  <sect1> 
     14    <title>Command line based Print Quota reports</title> 
     15     
     16    <para> 
     17      PyKota features a quota report generator, named <application>repykota</application>, 
     18      with which you can print the current state of the quota database. 
     19    </para> 
    1720   
    18   <para> 
    19     <application>PyKota</application> also features a CGI script to remotely access 
    20     to print quota reports with a web browser, it is called <application>printquota.cgi</application> 
    21     and you can put it in your web server's cgi-bin directory if a web server is installed on 
    22     any machine on which <application>PyKota</application> is also installed and configured 
    23     correctly. 
    24   </para> 
    25    
    26   <sect1> 
    27     <title><application>repykota</application> commmand line options</title> 
    28     <para> 
    29       Here's a decription of each of <application>repykota</application> 
    30       command line options. 
    31     </para> 
     21    <sect2> 
     22      <title>Reference</title> 
     23      <para> 
     24        <cmdsynopsis> 
     25          <command>repykota</command> 
     26          <group choice="opt"><arg>-v</arg><arg>--version</arg></group> 
     27          <group choice="opt"><arg>-h</arg><arg>--help</arg></group> 
     28          <group choice="opt"><arg>-u</arg><arg>--users</arg></group> 
     29          <group choice="opt"><arg>-g</arg><arg>--groups</arg></group> 
     30          <group choice="opt"> 
     31            <arg>-P <replaceable>printername</replaceable></arg> 
     32            <arg>--printer <replaceable>printername</replaceable></arg> 
     33          </group>   
     34          <group choice="opt"> 
     35            <arg><replaceable>name1</replaceable></arg> 
     36            <arg><replaceable>name2</replaceable></arg> 
     37            <arg><replaceable>...</replaceable></arg> 
     38            <arg><replaceable>nameN</replaceable></arg> 
     39          </group>   
     40        </cmdsynopsis> 
     41      </para> 
     42    </sect2> 
    3243  </sect1> 
    3344   
    3445  <sect1> 
    35     <title>examples</title> 
     46    <title>Web based Print Quota reports</title> 
     47     
    3648    <para> 
    37       Here are some examples of <application>repykota</application> usage. 
     49      <application>PyKota</application> also features a CGI script to remotely access 
     50      to print quota reports with a web browser, it is called <application>printquota.cgi</application> 
     51      and you can put it in your web server's <filename>cgi-bin</filename> directory if a web server is installed on 
     52      any machine on which <application>PyKota</application> is also installed and configured 
     53      correctly. 
     54    </para> 
     55     
     56    <para> 
     57      You can find <filename>printquota.cgi</filename> in the <filename>pykota/cgi-bin</filename> 
     58      directory. Here's how to install it, provided that your web server's <filename>cgi-bin</filename> 
     59      directory is <filename>/usr/lib/cgi-bin</filename> : 
     60<screen>       
     61port50-2:/home/jerome/pykota$ cp cgi-bin/printquota.cgi /usr/lib/cgi-bin 
     62port50-2:/home/jerome/pykota$ chmod 755 /usr/lib/cgi-bin/printquota.cgi 
     63</screen> 
     64 
     65      <note> 
     66        <title>Note</title> 
     67        <para> 
     68          Please ensure that the user your web server is run as, for example <literal>www-data</literal> under 
     69          Debian, is allowed to read <filename>/etc/pykota/pykota.conf</filename> but for security reasons you 
     70          must ensure that this user <emphasis>is not</emphasis> allowed to read <filename>/etc/pykota/pykotadmin.conf</filename> 
     71        </para> 
     72      </note>   
    3873    </para> 
    3974  </sect1> 
    … …  
    4378 
    4479$Log$ 
     80Revision 1.5  2003/07/25 13:10:58  jalet 
     81Improved documentation 
     82 
    4583Revision 1.4  2003/04/24 21:09:47  jalet 
    4684Documentation slightly improved. 

  • pykota/trunk/docs/warnpykota.sgml

    r959 r1101  
    3030    If you put this command in your <filename>crontab</filename>, launching it for example 
    3131    every day, then you'll be sure that all your users who are above their print quota 
    32     will not forget it ! 
     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 received them ;-) 
    3334  </para> 
    3435   
    3536  <para> 
    36     At the very least, try to make your best to disallow ordinary users to be able to 
    37     launch this command, since malicious users could fill other users mailboxes 
    38     by repeatedly running <application>warnpykota</application> : each user above 
    39     quota would receive multiple email messages, and possibly the administrator too ! 
     37    When a non-root user 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 non-root users uses the <literal>--groups</literal> command line 
     40    argument, then for each group he is a member of in the Quota Storage, 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 <application>warnpykota</application> 
     43    command. 
    4044  </para> 
    4145   
    42   <sect1> 
    43     <title>Command line parameters</title> 
    44     <para> 
    45       TODO : blah 
    46     </para> 
    47   </sect1> 
    48    
    49   <sect1> 
    50     <title>Examples</title> 
    51     <para> 
    52       TODO : blah 
    53     </para> 
    54   </sect1> 
     46  <para> 
     47    The <literal>root</literal> user can pass additionnal user or group names  
     48    (or wildcard filters) to only check the users or groups whose name matches. 
     49  </para>   
    5550   
    5651  <sect1> 
    … …  
    6762          <arg>--printer <replaceable>printername</replaceable></arg> 
    6863        </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>   
    6970      </cmdsynopsis> 
    70     </para> 
    71     <para> 
    72       TODO 
    7371    </para> 
    7472  </sect1> 
    … …  
    7876 
    7977$Log$ 
     78Revision 1.5  2003/07/25 13:10:58  jalet 
     79Improved documentation 
     80 
    8081Revision 1.4  2003/04/24 21:09:47  jalet 
    8182Documentation slightly improved. 
    … …  
    9091Documentation skeleton added 
    9192 
    92  
    9393-->