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