0f42bd1b0dae0b0615f66c263da61f0841add594
[libguestfs-talks.git] / 2019-fosdem / nbdview / README
1 nbdview is a small Tcl/Tk program that lets you visualize reads and
2 writes happening to an nbdkit server in real time.
3
4 To use it you will need to start your nbdkit server with the log
5 filter.  For example, using the memory plugin (but any plugin may be
6 used):
7
8   size=$((64 * 1024 * 1024))
9   nbdkit --filter=log memory size=$size logfile=/tmp/log
10
11 Then start nbdview.tcl specifying the log file and virtual size:
12
13   ./nbdview.tcl /tmp/log $size &
14
15 Note that only small disk sizes really work (larger sizes would
16 require too many pixels!)  With the defaults compiled into
17 nbdview.tcl: 4K block size, 128 x 128 pixel canvas, you can display at
18 most 64MB.
19
20 Then you can write to the NBD server using ordinary tools such as
21 qemu, qemu-io, guestfish, etc. and observe the reads and writes to the
22 disk.