root / pykota / trunk / docs / pkhint.sgml @ 2045

Revision 1409, 2.0 kB (checked in by jalet, 21 years ago)

Added pkhint's documentation

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1<!-- $Id$ -->
2
3<chapter>
4  <title>Detects the best settings for your printers with pkhint</title>
5  <para>Last modified on $Date$</para>
6 
7  <para>
8    <filename>pkhint</filename> is an experimental command designed with the goal to
9    help you find the best <application>PyKota</application> settings for each of your
10    printers.
11  </para> 
12 
13  <para>
14    Currently <filename>pkhint</filename> only recognizes <application>CUPS</application>' <filename>printers.conf</filename>
15    file format, but <application>LPRng</application>' <filename>printcap</filename> file format support will be added
16    in the future.
17  </para>
18 
19  <para>
20    <filename>pkhint</filename> accepts optional printers names as its arguments, and reads your printing system's
21    printers configuration file from stdin. Then it launches different tests to see if your printers supports
22    some special features which would allow you to use either hardware or software accounting on them, with
23    a preference for hardware since it's more reliable. If it can help you, it will print some text which
24    you will be able to copy and paste into <filename>/etc/pykota/pykota.conf</filename>.
25  </para>
26 
27  <warning>
28    <title>Warning</title>
29    <para>
30      Because <filename>pkhint</filename> is still a work in progress, don't expect it to allow you
31      to fully configure <application>PyKota</application> for you. You'll still have to double
32      check that your configuration is correct.
33    </para>
34  </warning> 
35 
36  <sect1>
37    <title>Reference</title>
38    <para>
39      <cmdsynopsis>
40        <command>pkhint</command>
41        <group choice="opt"><arg>-v</arg><arg>--version</arg></group>
42        <group choice="opt"><arg>-h</arg><arg>--help</arg></group>
43        <arg choice="opt"><replaceable>printer1</replaceable></arg>
44        <arg choice="opt"><replaceable>printer2</replaceable></arg>
45        <arg choice="opt"><replaceable>...</replaceable></arg>
46      </cmdsynopsis>
47    </para>
48  </sect1>
49</chapter>
50
51<!--
52
53$Log$
54Revision 1.1  2004/03/18 10:32:23  jalet
55Added pkhint's documentation
56
57-->
Note: See TracBrowser for help on using the browser.