From: pavel Date: Thu, 20 Sep 2001 21:07:16 +0000 (+0000) Subject: r11: Manpages from Wouter Verhelst . X-Git-Url: http://git.alex.org.uk r11: Manpages from Wouter Verhelst . --- diff --git a/nbd-client.8.sgml b/nbd-client.8.sgml new file mode 100644 index 0000000..10cf06e --- /dev/null +++ b/nbd-client.8.sgml @@ -0,0 +1,197 @@ + manpage.1'. You may view + the manual page with: `docbook-to-man manpage.sgml | nroff -man | + less'. A typical entry in a Makefile or Makefile.am is: + +manpage.1: manpage.sgml + docbook-to-man $< > $@ + --> + + + Wouter"> + Verhelst"> + + september 19, 2001"> + + 8"> + wouter@debian.org"> + + NBD-CLIENT"> + + + Debian GNU/Linux"> + GNU"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2001 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + connect to a server running nbd-server(1), to use its + exported block device + + + + &dhpackage; + + + + + + + + &dhpackage; + + + + + DESCRIPTION + + This manual page documents briefly the + &dhpackage; command. + + This manual page was written for the &debian; distribution + because the original program does not have a manual page. + + With &dhpackage;, you can connect to a + server running nbd-server, thus using raw + diskspace from that server as a blockdevice on the local + client. + + To do this, support from the Linux Kernel is necessary, in + the form of the Network Block Device (NBD). When you have that, + either in the kernel, or as a module, you can connect to an NBD + server and use its exported file through a block special file with + major mode 43. + + + + OPTIONS + + The following options are supported: + + + + + + Use a blocksize of "blocksize". Default is 1024; + allowed values are either 512, 1024, 2048 or 4096 + + + + + + The hostname of the machine running + nbd-server. + + + + + + The TCP port on which nbd-server is + running at the server. + + + + + + The block special file this nbd-client should connect + to. + + + + + + Specifies that this NBD device will be used as + swapspace. If you intend to do that, please use this + option to prevent deadlocks. You'll need a special kernel + patch, available at NBD's homepage: + http://atrey.karlin.mff.cuni.cz/~pavel + + + + + + EXAMPLES + + Some examples of nbd-client usage: + + + To connect to a server running on port 2000 at host + "server.domain.com", using the client's block special file + "/dev/nd0": + nbd-client 2000 server.domain.com + /dev/nd0 + + + To connect to a server running on port 2001 at host + "swapserver.domain.com", using the client's block special + file "/dev/nd1", for swap purposes: + nbd-client 2001 swapserver.domain.com /dev/nd1 + -swap + + + To disconnect the above connection again (after making + sure the block special file is not in use anymore): + nbd-client -d /dev/nd1 + + + + + SEE ALSO + + nbd-server (1). + + + + AUTHOR + + This manual page was written by &dhusername; (&dhemail;) for + the &debian; system (but may be used by others). Permission is + granted to copy, distribute and/or modify this document under the + terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation; with no Invariant Sections, no Front-Cover Texts and + no Back-Cover Texts. + + + + + diff --git a/nbd-server.1.sgml b/nbd-server.1.sgml new file mode 100644 index 0000000..efca0d7 --- /dev/null +++ b/nbd-server.1.sgml @@ -0,0 +1,225 @@ + manpage.1'. You may view + the manual page with: `docbook-to-man manpage.sgml | nroff -man | + less'. A typical entry in a Makefile or Makefile.am is: + +manpage.1: manpage.sgml + docbook-to-man $< > $@ + --> + + + Wouter"> + Verhelst"> + + september 19, 2001"> + + 1"> + wouter@debian.org"> + + NBD-SERVER"> + + + Debian GNU/Linux"> + GNU"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2001 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + serve a file as a block device to other computers + running the Linux(tm) Operating System + + + + &dhpackage; + + + port + filename + size + + + + + + + DESCRIPTION + + This manual page documents the + &dhpackage; command. + + This manual page was written for the &debian; distribution + because the original program does not have a manual page. + + &dhpackage; is the server for the Linux + Network Block Device (NBD). With NBD, a client can use a file, + exported over the network from a server, as a block device. It can + then be used for whatever purpose a normal block device (harddisk, + CD-ROM, ...) can be used for. + + NBD can be usefull for diskless clients that need swapspace, + but you can also create a filesystem on it and use it as though it + were a local filesystem. + + &dhpackage; implements some security + through a file called "nbd_server.allow" in the current directory. + This file must list the IP-addresses of clients that are allowed + to connect. If it does not exist, all clients are able to connect. + If the file is empty, no clients can connect. + + + OPTIONS + + + + + + + The port the server should listen to. A valid port is + any number between 1 and 65536; if 0 is used, nbd-server + will listen on stdin (so that nbd-server can be ran from + inetd) + + + + + + The filename of the file that should be exported. This + can be any file, including "real" blockdevices (i.e. a file + from /dev). If the filename includes the literal string + "%s", then this %s will be substituded with the IP-address + of the client trying to connect. + + + + + + The size of the block device at the client side. This + is especially usefull in conjunction with the -m + option + Can optionally be followed by one of K,k,M or + m, in which case the size will be multiplied by 1024 (K + or k) or 1048576 (M or m) + + + + + + Export the file read-only. If a client tries to write + to a read-only exported file, it will receive an error, but + the connection will stay up. + + + + + + Work with multiple files. This can be used to export + blockdevices that are larger than the maximum allowed + filesize on a given filesystem; i.e. when the filesystem + does not allow files larger than 2GB (which is true for + Linux 2.2 and below), you can use this option to store the + data in multiple files and export a larger filesystem, if + needed. + + + + + + Copy on write. When this option is provided, + write-operations are not done to the exported file, but to a + separate file. This separate file is removed when the + connection is closed, which means that serving this way will + make nbd-server slow down (especially on large block devices + with lots of writes), and that after disconnecting and + reconnecting the client or the server, all changes are + lost. + + + + + + EXAMPLES + Some examples of nbd-server usage: + + + To export a file /export/nbd/exp-bl-dev on port 2000: + nbd-server 2000 /export/nbd/exp-bl-dev + + + To export a the same file read-only: + nbd-server 2000 /export/nbd/exp-bl-dev -r + + + To export the same file read-write, but make sure + changes are lost after restarting the client or the + server: + nbd-server 2000 /export/nbd/exp-bl-dev + -c + + + + + FILES + + nbd_server.allow + + + + SEE ALSO + + nbd-client (8). + + + + AUTHOR + + This manual page was written by &dhusername; (&dhemail;) for + the &debian; system (but may be used by others). Permission is + granted to copy, distribute and/or modify this document under + the terms of the GNU Free Documentation + License, Version 1.1 or any later version published by the Free + Software Foundation; with no Invariant Sections, no Front-Cover + Texts and no Back-Cover Texts. + + + + +