From: Ralph Ronnquist Date: Sun, 21 Apr 2024 01:15:53 +0000 (+1000) Subject: editorial improvements X-Git-Tag: 0.2 X-Git-Url: https://git.rrq.au/?a=commitdiff_plain;ds=sidebyside;p=rrq%2Fnbd-mount-helper.git editorial improvements --- diff --git a/README.adoc b/README.adoc index 4ebe624..6ef482b 100644 --- a/README.adoc +++ b/README.adoc @@ -22,7 +22,7 @@ can access a hard disk drive that is attached to another computer. To do so, a remote machine, say `nbdhost.example.com` is set up as `NBD server` with one or more export names, say including `part000`, -that on the server side maps to a partition image file. +that on the server side maps to a partition image or file. With a mount helper the client side would include an entry in its `/etc/fstab` for instance like the following: @@ -30,20 +30,22 @@ With a mount helper the client side would include an entry in its nbd://nbdhost.example.com/part000 /nbd/1 nbd noauto,noatime 0 2 ---- That would declare a mounting of that exported NBD partition onto the -(alread existsing) pathname `/mnt/1` on the local machine. With the +(already existsing) pathname `/mnt/1` on the local machine. With the __type__ field of the `fstab` entry being `nbd`, the mount program will use `/sbin/mount.nbd` as helper for handling that entry. The helper script `/sbin/mount.nbd` provided here uses the -`nbd-client` program to handle the service connection as device node -such as `/dev/nbd0` and then mount that onto `/mnt/1`. The script will -further spawn a monitor daemon to terminate the service connection -upon unmounting. This script needs `inotify`, `nbd-client` and the -`nbd` kernel module or built-in to function. +`nbd-client` program to handle the service connection and provide that +as a device node such as `/dev/nbd0`. Ths script mounts that device +node on `/mnt/1` and spawn a monitor daemon to terminate the service +connection upon unmounting. This script needs `inotify`, `nbd-client` +and the `nbd` kernel module or built-in to function. The helper script `/sbin/mount.nbdfuse` provided here is similar but -will rely on `nbdfuse` for service connection. The `fstab` entry would -then have `nbdfuse` as __type__ indicator. This script needs -`inotify`, `nbdfuse` and the `fuse` and `loop` kernel modules or -built-in to function. - +will rely on `nbdfuse` for service connection and presents that on a +`/run` directory (named by a mangling of the remote URL). For this +case the `fstab` entry would then have `nbdfuse` as __type__ +indicator. The helper script mounts the `nbdfuse` "partition" on +`/mnt/1` and spawn a monitor daemon to terminate the service +connection upon unmounting. This script needs `inotify`, `nbdfuse` and +the `fuse` and `loop` kernel modules or built-in to function.