diff docs/index.rst @ 283:1fc3b04b39fa

Build and package manual pages for fzfs, fzfs-mount and fzfs-umount. Also put some stub info into the manual page for local-bsdtools.
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 18 Sep 2022 01:31:47 +0200
parents 86d8929e4747
children 106cd5d9da7e
line wrap: on
line diff
--- a/docs/index.rst	Sun Sep 18 00:27:04 2022 +0200
+++ b/docs/index.rst	Sun Sep 18 01:31:47 2022 +0200
@@ -1,20 +1,30 @@
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
+
 .. local-bsdtools documentation master file, created by
    sphinx-quickstart on Sat Sep 17 21:32:09 2022.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+
 
-Welcome to local-bsdtools's documentation!
-==========================================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+local-bsdtools
+==============
 
 
+See Also
+--------
 
-Indices and tables
-==================
+- :manpage:`bsmtp2dma(1)`
+- :manpage:`check-ports(1)`
+- :manpage:`fjail(1)`
+- :manpage:`ftjail(1)`
+- :manpage:`fpkg(1)`
+- :manpage:`fzfs(1)`
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+  * :manpage:`fzfs-mount(1)`
+  * :manpage:`fzfs-umount(1)`
+
+
+Environment
+-----------
+
+Because the tools use different helper tools like :command:`zfs` or
+:command:`pkg` the relevant environment variables according to this tools
+also apply generally.