aboutsummaryrefslogtreecommitdiff
path: root/man/wgconfd.8.scd
diff options
context:
space:
mode:
authorHristo Venev <hristo@venev.name>2020-02-05 02:55:36 +0100
committerHristo Venev <hristo@venev.name>2020-02-05 03:17:43 +0100
commit436256044bd2577a05de0428303c326b1a0225f0 (patch)
tree99191037b61d9eeb3b32f133b8690c7358f2faaf /man/wgconfd.8.scd
parentff7ea7b5583ffce18ccb4bb56860a3eb145c688e (diff)
Add man pages.
Diffstat (limited to 'man/wgconfd.8.scd')
-rw-r--r--man/wgconfd.8.scd55
1 files changed, 55 insertions, 0 deletions
diff --git a/man/wgconfd.8.scd b/man/wgconfd.8.scd
new file mode 100644
index 0000000..216bbd2
--- /dev/null
+++ b/man/wgconfd.8.scd
@@ -0,0 +1,55 @@
+wgconfd(8)
+
+# NAME
+
+wgconfd - configuration manager for WireGuard
+
+# SYNOPSIS
+
+*wgconfd* _IFNAME_ _CONFIG_++
+*wgconfd* --cmdline _IFNAME_ _ARGS_...++
+*wgconfd* --check-source _PATH_
+
+# DESCRIPTION
+
+In the 1st and 2nd form, run wgconfd on the network interface named IFNAME. In
+the 1st form, CONFIG is the path to the configuration file, the format of which
+is described in *wgconfd*(5). In the 2nd form, the configuration is provided on
+the command line. The way this is done is described in the _COMMAND-LINE
+CONFIGURATION_ section.
+
+In the 3rd form, wgconfd checks the validity of a source JSON. PATH is a path
+to a local file.
+
+# COMMAND-LINE CONFIGURATION
+
+While the usual way to configure wgconfd is through a file, in some cases it
+is easier to pass everything on the command line. The arguments consist of a
+sequence of global options, sources, and peers:
+
+ min_keepalive _SEC_++
+max_keepalive _SEC_++
+refresh_sec _SEC_++
+source _NAME_ _URL_ [psk _PATH_] [ipv4 _NET_,_NET_,...] [ipv6 _NET_,_NET_,...] [required] [allow_road_warriors | deny_road_warriors]++
+peer _PUBKEY_ [endpoint _IP_:_PORT_] [psk _PATH_] [keepalive _SEC_] [source _NAME_]
+
+# EXIT VALUE
+
+When managing an interface, wgconfd does not exit. When checking the validity of
+a source, a nonzero exit status would indicate a problem with the source.
+
+# ENVIRONMENT
+
+*wgconfd* uses the following environment variables:
+
+ WG - the *wg*(8) command. Used for configuring the interface. Default: _wg_
+
+ CURL - the *curl*(1) command. Used for fetching sources. Default: _curl_
+
+ CACHE_DIRECTORY - the path where sources are cached.
+
+ RUNTIME_DIRECTORY - the path where the runtime state is preserved.
+
+# SEE ALSO
+
+*wgconfd*(5), *wg*(8), *curl*(1)