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

<!-- $Id$ -->

<chapter>
  <title id="pykotme">Get print quotes before printing for real with <command>pykotme</command></title>
  <para>Last modified on $Date$</para>
  
  <para>
    PyKota features a print quote generator, named <command>pykotme</command>.
    This command line tool can be used to learn in advance how much a print job
    will cost to you if you really send it to a printer.
    You can then decide if printing your document is a good idea or not, and do it
    knowingly.
  </para>
  
  <para>
    To get a print quote, you have to launch <command>pykotme</command>
    from the command line, passing your print job's content in the PostScript
    format, either in the form of one or more file names on the command line,
    or on its standard input (i.e. in a shell pipe or redirection).
  </para>
  
  <para>
    Without any command line argument, <command>pykotme</command>
    automatically reads your job's data from its standard input.
  </para>
  
  <para>
    By default, <command>pykotme</command>
    will display a quote for your job on all printers. You can restrict
    this by using the <literal>-p | --printer</literal> command line
    option followed with either a printer's name or a wildcard
    which will be used to search all printers which name matches.
    You can pass more than one printer name wildcard, separating
    them with commas.
  </para>
  
  <sect1>
    <title>Examples</title>
    <para>
      Here are some examples of <command>pykotme</command> usage.
    </para>
    
    <para>
      The simplest form :
<screen>    
port50-2:~$ pykotme pykota.ps
Your account balance : 16.25
Job size : 22 pages
Cost on printer apple : 1.35
port50-2:~$ 
</screen>    
    </para>
    
    <para>
      More complex, with printer name wildcard and within a pipe :
<screen>      
port50-2:~$ a2ps -o - pykota/README | pykotme --printer "a*"
[pykota/README (plain): 6 pages on 3 sheets]
[Total: 6 pages on 3 sheets] sent to the standard output
Your account balance : 16.25
Job size : 3 pages
Cost on printer apple : 0.40
port50-2:~$ 
</screen>
    </para>
  </sect1>
  
  <sect1>
    <title>Reference</title>
    <para>
      <cmdsynopsis>
        <command>pykotme</command>
        <group choice="opt"><arg>-v</arg><arg>--version</arg></group>
        <group choice="opt"><arg>-h</arg><arg>--help</arg></group>
        <group choice="opt">
          <arg>-P <replaceable>printername</replaceable></arg>
          <arg>--printer <replaceable>printername</replaceable></arg>
        </group>  
        <group choice="opt">
          <arg><replaceable>filename1</replaceable></arg>
          <arg><replaceable>filename2</replaceable></arg>
          <arg><replaceable>...</replaceable></arg>
          <arg><replaceable>filenameN</replaceable></arg>
        </group>  
      </cmdsynopsis>
    </para>
  </sect1>
</chapter>

<!--

$Log$
Revision 1.6  2005/02/28 00:07:37  jalet
Added pkmail's doc.
Used the <command> tag instead of <application> for commands.
Fixed some typos.
Added some missing command line options in the commands reference.

Revision 1.5  2003/10/12 20:47:51  jalet
Doc enhanced.

Revision 1.4  2003/07/25 13:18:44  jalet
Typos

Revision 1.3  2003/07/25 13:16:44  jalet
Typo

Revision 1.2  2003/07/25 13:10:58  jalet
Improved documentation

Revision 1.1  2003/07/25 10:41:30  jalet
Better documentation.
pykotme now displays the current user's account balance.
Some test changed in ldap module.


-->