Changeset 3115

Timestamp:

12/03/06 11:50:20 (18 years ago)

Author:

jerome

Message:

Fixed some issues in the documentation.
Added the documentation for pkrefund.

Location:

pykota/trunk/docs

Files:

• installation.sgml (modified) (16 diffs)
• pkinvoice.sgml (modified) (1 diff)
• pkrefund.sgml (added)
• pykota.sgml (modified) (2 diffs)

pykota/trunk/docs/installation.sgml

@@ -35 +35 @@
     have to decompress and visit its archive, to do so just type the following commands :
     <screen>
-jerome@nordine:~$ tar -zxf pykota-1.24_official.tar.gz    
-jerome@nordine:~$ cd pykota-1.24_official
-jerome@nordine:~/pykota-1.24_official$
+jerome@nordine:~$ tar -zxf pykota-1.25_official.tar.gz    
+jerome@nordine:~$ cd pykota-1.25_official
+jerome@nordine:~/pykota-1.25_official$
     </screen>
   </para>
@@ -160 +160 @@
         is waiting for your connections, you have to create the print quota database.
         To do so, you'll have to feed <application>PostgreSQL</application> with the
-        <filename>pykota-1.24_official/initscripts/postgresql/pykota-postgresql.sql</filename> file.
+        <filename>pykota-1.25_official/initscripts/postgresql/pykota-postgresql.sql</filename> file.
         This file will create a print quota database administrator in the <application>PostgreSQL</application> system, then create an empty
         print quota database and set some permissions on it. The print quota database administrator
@@ -197 +197 @@
         From a command line interpreter (i.e. shell), type the following commands :
         <screen>
-jerome@nordine:~$ cd pykota-1.24_official/initscripts/postgresql
-jerome@nordine:~/pykota-1.24_official/initscripts$ psql -h localhost -U postgres template1
+jerome@nordine:~$ cd pykota-1.25_official/initscripts/postgresql
+jerome@nordine:~/pykota-1.25_official/initscripts$ psql -h localhost -U postgres template1
 Welcome to psql, the PostgreSQL interactive terminal.
 
@@ -233 +233 @@
 pykota=# ALTER USER pykotauser PASSWORD 'anotherpassword';
 pykota=# \q
-jerome@nordine:~/pykota-1.24_official/initscripts/postgresql$
+jerome@nordine:~/pykota-1.25_official/initscripts/postgresql$
         </screen>
       </para>
@@ -261 +261 @@
       
       <para>
-        For more details, please see <filename>initscripts/mysql/README.mysql</filename>.
+        For more details, please see <filename>initscripts/mysql/README.postgresql</filename>.
       </para>
       
@@ -479 +479 @@
         is waiting for your connections, you have to create the print quota database.
         To do so, you'll have to feed <application>MySQL</application> with the
-        <filename>pykota-1.24_official/initscripts/mysql/pykota-mysql.sql</filename> file.
+        <filename>pykota-1.25_official/initscripts/mysql/pykota-mysql.sql</filename> file.
         This file will create an empty
         print quota database and set some permissions on it. 
@@ -506 +506 @@
         From a command line interpreter (i.e. shell), type the following commands :
         <screen>
-jerome@nordine:~$ cd pykota-1.24_official/initscripts/mysql
-jerome@nordine:~/pykota-1.24_official/initscripts$ mysql &lt;pykota-mysql.sql
+jerome@nordine:~$ cd pykota-1.25_official/initscripts/mysql
+jerome@nordine:~/pykota-1.25_official/initscripts$ mysql &lt;pykota-mysql.sql
         </screen>
         <note>
@@ -642 +642 @@
         <listitem>
           <para>
-            <application>CUPS</application> version 1.1.14 or above.
+            <application>CUPS</application> version 1.1.14 or higher, version 1.2.4 or higher
+            is recommanded.
             You can download it from <ulink url="http://www.cups.org">http://www.cups.org</ulink>
           </para>
@@ -648 +649 @@
         <listitem>
           <para>
