root / pykota / trunk / docs / pykotme.sgml @ 2101

Revision 1166, 3.2 kB (checked in by jalet, 21 years ago)

Doc enhanced.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1<!-- $Id$ -->
2
3<chapter>
4  <title id="pykotme">Get print quotes before printing for real with <application>pykotme</application></title>
5  <para>Last modified on $Date$</para>
6 
7  <para>
8    PyKota features a print quote generator, named <application>pykotme</application>.
9    This command line tool can be used to learn in advance how much a print job
10    will cost to you if you really send it to a printer.
11    You can then decide if printing your document is a good idea or not, and do it
12    knowingly.
13  </para>
14 
15  <para>
16    To get a print quote, you have to launch <application>pykotme</application>
17    from the command line, passing your print job's content in the PostScript
18    format, either in the form of one or more file names on the command line,
19    or on its standard input (i.e. in a shell pipe or redirection).
20  </para>
21 
22  <para>
23    Without any command line argument, <application>pykotme</application>
24    automatically reads your job's data from its standard input.
25  </para>
26 
27  <para>
28    By default, <application>pykotme</application>
29    will display a quote for your job on all printers. You can restrict
30    this by using the <literal>-p | --printer</literal> command line
31    option followed with either a printer's name or a wildcard
32    which will be used to search all printers which name matches.
33    You can pass more than one printer name wildcard, separating
34    them with commas.
35  </para>
36 
37  <sect1>
38    <title>Examples</title>
39    <para>
40      Here are some examples of <application>pykotme</application> usage.
41    </para>
42   
43    <para>
44      The simplest form :
45<screen>    
46port50-2:~$ pykotme pykota.ps
47Your account balance : 16.25
48Job size : 22 pages
49Cost on printer apple : 1.35
50port50-2:~$
51</screen>   
52    </para>
53   
54    <para>
55      More complex, with printer name wildcard and within a pipe :
56<screen>      
57port50-2:~$ a2ps -o - pykota/README | pykotme --printer "a*"
58[pykota/README (plain): 6 pages on 3 sheets]
59[Total: 6 pages on 3 sheets] sent to the standard output
60Your account balance : 16.25
61Job size : 3 pages
62Cost on printer apple : 0.40
63port50-2:~$
64</screen>
65    </para>
66  </sect1>
67 
68  <sect1>
69    <title>Reference</title>
70    <para>
71      <cmdsynopsis>
72        <command>pykotme</command>
73        <group choice="opt"><arg>-v</arg><arg>--version</arg></group>
74        <group choice="opt"><arg>-h</arg><arg>--help</arg></group>
75        <group choice="opt">
76          <arg>-P <replaceable>printername</replaceable></arg>
77          <arg>--printer <replaceable>printername</replaceable></arg>
78        </group> 
79        <group choice="opt">
80          <arg><replaceable>filename1</replaceable></arg>
81          <arg><replaceable>filename2</replaceable></arg>
82          <arg><replaceable>...</replaceable></arg>
83          <arg><replaceable>filenameN</replaceable></arg>
84        </group> 
85      </cmdsynopsis>
86    </para>
87  </sect1>
88</chapter>
89
90<!--
91
92$Log$
93Revision 1.5  2003/10/12 20:47:51  jalet
94Doc enhanced.
95
96Revision 1.4  2003/07/25 13:18:44  jalet
97Typos
98
99Revision 1.3  2003/07/25 13:16:44  jalet
100Typo
101
102Revision 1.2  2003/07/25 13:10:58  jalet
103Improved documentation
104
105Revision 1.1  2003/07/25 10:41:30  jalet
106Better documentation.
107pykotme now displays the current user's account balance.
108Some test changed in ldap module.
109
110
111-->
Note: See TracBrowser for help on using the browser.