root / pykota / trunk / docs / pkbanner.sgml @ 3202

Revision 2561, 3.3 kB (checked in by jerome, 19 years ago)

Added pkbanner's documentation

  • Property svn:keywords set to Author Date Id Revision
Line 
1<!-- $Id$ -->
2
3<chapter>
4  <title>Generate banners with pkbanner</title>
5  <para>Last modified on $Date$</para>
6 
7  <para>
8    <application>CUPS</application> integrated bannering facility sucks because banners can only
9    be static PostScript files, even if they can include a few dynamic datas. Also it is possible
10    to have several banners and jobs mixed in an unexpected way because of the way <application>CUPS</application>
11    works.
12  </para> 
13 
14  <para>
15    To fix this problem for good, <application>PyKota</application> can use its own banners, which can be :
16    <itemizedlist>
17      <listitem>
18        <para>
19          Any static file, not only PostScript ones.
20        </para>
21      </listitem>
22      <listitem>
23        <para>
24          The output of any executable command of your choice, launched at printing time,
25          and to which are made available a bunch of environment variables which can help
26          your command create a purely dynamic banner on the fly. In particular your
27          command knows all about the status of the current user's print quota information.
28        </para>
29      </listitem>
30    </itemizedlist>
31  </para>
32 
33  <para>
34    Although you can use any command to generate banners for you, you can also use
35    the <command>pkbanner</command> command line tool which is included in <application>PyKota</application>.
36    It was designed for ease of use, without any compromise on its flexibility.
37  </para>
38 
39  <para>
40    For example <command>pkbanner</command> allows you to specify a particular logo and url to be
41    printed on the banner pages, as well as define a transparency factor to save toner while
42    printing banners. You can also choose a particular page size to use, as well as include
43    additionnal textual information on the banner page.
44  </para>
45 
46  <para>
47    <command>pkbanner</command> generates PostScript code, but <application>PyKota</application>
48    accepts that you pipe its output into any other command if you ever need to use
49    another file format for your printer.
50  </para>
51 
52  <para>
53    <command>pkbanner</command> is not meant to be launched from the command line though,
54    but only through the <literal>startingbanner</literal> and <literal>endingbanner</literal>
55    directives in <filename>pykota.conf</filename>.
56  </para>
57 
58  <sect1>
59    <title>Reference</title>
60    <para>
61      <cmdsynopsis>
62        <command>pkbanner</command>
63        <group choice="opt"><arg>-v</arg><arg>--version</arg></group>
64        <group choice="opt"><arg>-h</arg><arg>--help</arg></group>
65        <group choice="opt">
66          <arg>-l <replaceable>image</replaceable></arg>
67          <arg>--logo <replaceable>image</replaceable></arg>
68        </group> 
69        <group choice="opt">
70          <arg>-p <replaceable>size</replaceable></arg>
71          <arg>--pagesize <replaceable>size</replaceable></arg>
72        </group> 
73        <group choice="opt">
74          <arg>-s <replaceable>luminosity</replaceable></arg>
75          <arg>--savetoner <replaceable>luminosity</replaceable></arg>
76        </group> 
77        <group choice="opt">
78          <arg>-u <replaceable>link</replaceable></arg>
79          <arg>--url <replaceable>link</replaceable></arg>
80        </group> 
81        <group choice="opt">
82          <arg><replaceable>additionnal info</replaceable></arg>
83        </group>
84      </cmdsynopsis>
85    </para>
86  </sect1>
87</chapter>
88
Note: See TracBrowser for help on using the browser.