Changeset 1783

Show
Ignore:
Timestamp:
10/06/04 12:03:16 (20 years ago)
Author:
jalet
Message:

Improved documentation

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

Legend:

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

    r1744 r1783  
    1414  <para> 
    1515    <application>dumpykota</application> can export <application>PyKota</application> 
    16     datas in a number of formats. As of September 27th 2004, output formats are 
    17     comma separated values, semicolon separated values, and tab separated values. 
    18     More formats, different, are planned : <acronym>XML</acronym>, <acronym>SQL</acronym>, 
    19     and <acronym>LDIF</acronym> are planned, but are currently not implemented. 
     16    datas in a number of formats. The supported output formats are 
     17    comma separated values, semicolon separated values, tab separated values, and <acronym>XML</acronym>. 
     18    More formats may be added in the future. In particular,  
     19    <acronym>SQL</acronym> and <acronym>LDIF</acronym> are planned, but  
     20    are currently not implemented.  
    2021  </para> 
    2122   
     
    5354    <title>Warning</title> 
    5455    <para> 
    55       Contrary to the <application>repykota</application> command, <application>dumpykota</application> 
    56       doesn't currently limit which datas can be exported by normal users, so please take 
    57       care to not allow normal users to read the <filename>/etc/pykota/pykota.conf</filename> 
    58       file or to execute the <application>dumpykota</application> command if you don't 
    59       want to expose possibly sensitive datas. 
     56      Only <application>PyKota</application> administrators can dump PyKota's datas. 
    6057    </para> 
    6158  </warning>   
     
    7269          <arg>--format <replaceable>outputformat</replaceable></arg> 
    7370        </group> 
     71        <group choice="opt"> 
     72          <arg>-o <replaceable>filename</replaceable></arg> 
     73          <arg>--output <replaceable>filename</replaceable></arg> 
     74        </group> 
    7475        <group choice="req"> 
    7576          <arg>-d <replaceable>datatype</replaceable></arg> 
     
    8485 
    8586$Log$ 
     87Revision 1.2  2004/10/06 10:03:16  jalet 
     88Improved documentation 
     89 
    8690Revision 1.1  2004/09/27 08:19:14  jalet 
    8791Wrote some doc for dumpykota 
  • pykota/trunk/docs/installation.sgml

    r1612 r1783  
    2929    have to decompress and visit its archive, to do so just type the following commands : 
    3030    <screen> 
    31 jerome@nordine:~$ tar -zxf pykota-1.19_official.tar.gz     
    32 jerome@nordine:~$ cd pykota-1.19_official 
    33 jerome@nordine:~/pykota-1.19_official$ 
     31jerome@nordine:~$ tar -zxf pykota-1.20_official.tar.gz     
     32jerome@nordine:~$ cd pykota-1.20_official 
     33jerome@nordine:~/pykota-1.20_official$ 
    3434    </screen> 
    3535  </para> 
     
    143143        A Quota Storage read-only user is also created under the name of <literal>pykotauser</literal>. 
    144144        This read-only user is used by <application>PyKota</application> to connect to the  
    145         Quota Storage when a non-root user launches a pykota command. This prevents normal 
     145        Quota Storage when an user who is not a <application>PyKota</application> administrator  
     146        <footnote><para>a <application>PyKota</application> administrator is an user who can read the <filename>/etc/pykota/pykotadmin.conf</filename> file.</para></footnote> 
     147        launches a pykota command. This prevents normal 
    146148        users from being able to modify their own, or other users', quota information. 
    147149        The database which will be created will be named <literal>pykota</literal> by default. 
     
    165167        From a command line interpreter (i.e. shell), type the following commands : 
    166168        <screen> 
    167 jerome@nordine:~$ cd pykota-1.19_official/initscripts/postgresql 
    168 jerome@nordine:~/pykota-1.19_official/initscripts$ psql -h localhost -U postgres template1 
     169jerome@nordine:~$ cd pykota-1.20_official/initscripts/postgresql 
     170jerome@nordine:~/pykota-1.20_official/initscripts$ psql -h localhost -U postgres template1 
    169171Welcome to psql, the PostgreSQL interactive terminal. 
    170172 
     
    197199ALTER USER 
    198200pykota=# \q 
    199 jerome@nordine:~/pykota-1.19_official/initscripts/postgresql$ 
     201jerome@nordine:~/pykota-1.20_official/initscripts/postgresql$ 
    200202        </screen> 
    201203      </para> 
     
    585587$ chmod 640 /etc/pykota/pykotadmin.conf       
    586588      </screen> 
    587     </para> 
     589       
     590      <warning> 
     591        <title>Warning</title> 
     592        <para> 
     593          All the users allowed to read the <filename>/etc/pykota/pykotadmin.conf</filename>  
     594          are considered to be <application>PyKota</application> administrators. So be 
     595          careful with these files permissions. 
     596        </para> 
     597      </warning> 
     598    </para> 
     599     
    588600     
    589601    <para> 
     
    725737 
    726738$Log$ 
     739Revision 1.28  2004/10/06 10:03:16  jalet 
     740Improved documentation 
     741 
    727742Revision 1.27  2004/07/21 09:39:03  jalet 
    728743LPRng documentation 
  • pykota/trunk/docs/pykota.sgml

    r1744 r1783  
    1212  <!entity PYKOSD system "pykosd.sgml"> 
    1313  <!entity DUMPYKOTA system "dumpykota.sgml"> 
     14  <!entity AUTOPYKOTA system "autopykota.sgml"> 
    1415  <!entity GNUGPL system "gnugpl.sgml"> 
    1516 
     
    112113 
    113114  &EDPYKOTA; 
     115   
     116  &AUTOPYKOTA; 
    114117     
    115118  &REPYKOTA; 
     
    134137 
    135138$Log$ 
     139Revision 1.15  2004/10/06 10:03:16  jalet 
     140Improved documentation 
     141 
    136142Revision 1.14  2004/09/27 08:19:14  jalet 
    137143Wrote some doc for dumpykota 
  • pykota/trunk/docs/repykota.sgml

    r1287 r1783  
    2020     
    2121    <para> 
    22       <application>repykota</application> behaves differently when it is launched by the  
    23       <literal>root</literal> user, compared to when it is launched by a normal user. 
     22      <application>repykota</application> behaves differently when it is launched by a 
     23      <application>PyKota</application> administrator, compared to when it is launched by a normal user. 
    2424    </para>   
    2525     
     
    152152 
    153153$Log$ 
     154Revision 1.8  2004/10/06 10:03:16  jalet 
     155Improved documentation 
     156 
    154157Revision 1.7  2004/01/12 23:10:35  jalet 
    155158PyKota 1.16beta1 is finally out. 
  • pykota/trunk/docs/warnpykota.sgml

    r1101 r1783  
    3535   
    3636  <para> 
    37     When a non-root user launches this command, only him can receive a warning 
     37    When an user who is not a <application>PyKota</application> administrator launches this command, only him can receive a warning 
    3838    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 
     39    on specific printers. If a normal user uses the <literal>--groups</literal> command line 
    4040    argument, then for each group he is a member of in the Quota Storage, each 
    4141    group member may receive a warning message. You can take care of this if this 
     
    4545   
    4646  <para> 
    47     The <literal>root</literal> user can pass additionnal user or group names  
     47    <application>PyKota</application> administrators can pass additionnal user or group names  
    4848    (or wildcard filters) to only check the users or groups whose name matches. 
    4949  </para>   
     
    7676 
    7777$Log$ 
     78Revision 1.6  2004/10/06 10:03:16  jalet 
     79Improved documentation 
     80 
    7881Revision 1.5  2003/07/25 13:10:58  jalet 
    7982Improved documentation