Changeset 32043 for trunk/doc-new


Ignore:
Timestamp:
Dec 14, 2007, 12:10:29 PM (12 years ago)
Author:
simon@…
Message:

doc-new: Integrated "StartupItems" section from the old portfile.7 man page. Please check this if everything is ok.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc-new/guide/xml/portfile-startupitem.7.xml

    r32039 r32043  
    4949          <itemizedlist>
    5050            <listitem>
    51               <para>Type: optional</para>
    52             </listitem>
    53 
    54             <listitem>
    55               <para>Default: no</para>
    56             </listitem>
    57 
    58             <listitem>
    59               <para>Values: yes no</para>
     51              <para>Default: <option>no</option></para>
    6052            </listitem>
    6153
     
    7769          <itemizedlist>
    7870            <listitem>
    79               <para>Type: required</para>
    80             </listitem>
    81 
    82             <listitem>
    8371              <para>Default: none</para>
    8472            </listitem>
    8573
    8674            <listitem>
    87               <para>Values: <replaceable>any_name</replaceable></para>
    88             </listitem>
    89 
    90             <listitem>
    9175              <para>Example:</para>
    9276
    9377              <programlisting>startupitem.name        OpenSSH</programlisting>
     78            </listitem>
     79          </itemizedlist>
     80        </listitem>
     81      </varlistentry>
     82
     83      <varlistentry>
     84        <term>startupitem.type</term>
     85
     86        <!-- TODO: check if this is still up to date -->
     87
     88        <listitem>
     89          <para>Select the type of startupitem to generate. By default, a
     90          startupitem will be generated that is of the appropriate type for
     91          the OS. For instance, launchd is used on system 10.4, while
     92          SystemStarter is used on prior Mac OS X systems. A global default
     93          may be specified with the startupitem_type preference in ports.conf.
     94          </para>
     95
     96          <itemizedlist>
     97            <listitem>
     98              <para>Default: none</para>
     99            </listitem>
     100
     101            <listitem>
     102              <para>Values: <literal>SystemStarter</literal>
     103              <literal>launchd</literal> <literal>default</literal>
     104              <literal>rcNG</literal></para>
     105            </listitem>
     106
     107            <listitem>
     108              <para>Example:</para>
     109
     110              <programlisting>startupitem.type        launchd</programlisting>
    94111            </listitem>
    95112          </itemizedlist>
     
    108125          <itemizedlist>
    109126            <listitem>
    110               <para>Type: optional</para>
    111             </listitem>
    112 
    113             <listitem>
    114127              <para>Default: <filename>/dev/null</filename></para>
    115             </listitem>
    116 
    117             <listitem>
    118               <para>Values: <replaceable>/file/path</replaceable></para>
    119128            </listitem>
    120129
     
    138147          <itemizedlist>
    139148            <listitem>
    140               <para>Type: optional</para>
    141             </listitem>
    142 
    143             <listitem>
    144               <para>Default: no</para>
    145             </listitem>
    146 
    147             <listitem>
    148               <para>Values: yes no</para>
     149              <para>Default: <option>no</option></para>
    149150            </listitem>
    150151
     
    167168          <itemizedlist>
    168169            <listitem>
    169               <para>Type: optional</para>
    170             </listitem>
    171 
    172             <listitem>
    173               <para>Default: no</para>
    174             </listitem>
    175 
    176             <listitem>
    177               <para>Values: yes no</para>
     170              <para>Default: <option>no</option></para>
    178171            </listitem>
    179172
     
    201194    automatically knows how to monitor a daemon process and restart it if
    202195    it dies. Daemons used with <quote>executable</quote> StartupItems may
    203     be programs or scripts (shell, perl, python, etc.), but when a script
    204     the script <emphasis>itself</emphasis> must be the daemon, rather than
    205     a script that launches a daemon. <quote>Script</quote> StartupItems
     196    be programs or scripts (shell, perl, python, etc.), but when a script is
     197    used the script <emphasis>itself</emphasis> must be the daemon, rather
     198    than a script that launches a daemon. <quote>Script</quote> StartupItems
    206199    are to be used for the latter.</para>
    207200
     
    224217          <itemizedlist>
    225218            <listitem>
    226               <para>Type: optional</para>
    227             </listitem>
    228 
    229             <listitem>
    230               <para>Default: no</para>
    231             </listitem>
    232 
    233             <listitem>
    234               <para>Values: <replaceable>/path/to/daemon</replaceable>
    235               [<replaceable>args</replaceable>]</para>
     219              <!-- TODO: is the default really no, not none? -->
     220              <para>Default: <option>no</option></para>
    236221            </listitem>
    237222
     
    262247        <string>;</string>
    263248</array>]]></programlisting>
     249            <!-- TODO: what is the meaning of this snippet here? -->
    264250          </note>
    265251        </listitem>
     
    280266
    281267    <programlisting>#!/bin/sh
    282 #
     268
    283269case "$1" in
    284   start)
    285        echo -n "Starting vm-pop3d: "
    286        /opt/local/sbin/vm-pop3d -d 10 -t 600
    287 
     270    start)
     271        echo -n "Starting vm-pop3d: "
     272        /opt/local/sbin/vm-pop3d -d 10 -t 600
    288273
    289274[... trimmed ...]</programlisting>
     
    312297
    313298        <listitem>
    314           <para>Specify a shell script to start, stop, and restart the
    315           daemon. In the absence of a restart key, the daemon will be
    316           restarted by taking the stop action, followed by the start
     299          <para>Specify a shell script to start, stop, and restart the daemon.
     300          In the absence of <code>startupitem.restart</code>, the daemon will
     301          be restarted by taking the stop action, followed by the start
    317302          action.</para>
    318303
    319304          <itemizedlist>
    320305            <listitem>
    321               <para>Type: optional</para>
    322             </listitem>
    323 
    324             <listitem>
    325306              <para>Default: none</para>
    326             </listitem>
    327 
    328             <listitem>
    329               <para>Values: <replaceable>shell_script</replaceable></para>
    330307            </listitem>
    331308
     
    356333
    357334          <itemizedlist>
    358             <listitem>
    359               <para>Type: optional</para>
    360             </listitem>
    361 
    362             <listitem>
    363               <para>Default: no</para>
    364             </listitem>
    365 
    366             <listitem>
    367               <para>Values: <replaceable>shell_script</replaceable></para>
     335
     336            <listitem>
     337              <!-- TODO: is the default really no, not none? -->
     338              <para>Default: <option>no</option></para>
    368339            </listitem>
    369340
     
    389360          <itemizedlist>
    390361            <listitem>
    391               <para>Type: optional</para>
    392             </listitem>
    393 
    394             <listitem>
     362              <!-- TODO: this is the default value described in the old
     363              portfile.7 man page -->
     364              <para>Default: <literal>none
     365              ${prefix}/var/run/${name}.pid</literal></para>
     366              <!-- TODO: clarify the default value -->
    395367              <para>Default: [none] |
    396368              [<filename>${prefix}/var/run/${name}.pid</filename>]</para>
     
    398370
    399371            <listitem>
     372              <!-- TODO: clarify this -->
    400373              <para>Values [none auto manual clean]
    401374              [<replaceable>/path/to/pidfile</replaceable>]</para>
     
    444417              written for some special use. A PID file is not needed to
    445418              detect process death for daemons launched directly by
    446               daemondo. As with executale StartupItems, daemondo remembers
     419              daemondo. As with executable StartupItems, daemondo remembers
    447420              the PID of the launched process and tracks it
    448421              automatically.</para>
     
    499472
    500473    <programlisting>#!/bin/sh
    501 #
     474
    502475# MacPorts generated daemondo support script
    503476
     
    505478Start()
    506479{
    507         /opt/local/share/mysql5/mysql/mysql.server start
     480    /opt/local/share/mysql5/mysql/mysql.server start
    508481}
    509482
     
    511484Stop()
    512485{
    513         /opt/local/share/mysql5/mysql/mysql.server stop
     486    /opt/local/share/mysql5/mysql/mysql.server stop
    514487}
    515488
Note: See TracChangeset for help on using the changeset viewer.