1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
3 <!-- Process this file with docbook-to-man to generate an nroff manual
4 page: `docbook-to-man manpage.sgml > manpage.1'. You may view
5 the manual page with: `docbook-to-man manpage.sgml | nroff -man |
6 less'. A typical entry in a Makefile or Makefile.am is:
8 manpage.1: manpage.sgml
12 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
13 <!ENTITY dhfirstname "<firstname>Wouter</firstname>">
14 <!ENTITY dhsurname "<surname>Verhelst</surname>">
15 <!-- Please adjust the date whenever revising the manpage. -->
16 <!ENTITY dhdate "<date>$Date$</date>">
17 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
18 allowed: see man(7), man(1). -->
19 <!ENTITY dhsection "<manvolnum>8</manvolnum>">
20 <!ENTITY dhemail "<email>wouter@debian.org</email>">
21 <!ENTITY dhusername "Wouter Verhelst">
22 <!ENTITY dhucpackage "<refentrytitle>NBD-CLIENT</refentrytitle>">
23 <!ENTITY dhpackage "nbd-client">
25 <!ENTITY debian "<productname>Debian GNU/Linux</productname>">
26 <!ENTITY gnu "<acronym>GNU</acronym>">
40 <holder>&dhusername;</holder>
50 <refname>&dhpackage;</refname>
52 <refpurpose>connect to a server running nbd-server(1), to use its
53 exported block device</refpurpose>
57 <command>&dhpackage;</command>
58 <arg><option>bs=<replaceable>blocksize</replaceable></option></arg>
59 <arg><option>timeout=<replaceable>seconds</replaceable></option></arg>
60 <arg choice=plain><option><replaceable>host</replaceable></option></arg>
61 <arg choice=plain><option><replaceable>port</replaceable></option></arg>
62 <arg choice=plain><option><replaceable>nbd-device</replaceable></option></arg>
63 <arg><optoin>-sdp</option></arg>
64 <arg><option>-swap</option></arg>
65 <arg><option>-persist</option></arg>
68 <command>&dhpackage;</command>
69 <arg choice=plain><option>-d <replaceable>nbd-device</replaceable></option></arg>
73 <title>DESCRIPTION</title>
75 <para>With <command>&dhpackage;</command>, you can connect to a
76 server running <command>nbd-server</command>, thus using raw
77 diskspace from that server as a blockdevice on the local
80 <para>To do this, support from the Linux Kernel is necessary, in
81 the form of the Network Block Device (NBD). When you have that,
82 either in the kernel, or as a module, you can connect to an NBD
83 server and use its exported file through a block special file with
88 <title>OPTIONS</title>
90 <para>The following options are supported:</para>
94 <term><option>bs=<replaceable>blocksize</replaceable></option></term>
96 <para>Use a blocksize of "blocksize". Default is 1024;
97 allowed values are either 512, 1024, 2048 or 4096</para>
101 <term><option>host</option></term>
103 <para>The hostname of the machine running
104 <command>nbd-server</command>.</para>
108 <term><option>port</option></term>
110 <para>The TCP port on which <command>nbd-server</command> is
111 running at the server.</para>
115 <term><option>nbd-device</option></term>
117 <para>The block special file this nbd-client should connect
122 <term><option>-sdp</option></term>
124 <para>Connect to the server using the Socket Direct Protocol
125 (SDP), rather than IP. See nbd-server(1) for details.
129 <term><option>-swap</option></term>
131 <para>Specifies that this NBD device will be used as
132 swapspace. If you intend to do that, please use this
133 option to prevent deadlocks. You'll need a special kernel
134 patch, available at NBD's homepage:
135 http://atrey.karlin.mff.cuni.cz/~pavel</para>
141 <title>EXAMPLES</title>
143 <para>Some examples of nbd-client usage:</para>
144 <itemizedlist mark="none">
146 <para>To connect to a server running on port 2000 at host
147 "server.domain.com", using the client's block special file
149 <para><command>nbd-client server.domain.com 2000
150 /dev/nb0</command></para>
153 <para>To connect to a server running on port 2001 at host
154 "swapserver.domain.com", using the client's block special
155 file "/dev/nb1", for swap purposes:</para>
156 <para><command>nbd-client swapserver.domain.com 2001 /dev/nb1
157 -swap</command></para>
160 <para>To disconnect the above connection again (after making
161 sure the block special file is not in use anymore):</para>
162 <para><command>nbd-client -d /dev/nb1</command></para>
167 <title>SEE ALSO</title>
169 <para>nbd-server (1).</para>
173 <title>AUTHOR</title>
174 <para>The NBD kernel module and the NBD tools have been written by
175 Pavel Macheck (pavel@ucw.cz).</para>
177 <para>The kernel module is now maintained by Paul Clements
178 (Paul.Clements@steeleye.com), while the userland tools are maintained by
179 Wouter Verhelst (wouter@debian.org)</para>
181 <para>This manual page was written by &dhusername; (&dhemail;) for
182 the &debian; system (but may be used by others). Permission is
183 granted to copy, distribute and/or modify this document under the
184 terms of the <acronym>GNU</acronym> General Public License,
185 version 2, as published by the Free Software Foundation.</para>
190 <!-- Keep this comment at the end of the file
195 sgml-minimize-attributes:nil
196 sgml-always-quote-attributes:t
199 sgml-parent-document:nil
200 sgml-default-dtd-file:nil
201 sgml-exposed-tags:nil
202 sgml-local-catalogs:nil
203 sgml-local-ecat-files:nil