Documentation: nbd: Reformat to allow more documentation
[linux-block.git] / Documentation / blockdev / nbd.txt
CommitLineData
ef8d9e7d
MP
1Network Block Device (TCP version)
2==================================
5e4b269b 3
ef8d9e7d
MP
41) Overview
5-----------
1da177e4 6
ef8d9e7d
MP
7What is it: With this compiled in the kernel (or as a module), Linux
8can use a remote server as one of its block devices. So every time
9the client computer wants to read, e.g., /dev/nb0, it sends a
10request over TCP to the server, which will reply with the data read.
11This can be used for stations with low disk space (or even diskless)
12to borrow disk space from another computer.
13Unlike NFS, it is possible to put any filesystem on it, etc.
14
15For more information, or to download the nbd-client and nbd-server
16tools, go to http://nbd.sf.net/.
17
18The nbd kernel module need only be installed on the client
19system, as the nbd-server is completely in userspace. In fact,
20the nbd-server has been successfully ported to other operating
21systems, including Windows.