Changeset 2551 for pykota/trunk/docs/pkbcodes.sgml

Timestamp:

10/09/05 22:39:06 (19 years ago)

Author:

jerome

Message:

Replaced some 'filename' tags with 'command' tags.
Improved pkbcodes' documentation.

Files:

• pykota/trunk/docs/pkbcodes.sgml (modified) (2 diffs)

pykota/trunk/docs/pkbcodes.sgml

@@ -6 +6 @@
   
   <para>
+    Some people like lawyers for example need to be able to invoice their own clients
+    for printouts. To address such needs, <application>CUPS</application> features
+    the possibility to attach a particular billing code to each print job, and of course,
+    <application>PyKota</application> can make use of it.
   </para>  
+  
+  <para>
+    To use a billing code when printing, you have to pass an additionnal argument to the 
+    <command>lp</command> command, for example for a client named <literal>smith</literal>
+    this could be something like :
+    <screen>
+$ lp -o job-billing=smith the_file_to_print.ps
+    </screen>
+  </para>
+  
+  <para>
+    For <application>PyKota</application> to be able to maintain statistics
+    per billing code, you first have to add these billing codes to <application>PyKota</application>'s
+    database. This is the main goal of the <command>pkbcodes</command> command line tool.
+  </para>
+  
+  <para>
+    But <command>pkbcodes</command> also allows you to add a textual description to each billing
+    code, to delete them, to reset billing code specific counters, and finally to list
+    existing billing codes.
+  </para>
   
   <sect1>
@@ -12 +37 @@
     <para>
       <cmdsynopsis>
-        <command>pkmail</command>
+        <command>pkbcodes</command>
         <group choice="opt"><arg>-v</arg><arg>--version</arg></group>
         <group choice="opt"><arg>-h</arg><arg>--help</arg></group>