man/nbdtab.5.in.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: 2006-10-18 15:01:57 +0200 (wo, 18 okt 2006) $</date>">
  17   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  18        allowed: see man(7), man(1). -->
  19   <!ENTITY dhsection   "<manvolnum>5</manvolnum>">
  20   <!ENTITY dhemail     "<email>wouter@debian.org</email>">
  21   <!ENTITY dhusername  "Wouter Verhelst">
  22   <!ENTITY dhucpackage "<refentrytitle>NBDTAB</refentrytitle>">
  23   <!ENTITY dhpackage   "$sysconfdir/nbdtab">
  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>2015</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>configuration file for nbd-client</refpurpose>
  53   </refnamediv>
  54   <refsynopsisdiv>
  55     <cmdsynopsis>
  56       <command>&dhpackage; </command>
  57
  58     </cmdsynopsis>
  59   </refsynopsisdiv>
  60   <refsect1>
  61     <title>DESCRIPTION</title>
  62
  63     <para>This file allows to configure predefined connections for
  64       nbd-client. It may contain multiple definitions, one per line,
  65       each of which contains four space-separated fields.</para>
  66
  67     <para>To connect a device specified in the nbdtab file,
  68       run <command>nbd-client</command>(8) with the short name of that
  69       device as the sole argument. It will then look up the required
  70       information in <filename>nbdtab</filename>, and make the
  71       connection.</para>
  72
  73     <para>Fields are separated from one another by any number of space
  74       or tab characters; records are separated from one another by
  75       newline characters. The file may also contain any number of
  76       comments, which start with a '#' character and continue until the
  77       end of the line or the end of the file, whichever is first.</para>
  78     <refsect2>
  79       <title>Fields</title>
  80       <para>The file contains the following fields:</para>
  81       <orderedlist>
  82         <listitem>
  83           <para>The short name of the device file. That is, it should
  84           contain the name of the device without the leading
  85           <filename>/dev/</filename> part; e.g., it could say
  86           <filename>nbd0</filename>.</para>
  87         </listitem>
  88         <listitem>
  89           <para>The hostname (in case of a TCP socket) or filename (in
  90           case of a unix domain socket) on which the server is
  91           listening.</para>
  92         </listitem>
  93         <listitem>
  94           <para>The name of the export as exported by
  95           <command>nbd-server</command>.</para>
  96         </listitem>
  97         <listitem>
  98           <para>Any extra options. This field is optional (no pun
  99           intended), and need not appear in a file if no options are
 100           necessary. The options recognized by
 101           <command>nbd-client</command>(8) are specified below, in the
 102           section "Options". Any unknown options in
 103           this field will produce a warning by
 104           <command>nbd-client</command>, unless they are prepended by
 105           an underscore ('_') character; the underscore is
 106           specifically reserved for local use, or for distribution
 107           customization.</para>
 108         </listitem>
 109       </orderedlist>
 110     </refsect2>
 111     <refsect2>
 112       <title>Options</title>
 113       <para>Every command-line <command>nbd-client</command> option
 114         has a corresponding option in the <filename>nbdtab</filename> file,
 115         and vice versa; where this isn't the case, that is a
 116         bug.</para>
 117       <para>Individual options in this field should be separated from
 118         one another by the comma character.</para>
 119       <variablelist>
 120         <varlistentry>
 121           <term><option>bs=<replaceable>block size</replaceable></option></term>
 122           <listitem>
 123             <para>The block size for this export. If this option is
 124             not used, the kernel's default will be used
 125             instead.</para>
 126             <para>Corresponds to the <option>-b</option> option on the
 127             command line.</para>
 128           </listitem>
 129         </varlistentry>
 130         <varlistentry>
 131           <term><option>port=<replaceable>port number</replaceable></option></term>
 132           <listitem>
 133             <para>The port on which to communicate with the
 134             <command>nbd-server</command>. Defaults to the
 135             IANA-assigned port for NBD, 10809.</para>
 136           </listitem>
 137         </varlistentry>
 138         <varlistentry>
 139           <term><option>timeout=<replaceable>timeout</replaceable></option></term>
 140           <listitem>
 141             <para>The timeout. If this option is not specified, no
 142             timeout is configured.</para>
 143             <para>Corresponds to the <option>-t</option> option on the
 144             command line.</para>
 145           </listitem>
 146         </varlistentry>
 147         <varlistentry>
 148           <term><option>persist</option></term>
 149           <listitem>
 150             <para>Persist the connection, using the semantics of the
 151             <option>-p</option> command-line option.</para>
 152           </listitem>
 153         </varlistentry>
 154         <varlistentry>
 155           <term><option>swap</option></term>
 156           <listitem>
 157             <para>Optimize for swap; <option>-s</option>.</para>
 158           </listitem>
 159         </varlistentry>
 160         <varlistentry>
 161           <term><option>sdp</option></term>
 162           <listitem>
 163             <para>Use the Socket Direct protocol; <option>-S</option>.</para>
 164           </listitem>
 165         </varlistentry>
 166         <varlistentry>
 167           <term><option>unix</option></term>
 168           <listitem>
 169             <para>Use a Unix Domain socket to connect to the server;
 170             <option>-u</option>.</para>
 171           </listitem>
 172         </varlistentry>
 173       </variablelist>
 174     </refsect2>
 175   </refsect1>
 176   <refsect1>
 177     <title>SEE ALSO</title>
 178
 179     <para>nbd-server (1), nbd-client (8), nbd-trdump (8)</para>
 180
 181
 182   </refsect1>
 183   <refsect1>
 184     <title>AUTHOR</title>
 185     <para>The NBD kernel module and the NBD tools were originally
 186       written by Pavel Machek (pavel@ucw.cz)</para>
 187
 188     <para>The Linux kernel module is now maintained by Paul Clements
 189       (Paul.Clements@steeleye.com), while the userland tools are
 190       maintained by &dhusername; (&dhemail;)</para>
 191
 192     <para>On The Hurd there is a regular translator available to perform the
 193       client side of the protocol, and the use of
 194       <command>nbd-client</command> is not required. Please see the
 195       relevant documentation for more information.</para>
 196
 197     <para>This manual page was written by &dhusername; (&dhemail;).
 198       Permission is granted to copy, distribute and/or modify this
 199       document under the terms of the <acronym>GNU</acronym> General
 200       Public License, version 2, as published by the Free Software
 201       Foundation.</para>
 202
 203   </refsect1>
 204   <refsect1>
 205     <title>EXAMPLES</title>
 206     <para>A simple <filename>nbdtab</filename> file could look like
 207     this:</para>
 208     <programlisting>
 209 # swap space, called "swapexport" on the server
 210 # optimize for swap, and try to reconnect upon disconnect.
 211 nbd0 nbdserver.example.com swapexport swap,persist
 212 # other export, called "data" on the server. No options for this one.
 213 nbd1 nbdserver.example.com data
 214 </programlisting>
 215   </refsect1>
 216 </refentry>