Changeset 30591 for trunk/doc-new


Ignore:
Timestamp:
Nov 1, 2007, 5:16:08 AM (12 years ago)
Author:
markd@…
Message:

Enhancements to the startupitem.executable section to specify how to pass arguments to a daemon.

File:
1 edited

Legend:

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

    r30444 r30591  
    251251
    252252                <listitem>
    253                   <para>Values:
    254                   <replaceable>/path/to/executable</replaceable></para>
    255                 </listitem>
    256 
    257                 <listitem>
    258                   <para>Example:</para>
    259 
    260                   <programlisting>startupitem.executable  "${prefix}/bin/nmicmpd"</programlisting>
    261                 </listitem>
    262               </itemizedlist>
     253                  <para>Values: <replaceable>/path/to/daemon</replaceable>
     254                  [<replaceable>args</replaceable>]</para>
     255                </listitem>
     256
     257                <listitem>
     258                  <para>Example:</para>
     259
     260                  <programlisting>startupitem.executable  ${prefix}/sbin/vmpop3d -d 10 -t 600</programlisting>
     261                </listitem>
     262              </itemizedlist>
     263
     264              <note>
     265                <para>Do not to wrap the value in quotes if passing arguments
     266                to the daemon; unlike with<quote>script</quote> StartupItem
     267                values, executable StartupItem value elements must be tagged
     268                separately as shown in this example .plist file
     269                snippet.</para>
     270
     271                <programlisting>&lt;key&gt;ProgramArguments&lt;/key&gt;
     272        &lt;array&gt;
     273                &lt;string&gt;/opt/local/bin/daemondo&lt;/string&gt;
     274                &lt;string&gt;--label=vm-pop3d&lt;/string&gt;
     275                &lt;string&gt;--start-cmd&lt;/string&gt;
     276                &lt;string&gt;/opt/local/sbin/vm-pop3d&lt;/string&gt;
     277                &lt;string&gt;-d&lt;/string&gt;
     278                &lt;string&gt;10&lt;/string&gt;
     279                &lt;string&gt;-t&lt;/string&gt;
     280                &lt;string&gt;600&lt;/string&gt;
     281                &lt;string&gt;;&lt;/string&gt;
     282        &lt;/array&gt;</programlisting>
     283              </note>
    263284            </listitem>
    264285          </varlistentry>
     
    350371
    351372                  <programlisting>startupitem.inetdnowait   yes</programlisting>
    352                 </listitem>
    353               </itemizedlist>
    354             </listitem>
    355           </varlistentry>
    356 
    357           <varlistentry>
    358             <term>startupitem.logevents</term>
    359 
    360             <listitem>
    361               <para>Control whether or not to log events to the log file. If
    362               logevents is set, events with timestamps are logged to the
    363               logfile.</para>
    364 
    365               <itemizedlist>
    366                 <listitem>
    367                   <para>Type: optional</para>
    368                 </listitem>
    369 
    370                 <listitem>
    371                   <para>Default: no</para>
    372                 </listitem>
    373 
    374                 <listitem>
    375                   <para>Values: yes no</para>
    376                 </listitem>
    377 
    378                 <listitem>
    379                   <para>Example:</para>
    380 
    381                   <programlisting>startupitem.logevents   yes</programlisting>
    382373                </listitem>
    383374              </itemizedlist>
     
    408399[... trimmed ...]</programlisting>
    409400
    410         <para>But if a script itself is a daemon, use the executable
    411         StartupItem type since that way it will be launched directly and its
    412         health tracked automatically. When using <quote>script</quote>
    413         StartupItems, the <code>startupitem.pidfile</code> keyword must be
    414         used if you want <command>daemondo</command> to monitor a daemon
    415         process and restart it if it dies.</para>
     401        <para>But if a script itself is a daemon, use the
     402        <quote>executable</quote> StartupItem type since that way it will be
     403        launched directly and its health tracked automatically. When using
     404        <quote>script</quote> StartupItems, the
     405        <code>startupitem.pidfile</code> keyword must be used if you want
     406        <command>daemondo</command> to monitor a daemon process and restart it
     407        if it dies.</para>
    416408
    417409        <note>
     
    451443                  <para>Examples:</para>
    452444
    453                   <programlisting>startupitem.start ${prefix}/share/mysql/mysql.server start
    454 startupitem.stop ${prefix}/share/mysql/mysql.server stop
    455 startupitem.restart ${prefix}/share/mysql/mysql.server restart</programlisting>
    456                 </listitem>
    457               </itemizedlist>
     445                  <programlisting>startupitem.start "${prefix}/share/mysql/mysql.server start"
     446startupitem.stop "${prefix}/share/mysql/mysql.server stop"
     447startupitem.restart "${prefix}/share/mysql/mysql.server restart"</programlisting>
     448                </listitem>
     449              </itemizedlist>
     450
     451              <note>
     452                <para>Wrap the stop, start, and restart values in quotes so
     453                they will be placed in the wrapper as a single command.</para>
     454              </note>
    458455            </listitem>
    459456          </varlistentry>
     
    484481                  <para>Example:</para>
    485482
    486                   <programlisting>startupitem.init  "PID=/var/run/dhcpd.pid"</programlisting>
     483                  <programlisting>startupitem.init "BIN=${prefix}/sbin/bacula-fd"</programlisting>
    487484                </listitem>
    488485              </itemizedlist>
Note: See TracChangeset for help on using the changeset viewer.