Changeset 2551 for pykota

Show
Ignore:
Timestamp:
10/09/05 22:39:06 (19 years ago)
Author:
jerome
Message:

Replaced some 'filename' tags with 'command' tags.
Improved pkbcodes' documentation.

Location:
pykota/trunk/docs
Files:
12 modified

Legend:

Unmodified
Added
Removed
  • pykota/trunk/docs/dumpykota.sgml

    r2478 r2551  
    8888  <para> 
    8989    Finally, <command>dumpykota</command>'s functionnality is now also available remotely through 
    90     the use of the <filename>dumpykota.cgi</filename> <acronym>CGI</acronym> script. 
     90    the use of the <command>dumpykota.cgi</command> <acronym>CGI</acronym> script. 
    9191  </para> 
    9292   
  • pykota/trunk/docs/filterpykota.sgml

    r2478 r2551  
    2222    A filter is a computer program which takes data in one format as its input, and outputs the 
    2323    same data but transformed into another format. <application>CUPS</application> already 
    24     contains many filters. For example there's one filter named <filename>pstops</filename> which accepts  
     24    contains many filters. For example there's one filter named <command>pstops</command> which accepts  
    2525    PostScript data as its input, and, as its name implies, outputs PostScript data too, but after having 
    2626    eventually rearranged the pages to fit several pages on a single sheet of paper, or other manipulations 
     
    2929   
    3030  <para> 
    31     The <filename>pstops</filename> filter described above is also in charge of doing basic page 
     31    The <command>pstops</command> filter described above is also in charge of doing basic page 
    3232    accounting, but <application>PyKota</application> currently doesn't use this facility since it may 
    3333    prove to be unreliable depending on the drivers used or if a paper jam occurs for example. 
     
    3636  <para> 
    3737    So to do its own accounting, <application>PyKota</application> has its own filters, for <application>CUPS</application> 
    38     it's named <filename>cupspykota</filename>, which is in fact a <application>CUPS</application> backends wrapper. 
     38    it's named <command>cupspykota</command>, which is in fact a <application>CUPS</application> backends wrapper. 
    3939    The procedure to plug the correct filter into your printing system is described in the  
    4040    <xref linkend="installation" endterm="installation"> chapter. 
     
    4242   
    4343  <para> 
    44     Currently with a <application>CUPS</application> internal accounting mechanism, the <filename>pstops</filename> 
     44    Currently with a <application>CUPS</application> internal accounting mechanism, the <command>pstops</command> 
    4545    filter can be bypassed. That's why <application>PyKota</application> uses its own backend. 
    46     The <filename>cupspykota</filename> backend wrapper ensures that jobs can't bypass it, so you can use 
     46    The <command>cupspykota</command> backend wrapper ensures that jobs can't bypass it, so you can use 
    4747    any printer with any driver and any command line option, and you can be sure that your 
    4848    print job will be correctly accounted for. 
  • pykota/trunk/docs/installation.sgml

    r2478 r2551  
    606606     
    607607    <para> 
    608        You can check that all needed software is installed by launching the <filename>checkdeps.py</filename> 
     608       You can check that all needed software is installed by launching the <command>checkdeps.py</command> 
    609609       command : 
    610610      <screen>       
     
    771771       
    772772      <para> 
    773         You just have to create a symbolic link to the <filename>cupspykota</filename> 
     773        You just have to create a symbolic link to the <command>cupspykota</command> 
    774774        command in <application>CUPS</application>' backend directory : 
    775775        <screen>         
  • pykota/trunk/docs/introduction.sgml

    r2540 r2551  
    109109        <listitem> 
    110110          <para> 
    111             A generic <acronym>CUPS</acronym> backend wrapper, named <filename>cupspykota</filename> : 
     111            A generic <acronym>CUPS</acronym> backend wrapper, named <command>cupspykota</command> : 
    112112            this software captures all print jobs passing through the print queues it manages, 
    113113            and does the accounting and quota checking. It can reject print jobs in a number 
     
    129129              <listitem> 
    130130                <para> 
    131                   <filename>pkturnkey</filename> : to help you do the initial 
     131                  <command>pkturnkey</command> : to help you do the initial 
    132132                  configuration and database initialization. This command almost transforms <application>PyKota</application> 
    133133                  into a turn-key solution, hence the name. 
     
    136136              <listitem> 
    137137                <para> 
    138                   <filename>pkprinters</filename> : to manage printers and printers groups. 
    139                 </para> 
    140               </listitem>   
    141               <listitem> 
    142                 <para> 
    143                   <filename>edpykota</filename> : to manage users, users groups and quotas. 
    144                 </para> 
    145               </listitem>   
    146               <listitem> 
    147                 <para> 
    148                   <filename>pkbcodes</filename> : to manage billing codes. 
    149                 </para> 
    150               </listitem>   
    151               <listitem> 
    152                 <para> 
    153                   <filename>repykota</filename> : to do some basic print quota reporting. 
    154                 </para> 
    155               </listitem>   
    156               <listitem> 
    157                 <para> 
    158                    <filename>dumpykota</filename> : to dump the database's contents in a portable 
     138                  <command>pkprinters</command> : to manage printers and printers groups. 
     139                </para> 
     140              </listitem>   
     141              <listitem> 
     142                <para> 
     143                  <command>edpykota</command> : to manage users, users groups and quotas. 
     144                </para> 
     145              </listitem>   
     146              <listitem> 
     147                <para> 
     148                  <command>pkbcodes</command> : to manage billing codes. 
     149                </para> 
     150              </listitem>   
     151              <listitem> 
     152                <para> 
     153                  <command>repykota</command> : to do some basic print quota reporting. 
     154                </para> 
     155              </listitem>   
     156              <listitem> 
     157                <para> 
     158                   <command>dumpykota</command> : to dump the database's contents in a portable 
    159159                   way. This command can be used to export <application>PyKota</application>'s 
    160160                   datas to third party software, like print log analyzers or spreadsheets, and 
     
    164164              <listitem> 
    165165                <para> 
    166                    <filename>autopykota</filename> : to automate the creation of user print accounts on 
     166                   <command>autopykota</command> : to automate the creation of user print accounts on 
    167167                   first print. This command is not meant to be used from the command line, but 
    168168                   instead from <filename>pykota.conf</filename>'s <literal>policy</literal> directive. 
     
    171171              <listitem> 
    172172                <para> 
    173                   <filename>pykosd</filename> : to display their remaining credits or 
     173                  <command>pykosd</command> : to display their remaining credits or 
    174174                  pages to end users. This is an <acronym>OSD</acronym> <footnote><para>On Screen Display</para></footnote> 
    175175                  application which works under the X Window system. 
     
    178178              <listitem> 
    179179                <para> 
    180                   <filename>pykotme</filename> : to give detailed quotes to end users before they print, this way 
     180                  <command>pykotme</command> : to give detailed quotes to end users before they print, this way 
    181181                  they know in advance how much a print job will cost to them and can decide to route it to 
    182182                  a less costly printer. 
     
    185185              <listitem> 
    186186                <para> 
    187                    <filename>pkbanner</filename> : to generate dynamic banner pages when printing. 
     187                   <command>pkbanner</command> : to generate dynamic banner pages when printing. 
    188188                   This command is 
    189189                   not meant to be used from the command line, but 
     
    195195              <listitem> 
    196196                <para> 
    197                   <filename>warnpykota</filename> : to warn users over quota from time to time, for example 
     197                  <command>warnpykota</command> : to warn users over quota from time to time, for example 
    198198                  from <filename>crontab</filename>. Users are warned while printing in any case, so 
    199199                  this command is meant to be used as a periodic reminder. 
     
    202202              <listitem> 
    203203                <para> 
    204                   <filename>pkmail</filename> : to let users obtain their print quota situation by email. 
     204                  <command>pkmail</command> : to let users obtain their print quota situation by email. 
    205205                  In the future other functionnalities will be added. 
    206206                  This command is not meant to be used from the command line, but 
     
    220220              <listitem> 
    221221                <para> 
    222                   <filename>printquota.cgi</filename> : to do basic print quota reports like repykota,  
     222                  <command>printquota.cgi</command> : to do basic print quota reports like repykota,  
    223223                  and also to examine the printing history, which is not possible with repykota for now. 
    224224                </para> 
     
    226226              <listitem> 
    227227                <para> 
    228                   <filename>dumpykota.cgi</filename> : identical to the <filename>dumpykota</filename> 
     228                  <command>dumpykota.cgi</command> : identical to the <command>dumpykota</command> 
    229229                  command line tool, but works from within a web browser. 
    230230                </para> 
     
    232232              <listitem> 
    233233                <para> 
    234                   <filename>pykotme.cgi</filename> : identical to the <filename>pykotme</filename> 
     234                  <command>pykotme.cgi</command> : identical to the <command>pykotme</command> 
    235235                  command line tool, but works from within a web browser. 
    236236                </para> 
  • pykota/trunk/docs/pkbcodes.sgml

    r2541 r2551  
    66   
    77  <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. 
    812  </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> 
    934   
    1035  <sect1> 
     
    1237    <para> 
    1338      <cmdsynopsis> 
    14         <command>pkmail</command> 
     39        <command>pkbcodes</command> 
    1540        <group choice="opt"><arg>-v</arg><arg>--version</arg></group> 
    1641        <group choice="opt"><arg>-h</arg><arg>--help</arg></group> 
  • pykota/trunk/docs/pkmail.sgml

    r2147 r2551  
    1 <!-- $Id: --> 
     1<!-- $Id$ --> 
    22 
    33<chapter> 
  • pykota/trunk/docs/pkprinters.sgml

    r2550 r2551  
    66   
    77  <para> 
    8     <filename>pkprinters</filename> is the preferred tool to manage printers in <application>PyKota</application>.   
     8    <command>pkprinters</command> is the preferred tool to manage printers in <application>PyKota</application>.   
    99    It only manages printers, and do it well. With it you can add or delete printers or printer groups, or modify 
    1010    existing printers or printers groups. This is also the tool to use to put printers into one or more printers groups. 
     
    1515    is to add into <application>PyKota</application>'s database an entry for each of the print queues on 
    1616    which you want to have print quota or accounting. 
    17     Although the <filename>pkturnkey</filename> command can be used to initialize your database and import 
    18     printers into it, the <filename>pkprinters</filename> command offers additionnal functionnalities 
     17    Although the <command>pkturnkey</command> command can be used to initialize your database and import 
     18    printers into it, the <command>pkprinters</command> command offers additionnal functionnalities 
    1919    like full management of printers. 
    2020  </para> 
  • pykota/trunk/docs/pkturnkey.sgml

    r2541 r2551  
    1 <!-- $Id: --> 
     1<!-- $Id$ --> 
    22 
    33<chapter> 
  • pykota/trunk/docs/pykosd.sgml

    r2147 r2551  
    66   
    77  <para> 
    8     <filename>pykosd</filename> is a graphical <application>X Window</application> application which when launched  
     8    <command>pykosd</command> is a graphical <application>X Window</application> application which when launched  
    99    will display print quota information for the current user. 
    1010  </para>   
    1111   
    1212  <para> 
    13     Whenever you launch <filename>pykosd</filename>, it will display the current user's print quota 
     13    Whenever you launch <command>pykosd</command>, it will display the current user's print quota 
    1414    information in the top-left corner of the screen, above all existing windows, and with 
    1515    a transparent background.  
  • pykota/trunk/docs/pykotme.sgml

    r2381 r2551  
    4141  <para> 
    4242    <command>pykotme</command>'s functionnality is also available through the 
    43     use of the <filename>pykotme.cgi</filename> <acronym>CGI</acronym> script. 
    44     However without authentication <filename>pykotme.cgi</filename> will only 
     43    use of the <command>pykotme.cgi</command> <acronym>CGI</acronym> script. 
     44    However without authentication <command>pykotme.cgi</command> will only 
    4545    return the print job's size and not its cost, because the cost depends on 
    4646    the value of the user's overcharging factor and the printer being used.  
     
    4848    obtain the same functionnality with the <acronym>CGI</acronym> script than  
    4949    with the command line tool, you must configure your web server to force 
    50     users to authenticate whevenver they access to <filename>pykotme.cgi</filename>. 
     50    users to authenticate whevenver they access to <command>pykotme.cgi</command>. 
    5151    Then they will be able to choose one or more printers (all by default),  
    5252    and also to enter their username, 
  • pykota/trunk/docs/repykota.sgml

    r2147 r2551  
    8383    <para> 
    8484      <application>PyKota</application> also features a CGI script to remotely access 
    85       to print quota reports with a web browser, it is called <filename>printquota.cgi</filename> 
     85      to print quota reports with a web browser, it is called <command>printquota.cgi</command> 
    8686      and you can put it in your web server's <filename>cgi-bin</filename> directory if a web server is installed on 
    8787      any machine on which <application>PyKota</application> is also installed and configured 
     
    9797     
    9898    <para> 
    99       You can find <filename>printquota.cgi</filename> in the <filename>pykota/cgi-bin</filename> 
     99      You can find <command>printquota.cgi</command> in the <filename>pykota/cgi-bin</filename> 
    100100      directory. Here's how to install it, provided that your web server's <filename>cgi-bin</filename> 
    101101      directory is <filename>/usr/lib/cgi-bin</filename> : 
  • pykota/trunk/docs/scripts.sgml

    r2147 r2551  
    2828     
    2929    <para> 
    30       <filename>waitprinter.sh</filename> can be used to be sure that <application>PyKota</application> 
     30      <command>waitprinter.sh</command> can be used to be sure that <application>PyKota</application> 
    3131      waits until no job is being printed, and no paper sheet is travelling inside the printer.  
    3232    </para> 
     
    5656     
    5757    <para> 
    58       <filename>papwaitprinter.sh</filename> can be used to be sure that <application>PyKota</application> 
     58      <command>papwaitprinter.sh</command> can be used to be sure that <application>PyKota</application> 
    5959      waits until no job is being printed, and no paper sheet is travelling inside the printer.  
    6060    </para>