changeset 462:bfa134565e0e

Begin the manual pages for fwireguard
author Franz Glasner <fzglas.hg@dom66.de>
date Tue, 11 Jun 2024 09:44:10 +0200
parents f8858fc8c7f3
children 45d95fee0804
files docs/conf.py docs/man/index.rst docs/man/man8/fwireguard.rst docs/man/man8/local-bsdtools.rst pkg-plist
diffstat 5 files changed, 36 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/docs/conf.py	Tue Jun 11 09:20:21 2024 +0200
+++ b/docs/conf.py	Tue Jun 11 09:44:10 2024 +0200
@@ -101,6 +101,7 @@
 ("man/man8/ftjail-populate-tmpl", "ftjail-populate-tmpl", "Populate a prepared directory structure with the contents of a FreeBSD base system", [author], 8),
     ("man/man8/ftjail-snapshot-tmpl", "ftjail-snapshot-tmpl", "Recursively create ZFS snapshots of the RO base datasets and the RW skeleton datasets", [author], 8),
     ("man/man8/ftjail-umount-tmpl", "ftjail-umount-tmpl", "Unmount mounted Thin Jail template datasets", [author], 8),
+    ("man/man8/fwireguard", "fwireguard", "Manage Wireguard interfaces", [author], 8),
     ("man/man8/fzfs", "fzfs", "A ZFS management helper tool", [author], 8),
     ("man/man8/fzfs-copy-tree", "fzfs-copy-tree", "Copy a ZFS dataset tree based on an existing tree", [author], 8),
     ("man/man8/fzfs-create-tree", "fzfs-create-tree", "Create a ZFS dataset tree structure based on an existing tree", [author], 8),
--- a/docs/man/index.rst	Tue Jun 11 09:20:21 2024 +0200
+++ b/docs/man/index.rst	Tue Jun 11 09:44:10 2024 +0200
@@ -16,6 +16,7 @@
    man8/fjail-freebsd-update
    man8/fjail-hostid
    man8/fpkg
+   man8/fwireguard
    man8/ftjail
    man8/ftjail-build-etcupdate-current-tmpl
    man8/ftjail-copy-skel
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man/man8/fwireguard.rst	Tue Jun 11 09:44:10 2024 +0200
@@ -0,0 +1,30 @@
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
+
+fwireguard
+==========
+
+Synopsis
+--------
+
+**service fwireguard** [ **start** | **stop** | **reload** | **status** ]
+
+
+Description
+-----------
+
+An :file:`rc.d` script to manage and configure Wireguard interfaces.
+
+
+Files
+-----
+
+- :file:`/usr/local/etc/fwireguard`
+
+    Default-directory where all the configuration files for all wireguard
+    interfaces are looked up.
+
+
+See also
+--------
+
+:manpage:`wg(8)`
--- a/docs/man/man8/local-bsdtools.rst	Tue Jun 11 09:20:21 2024 +0200
+++ b/docs/man/man8/local-bsdtools.rst	Tue Jun 11 09:44:10 2024 +0200
@@ -65,6 +65,9 @@
   * :manpage:`ftjail-umount-tmpl(8)`
 
 - :manpage:`fpkg(8)`
+
+- :manpage:`fwireguard(8)`
+  
 - :manpage:`fzfs(8)`
 
   * :manpage:`fzfs-copy-tree(8)`
--- a/pkg-plist	Tue Jun 11 09:20:21 2024 +0200
+++ b/pkg-plist	Tue Jun 11 09:44:10 2024 +0200
@@ -33,6 +33,7 @@
 %%DOCS%%share/man/man8/ftjail-populate-tmpl.8.gz
 %%DOCS%%share/man/man8/ftjail-snapshot-tmpl.8.gz
 %%DOCS%%share/man/man8/ftjail-umount-tmpl.8.gz
+%%DOCS%%share/man/man8/fwireguard.8.gz
 %%DOCS%%share/man/man8/fzfs.8.gz
 %%DOCS%%share/man/man8/fzfs-copy-tree.8.gz
 %%DOCS%%share/man/man8/fzfs-create-tree.8.gz