changeset 622:54c6eecbe53f

Docs: as per the Sphinx docs: option argument names should be enclosed in angle brackets
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 22 Sep 2024 16:04:18 +0200
parents ba3eb2b73373
children b74c65ceab96
files docs/man/man8/bsmtp2dma.rst docs/man/man8/fjail-freebsd-update.rst docs/man/man8/ftjail-copy-skel.rst docs/man/man8/ftjail-freebsd-update.rst docs/man/man8/fzfs-copy-tree.rst docs/man/man8/fzfs-create-tree.rst
diffstat 6 files changed, 12 insertions(+), 12 deletions(-) [+]
line wrap: on
line diff
--- a/docs/man/man8/bsmtp2dma.rst	Sun Sep 22 15:35:03 2024 +0200
+++ b/docs/man/man8/bsmtp2dma.rst	Sun Sep 22 16:04:18 2024 +0200
@@ -37,33 +37,33 @@
 
    Does nothing. Act as a compatibility option for :command:`bsmtp`.
 
-.. option:: -c address
+.. option:: -c <address>
 
    Set the ``CC:`` header to `address`
 
-.. option:: -d n
+.. option:: -d <n>
 
    Does nothing. Act as a compatibility option for :command:`bsmtp`.
 
-.. option:: -f address
+.. option:: -f <address>
 
    Set the ``FROM:`` header to `address`.
 
    If not given it it set to the sender's address.
 
-.. option:: -h mailhost:port
+.. option:: -h <mailhost:port>
 
    Does nothing. Act as a compatibility option for :command:`bsmtp`.
 
-.. option:: -l number
+.. option:: -l <number>
 
    Does nothing. Act as a compatibility option for :command:`bsmtp`.
 
-.. option:: -r address
+.. option:: -r <address>
 
    Set the ``Reply-To:`` header to `address`.
 
-.. option:: -s subject
+.. option:: -s <subject>
 
    Set the "Subject:" header to `subject`.
 
--- a/docs/man/man8/fjail-freebsd-update.rst	Sun Sep 22 15:35:03 2024 +0200
+++ b/docs/man/man8/fjail-freebsd-update.rst	Sun Sep 22 16:04:18 2024 +0200
@@ -17,7 +17,7 @@
 
 .. program:: fjail freebsd-update
 
-.. option:: -c currently-running
+.. option:: -c <currently-running>
 
    Do not assume that the system at `directory` is currently running
    the host's FreeBSD version but the version given in
--- a/docs/man/man8/ftjail-copy-skel.rst	Sun Sep 22 15:35:03 2024 +0200
+++ b/docs/man/man8/ftjail-copy-skel.rst	Sun Sep 22 16:04:18 2024 +0200
@@ -39,7 +39,7 @@
    Copy dataset properties optimized for employing a :file:`skeleton`
    subdirectory.
 
-.. option:: -M mountpoint
+.. option:: -M <mountpoint>
 
    Set the `mountpoint` property for the TARGET-DS to `mountpoint`.
    All children will be set to inherit it.
--- a/docs/man/man8/ftjail-freebsd-update.rst	Sun Sep 22 15:35:03 2024 +0200
+++ b/docs/man/man8/ftjail-freebsd-update.rst	Sun Sep 22 16:04:18 2024 +0200
@@ -32,7 +32,7 @@
 
    .. note:: On unexpected errors temp files are automatically kept.
 
-.. option:: -o old-origin
+.. option:: -o <old-origin>
 
    In addition to check that `directory` is a ZFS clone also check that
    its origin is equal to `old-origin`.
--- a/docs/man/man8/fzfs-copy-tree.rst	Sun Sep 22 15:35:03 2024 +0200
+++ b/docs/man/man8/fzfs-copy-tree.rst	Sun Sep 22 16:04:18 2024 +0200
@@ -38,7 +38,7 @@
    created datasets in the destination tree, unless the source dataset
    has `canmount=off`.
 
-.. option:: -M mountpoint
+.. option:: -M <mountpoint>
 
    Set the `mountpoint` property for the root `dest-dataset` to `mountpoint`.
    All children will be set to inherit it.
--- a/docs/man/man8/fzfs-create-tree.rst	Sun Sep 22 15:35:03 2024 +0200
+++ b/docs/man/man8/fzfs-create-tree.rst	Sun Sep 22 16:04:18 2024 +0200
@@ -40,7 +40,7 @@
    created datasets in the destination tree. This option overwrites
    option :option:`-p`.
 
-.. option:: -M mountpoint
+.. option:: -M <mountpoint>
 
    Set the `mountpoint` property for the root `dest-dataset` to `mountpoint`.
    All children will be set to inherit it.