Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools

annotate docs/man/man8/fwireguard.rst @ 467:6ecd16725818

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Begin refactoring bhyve into fbhyve. Planned: - more consistent naming (analogous to jails) - using bhyve configuration files instead of RC variables for bhyve devices - more docs
author Franz Glasner <fzglas.hg@dom66.de>
date Fri, 14 Jun 2024 09:40:04 +0200
parents 4638f2f68b9d
children e2555d5fc61f
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
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
30 `fwireguard_configdir`
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
31 Default: /usr/local/etc/fwireguard
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
32
45d95fee0804 More content for the manpage of fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
33
462
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34 Files
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35 -----
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37 - :file:`/usr/local/etc/fwireguard`
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
38
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39 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
40 interfaces are looked up.
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
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
43 See also
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
44 --------
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45
466
4638f2f68b9d FIX: Docs: link to manpage to rc.conf
Franz Glasner <fzglas.hg@dom66.de>
parents: 463
diff changeset
46 :manpage:`wg(8)`, :manpage:`rc.conf(5)`