editorial improvements
[rrq/nbd-mount-helper.git] / mount.nbd.adoc
1 = mount.nbd(7)
2 :doctype: manpage
3
4 == NAME
5
6 mount.nbd - mount helper for *nbd* fstab entries
7
8 == SYNOPSIS
9
10 .in /etc/fstab
11 ====
12 nbd://$host/$export $mount *nbd* _options_ _dumpflag_ _fscheckorder_
13 ====
14
15 .manual invocation
16 ====
17 # mount.nbd nbd://$host/$export $mount -o _options_
18 ====
19
20 == DESCRIPTION
21
22 This is a helper program (script) for mounting NBD (Network Block
23 Device) partitions via `/etc/fstab` entries. The program starts an
24 `nbd-client` connection for the given _export name_ from the NBD
25 server _host_ using the first available nbd device and mounts that
26 device on the given mount point, and it further starts a monitor
27 daemon that disconnects the service upon unmounting.
28
29 == OPTIONS
30
31 The following options are available in addition to file system mount
32 options:
33
34 > **block_size**=__N__ - to use block size _N_
35
36 > **connections=**__N__ - to use _N_ server connections
37
38 > **timeout=**__N__ - to disconnect when idle for _N_ seconds
39
40 The program also uses the *-persist* option for `nbd-client`.