1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH VIRTNBDMAP "1" "December 2025" "virtnbdmap 2.42" "User Commands"
.SH NAME
virtnbdmap \- map virtnbdbackup image files to nbd devices
.SH DESCRIPTION
usage: virtnbdmap [\-h] \fB\-f\fR FILE [\-b BLOCKSIZE] [\-d DEVICE] [\-e EXPORT_NAME]
.IP
[\-t THREADS] [\-l LISTEN_ADDRESS] [\-p LISTEN_PORT] [\-n]
[\-L LOGFILE] [\-\-nocolor] [\-r] [\-H] [\-v] [\-V]
.PP
Map backup image(s) to block device
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.SS "General options:"
.TP
\fB\-f\fR, \fB\-\-file\fR FILE
List of Backup files to map
.TP
\fB\-b\fR, \fB\-\-blocksize\fR BLOCKSIZE
Maximum blocksize passed to nbdkit. (default: 4096)
.TP
\fB\-d\fR, \fB\-\-device\fR DEVICE
Target device. (default: \fI\,/dev/nbd0\/\fP)
.TP
\fB\-e\fR, \fB\-\-export\-name\fR EXPORT_NAME
Export name passed to nbdkit. (default: sda)
.TP
\fB\-t\fR, \fB\-\-threads\fR THREADS
Amount of threads passed to nbdkit process. (default: 1)
.TP
\fB\-l\fR, \fB\-\-listen\-address\fR LISTEN_ADDRESS
IP Address for nbdkit process to listen on. (default: 127.0.0.1)
.TP
\fB\-p\fR, \fB\-\-listen\-port\fR LISTEN_PORT
Port for nbdkit process to listen on. (default: 10809)
.TP
\fB\-n\fR, \fB\-\-noprogress\fR
Disable progress bar
.SS "Logging options:"
.TP
\fB\-L\fR, \fB\-\-logfile\fR LOGFILE
Path to Logfile (default: \fI\,/home/abi/virtnbdmap.log\/\fP)
.TP
\fB\-\-nocolor\fR
Disable colored output (default: False)
.SS "Debug options:"
.TP
\fB\-r\fR, \fB\-\-readonly\fR
Map image readonly (default: False)
.TP
\fB\-H\fR, \fB\-\-hexdump\fR
Hexdump data to logfile for debugging (default: False)
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Enable debug output
.TP
\fB\-V\fR, \fB\-\-version\fR
Show version and exit
.SH EXAMPLES
.IP
# Map full backup to device /dev/nbd0:
.IP
virtnbdmap \-f /backup/sda.full.data
.IP
# Map full backup to device /dev/nbd2:
.IP
virtnbdmap \-f /backup/sda.full.data \-d /dev/nbd2
.IP
# Map sequence of full and incremental to device /dev/nbd2:
.IP
virtnbdmap \-f /backup/sda.full.data,/backup/sda.inc.1.data \-d /dev/nbd2
|
