Changeset 11450 for trunk/doc


Ignore:
Timestamp:
Mar 24, 2005, 7:04:03 PM (14 years ago)
Author:
mww
Message:

add some illustrations to startupitem commands

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/guide/xml/portfiles/details.xml

    r11442 r11450  
    10291029                        <para>To create StartupItems for your port, use these directives. It is considered good style to use the startupitem commands instead of creating a rc.s-tyle script.</para>
    10301030                        <variablelist>
    1031                                 <varlistentry id="startupitem.create">
     1031                                <varlistentry id='startupitem.create'>
    10321032                                        <term>startupitem.create</term>
    10331033                                        <listitem>
    1034                                                 <para>this triggers the creation of a StartupItem (yes/no)</para>
    1035                                         </listitem>
    1036                                 </varlistentry>
    1037 
    1038                                 <varlistentry id="startupitem.name">
     1034                                                <para>This triggers the creation of a StartupItem, defaults to <userinput>no</userinput>.</para>
     1035                                        </listitem>
     1036                                </varlistentry>
     1037
     1038                                <varlistentry id='startupitem.name'>
    10391039                                        <term>startupitem.name</term>
    10401040                                        <listitem>
    1041                                                 <para>sets the name for the StartupItem, defaults to ${portname}</para>
    1042                                         </listitem>
    1043                                 </varlistentry>
    1044 
    1045                                 <varlistentry id="startupitem.start">
     1041                                                <para>sets the name for the StartupItem, defaults to <userinput>${portname}</userinput></para>
     1042                                        </listitem>
     1043                                </varlistentry>
     1044
     1045                                <varlistentry id='startupitem.init'>
     1046                                        <term>startupitem.init</term>
     1047                                        <listitem>
     1048                                                <para>commands that will get executes on initialization of StartupItem, e. g. assign common variables. Default is empty.</para>
     1049                                                <para>Common usage would be to define the location of the pidfile, like <userinput>PIDFILE=${prefix}/var/run/food.pid</userinput>.</para>
     1050                                        </listitem>
     1051                                </varlistentry>
     1052
     1053                                <varlistentry id='startupitem.start'>
    10461054                                        <term>startupitem.start</term>
    10471055                                        <listitem>
    1048                                                 <para>command to call to start the daemon etc.; defaults to ${prefix}/etc/rc.d/${portname}.sh start</para>
    1049                                         </listitem>
    1050                                 </varlistentry>
    1051 
    1052                                 <varlistentry id="startupitem.stop">
     1056                                                <para>command to call to start the daemon etc.; defaults to <userinput>${prefix}/etc/rc.d/${portname}.sh start</userinput></para>
     1057                                                <para>The common unix daemon would just have something like <userinput>${prefix}/sbin/food</userinput></para>
     1058                                        </listitem>
     1059                                </varlistentry>
     1060
     1061                                <varlistentry id='startupitem.stop'>
    10531062                                        <term>startupitem.stop</term>
    10541063                                        <listitem>
    1055                                                 <para>command to call to stop the daemon etc.; defaults to ${prefix}/etc/rc.d/${portname}.sh stop</para>
    1056                                         </listitem>
    1057                                 </varlistentry>
    1058 
    1059                                 <varlistentry id="startupitem.restart">
     1064                                                <para>command to call to stop the daemon etc.; defaults to <userinput>${prefix}/etc/rc.d/${portname}.sh stop</userinput></para>
     1065                                                <para>The common schema on this command is to call <userinput>kill</userinput> on the daemons pid. If you have a pid-file, you would use something like <userinput>kill \$(cat ${prefix}/var/run/food.pid)</userinput>.</para>
     1066                                        </listitem>
     1067                                </varlistentry>
     1068
     1069                                <varlistentry id='startupitem.restart'>
    10601070                                        <term>startupitem.restart</term>
    10611071                                        <listitem>
    1062                                                 <para>command to call to restart the daemon etc.; defaults to execute stop, start on self</para>
     1072                                                <para>command to call to restart the daemon etc.; defaults to <userinput>StopService; StartService</userinput> (execute stop, start on self).</para>
     1073                                        </listitem>
     1074                                </varlistentry>
     1075
     1076                                <varlistentry id='startupitem.requires'>
     1077                                        <term>startupitem.requires</term>
     1078                                        <listitem>
     1079                                                <para>The required services to run this daemon, defaults to <userinput>"Disk" "NFS"</userinput>.</para>
    10631080                                        </listitem>
    10641081                                </varlistentry>
Note: See TracChangeset for help on using the changeset viewer.