root / pykota / branches / specialauth / docs / pkbcodes.sgml @ 3527

Revision 2555, 2.8 kB (checked in by jerome, 19 years ago)

Finished (for now) 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  <para>
36    With the help of the <literal>unknown_billingcode</literal> directive in
37    <filename>pykota.conf</filename>, you can decide what happens when a billing
38    code is encountered when printing, and this billing code is not yet in
39    <application>PyKota</application>'s database. Automatically adding it to
40    the database is a common choice, which saves time for the <application>PyKota</application>
41    administrator.
42  </para>
43 
44  <para>
45    Finally, the <literal>overwrite_jobticket</literal> directive in
46    <filename>pykota.conf</filename> allows you to overwrite the job billing
47    information at the latest stage of printing, for example if the application used to print
48    doesn't allow end users to give a value to the billing code when submitting the print job.
49  </para>
50 
51  <sect1>
52    <title>Reference</title>
53    <para>
54      <cmdsynopsis>
55        <command>pkbcodes</command>
56        <group choice="opt"><arg>-v</arg><arg>--version</arg></group>
57        <group choice="opt"><arg>-h</arg><arg>--help</arg></group>
58        <group choice="opt"><arg>-a</arg><arg>--add</arg></group>
59        <group choice="opt"><arg>-d</arg><arg>--delete</arg></group>
60        <group choice="opt">
61          <arg>-D <replaceable>desc</replaceable></arg>
62          <arg>--description <replaceable>desc</replaceable></arg>
63        </group>
64        <group choice="opt"><arg>-l</arg><arg>--list</arg></group>
65        <group choice="opt"><arg>-r</arg><arg>--reset</arg></group>
66        <group choice="opt"><arg>-s</arg><arg>--skipexisting</arg></group>
67      </cmdsynopsis>
68    </para>
69  </sect1>
70</chapter>
71
Note: See TracBrowser for help on using the browser.