nbd-client.8.sgml

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2
   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:
   7
   8 manpage.1: manpage.sgml
   9         docbook-to-man $< > $@
  10   -->
  11
  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">
  24
  25   <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  26   <!ENTITY gnu         "<acronym>GNU</acronym>">
  27 ]>
  28
  29 <refentry>
  30   <refentryinfo>
  31     <address>
  32       &dhemail;
  33     </address>
  34     <author>
  35       &dhfirstname;
  36       &dhsurname;
  37     </author>
  38     <copyright>
  39       <year>2001</year>
  40       <holder>&dhusername;</holder>
  41     </copyright>
  42     &dhdate;
  43   </refentryinfo>
  44   <refmeta>
  45     &dhucpackage;
  46
  47     &dhsection;
  48   </refmeta>
  49   <refnamediv>
  50     <refname>&dhpackage;</refname>
  51
  52     <refpurpose>connect to a server running nbd-server(1), to use its
  53     exported block device</refpurpose>
  54   </refnamediv>
  55   <refsynopsisdiv>
  56     <cmdsynopsis>
  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><option>-sdp</option></arg>
  64       <arg><option>-swap</option></arg>
  65       <arg><option>-persist</option></arg>
  66     </cmdsynopsis>
  67     <cmdsynopsis>
  68       <command>&dhpackage;</command>
  69       <arg choice=plain><option>-d <replaceable>nbd-device</replaceable></option></arg>
  70     </cmdsynopsis>
  71   </refsynopsisdiv>
  72   <refsect1>
  73     <title>DESCRIPTION</title>
  74
  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
  78     client.</para>
  79
  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
  84     major mode 43.</para>
  85
  86   </refsect1>
  87   <refsect1>
  88     <title>OPTIONS</title>
  89
  90     <para>The following options are supported:</para>
  91
  92     <variablelist>
  93       <varlistentry>
  94         <term><option>bs=<replaceable>blocksize</replaceable></option></term>
  95         <listitem>
  96           <para>Use a blocksize of "blocksize". Default is 1024;
  97             allowed values are either 512, 1024, 2048 or 4096</para>
  98         </listitem>
  99       </varlistentry>
 100       <varlistentry>
 101         <term><option>host</option></term>
 102         <listitem>
 103           <para>The hostname of the machine running
 104             <command>nbd-server</command>.</para>
 105         </listitem>
 106       </varlistentry>
 107       <varlistentry>
 108         <term><option>timeout=<replaceable>seconds</replaceable></option></term>
 109         <listitem>
 110           <para>Set the connection timeout to "seconds". For this to
 111           work, you need a kernel with support for the NBD_SET_TIMEOUT
 112           ioctl; this was introduced into Linus' tree on 2007-10-11,
 113           and will be part of kernel 2.6.24.</para>
 114         </listitem>
 115       </varlistentry>
 116       <varlistentry>
 117         <term><option>port</option></term>
 118         <listitem>
 119           <para>The TCP port on which <command>nbd-server</command> is
 120             running at the server.</para>
 121         </listitem>
 122       </varlistentry>
 123       <varlistentry>
 124         <term><option>nbd-device</option></term>
 125         <listitem>
 126           <para>The block special file this nbd-client should connect
 127             to.</para>
 128         </listitem>
 129       </varlistentry>
 130       <varlistentry>
 131         <term>-d</term>
 132         <listitem>
 133           <para>Disconnect the specified nbd device from the
 134           server</para>
 135         </listitem>
 136       </varlistentry>
 137       <varlistentry>
 138         <term>-persist</term>
 139         <listitem>
 140           <para>When this option is specified, &dhpackage; will
 141             immediately try to reconnect an nbd device if the
 142             connection ever drops unexpectedly due to a lost
 143             server or something similar.</para>
 144         </listitem>
 145       </varlistentry>
 146       <varlistentry>
 147         <term><option>-sdp</option></term>
 148         <listitem>
 149           <para>Connect to the server using the Socket Direct Protocol
 150             (SDP), rather than IP. See nbd-server(1) for details.
 151           </para>
 152         </listitem>
 153       </varlistentry>
 154       <varlistentry>
 155         <term><option>-swap</option></term>
 156         <listitem>
 157           <para>Specifies that this NBD device will be used as
 158             swapspace. If you intend to do that, please use this
 159             option to prevent deadlocks. You'll need a special kernel
 160             patch, available at NBD's homepage:
 161             http://atrey.karlin.mff.cuni.cz/~pavel</para>
 162         </listitem>
 163       </varlistentry>
 164     </variablelist>
 165   </refsect1>
 166   <refsect1>
 167     <title>EXAMPLES</title>
 168
 169     <para>Some examples of nbd-client usage:</para>
 170     <itemizedlist mark="none">
 171       <listitem>
 172         <para>To connect to a server running on port 2000 at host
 173           "server.domain.com", using the client's block special file
 174           "/dev/nb0":</para>
 175         <para><command>nbd-client server.domain.com 2000
 176           /dev/nb0</command></para>
 177       </listitem>
 178       <listitem>
 179         <para>To connect to a server running on port 2001 at host
 180           "swapserver.domain.com", using the client's block special
 181           file "/dev/nb1", for swap purposes:</para>
 182         <para><command>nbd-client swapserver.domain.com 2001 /dev/nb1
 183           -swap</command></para>
 184       </listitem>
 185       <listitem>
 186         <para>To disconnect the above connection again (after making
 187           sure the block special file is not in use anymore):</para>
 188         <para><command>nbd-client -d /dev/nb1</command></para>
 189       </listitem>
 190     </itemizedlist>
 191   </refsect1>
 192   <refsect1>
 193     <title>SEE ALSO</title>
 194
 195     <para>nbd-server (1).</para>
 196
 197   </refsect1>
 198   <refsect1>
 199     <title>AUTHOR</title>
 200     <para>The NBD kernel module and the NBD tools have been written by
 201     Pavel Macheck (pavel@ucw.cz).</para>
 202
 203     <para>The kernel module is now maintained by Paul Clements
 204     (Paul.Clements@steeleye.com), while the userland tools are maintained by
 205     Wouter Verhelst (wouter@debian.org)</para>
 206
 207     <para>This manual page was written by &dhusername; (&dhemail;) for
 208     the &debian; system (but may be used by others).  Permission is
 209     granted to copy, distribute and/or modify this document under the
 210     terms of the <acronym>GNU</acronym> General Public License,
 211     version 2, as published by the Free Software Foundation.</para>
 212
 213   </refsect1>
 214 </refentry>
 215
 216 <!-- Keep this comment at the end of the file
 217 Local variables:
 218 mode: sgml
 219 sgml-omittag:t
 220 sgml-shorttag:t
 221 sgml-minimize-attributes:nil
 222 sgml-always-quote-attributes:t
 223 sgml-indent-step:2
 224 sgml-indent-data:t
 225 sgml-parent-document:nil
 226 sgml-default-dtd-file:nil
 227 sgml-exposed-tags:nil
 228 sgml-local-catalogs:nil
 229 sgml-local-ecat-files:nil
 230 End:
 231 -->