From: Wouter Verhelst <w@uter.be>
Date: Sun, 25 Jul 2010 13:19:20 +0000 (+0200)
Subject: Documentation update
X-Git-Url: http://git.alex.org.uk

Documentation update
---

diff --git a/nbd-client.8.sgml b/nbd-client.8.sgml
index 3cc6c8b..65f0e21 100644
--- a/nbd-client.8.sgml
+++ b/nbd-client.8.sgml
@@ -55,8 +55,6 @@ manpage.1: manpage.sgml
   <refsynopsisdiv>
     <cmdsynopsis>
       <command>&dhpackage;</command>
-      <arg><option>bs=<replaceable>blocksize</replaceable></option></arg>
-      <arg><option>timeout=<replaceable>seconds</replaceable></option></arg>
       <arg choice=plain><option><replaceable>host</replaceable></option></arg>
       <arg choice=plain><option><replaceable>port</replaceable></option></arg>
       <arg choice=plain><option><replaceable>nbd-device</replaceable></option></arg>
@@ -64,6 +62,8 @@ manpage.1: manpage.sgml
       <arg><option>-swap</option></arg>
       <arg><option>-persist</option></arg>
       <arg><option>-nofork</option></arg>
+      <arg><option>-block-size <replaceable>block size</replaceable></option></arg>
+      <arg><option>-timeout <replaceable>seconds</replaceable></option></arg>
     </cmdsynopsis>
     <cmdsynopsis>
       <command>&dhpackage;</command>
@@ -96,9 +96,9 @@ manpage.1: manpage.sgml
 
     <variablelist>
       <varlistentry>
-	<term><option>bs=<replaceable>blocksize</replaceable></option></term>
+	<term><option>-block-size <replaceable>block size</replaceable></option></term>
 	<listitem>
-	  <para>Use a blocksize of "blocksize". Default is 1024;
+	  <para>Use a blocksize of "block size". Default is 1024;
 	    allowed values are either 512, 1024, 2048 or 4096</para>
 	</listitem>
       </varlistentry>
@@ -111,7 +111,7 @@ manpage.1: manpage.sgml
 	</listitem>
       </varlistentry>
       <varlistentry>
-	<term><option>timeout=<replaceable>seconds</replaceable></option></term>
+	<term><option>-timeout <replaceable>seconds</replaceable></option></term>
 	<listitem>
 	  <para>Set the connection timeout to "seconds". For this to
 	  work, you need a kernel with support for the NBD_SET_TIMEOUT
diff --git a/nbd-client.c b/nbd-client.c
index 0e1da2b..1a2e5e9 100644
--- a/nbd-client.c
+++ b/nbd-client.c
@@ -227,9 +227,10 @@ void finish_sock(int sock, int nbd, int swap) {
 
 void usage(void) {
 	fprintf(stderr, "nbd-client version %s\n", PACKAGE_VERSION);
-	fprintf(stderr, "Usage: nbd-client [bs=blocksize] [timeout=sec] host port nbd_device [-swap] [-sdp] [-persist] [-nofork]\n");
+	fprintf(stderr, "Usage: nbd-client host port nbd_device [-block-size|-b block size] [-timeout|-t timeout] [-swap|-s] [-sdp|-S] [-persist|-p] [-nofork|-n]\n");
 	fprintf(stderr, "Or   : nbd-client -d nbd_device\n");
 	fprintf(stderr, "Or   : nbd-client -c nbd_device\n");
+	fprintf(stderr, "Or   : nbd-client -h|--help\n");
 	fprintf(stderr, "Default value for blocksize is 1024 (recommended for ethernet)\n");
 	fprintf(stderr, "Allowed values for blocksize are 512,1024,2048,4096\n"); /* will be checked in kernel :) */
 	fprintf(stderr, "Note, that kernel 2.4.2 and older ones do not work correctly with\n");