Changeset 865

Show
Ignore:
Timestamp:
03/25/03 10:32:06 (22 years ago)
Author:
jalet
Message:

Improved documentation.

Location:
pykota/trunk/docs
Files:
6 modified

Legend:

Unmodified
Added
Removed

  • pykota/trunk/docs/edpykota.sgml

    r753 r865  
    22 
    33<chapter> 
    4   <title>TODO : Title here</title> 
     4  <title id="edpykota">Setting print quotas with edpykota</title> 
     5  <para>Last modified on $Date$</para> 
     6   
    57  <para> 
    68    TODO : blah 
    … …  
    1113 
    1214$Log$ 
     15Revision 1.2  2003/03/25 09:32:06  jalet 
     16Improved documentation. 
     17 
    1318Revision 1.1  2003/02/08 00:03:35  jalet 
    1419Documentation skeleton added 

  • pykota/trunk/docs/filterpykota.sgml

    r753 r865  
    22 
    33<chapter> 
    4   <title>TODO : Title here</title> 
     4  <title id="filter">The pykota filter</title> 
     5   
     6  <para>Last modified on $Date$</para> 
     7   
    58  <para> 
    6     TODO : blah 
     9    To account for pages or eventually ink usage, you must plug your accounting 
     10    system into <application>CUPS</application>. One way to do this without having 
     11    to modify <application>CUPS</application> itself, is by using a <firstterm>filter</firstterm>. 
    712  </para> 
     13   
     14  <para> 
     15    A filter is a computer program which takes data in one format as its input, and outputs the 
     16    same data but transformed into another format. <application>CUPS</application> already 
     17    contains many filters. For example there's one filter named <application>pstops</application> which accepts  
     18    PostScript data as its input, and, as its name implies, outputs PostScript data too, but after having 
     19    eventually rearranged the pages to fit several pages on a single sheet of paper, or other manipulations 
     20    like that. 
     21  </para> 
     22   
     23  <para> 
     24    The <application>pstops</application> filter described above is also in charge of doing basic page 
     25    accounting, but <application>PyKota</application> currently doesn't use this facility since it may 
     26    prove to be unreliable depending on the drivers used or if a paper jam occur for example. 
     27  </para> 
     28   
     29  <para> 
     30    So to do its own accounting, <application>PyKota</application> has its own filter, named <application>pykota</application>, 
     31    which you have to plug into the different set of filters used by <application>CUPS</application>. The procedure to  
     32    install the <application>pykota</application> filter is described in the  
     33    <xref linkend="installation" endterm="installation"> chapter. 
     34  </para> 
     35   
     36  <para> 
     37    Currently the <application>pykota</application> filter is used at the very last stage of the print mechanism, 
     38    just before the final data is sent to the printer, but it may eventually be used earlier with some 
     39    modifications to <application>CUPS</application>'s filtering configuration. This is not tested yet, but this 
     40    may be the solution to use <application>PyKota</application> with printers which really needs to have 
     41    a <literal>*cupsFilter</literal> line in their <acronym>PPD</acronym> file, i.e. non-postscript printers. 
     42  </para> 
     43   
     44  <para> 
     45    The <application>pykota</application> filter really is the only thing which depends on <application>CUPS</application>, 
     46    so it is probable that a next version of <application>PyKota</application> will support other printing environments. 
     47  </para> 
     48   
    849</chapter> 
    950 
    … …  
    1152 
    1253$Log$ 
     54Revision 1.2  2003/03/25 09:32:06  jalet 
     55Improved documentation. 
     56 
    1357Revision 1.1  2003/02/08 00:03:35  jalet 
    1458Documentation skeleton added 

  • pykota/trunk/docs/installation.sgml

    r864 r865  
    22 
    33<chapter> 
    4   <title>Installation</title> 
     4  <title id="installation">Installation</title> 
    55   
    66  <para>Last modified on $Date$</para> 
    … …  
    358358 
    359359$Log$ 
     360Revision 1.11  2003/03/25 09:32:06  jalet 
     361Improved documentation. 
     362 
    360363Revision 1.10  2003/03/23 17:59:56  jalet 
    361364Clarify a point. 

  • pykota/trunk/docs/pykota.sgml

    r857 r865  
    8080  &INSTALLATION; 
    8181 
     82  &FILTERPYKOTA; 
     83 
    8284  &EDPYKOTA; 
    8385     
    … …  
    8688  &WARNPYKOTA; 
    8789     
    88   &FILTERPYKOTA; 
    89  
    9090  &GNUFDL; 
    9191 
    … …  
    9595 
    9696$Log$ 
     97Revision 1.4  2003/03/25 09:32:06  jalet 
     98Improved documentation. 
     99 
    97100Revision 1.3  2003/03/18 22:18:25  jalet 
    98101The documentation will only be a sequence of chapters in a single part, not 

  • pykota/trunk/docs/repykota.sgml

    r836 r865  
    22 
    33<chapter> 
    4   <title>Print Quota usage reports</title> 
    5   <subtitle><application>repykota</application></subtitle> 
     4  <title id="repykota">Create print quota usage reports with repykota</title> 
     5  <para>Last modified on $Date$</para> 
    66   
    77  <para> 
    … …  
    3535 
    3636$Log$ 
     37Revision 1.3  2003/03/25 09:32:06  jalet 
     38Improved documentation. 
     39 
    3740Revision 1.2  2003/03/08 22:22:40  jalet 
    3841First bit of documentation 

  • pykota/trunk/docs/warnpykota.sgml

    r753 r865  
    22 
    33<chapter> 
    4   <title>TODO : Title here</title> 
     4  <title>Warn users above print quota with warnpykota</title> 
     5  <para>Last modified on $Date$</para> 
    56  <para> 
    67    TODO : blah 
    … …  
    1112 
    1213$Log$ 
     14Revision 1.2  2003/03/25 09:32:06  jalet 
     15Improved documentation. 
     16 
    1317Revision 1.1  2003/02/08 00:03:35  jalet 
    1418Documentation skeleton added