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.

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • 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>