annotate docs/man/man8/fwireguard.rst @ 800:1c4d729963dc

fports: Implement "fports detail -A" and "fports detail -M". Autoselect packages: use all non-auto packages and use all packages with a mapping in package-mapping.conf.
author Franz Glasner <fzglas.hg@dom66.de>
date Fri, 01 Nov 2024 02:20:56 +0100
parents e2555d5fc61f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
462
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 fwireguard
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 ==========
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 Synopsis
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7 --------
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 **service fwireguard** [ **start** | **stop** | **reload** | **status** ]
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12 Description
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13 -----------
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 An :file:`rc.d` script to manage and configure Wireguard interfaces.
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
16
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
17
463
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
18 Configuration Variables
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
19 ~~~~~~~~~~~~~~~~~~~~~~~
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
20
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
21 `fwireguard_enable`
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
22 Default: NO
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
23
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
24 `fwireguard_wait`
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
25 Sleep the given amount of time between configuring the interface and
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
26 calling the post-start script.
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
27 Default: 2s
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
28
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
29 `fwireguard_configdir`
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
30 Default: /usr/local/etc/fwireguard
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
31
471
e2555d5fc61f Implement a fwireguard RC variable to manually determine the names of wireguard interfaces to configure to.
Franz Glasner <fzglas.hg@dom66.de>
parents: 466
diff changeset
32 `fwireguard_interfaces`
e2555d5fc61f Implement a fwireguard RC variable to manually determine the names of wireguard interfaces to configure to.
Franz Glasner <fzglas.hg@dom66.de>
parents: 466
diff changeset
33 The list of names of the Wireguard interfaces to configure.
e2555d5fc61f Implement a fwireguard RC variable to manually determine the names of wireguard interfaces to configure to.
Franz Glasner <fzglas.hg@dom66.de>
parents: 466
diff changeset
34
e2555d5fc61f Implement a fwireguard RC variable to manually determine the names of wireguard interfaces to configure to.
Franz Glasner <fzglas.hg@dom66.de>
parents: 466
diff changeset
35 Default: AUTO -- i.e. determine the Wireguard interfaces automatically by
e2555d5fc61f Implement a fwireguard RC variable to manually determine the names of wireguard interfaces to configure to.
Franz Glasner <fzglas.hg@dom66.de>
parents: 466
diff changeset
36 calling :command:`ifconfig -g wg`.
e2555d5fc61f Implement a fwireguard RC variable to manually determine the names of wireguard interfaces to configure to.
Franz Glasner <fzglas.hg@dom66.de>
parents: 466
diff changeset
37
463
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
38
462
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39 Files
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
40 -----
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
41
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
42 - :file:`/usr/local/etc/fwireguard`
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
43
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
44 Default-directory where all the configuration files for all wireguard
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45 interfaces are looked up.
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
47
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
48 See also
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
49 --------
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
50
466
4638f2f68b9d FIX: Docs: link to manpage to rc.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 463
diff changeset
51 :manpage:`wg(8)`, :manpage:`rc.conf(5)`