Changeset 28626 for trunk/doc


Ignore:
Timestamp:
Sep 5, 2007, 1:50:09 PM (12 years ago)
Author:
markd@…
Message:

Refine startupitems section.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/guide/new/xml/portfileref.xml

    r28616 r28626  
    260260
    261261              <member>Values: <option>yes no</option></member>
     262
     263              <member>Example:</member>
    262264            </simplelist>
    263265
     
    277279              <member>Default: none</member>
    278280
    279               <member>Values:</member>
     281              <member>Values: <replaceable>any name</replaceable></member>
     282
     283              <member>Example:</member>
    280284            </simplelist>
    281285
     
    299303
    300304              <member>Values: <replaceable>/file/path/</replaceable></member>
     305
     306              <member>Example:</member>
    301307            </simplelist>
    302308
     
    319325
    320326              <member>Values: <option>yes no</option></member>
     327
     328              <member>Example:</member>
    321329            </simplelist>
    322330
     
    360368
    361369              <member>Values: <literal>shell script</literal></member>
     370
     371              <member>Example:</member>
    362372            </simplelist>
    363373
     
    378388
    379389              <member>Values: <literal>shell script</literal></member>
     390
     391              <member>Example:</member>
    380392            </simplelist>
    381393
     
    396408
    397409              <member>Values: <literal>shell script</literal></member>
     410
     411              <member>Example:</member>
    398412            </simplelist>
    399413
     
    416430
    417431              <member>Values: <literal>shell script</literal></member>
     432
     433              <member>Example:</member>
    418434            </simplelist>
    419435
     
    455471
    456472              <member>Values: <option>yes no</option></member>
     473
     474              <member>Example:</member>
    457475            </simplelist>
    458476
     
    465483
    466484          <listitem>
    467             <para>A specification for process id (PID) file handling that may
    468             be used in conjunction with the
    469             <code>startupitem.executable</code> key to inform the startupitem
    470             how to track the executable. This keyword specifies whether the
    471             daemon is not to use a pidfile (<option>none</option>), generates
    472             its own pidfile (<option>auto</option>), never generates one (so
    473             the StartupItem should manage the pidfile on its own
    474             (<option>manual</option>), or generates its own but will not
    475             delete it (so the StartupItem should delete it using
    476             <option>clean</option>).</para>
     485            <para>This keyword may be used in conjunction with the
     486            <code>startupitem.executable</code> key to inform the StartupItem
     487            how to track the executable. It specifies two things; a process id
     488            (PID) file handling type, and a pidfile name and path.</para>
    477489
    478490            <simplelist>
    479491              <member>Type: optional</member>
    480492
    481               <member>Default: <option>none</option> |
    482               <filename>${prefix}/var/run/${name}.pid</filename></member>
    483 
    484               <member>Values: <option>none auto manual clean</option>
     493              <member>Default: <option>[none]</option> |
     494              <filename>[${prefix}/var/run/${name}.pid]</filename></member>
     495
     496              <member>Values: <option>[none auto manual clean]</option>
    485497              [<replaceable>/path/to/pidfile</replaceable>]</member>
     498
     499              <member>Example:</member>
    486500            </simplelist>
    487501
    488502            <programlisting>startupitem.pidfile auto ${prefix}/var/run/${name}.pidfile</programlisting>
     503
     504            <para>Pidfile handling options:</para>
     505
     506            <simplelist>
     507              <member><option>none</option> - The daemon is not to use a
     508              pidfile.</member>
     509
     510              <member><option>auto</option> - The daemon generates its own
     511              pidfile.</member>
     512
     513              <member><option>manual</option> - The daemon never generates a
     514              pidfile; the StartupItem must manage the pidfile on its
     515              own.</member>
     516
     517              <member><option>clean</option> - The daemon generates its own
     518              but will not delete it; the StartupItem must delete it.</member>
     519            </simplelist>
    489520          </listitem>
    490521        </varlistentry>
Note: See TracChangeset for help on using the changeset viewer.