root / pykota / trunk / docs / pkbcodes.sgml @ 2553

Revision 2553, 2.1 kB (checked in by jerome, 19 years ago)

Improved pkbcodes' documentation.

  • Property svn:keywords set to Author Date Id Revision
Line 
1<!-- $Id$ -->
2
3<chapter>
4  <title>Manage billing codes with pkbcodes</title>
5  <para>Last modified on $Date$</para>
6 
7  <para>
8    Some people like lawyers for example need to be able to invoice their own clients
9    for printouts. To address such needs, <application>CUPS</application> features
10    the possibility to attach a particular billing code to each print job, and of course,
11    <application>PyKota</application> can make use of it.
12  </para> 
13 
14  <para>
15    To use a billing code when printing, you have to pass an additionnal argument to the
16    <command>lp</command> command, for example for a client named <literal>smith</literal>
17    this could be something like :
18    <screen>
19$ lp -o job-billing=smith the_file_to_print.ps
20    </screen>
21  </para>
22 
23  <para>
24    For <application>PyKota</application> to be able to maintain statistics
25    per billing code, you first have to add these billing codes to <application>PyKota</application>'s
26    database. This is the main goal of the <command>pkbcodes</command> command line tool.
27  </para>
28 
29  <para>
30    But <command>pkbcodes</command> also allows you to add a textual description to each billing
31    code, to delete them, to reset billing code specific counters, and finally to list
32    existing billing codes.
33  </para>
34 
35  <sect1>
36    <title>Reference</title>
37    <para>
38      <cmdsynopsis>
39        <command>pkbcodes</command>
40        <group choice="opt"><arg>-v</arg><arg>--version</arg></group>
41        <group choice="opt"><arg>-h</arg><arg>--help</arg></group>
42        <group choice="opt"><arg>-a</arg><arg>--add</arg></group>
43        <group choice="opt"><arg>-d</arg><arg>--delete</arg></group>
44        <group choice="opt">
45          <arg>-D <replaceable>desc</replaceable></arg>
46          <arg>--description <replaceable>desc</replaceable></arg>
47        </group>
48        <group choice="opt"><arg>-l</arg><arg>--list</arg></group>
49        <group choice="opt"><arg>-r</arg><arg>--reset</arg></group>
50        <group choice="opt"><arg>-s</arg><arg>--skipexisting</arg></group>
51      </cmdsynopsis>
52    </para>
53  </sect1>
54</chapter>
55
Note: See TracBrowser for help on using the browser.