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 choice=plain><option><replaceable>host</replaceable></option></arg>
  60       <arg choice=plain><option><replaceable>port</replaceable></option></arg>
  61       <arg choice=plain><option><replaceable>nbd-device</replaceable></option></arg>
  62       <arg><option>-swap</option></arg>
  63       <arg><option>-persist</option></arg>
  64       <arg><option>-timeout <replaceable>timeout</replaceable></option></arg>
  65     </cmdsynopsis>
  66     <cmdsynopsis>
  67       <command>&dhpackage;</command>
  68       <arg choice=plain><option>-d <replaceable>nbd-device</replaceable></option></arg>
  69     </cmdsynopsis>
  70   </refsynopsisdiv>
  71   <refsect1>
  72     <title>DESCRIPTION</title>
  73
  74     <para>With <command>&dhpackage;</command>, you can connect to a
  75     server running <command>nbd-server</command>, thus using raw
  76     diskspace from that server as a blockdevice on the local
  77     client.</para>
  78
  79     <para>To do this, support from the Linux Kernel is necessary, in
  80     the form of the Network Block Device (NBD). When you have that,
  81     either in the kernel, or as a module, you can connect to an NBD
  82     server and use its exported file through a block special file with
  83     major mode 43.</para>
  84
  85   </refsect1>
  86   <refsect1>
  87     <title>OPTIONS</title>
  88
  89     <para>The following options are supported:</para>
  90
  91     <variablelist>
  92       <varlistentry>
  93         <term><option>bs=<replaceable>blocksize</replaceable></option></term>
  94         <listitem>
  95           <para>Use a blocksize of "blocksize". Default is 1024;
  96             allowed values are either 512, 1024, 2048 or 4096</para>
  97         </listitem>
  98       </varlistentry>
  99       <varlistentry>
 100         <term><option>host</option></term>
 101         <listitem>
 102           <para>The hostname of the machine running
 103             <command>nbd-server</command>.</para>
 104         </listitem>
 105       </varlistentry>
 106       <varlistentry>
 107         <term><option>port</option></term>
 108         <listitem>
 109           <para>The TCP port on which <command>nbd-server</command> is
 110             running at the server.</para>
 111         </listitem>
 112       </varlistentry>
 113       <varlistentry>
 114         <term><option>nbd-device</option></term>
 115         <listitem>
 116           <para>The block special file this nbd-client should connect
 117             to.</para>
 118         </listitem>
 119       </varlistentry>
 120       <varlistentry>
 121         <term><option>-swap</option></term>
 122         <listitem>
 123           <para>Specifies that this NBD device will be used as
 124             swapspace. If you intend to do that, please use this
 125             option to prevent deadlocks. You'll need a special kernel
 126             patch, available at NBD's homepage:
 127             http://atrey.karlin.mff.cuni.cz/~pavel</para>
 128         </listitem>
 129       </varlistentry>
 130     </variablelist>
 131   </refsect1>
 132   <refsect1>
 133     <title>EXAMPLES</title>
 134
 135     <para>Some examples of nbd-client usage:</para>
 136     <itemizedlist mark="none">
 137       <listitem>
 138         <para>To connect to a server running on port 2000 at host
 139           "server.domain.com", using the client's block special file
 140           "/dev/nb0":</para>
 141         <para><command>nbd-client server.domain.com 2000
 142           /dev/nb0</command></para>
 143       </listitem>
 144       <listitem>
 145         <para>To connect to a server running on port 2001 at host
 146           "swapserver.domain.com", using the client's block special
 147           file "/dev/nb1", for swap purposes:</para>
 148         <para><command>nbd-client swapserver.domain.com 2001 /dev/nb1
 149           -swap</command></para>
 150       </listitem>
 151       <listitem>
 152         <para>To disconnect the above connection again (after making
 153           sure the block special file is not in use anymore):</para>
 154         <para><command>nbd-client -d /dev/nb1</command></para>
 155       </listitem>
 156     </itemizedlist>
 157   </refsect1>
 158   <refsect1>
 159     <title>SEE ALSO</title>
 160
 161     <para>nbd-server (1).</para>
 162
 163   </refsect1>
 164   <refsect1>
 165     <title>AUTHOR</title>
 166     <para>The NBD kernel module and the NBD tools have been written by
 167     Pavel Macheck (pavel@ucw.cz).</para>
 168
 169     <para>The kernel module is now maintained by Paul Clements
 170     (Paul.Clements@steeleye.com), while the userland tools are maintained by
 171     Wouter Verhelst (wouter@debian.org)</para>
 172
 173     <para>This manual page was written by &dhusername; (&dhemail;) for
 174     the &debian; system (but may be used by others).  Permission is
 175     granted to copy, distribute and/or modify this document under the
 176     terms of the <acronym>GNU</acronym> General Public License,
 177     version 2, as published by the Free Software Foundation.</para>
 178
 179   </refsect1>
 180 </refentry>
 181
 182 <!-- Keep this comment at the end of the file
 183 Local variables:
 184 mode: sgml
 185 sgml-omittag:t
 186 sgml-shorttag:t
 187 sgml-minimize-attributes:nil
 188 sgml-always-quote-attributes:t
 189 sgml-indent-step:2
 190 sgml-indent-data:t
 191 sgml-parent-document:nil
 192 sgml-default-dtd-file:nil
 193 sgml-exposed-tags:nil
 194 sgml-local-catalogs:nil
 195 sgml-local-ecat-files:nil
 196 End:
 197 -->