Show
Ignore:
Timestamp:
07/25/03 15:10:58 (21 years ago)
Author:
jalet
Message:

Improved documentation

Files:
1 modified

Legend:

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

    r959 r1101  
    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 
    32     will not forget it ! 
     32    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 ;-) 
    3334  </para> 
    3435   
    3536  <para> 
    36     At the very least, try to make your best to disallow ordinary users to be able to 
    37     launch this command, since malicious users could fill other users mailboxes 
    38     by repeatedly running <application>warnpykota</application> : each user above 
    39     quota would receive multiple email messages, and possibly the administrator too ! 
     37    When a non-root user launches this command, only him can receive a warning 
     38    message. He can specify a printer name's filter to check his quota only 
     39    on specific printers. If a non-root users uses the <literal>--groups</literal> command line 
     40    argument, then for each group he is a member of in the Quota Storage, each 
     41    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> 
     43    command. 
    4044  </para> 
    4145   
    42   <sect1> 
    43     <title>Command line parameters</title> 
    44     <para> 
    45       TODO : blah 
    46     </para> 
    47   </sect1> 
    48    
    49   <sect1> 
    50     <title>Examples</title> 
    51     <para> 
    52       TODO : blah 
    53     </para> 
    54   </sect1> 
     46  <para> 
     47    The <literal>root</literal> user can pass additionnal user or group names  
     48    (or wildcard filters) to only check the users or groups whose name matches. 
     49  </para>   
    5550   
    5651  <sect1> 
     
    6762          <arg>--printer <replaceable>printername</replaceable></arg> 
    6863        </group>   
     64        <group choice="opt"> 
     65          <arg><replaceable>name1</replaceable></arg> 
     66          <arg><replaceable>name2</replaceable></arg> 
     67          <arg><replaceable>...</replaceable></arg> 
     68          <arg><replaceable>nameN</replaceable></arg> 
     69        </group>   
    6970      </cmdsynopsis> 
    70     </para> 
    71     <para> 
    72       TODO 
    7371    </para> 
    7472  </sect1> 
     
    7876 
    7977$Log$ 
     78Revision 1.5  2003/07/25 13:10:58  jalet 
     79Improved documentation 
     80 
    8081Revision 1.4  2003/04/24 21:09:47  jalet 
    8182Documentation slightly improved. 
     
    9091Documentation skeleton added 
    9192 
    92  
    9393-->