1 .\"
2 .\" Copyright (c) 2022 Stefan Sperling
3 .\"
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
7 .\"
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 .\"
16 .Dd $Mdocdate$
17 .Dt GOTCTL 8
18 .Os
19 .Sh NAME
20 .Nm gotctl
21 .Nd control the Game of Trees Daemon
22 .Sh SYNOPSIS
23 .Nm
24 .Op Fl hV
25 .Op Fl f Ar path
26 .Ar command
27 .Op Ar arg ...
28 .Sh DESCRIPTION
29 .Nm
30 controls the
31 .Xr gotd 8
32 daemon.
33 .Pp
34 The options for
35 .Nm
36 are as follows:
37 .Bl -tag -width Ds
38 .It Fl h
39 Display usage information and exit immediately.
40 .It Fl f Ar path
41 Set the
42 .Ar path
43 to the unix socket which
44 .Xr gotd 8
45 is listening on.
46 If not specified, the default path
47 .Pa /var/run/gotd.sock
48 will be used.
49 .It Fl V , -version
50 Display program version and exit immediately.
51 .El
52 .Pp
53 The commands for
54 .Nm
55 are as follows:
56 .Bl -tag -width Ds
57 .It Cm info
58 Display information about a running
59 .Xr gotd 8
60 instance.
61 This operation requires root privileges.
62 .It Cm stop
63 Stop a running
64 .Xr gotd 8
65 instance.
66 This operation requires root privileges.
67 .El
68 .Sh SEE ALSO
69 .Xr got 1 ,
70 .Xr gotd 8
71 .Sh AUTHORS
72 .An Stefan Sperling Aq Mt stsp@openbsd.org