Changeset 2557 for pykota

Show
Ignore:
Timestamp:
10/09/05 23:28:25 (19 years ago)
Author:
jerome
Message:

Finished (for now) pkturnkey's documentation

Location:
pykota/trunk/docs
Files:
2 modified

Legend:

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

    r2551 r2557  
    66   
    77  <para> 
     8    The ultimate goal of the <command>pkturnkey</command> command line tool is 
     9    to transform <application>PyKota</application> into a turn-key solution. 
    810  </para>   
     11   
     12  <para> 
     13    For now its functionnalities are fairly limited, but it can : 
     14    <itemizedlist> 
     15      <listitem> 
     16        <para> 
     17          Import existing print queues into <application>PyKota</application>'s database. 
     18        </para> 
     19      </listitem>   
     20      <listitem> 
     21        <para> 
     22          Import existing users into <application>PyKota</application>'s database. 
     23        </para> 
     24      </listitem>   
     25      <listitem> 
     26        <para> 
     27          Import existing users groups into <application>PyKota</application>'s database. 
     28        </para> 
     29      </listitem>   
     30      <listitem> 
     31        <para> 
     32          Tell you which accounting method is the best for your printers. 
     33        </para> 
     34      </listitem>   
     35    </itemizedlist> 
     36  </para> 
     37   
     38  <para> 
     39    In the future, it is possible that this command will entirely generate configuration 
     40    files for you, and do a bunch of other things to ease the installation and  
     41    configuration of <application>PyKota</application> 
     42  </para> 
     43   
     44  <para> 
     45    One very important thing to remember is that, by default, <command>pkturnkey</command> 
     46    doesn't modify anything, unless you tell it to really do so by using its 
     47    <literal>--force</literal> (or <literal>-f</literal>) command line switch. 
     48    This lets you familiarize with what would happen before doing it for real, 
     49    especially because <command>pkturnkey</command> displays the other commands 
     50    it would launch. 
     51  </para> 
     52   
     53  <para> 
     54    You can restrict the datas you want to import into the database by using the 
     55    appropriate command line switches, or by passing printers' names as non-option 
     56    arguments at the end of the command line. 
     57  </para> 
     58   
     59  <para> 
     60    The following example will import all existing print queues, as well as all 
     61    users whose uid is comprised between 1000 and 50000 and all groups whose 
     62    gid is comprised between 5000 and 6000 : 
     63    <screen> 
     64$ pkturnkey --force --uidmin 1000 --dousers --uidmax 50000 --dogroups --gidmin 5000 --gidmax 6000     
     65    </screen> 
     66  </para> 
    967   
    1068  <sect1> 
     
    1573        <group choice="opt"><arg>-v</arg><arg>--version</arg></group> 
    1674        <group choice="opt"><arg>-h</arg><arg>--help</arg></group> 
     75        <group choice="opt"><arg>-f</arg><arg>--force</arg></group> 
     76        <group choice="opt"><arg>-d</arg><arg>--dousers</arg></group> 
     77        <group choice="opt"><arg>-D</arg><arg>--dogroups</arg></group> 
     78        <group choice="opt"> 
     79          <arg>-u <replaceable>uid</replaceable></arg> 
     80          <arg>--uidmin <replaceable>uid</replaceable></arg> 
     81        </group>   
     82        <group choice="opt"> 
     83          <arg>-U <replaceable>uid</replaceable></arg> 
     84          <arg>--uidmax <replaceable>uid</replaceable></arg> 
     85        </group>   
     86        <group choice="opt"> 
     87          <arg>-g <replaceable>gid</replaceable></arg> 
     88          <arg>--gidmin <replaceable>gid</replaceable></arg> 
     89        </group>   
     90        <group choice="opt"> 
     91          <arg>-G <replaceable>gid</replaceable></arg> 
     92          <arg>--gidmax <replaceable>gid</replaceable></arg> 
     93        </group>   
    1794      </cmdsynopsis> 
    1895    </para> 
  • pykota/trunk/docs/pykota.sgml

    r2541 r2557  
    114114  &INSTALLATION; 
    115115   
     116  &FILTERPYKOTA; 
     117   
    116118  &PKTURNKEY; 
    117    
    118   &FILTERPYKOTA; 
    119119   
    120120  &PKPRINTERS;