-            <application>Python</application> version 2.2 or above.
+            <application>Python</application> version 2.3 or higher.
             You can download it from <ulink url="http://www.python.org">http://www.python.org</ulink>.
             While <application>PyKota</application> itself will try to preserve compatibility
-            with <application>Python</application> version 2.2 for the near future, some <application>Python</application>
+            with <application>Python</application> version 2.3 for the near future, some <application>Python</application>
             modules which are needed by <application>PyKota</application> may require a more recent version
             of this language.
@@ -757 +758 @@
             the <command>snmpget</command> command.
             You can download this software from <ulink url="http://www.sourceforge.net/projects/net-snmp/">http://www.sourceforge.net/projects/net-snmp/</ulink>.
-            You only need this if you plan to query your printers for their internal page counter via SNMP.
+            You only need this if PyKota's internal SNMP accounting code doesn't work for your SNMP-aware
+            printers.
           </para>
         </listitem>  
@@ -784 +786 @@
         <listitem>
           <para>
-            The <application>pysnmp</application> Python module version 3.4.2, or higher. 
+            The <application>pysnmp</application> Python module version 3.4.2, or higher, version 4 is recommanded.
             You can download it from <ulink url="http://pysnmp.sourceforge.net">http://pysnmp.sourceforge.net</ulink>.
           </para>
@@ -815 +817 @@
           <para>
             The <application>pkpgcounter</application> Generic Page Description Language parser. 
-            You can download it from <ulink url="http://www.pykota.com.com/software/pkpgcounter">http://www.pykota.com.com/software/pkpgcounter</ulink>.
+            You can download it from <ulink url="http://www.pykota.com.com/software/pkpgcounter">http://www.pykota.com/software/pkpgcounter</ulink>.
           </para>
         </listitem>  
@@ -935 +937 @@
       to give the correct permissions to <application>PyKota</application>'s configuration files :
       <screen>
-$ chown pykota.pykota ~pykota/pykota.conf      
+$ chown -R pykota.pykota ~pykota/      
+$ chmod 750 ~pykota/
 $ chmod 644 ~pykota/pykota.conf      
-$ chown pykota.pykota ~pykota/pykotadmin.conf      
 $ chmod 640 ~pykota/pykotadmin.conf      
       </screen>
@@ -954 +956 @@
       On some systems, you may be able to strenghten permissions like this :
       <screen>
-$ chown pykota.pykota ~pykota/pykota.conf      
+$ chown -R pykota.pykota ~pykota/      
+$ chmod 750 ~pykota/
 $ chmod 640 ~pykota/pykota.conf      
-$ chown pykota.pykota ~pykota/pykotadmin.conf      
 $ chmod 600 ~pykota/pykotadmin.conf      
       </screen>
@@ -964 +966 @@
       And on other ones, you may need to relax them, and change the files' owner :
       <screen>
+$ chown pykota.pykota ~pykota/      
+$ chmod 755 ~pykota/
 $ chown lp.pykota ~pykota/pykota.conf      
 $ chmod 640 ~pykota/pykota.conf      
@@ -1029 +1033 @@
       
       <para>
-        If you use CUPS v1.2 or higher, it is recommended that you
+        If you use CUPS v1.2 or higher, you must
         also type the following command to allow the <command>cupspykota</command>
         backend to correctly support other backends which must be run

pykota/trunk/docs/pkinvoice.sgml

@@ -12 +12 @@
   <para>
     You'll be allowed to optionally filter the data extraction based on starting and ending dates, which
-    defaults to the complete history,
-    and a set of usernames, which defaults to all users.
+    defaults to the complete history, user, printer, client hostname, etc...
   </para>
   

pykota/trunk/docs/pykota.sgml

@@ -20 +20 @@
   <!entity PKNOTIFY system "pknotify.sgml">
   <!entity PKINVOICE system "pkinvoice.sgml">
+  <!entity PKREFUND system "pkrefund.sgml">
   <!entity GNUGPL system "gnugpl.sgml">
 
@@ -145 +146 @@
   &PKINVOICE;
   
+  &PKREFUND;
+  
   &PKBANNER;