1 | General notes on startup items: |
---|
2 | |
---|
3 | - In general, it is preferable to use startupitem.executable rather than |
---|
4 | any of startupitem.init, startupitem.start, startupitem.stop, |
---|
5 | startupitem.restart. If startupitem.executable is used, a pidfile |
---|
6 | path and style should also be specified. |
---|
7 | |
---|
8 | startupitem.create |
---|
9 | Choose whether or not to generate a startup item |
---|
10 | |
---|
11 | Type: optional |
---|
12 | Values: yes no |
---|
13 | Default: no |
---|
14 | Example: |
---|
15 | startupitem.create yes |
---|
16 | |
---|
17 | startupitem.type |
---|
18 | Select the type of startupitem to generate. By default, a startupitem |
---|
19 | will be generated that is of the appropriate type for the OS. For instance, |
---|
20 | launchd is favored on system 10.4, while SystemStarter is favored on prior |
---|
21 | Mac OS X systems. A global default may be specified with the startupitem_type |
---|
22 | preference in ports.conf. |
---|
23 | |
---|
24 | Type: optional |
---|
25 | Values: SystemStarter, launchd, default, rcNG |
---|
26 | Default: default |
---|
27 | Example: |
---|
28 | startupitem.type launchd |
---|
29 | |
---|
30 | startupitem.executable |
---|
31 | The name of the daemon to be run in the background. This option may contain |
---|
32 | multiple arguments, but they must be appropriate for a call to exec; they |
---|
33 | may not contain arbitrary shell code. This option may not be used together |
---|
34 | with any of the four options startupitem.init, startupitem.start, |
---|
35 | startupitem.stop and startupitem.restart. |
---|
36 | |
---|
37 | Type: optional |
---|
38 | Values: name of executable, and any arguments |
---|
39 | Example: |
---|
40 | startupitem.executable $prefix/bin/wonka |
---|
41 | |
---|
42 | startupitem.init |
---|
43 | Shell code that will be executed prior to any of the options startupitem.init, |
---|
44 | startupitem.start, startupitem.stop and startupitem.restart. |
---|
45 | |
---|
46 | Type: optional |
---|
47 | Values: sh code |
---|
48 | Example: |
---|
49 | startupitem.init FOO=start |
---|
50 | |
---|
51 | startupitem.start |
---|
52 | Shell code that should be executed to start the daemon. |
---|
53 | |
---|
54 | Type: optional |
---|
55 | Values: sh code |
---|
56 | Example: |
---|
57 | startupitem.start $prefix/share/mysql/mysql.server start |
---|
58 | |
---|
59 | startupitem.stop |
---|
60 | Shell code that should be executed to stop the daemon. |
---|
61 | |
---|
62 | Type: optional |
---|
63 | Values: sh code |
---|
64 | Example: |
---|
65 | startupitem.start $prefix/share/mysql/mysql.server stop |
---|
66 | |
---|
67 | startupitem.restart |
---|
68 | Shell code that should be executed to restart the daemon. In the absense |
---|
69 | of this key, the daemon will be restarted by taking the stop action, |
---|
70 | followed by taking the start action. |
---|
71 | |
---|
72 | Type: optional |
---|
73 | Values: sh code |
---|
74 | Example: |
---|
75 | startupitem.start $prefix/share/mysql/mysql.server restart |
---|
76 | |
---|
77 | startupitem.pidfile |
---|
78 | Specification for pidfile handling. This is particularly useful |
---|
79 | in conjunction with the startupitem.executable key, as in this case |
---|
80 | it is important that the startupitem know how to track the executable. |
---|
81 | This specifies whether the daemon generates its own pidfile (auto), whether |
---|
82 | it generates its own but forgets to delete it, so that the startupitem |
---|
83 | should delete it (clean), or whether it never generates one, in which |
---|
84 | case the startupitem should manage the pidfile on its own (manual), or |
---|
85 | whether no pidfile should be used at all (none). |
---|
86 | |
---|
87 | Type: optional |
---|
88 | Values: none|auto|manual|clean [/path/to/pidfile] |
---|
89 | Default: pidstyle defaults to "none", pidfilepath defaults to |
---|
90 | "${prefix}/var/run/${name}.pid" |
---|
91 | |
---|
92 | Example: |
---|
93 | startupitem.pidfile auto $prefix/var/run/${name}.pidfile |
---|
94 | |
---|
95 | startupitem.logfile |
---|
96 | Path to a logfile into which to log events about the lifetime of the |
---|
97 | startupitem. Depending on the type of startupitem, and the manner |
---|
98 | in which it is started, standard output from the daemon may also be |
---|
99 | directed to the logfile. |
---|
100 | |
---|
101 | Type: optional |
---|
102 | Values: path |
---|
103 | Default: /dev/null |
---|
104 | Example: |
---|
105 | startupitem.logfile $prefix/var/log/mydaemon.log |
---|
106 | |
---|
107 | startupitem.logevents |
---|
108 | Control whether or not to log events to the log file. If logevents |
---|
109 | is set, events are logged, with their time, to the logfile. |
---|
110 | |
---|
111 | Type: optional |
---|
112 | Values: yes|no |
---|
113 | Default: no |
---|
114 | Example: |
---|
115 | startupitem.logevents yes |
---|
116 | |
---|
117 | |
---|
118 | |
---|
119 | svn.url |
---|
120 | Specify the url from which to fetch files. |
---|
121 | |
---|
122 | Type: required (if subversion is going to be used) |
---|
123 | Values: a legal subversion url |
---|
124 | Default: none |
---|
125 | Examples: |
---|
126 | svn.url http://www.domain.com/svn-repo/mydirectory |
---|
127 | svn.url svn://www.domain.com/svn-repo/mydirectory |
---|
128 | |
---|
129 | svn.tag |
---|
130 | Specify the a tag from which svn should fetch files. |
---|
131 | This corresponds to the -r option to the svn cli. |
---|
132 | |
---|
133 | Type: optional |
---|
134 | Values: a legal subversion tag |
---|
135 | Default: none |
---|
136 | Examples: |
---|
137 | svn.tag 1020 |
---|
138 | svn.tag {2005-10-05} |
---|
139 | svn.tag HEAD |
---|
140 | |
---|
141 | |
---|
142 | |
---|
143 | |
---|