aboutsummaryrefslogtreecommitdiffstats
path: root/doc/source/system/other/local.html
blob: 29c25e586a87d7d6dbb790807e01dccf118c8d16 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<!DOCTYPE html>
<html>
	<head>
    	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    	<meta http-equiv="Content-Language" content="en" />
		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
    	<title>local service</title>
    	<meta name="Description" content="System oneshot that executes scripts." />
    	<meta name="Keywords" content="goetia s6-rc FreeBSD script system supervision tree" />
	</head>
	<header>
		<p>
			<a href="//0x53.net/software/goetia/goetia-freebsd">goetia-freebsd</a>
			<br />
			<a href="//0x53.net/software/goetia">goetia</a>
			<br />
			<a href="//0x53.net/software">Software</a>
			<br />
			<a href="//0x53.net">0x53.net</a>
		</p>
	</header>
	<body>
		<h1>The local service</h1>
		<p>
    		local is a
    		<a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">oneshot service</a>.
		</p>
		<ul>
    		<li>
    			It tries to execute all
    			files <code>/etc/local.d/*.up</code>
    			when it is started (typically during boot).
    		</li>
    		<li>
    			It tries to execute all files <code>/etc/local.d/*.down</code>
    			when it is stopped (typically during shutdown).
    		</li>
		</ul>
		<p>
    		The files are executed in random order
    		and in parallel.
		</p>
		<section id="examples">
    		<h2>Examples</h2>
    		<p>
        		An executable file <code>/etc/local.d/echo.up</code>
        		with the content
        		<pre>
#!/bin/execlineb -P

echo "example"
        		</pre>
        		would be executed and write "example" to the system log
        		upon starting the service local.
    		</p>
    		<p>
        		An executable file <code>/etc/local.d/echo.down</code>
        		with the content
        		<pre>
#!/bin/execlineb -P

echo "example"
        		</pre>
        		would be executed and write "example" to the system log
        		upon stopping the service local.
    		</p>
		</section>
	</body>
</html>