Changeset 2115

Show
Ignore:
Timestamp:
02/28/05 01:07:37 (13 years ago)
Author:
jalet
Message:

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.

Location:
pykota/trunk/docs
Files:
1 added
9 modified

Legend:

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

    r1783 r2115  
    1313   
    1414  <para> 
    15     <application>autopykota</application> was designed to automatically set 
     15    <command>autopykota</command> was designed to automatically set 
    1616    an initial account balance value to newly added users, while taking 
    1717    care of not resetting the balance value if the user already exists  
     
    2121  <para> 
    2222    If you want to limit your users by page quota then you must not use 
    23     this command. Just use some form of the <application>edpykota</application> 
     23    this command. Just use some form of the <command>edpykota</command> 
    2424    command and it will work just fine. On the other hand, if you want 
    2525    to limit your users by their account balance, this command was 
     
    2727    script to check if user already exists or have a quota entry on 
    2828    the current printer before deciding if you have to set the initial 
    29     balance value or not : <application>autopykota</application> takes 
     29    balance value or not : <command>autopykota</command> takes 
    3030    care of all this automagically. 
    3131  </para> 
     
    5050 
    5151$Log$ 
     52Revision 1.2  2005/02/28 00:07:37  jalet 
     53Added pkmail's doc. 
     54Used the <command> tag instead of <application> for commands. 
     55Fixed some typos. 
     56Added some missing command line options in the commands reference. 
     57 
    5258Revision 1.1  2004/10/06 10:03:16  jalet 
    5359Improved documentation 
  • pykota/trunk/docs/dumpykota.sgml

    r1783 r2115  
    66   
    77  <para> 
    8     If you want to reuse <application>PyKota</application> datas in another 
     8    If you want to reuse <application>PyKota</application> datas from another 
    99    software, but don't want to modify your existing application to 
    1010    have it connect to <application>PyKota</application>'s database, your 
    11     best option is the new <application>dumpykota</application> command. 
     11    best option is the new <command>dumpykota</command> command. 
    1212  </para> 
    1313   
    1414  <para> 
    15     <application>dumpykota</application> can export <application>PyKota</application> 
     15    <command>dumpykota</command> can export <application>PyKota</application> 
    1616    datas in a number of formats. The supported output formats are 
    1717    comma separated values, semicolon separated values, tab separated values, and <acronym>XML</acronym>. 
     18  </para>   
     19   
     20  <para> 
     21    For the print job history's datas, a special format identical to <application>CUPS</application>' <literal>page_log</literal> 
     22    format is also supported. 
     23    This allows you to interface <application>PyKota</application> with third party tools like 
     24    <application>phpPrintAnalyzer</application> which is a logfile analyzer for <application>CUPS</application>, 
     25    even in the case where you use <application>LPRng</application> instead of <application>CUPS</application>. 
     26  </para>   
     27   
     28  <para> 
    1829    More formats may be added in the future. In particular,  
    1930    <acronym>SQL</acronym> and <acronym>LDIF</acronym> are planned, but  
     
    2233   
    2334  <para> 
    24     <application>dumpykota</application> can't dump all datas at once though, you have 
     35    <command>dumpykota</command> can't dump all datas at once though, you have 
    2536    to specify which type of datas you want. The possible types are : 
    2637    <itemizedlist> 
     
    4556  <para> 
    4657    This command could also be used if you plan to write your own management 
    47     tools : just write wrappers around the <application>pkprinters</application>, 
    48     <application>edpykota</application>, and <application>dumpykota</application> 
     58    tools : just write wrappers around the <command>pkprinters</command>, 
     59    <command>edpykota</command>, and <command>dumpykota</command> 
    4960    tools, and your own tools will automatically benefit from <application>PyKota</application> 
    5061    database backend independance layer. 
     62    This is exactly what the third party software <application>phpPykotaAdmin</application> does. 
     63  </para> 
     64   
     65  <para> 
     66    Finally, <command>dumpykota</command>'s functionnality is now also available remotely through 
     67    the use of the <filename>dumpykota.cgi</filename> <acronym>CGI</acronym> script. 
    5168  </para> 
    5269   
     
    85102 
    86103$Log$ 
     104Revision 1.3  2005/02/28 00:07:37  jalet 
     105Added pkmail's doc. 
     106Used the <command> tag instead of <application> for commands. 
     107Fixed some typos. 
     108Added some missing command line options in the commands reference. 
     109 
    87110Revision 1.2  2004/10/06 10:03:16  jalet 
    88111Improved documentation 
  • pykota/trunk/docs/edpykota.sgml

    r1782 r2115  
    66   
    77  <para> 
    8     <application>edpykota</application> is the command line tool with which you will  
     8    <command>edpykota</command> is the command line tool with which you will  
    99    maintain your print quota database. 
    1010  </para> 
     
    1616      <listitem> 
    1717        <para> 
    18           Add printers (it's preferable to use the <application>pkprinters</application> command for this though) ; 
     18          Add printers (it's preferable to use the <command>pkprinters</command> command for this though) ; 
    1919        </para> 
    2020      </listitem> 
  • pykota/trunk/docs/installation.sgml

    r1906 r2115  
    2929    have to decompress and visit its archive, to do so just type the following commands : 
    3030    <screen> 
    31 jerome@nordine:~$ tar -zxf pykota-1.20_official.tar.gz     
    32 jerome@nordine:~$ cd pykota-1.20_official 
    33 jerome@nordine:~/pykota-1.20_official$ 
     31jerome@nordine:~$ tar -zxf pykota-1.21_official.tar.gz     
     32jerome@nordine:~$ cd pykota-1.21_official 
     33jerome@nordine:~/pykota-1.21_official$ 
    3434    </screen> 
    3535  </para> 
     
    160160       
    161161      <para> 
    162         To run this script, you can use the <application>psql</application> frontend to 
     162        To run this script, you can use the <command>psql</command> frontend to 
    163163        <application>PostgreSQL</application>, but your priviledges must be sufficient 
    164         to be allowed to create users and databases. You can launch <application>psql</application> 
     164        to be allowed to create users and databases. You can launch <command>psql</command> 
    165165        as the <literal>postgres</literal> user which is <application>PostgreSQL</application>'s 
    166166        default administrator, and connect to the default database named <literal>template1</literal>. 
    167167        From a command line interpreter (i.e. shell), type the following commands : 
    168168        <screen> 
    169 jerome@nordine:~$ cd pykota-1.20_official/initscripts/postgresql 
    170 jerome@nordine:~/pykota-1.20_official/initscripts$ psql -h localhost -U postgres template1 
     169jerome@nordine:~$ cd pykota-1.21_official/initscripts/postgresql 
     170jerome@nordine:~/pykota-1.21_official/initscripts$ psql -h localhost -U postgres template1 
    171171Welcome to psql, the PostgreSQL interactive terminal. 
    172172 
     
    202202       
    203203      <para> 
    204         To do so, just type the following lines while still being at the <application>psql</application> 
     204        To do so, just type the following lines while still being at the <command>psql</command> 
    205205        prompt (replace the password values by your own, and do the same for the <literal>pykotauser</literal> user) : 
    206206        <screen> 
     
    208208ALTER USER 
    209209pykota=# \q 
    210 jerome@nordine:~/pykota-1.20_official/initscripts/postgresql$ 
     210jerome@nordine:~/pykota-1.21_official/initscripts/postgresql$ 
    211211        </screen> 
    212212      </para> 
    213213       
    214214      <para> 
    215         The <literal>\q</literal> command above will quit the <application>psql</application> 
     215        The <literal>\q</literal> command above will quit the <command>psql</command> 
    216216        program and return you to the shell's command line prompt. 
    217217      </para> 
     
    360360        difficult to guess what is the best configuration for you. So you have to 
    361361        create them by yourself, either directly with a text editor and the 
    362         <application>ldapadd</application> command, or with some specialized tool 
    363         like <application>gq</application>. You can look at the <filename>initscripts/ldap/pykota-sample.ldif</filename> 
     362        <command>ldapadd</command> command, or with some specialized tool 
     363        like <command>gq</command>. You can look at the <filename>initscripts/ldap/pykota-sample.ldif</filename> 
    364364        file to see what minimal branches are necessary. 
    365365        <note> 
     
    381381        <filename>pykota/conf/pykota.conf.sample</filename> to see all the options that are 
    382382        needed. Adapt the values to your own configuration, and finally initialize your  
    383         Quota Storage with the help of the <application>edpykota</application> command. 
     383        Quota Storage with the help of the <command>edpykota</command> command. 
    384384      </para> 
    385385    </sect2>   
     
    501501          <para> 
    502502            <application>ucd-snmp</application> or <application>net-snmp</application> tools, version 4.2.5 or above. You only need 
    503             the <application>snmpget</application> command. 
     503            the <command>snmpget</command> command. 
    504504            You can download this software from <ulink url="http://www.sourceforge.net/projects/net-snmp/">http://www.sourceforge.net/projects/net-snmp/</ulink>. 
    505505            You only need this if you plan to query your printers for their internal page counter via SNMP. 
     
    509509          <para> 
    510510            <application>netatalk</application> version 1.6.1 or above. You only need 
    511             the <application>pap</application> command. 
     511            the <command>pap</command> command. 
    512512            You can download this software from <ulink url="http://netatalk.sourceforge.net/">http://netatalk.sourceforge.net/</ulink>. 
    513513            You only need this if you plan to query your printers for their internal page counter via AppleTalk. 
     
    763763 
    764764$Log$ 
     765Revision 1.30  2005/02/28 00:07:37  jalet 
     766Added pkmail's doc. 
     767Used the <command> tag instead of <application> for commands. 
     768Fixed some typos. 
     769Added some missing command line options in the commands reference. 
     770 
    765771Revision 1.29  2004/11/10 22:35:23  jalet 
    766772Changes to the installation documentation 
  • pykota/trunk/docs/pkprinters.sgml

    r1406 r2115  
    2020        <group choice="opt"><arg>-a</arg><arg>--add</arg></group> 
    2121        <group choice="opt"><arg>-d</arg><arg>--delete</arg></group> 
     22        <group choice="opt"> 
     23          <arg>-D <replaceable>desc</replaceable></arg> 
     24          <arg>--description <replaceable>desc</replaceable></arg> 
     25        </group> 
    2226        <group choice="opt"><arg>-r</arg><arg>--remove</arg></group> 
    2327        <group choice="opt"> 
     
    2933          <arg>--groups <replaceable>pgroup1</replaceable>,<replaceable>pgroup2</replaceable>,<replaceable>...</replaceable></arg> 
    3034        </group>   
     35        <group choice="opt"><arg>-l</arg><arg>--list</arg></group> 
     36        <group choice="opt"><arg>-r</arg><arg>--remove</arg></group> 
     37        <group choice="opt"><arg>-s</arg><arg>--skipexisting</arg></group> 
    3138      </cmdsynopsis> 
    3239    </para> 
     
    3744 
    3845$Log$ 
     46Revision 1.2  2005/02/28 00:07:37  jalet 
     47Added pkmail's doc. 
     48Used the <command> tag instead of <application> for commands. 
     49Fixed some typos. 
     50Added some missing command line options in the commands reference. 
     51 
    3952Revision 1.1  2004/03/16 14:42:31  jalet 
    4053Improved documentation 
  • pykota/trunk/docs/pykota.sgml

    r2028 r2115  
    1313  <!entity DUMPYKOTA system "dumpykota.sgml"> 
    1414  <!entity AUTOPYKOTA system "autopykota.sgml"> 
     15  <!entity PKMAIL system "pkmail.sgml"> 
    1516  <!entity GNUGPL system "gnugpl.sgml"> 
    1617 
     
    129130  &PYKOSD; 
    130131   
     132  &PKMAIL; 
     133   
    131134  &SCRIPTS; 
    132135     
     
    138141 
    139142$Log$ 
     143Revision 1.17  2005/02/28 00:07:37  jalet 
     144Added pkmail's doc. 
     145Used the <command> tag instead of <application> for commands. 
     146Fixed some typos. 
     147Added some missing command line options in the commands reference. 
     148 
    140149Revision 1.16  2005/01/17 08:44:24  jalet 
    141150Modified copyright years 
  • pykota/trunk/docs/pykotme.sgml

    r1166 r2115  
    22 
    33<chapter> 
    4   <title id="pykotme">Get print quotes before printing for real with <application>pykotme</application></title> 
     4  <title id="pykotme">Get print quotes before printing for real with <command>pykotme</command></title> 
    55  <para>Last modified on $Date$</para> 
    66   
    77  <para> 
    8     PyKota features a print quote generator, named <application>pykotme</application>. 
     8    PyKota features a print quote generator, named <command>pykotme</command>. 
    99    This command line tool can be used to learn in advance how much a print job 
    1010    will cost to you if you really send it to a printer. 
     
    1414   
    1515  <para> 
    16     To get a print quote, you have to launch <application>pykotme</application> 
     16    To get a print quote, you have to launch <command>pykotme</command> 
    1717    from the command line, passing your print job's content in the PostScript 
    1818    format, either in the form of one or more file names on the command line, 
     
    2121   
    2222  <para> 
    23     Without any command line argument, <application>pykotme</application> 
     23    Without any command line argument, <command>pykotme</command> 
    2424    automatically reads your job's data from its standard input. 
    2525  </para> 
    2626   
    2727  <para> 
    28     By default, <application>pykotme</application> 
     28    By default, <command>pykotme</command> 
    2929    will display a quote for your job on all printers. You can restrict 
    3030    this by using the <literal>-p | --printer</literal> command line 
     
    3838    <title>Examples</title> 
    3939    <para> 
    40       Here are some examples of <application>pykotme</application> usage. 
     40      Here are some examples of <command>pykotme</command> usage. 
    4141    </para> 
    4242     
     
    9191 
    9292$Log$ 
     93Revision 1.6  2005/02/28 00:07:37  jalet 
     94Added pkmail's doc. 
     95Used the <command> tag instead of <application> for commands. 
     96Fixed some typos. 
     97Added some missing command line options in the commands reference. 
     98 
    9399Revision 1.5  2003/10/12 20:47:51  jalet 
    94100Doc enhanced. 
  • pykota/trunk/docs/repykota.sgml

    r1783 r2115  
    1515     
    1616    <para> 
    17       PyKota features a quota report generator, named <application>repykota</application>, 
     17      PyKota features a quota report generator, named <command>repykota</command>, 
    1818      with which you can print the current state of the quota database. 
    1919    </para> 
    2020     
    2121    <para> 
    22       <application>repykota</application> behaves differently when it is launched by a 
     22      <command>repykota</command> behaves differently when it is launched by a 
    2323      <application>PyKota</application> administrator, compared to when it is launched by a normal user. 
    2424    </para>   
     
    3232     
    3333    <para> 
    34       In the second case, i.e. when <application>repykota</application> is launched by 
     34      In the second case, i.e. when <command>repykota</command> is launched by 
    3535      a normal user, the user will only be allowed to see informations about himself or  
    3636      the groups he his a member of. 
     
    4545     
    4646    <para> 
    47       Launching <application>repykota</application> with no arguments will generate 
     47      Launching <command>repykota</command> with no arguments will generate 
    4848      a complete print quota report, depending on what you are allowed to see. 
    4949    </para> 
     
    118118      If you install the CGI script as described above, any user will be allowed to view the complete print 
    119119      quota report, for all users, groups and printers. This is then a different behavior compared to when 
    120       a normal user wants a print quota report from the command line through <application>repykota</application>. 
    121       If you find this disturbing, then the best is to ask for user authentication whenever the <application>printquota.cgi</application> 
     120      a normal user wants a print quota report from the command line through <command>repykota</command>. 
     121      If you find this disturbing, then the best is to ask for user authentication whenever the <command>printquota.cgi</command> 
    122122      CGI script is accessed. This CGI script will then automatically behave as expected, showing in the print quota 
    123       report only what the authenticated user is allowed to see, just like when he launches <application>repykota</application> 
     123      report only what the authenticated user is allowed to see, just like when he launches <command>repykota</command> 
    124124      from the command line. As a special case, if the user authenticates using the <literal>root</literal> username, 
    125125      then there's no restriction on what may appear on the print quota report. 
     
    129129      To automatically ask for an authentication dialog whenever the CGI script is accessed, you have to configure 
    130130      your web server to do so. If your webserver is <ulink url="http://httpd.apache.org"><application>Apache</application></ulink>, then it's relatively easy. First you have to put  
    131       <application>printquota.cgi</application> in its own subdirectory below your web server's <filename>cgi-bin</filename> 
    132       directory, for example in <filename>cgi-bin/PyKota/</filename>. Then use the <application>htpasswd</application> 
     131      <command>printquota.cgi</command> in its own subdirectory below your web server's <filename>cgi-bin</filename> 
     132      directory, for example in <filename>cgi-bin/PyKota/</filename>. Then use the <command>htpasswd</command> 
    133133      command line tool to create a file which contains usernames and passwords for all your users allowed to see 
    134134      the print quota report from a web browser, and put this file outside of the directories served by <application>Apache</application> 
     
    152152 
    153153$Log$ 
     154Revision 1.9  2005/02/28 00:07:37  jalet 
     155Added pkmail's doc. 
     156Used the <command> tag instead of <application> for commands. 
     157Fixed some typos. 
     158Added some missing command line options in the commands reference. 
     159 
    154160Revision 1.8  2004/10/06 10:03:16  jalet 
    155161Improved documentation 
  • pykota/trunk/docs/warnpykota.sgml

    r1783 r2115  
    1717    However this may not be sufficient, and you may want to warn users who 
    1818    have reached their print quota at 
    19     regular intervals, like every day, for example in a <application>cron</application> job. 
     19    regular intervals, like every day, for example from a <application>cron</application> job. 
    2020  </para> 
    2121   
    2222  <para> 
    2323    This may be useful if the user has reached his print quota, and have received an email message telling him so, 
    24     but then he doesn't print for some days and may forget to solve the problem, by buying more 
     24    but then he doesn't print for some days and may forget to fix the problem, by buying more 
    2525    paper for example. 
    2626  </para> 
    2727   
    2828  <para> 
    29     The <application>warnpykota</application> command was written with this in mind.  
     29    The <command>warnpykota</command> command was written with this in mind.  
    3030    If you put this command in your <filename>crontab</filename>, launching it for example 
    3131    every day, then you'll be sure that all your users who are above their print quota 
    3232    will not forget it ! Of course they may delete the messages without having read them, 
    33     but at least they won't be able to say that they didn't received them ;-) 
     33    but at least they won't be able to say that they didn't receive them ;-) 
    3434  </para> 
    3535   
     
    4040    argument, then for each group he is a member of in the Quota Storage, each 
    4141    group member may receive a warning message. You can take care of this if this 
    42     becomes annoying by forbidding normal users to launch the <application>warnpykota</application> 
     42    becomes annoying by forbidding normal users to launch the <command>warnpykota</command> 
    4343    command. 
    4444  </para> 
     
    7676 
    7777$Log$ 
     78Revision 1.7  2005/02/28 00:07:37  jalet 
     79Added pkmail's doc. 
     80Used the <command> tag instead of <application> for commands. 
     81Fixed some typos. 
     82Added some missing command line options in the commands reference. 
     83 
    7884Revision 1.6  2004/10/06 10:03:16  jalet 
    7985Improved documentation