Changeset 33106 for trunk/doc-new


Ignore:
Timestamp:
Jan 18, 2008, 6:01:56 AM (12 years ago)
Author:
markd@…
Message:

Minor refinements to startupitem.executable; remove unnecessary keyword
startupitem.type.

File:
1 edited

Legend:

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

    r33086 r33106  
    6161
    6262        <listitem>
    63           <para>Sets the name for the StartupItem.</para>
    64 
    65           <itemizedlist>
    66             <listitem>
    67               <para>Default: none</para>
    68             </listitem>
    69 
    70             <listitem>
    71               <para>Example:</para>
    72 
    73               <programlisting>startupitem.name        OpenSSH</programlisting>
    74             </listitem>
    75           </itemizedlist>
    76         </listitem>
    77       </varlistentry>
    78 
    79       <varlistentry>
    80         <term>startupitem.type</term>
    81 
    82         <!-- TODO: check if this is still up to date -->
    83 
    84         <listitem>
    85           <para>Select the type of startupitem to generate. By default, a
    86           startupitem will be generated that is of the appropriate type for
    87           the OS. For instance, launchd is used on system 10.4, while
    88           SystemStarter is used on prior Mac OS X systems. A global default
    89           may be specified with the startupitem_type preference in
    90           <filename>ports.conf</filename>.</para>
    91 
    92           <itemizedlist>
    93             <listitem>
    94               <para>Default: none</para>
    95             </listitem>
    96 
    97             <listitem>
    98               <para>Values: <option>SystemStarter</option>
    99               <option>launchd</option> <option>default</option>
    100               <option>rcNG</option></para>
    101             </listitem>
    102 
    103             <listitem>
    104               <para>Example:</para>
    105 
    106               <programlisting>startupitem.type        launchd</programlisting>
     63          <para>Sets the name for the StartupItem. Defaults to the name of the
     64          port, so this keyword is usually unnecessary.</para>
     65
     66          <itemizedlist>
     67            <listitem>
     68              <para>Default: <varname>${name}</varname></para>
     69            </listitem>
     70
     71            <listitem>
     72              <para>Example:</para>
     73
     74              <programlisting>startupitem.name        dhcpd</programlisting>
    10775            </listitem>
    10876          </itemizedlist>
     
    234202          <note>
    235203            <para>Do not wrap values in quotes if passing arguments to the
    236             daemon. <quote>Executable</quote> StartupItem values must be
    237             tagged as individual strings and the spaces between arguments
    238             serve as delimiters for each string, as shown in example .plist
    239             snippet below.</para>
    240 
    241             <programlisting><![CDATA[<key>ProgramArguments</key>
    242 <array>
    243     <string>/opt/local/bin/daemondo</string>
    244     <string>--label=vm-pop3d</string>
    245     <string>--start-cmd</string>
    246     <string>/opt/local/sbin/vm-pop3d</string>
    247     <string>-d</string>
    248     <string>10</string>
    249     <string>-t</string>
    250     <string>600</string>
    251     <string>;</string>
    252 </array>]]></programlisting>
     204            daemon; <quote>executable</quote> StartupItem elements must be
     205            tagged individually so the spaces between arguments serve as
     206            delimiters for <quote>string</quote> tags. For example, this
     207            startupitem key/value pair:</para>
     208
     209            <programlisting>startupitem.executable    ${prefix}/sbin/vm-pop3d -d 10 -t 600</programlisting>
     210
     211            <para> generates a .plist file with these tags:</para>
     212
     213            <programlisting>&lt;key&gt;ProgramArguments&lt;/key&gt;
     214&lt;array&gt;
     215    &lt;string&gt;/opt/local/bin/daemondo&lt;/string&gt;
     216    &lt;string&gt;--label=vm-pop3d&lt;/string&gt;
     217    &lt;string&gt;--start-cmd&lt;/string&gt;
     218    &lt;string&gt;/opt/local/sbin/vm-pop3d&lt;/string&gt;
     219    &lt;string&gt;-d&lt;/string&gt;
     220    &lt;string&gt;10&lt;/string&gt;
     221    &lt;string&gt;-t&lt;/string&gt;
     222    &lt;string&gt;600&lt;/string&gt;
     223    &lt;string&gt;;&lt;/string&gt;
     224&lt;/array&gt;</programlisting>
    253225          </note>
    254226        </listitem>
     
    319291          <note>
    320292            <para>Wrap the stop, start, and restart values in quotes so they
    321             will be placed in the wrapper as a single command.</para>
     293            will be placed in the wrapper tagged as a single element.</para>
    322294          </note>
    323295        </listitem>
Note: See TracChangeset for help on using the changeset viewer.