Blob


1 <!DOCTYPE html>
2 <html>
3 <head>
4 <meta charset="utf-8"/>
5 <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
6 <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
7 <title>GOTCTL(8)</title>
8 </head>
9 <!-- This is an automatically generated file. Do not edit.
10 Copyright (c) 2022 Stefan Sperling
12 Permission to use, copy, modify, and distribute this software for any
13 purpose with or without fee is hereby granted, provided that the above
14 copyright notice and this permission notice appear in all copies.
16 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
17 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
18 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
19 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
20 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
21 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
22 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23 -->
24 <body>
25 <div class="head" role="doc-pageheader" aria-label="Manual header
26 line"><span class="head-ltitle">GOTCTL(8)</span> <span class="head-vol">System
27 Manager's Manual</span> <span class="head-rtitle">GOTCTL(8)</span></div>
28 <main class="manual-text">
29 <section class="Sh">
30 <h2 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h2>
31 <p class="Pp"><code class="Nm">gotctl</code> &#x2014;
32 <span class="Nd" role="doc-subtitle">control the Game of Trees
33 Daemon</span></p>
34 </section>
35 <section class="Sh">
36 <h2 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h2>
37 <table class="Nm">
38 <tr>
39 <td><code class="Nm">gotctl</code></td>
40 <td>[<code class="Fl">-hV</code>] [<code class="Fl">-f</code>
41 <var class="Ar">path</var>] <var class="Ar">command</var>
42 [<var class="Ar">arg ...</var>]</td>
43 </tr>
44 </table>
45 </section>
46 <section class="Sh">
47 <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h2>
48 <p class="Pp"><code class="Nm">gotctl</code> controls the
49 <a class="Xr" aria-label="gotd, section 8">gotd(8)</a> daemon.</p>
50 <p class="Pp">The options for <code class="Nm">gotctl</code> are as follows:</p>
51 <dl class="Bl-tag">
52 <dt id="h"><a class="permalink" href="#h"><code class="Fl">-h</code></a></dt>
53 <dd>Display usage information and exit immediately.</dd>
54 <dt id="f"><a class="permalink" href="#f"><code class="Fl">-f</code></a>
55 <var class="Ar">path</var></dt>
56 <dd>Set the <var class="Ar">path</var> to the unix socket which
57 <a class="Xr" aria-label="gotd, section 8">gotd(8)</a> is listening on. If
58 not specified, the default path <span class="Pa">/var/run/gotd.sock</span>
59 will be used.</dd>
60 <dt id="V"><a class="permalink" href="#V"><code class="Fl">-V</code></a>,
61 <code class="Fl">--version</code></dt>
62 <dd>Display program version and exit immediately.</dd>
63 </dl>
64 <p class="Pp">The commands for <code class="Nm">gotctl</code> are as
65 follows:</p>
66 <dl class="Bl-tag">
67 <dt id="info"><a class="permalink" href="#info"><code class="Cm">info</code></a></dt>
68 <dd>Display information about a running <a class="Xr" aria-label="gotd,
69 section 8">gotd(8)</a> instance. This operation requires root
70 privileges.</dd>
71 <dt id="stop"><a class="permalink" href="#stop"><code class="Cm">stop</code></a></dt>
72 <dd>Stop a running <a class="Xr" aria-label="gotd, section 8">gotd(8)</a>
73 instance. This operation requires root privileges.</dd>
74 </dl>
75 </section>
76 <section class="Sh">
77 <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
78 ALSO</a></h2>
79 <p class="Pp"><a class="Xr" aria-label="got, section 1">got(1)</a>,
80 <a class="Xr" aria-label="gotd, section 8">gotd(8)</a></p>
81 </section>
82 <section class="Sh">
83 <h2 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h2>
84 <p class="Pp"><span class="An">Stefan Sperling</span>
85 &lt;<a class="Mt" href="mailto:stsp@openbsd.org">stsp@openbsd.org</a>&gt;</p>
86 </section>
87 </main>
88 <div class="foot" role="doc-pagefooter" aria-label="Manual footer
89 line"><span class="foot-left"></span><span class="foot-date">July 11,
90 2024</span> <span class="foot-os">OpenBSD 7.5</span></div>
91 </body>
92 </html>