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

Improved documentation

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • 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.