Changeset 1783

Timestamp:

10/06/04 12:03:16 (20 years ago)

Author:

jalet

Message:

Improved documentation

Location:

pykota/trunk/docs

Files:

• autopykota.sgml (added)
• dumpykota.sgml (modified) (4 diffs)
• installation.sgml (modified) (6 diffs)
• pykota.sgml (modified) (3 diffs)
• repykota.sgml (modified) (2 diffs)
• warnpykota.sgml (modified) (3 diffs)

pykota/trunk/docs/dumpykota.sgml

@@ -14 +14 @@
   <para>
     <application>dumpykota</application> can export <application>PyKota</application>
-    datas in a number of formats. As of September 27th 2004, output formats are
-    comma separated values, semicolon separated values, and tab separated values.
-    More formats, different, are planned : <acronym>XML</acronym>, <acronym>SQL</acronym>,
-    and <acronym>LDIF</acronym> are planned, but are currently not implemented.
+    datas in a number of formats. The supported output formats are
+    comma separated values, semicolon separated values, tab separated values, and <acronym>XML</acronym>.
+    More formats may be added in the future. In particular, 
+    <acronym>SQL</acronym> and <acronym>LDIF</acronym> are planned, but 
+    are currently not implemented. 
   </para>
   
@@ -53 +54 @@
     <title>Warning</title>
     <para>
-      Contrary to the <application>repykota</application> command, <application>dumpykota</application>
-      doesn't currently limit which datas can be exported by normal users, so please take
-      care to not allow normal users to read the <filename>/etc/pykota/pykota.conf</filename>
-      file or to execute the <application>dumpykota</application> command if you don't
-      want to expose possibly sensitive datas.
+      Only <application>PyKota</application> administrators can dump PyKota's datas.
     </para>
   </warning>  
@@ -72 +69 @@
           <arg>--format <replaceable>outputformat</replaceable></arg>
         </group>
+        <group choice="opt">
+          <arg>-o <replaceable>filename</replaceable></arg>
+          <arg>--output <replaceable>filename</replaceable></arg>
+        </group>
         <group choice="req">
           <arg>-d <replaceable>datatype</replaceable></arg>
@@ -84 +85 @@
 
 $Log$
+Revision 1.2  2004/10/06 10:03:16  jalet
+Improved documentation
+
 Revision 1.1  2004/09/27 08:19:14  jalet
 Wrote some doc for dumpykota

pykota/trunk/docs/installation.sgml

@@ -29 +29 @@
     have to decompress and visit its archive, to do so just type the following commands :
     <screen>
-jerome@nordine:~$ tar -zxf pykota-1.19_official.tar.gz    
-jerome@nordine:~$ cd pykota-1.19_official
-jerome@nordine:~/pykota-1.19_official$
+jerome@nordine:~$ tar -zxf pykota-1.20_official.tar.gz    
+jerome@nordine:~$ cd pykota-1.20_official
+jerome@nordine:~/pykota-1.20_official$
     </screen>
   </para>
@@ -143 +143 @@
         A Quota Storage read-only user is also created under the name of <literal>pykotauser</literal>.
         This read-only user is used by <application>PyKota</application> to connect to the 
-        Quota Storage when a non-root user launches a pykota command. This prevents normal
+        Quota Storage when an user who is not a <application>PyKota</application> administrator 
+        <footnote><para>a <application>PyKota</application> administrator is an user who can read the <filename>/etc/pykota/pykotadmin.conf</filename> file.</para></footnote>
+        launches a pykota command. This prevents normal
         users from being able to modify their own, or other users', quota information.
         The database which will be created will be named <literal>pykota</literal> by default.
@@ -165 +167 @@
         From a command line interpreter (i.e. shell), type the following commands :
         <screen>
-jerome@nordine:~$ cd pykota-1.19_official/initscripts/postgresql
-jerome@nordine:~/pykota-1.19_official/initscripts$ psql -h localhost -U postgres template1
+jerome@nordine:~$ cd pykota-1.20_official/initscripts/postgresql
+jerome@nordine:~/pykota-1.20_official/initscripts$ psql -h localhost -U postgres template1
 Welcome to psql, the PostgreSQL interactive terminal.
 
@@ -197 +199 @@
 ALTER USER
 pykota=# \q
-jerome@nordine:~/pykota-1.19_official/initscripts/postgresql$
+jerome@nordine:~/pykota-1.20_official/initscripts/postgresql$
         </screen>
       </para>
@@ -585 +587 @@
 $ chmod 640 /etc/pykota/pykotadmin.conf      
       </screen>
-    </para>
+      
+      <warning>
+        <title>Warning</title>
+        <para>
+          All the users allowed to read the <filename>/etc/pykota/pykotadmin.conf</filename> 
+          are considered to be <application>PyKota</application> administrators. So be
+          careful with these files permissions.
+        </para>
+      </warning>
+    </para>
+    
     
     <para>
@@ -725 +737 @@
 
 $Log$
+Revision 1.28  2004/10/06 10:03:16  jalet
+Improved documentation
+
 Revision 1.27  2004/07/21 09:39:03  jalet
 LPRng documentation

pykota/trunk/docs/pykota.sgml

@@ -12 +12 @@
   <!entity PYKOSD system "pykosd.sgml">
   <!entity DUMPYKOTA system "dumpykota.sgml">
+  <!entity AUTOPYKOTA system "autopykota.sgml">
   <!entity GNUGPL system "gnugpl.sgml">
 
@@ -112 +113 @@
 
   &EDPYKOTA;
+  
+  &AUTOPYKOTA;
     
   &REPYKOTA;
@@ -134 +137 @@
 
 $Log$
+Revision 1.15  2004/10/06 10:03:16  jalet
+Improved documentation
+
 Revision 1.14  2004/09/27 08:19:14  jalet
 Wrote some doc for dumpykota

pykota/trunk/docs/repykota.sgml

@@ -20 +20 @@
     
     <para>
-      <application>repykota</application> behaves differently when it is launched by the 
-      <literal>root</literal> user, compared to when it is launched by a normal user.
+      <application>repykota</application> behaves differently when it is launched by a
+      <application>PyKota</application> administrator, compared to when it is launched by a normal user.
     </para>  
     
@@ -152 +152 @@
 
 $Log$
+Revision 1.8  2004/10/06 10:03:16  jalet
+Improved documentation
+
 Revision 1.7  2004/01/12 23:10:35  jalet
 PyKota 1.16beta1 is finally out.

pykota/trunk/docs/warnpykota.sgml

@@ -35 +35 @@
   
   <para>
-    When a non-root user launches this command, only him can receive a warning
+    When an user who is not a <application>PyKota</application> administrator launches this command, only him can receive a warning
     message. He can specify a printer name's filter to check his quota only
-    on specific printers. If a non-root users uses the <literal>--groups</literal> command line
+    on specific printers. If a normal user uses the <literal>--groups</literal> command line
     argument, then for each group he is a member of in the Quota Storage, each
     group member may receive a warning message. You can take care of this if this
@@ -45 +45 @@
   
   <para>
-    The <literal>root</literal> user can pass additionnal user or group names 
+    <application>PyKota</application> administrators can pass additionnal user or group names 
     (or wildcard filters) to only check the users or groups whose name matches.
   </para>  
@@ -76 +76 @@
 
 $Log$
+Revision 1.6  2004/10/06 10:03:16  jalet
+Improved documentation
+
 Revision 1.5  2003/07/25 13:10:58  jalet
 Improved documentation