From: Ralph Ronnquist <rrq@rrq.au>
Date: Sun, 21 Apr 2024 00:04:33 +0000 (+1000)
Subject: Added man page (asciidoctor source)
X-Git-Tag: 0.2~3
X-Git-Url: https://git.rrq.au/?a=commitdiff_plain;h=66622ea1024eb3c0ce562a4b3cea4e2c8f1dc8a8;p=rrq%2Fnbd-mount-helper.git

Added man page (asciidoctor source)
---

diff --git a/mount.nbd.adoc b/mount.nbd.adoc
new file mode 100644
index 0000000..b24632c
--- /dev/null
+++ b/mount.nbd.adoc
@@ -0,0 +1,40 @@
+= mount.nbd(7)
+:doctype: manpage
+
+== NAME
+
+mount.nbd - mount helper for *nbd* fstab entries
+
+== SYNOPSIS
+
+.in /etc/fstab
+====
+nbd://$host/$export $mount *nbd* _options_ _dumpflag_ _fscheckorder_
+====
+
+.manual invocation
+====
+# mount.nbd nbd://$host/$export $mount -o _options_
+====
+
+== DESCRIPTION
+
+This is a helper program (script) for mounting NBD (Network Block
+Device) partitions via `/etc/fstab` entries. The program starts an
+`nbd-client` connection for the given _export name_ from the NBD
+server _host_ using the first available nbd device and mounts that
+device on the given mount point, and it further starts a monitor
+daemon that disconnects the service upon unmounting.
+
+== OPTIONS
+
+The following options are available in addition to file system mount
+options:
+
+> **block_size**=__N__ - to use block size _N_
+
+> **connections=**__N__ - to use _N_ server connections
+
+> **timeout=**__N__ - to disconnect when idle for _N_ seconds
+
+The program also uses the *-persist* option for `nbd-client`.