From 5f3a81da32323db6d2e0c369cf5d51c4cdcde2b1 Mon Sep 17 00:00:00 2001 From: Wouter Verhelst Date: Thu, 1 Apr 2010 13:07:26 +0200 Subject: [PATCH] Documentation update Since we now support IPv6, upodate those bits of the documentation that assume v4 only. --- nbd-client.8.in | 7 ++++--- nbd-client.8.sgml | 5 +++-- nbd-server.1.in | 19 +++++++++++++++---- nbd-server.1.sgml | 16 +++++++++++++--- nbd-server.5.in | 17 ++++++++++------- nbd-server.5.sgml | 15 +++++++++------ 6 files changed, 54 insertions(+), 25 deletions(-) diff --git a/nbd-client.8.in b/nbd-client.8.in index 2cd73a1..9ccf65f 100644 --- a/nbd-client.8.in +++ b/nbd-client.8.in @@ -3,7 +3,7 @@ .\" .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng . -.TH "NBD-CLIENT" "8" "26 May 2009" "" "" +.TH "NBD-CLIENT" "8" "01 April 2010" "" "" .SH NAME nbd-client \- connect to a server running nbd-server(1), to use its exported block device @@ -38,8 +38,9 @@ Use a blocksize of "blocksize". Default is 1024; allowed values are either 512, 1024, 2048 or 4096 .TP \fBhost\fR -The hostname of the machine running -\fBnbd-server\fR\&. +The hostname or IP address of the machine running +\fBnbd-server\fR\&. Since 2.9.15, the NBD +utilities support IPv6. .TP \fBtimeout=\fIseconds\fB\fR Set the connection timeout to "seconds". For this to diff --git a/nbd-client.8.sgml b/nbd-client.8.sgml index ef120d9..635fc23 100644 --- a/nbd-client.8.sgml +++ b/nbd-client.8.sgml @@ -105,8 +105,9 @@ manpage.1: manpage.sgml - The hostname of the machine running - nbd-server. + The hostname or IP address of the machine running + nbd-server. Since 2.9.15, the NBD + utilities support IPv6. diff --git a/nbd-server.1.in b/nbd-server.1.in index 673a733..9e9f4cd 100644 --- a/nbd-server.1.in +++ b/nbd-server.1.in @@ -3,13 +3,13 @@ .\" .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng . -.TH "NBD-SERVER" "1" "04 August 2009" "" "" +.TH "NBD-SERVER" "1" "01 April 2010" "" "" .SH NAME nbd-server \- serve a file as a block device to other computers running the GNU/Linux(tm) or GNU/Hurd Operating System .SH SYNOPSIS -\fBnbd-server \fR \fB\fI[ip:]port\fB\fR \fB\fIfilename\fB\fR [ \fB\fIsize\fB\fR ] [ \fB-r\fR ] [ \fB-m\fR ] [ \fB-c\fR ] [ \fB-l \fIhost list filename\fB\fR ] [ \fB-o \fIsection name\fB\fR ] [ \fB-C \fIconfig file\fB\fR ] +\fBnbd-server \fR \fB\fI[ip@]port\fB\fR \fB\fIfilename\fB\fR [ \fB\fIsize\fB\fR ] [ \fB-r\fR ] [ \fB-m\fR ] [ \fB-c\fR ] [ \fB-l \fIhost list filename\fB\fR ] [ \fB-o \fIsection name\fB\fR ] [ \fB-C \fIconfig file\fB\fR ] .SH "DESCRIPTION" .PP @@ -31,8 +31,19 @@ If the file is empty, no clients can connect. .SH "OPTIONS" .TP \fBip\fR -The ip address the server should listen on. If -omitted, 0.0.0.0 (aka "any address") is used. +The ip address the server should listen on. This may +be an IPv4 address, an IPv6 address, or a hostname. In the +latter case, nbd-server will do a hostname lookup for the +name specified, and will listen on the first address that is +returned. For compatibility with past versions of +nbd-server, if an IPv4 address is specified, the @ sign that +serves as separator between the address and port may be +replaced by a colon. + +If this parameter is not specified, nbd-server will +listen on all local addresses on both IPv4 and IPv6. To +limit to IPv4, specify the address as 0.0.0.0; to limit to +IPv6, specify it as ::. .TP \fBport \fR The port the server should listen to. A valid port is diff --git a/nbd-server.1.sgml b/nbd-server.1.sgml index a492875..7219a9c 100644 --- a/nbd-server.1.sgml +++ b/nbd-server.1.sgml @@ -57,7 +57,7 @@ manpage.1: manpage.sgml &dhpackage; - [ip:]port + [ip@]port filename size @@ -94,8 +94,18 @@ manpage.1: manpage.sgml ip - The ip address the server should listen on. If - omitted, 0.0.0.0 (aka "any address") is used. + The ip address the server should listen on. This may + be an IPv4 address, an IPv6 address, or a hostname. In the + latter case, nbd-server will do a hostname lookup for the + name specified, and will listen on the first address that is + returned. For compatibility with past versions of + nbd-server, if an IPv4 address is specified, the @ sign that + serves as separator between the address and port may be + replaced by a colon. + If this parameter is not specified, nbd-server will + listen on all local addresses on both IPv4 and IPv6. To + limit to IPv4, specify the address as 0.0.0.0; to limit to + IPv6, specify it as ::. diff --git a/nbd-server.5.in b/nbd-server.5.in index b59c2e0..079af82 100644 --- a/nbd-server.5.in +++ b/nbd-server.5.in @@ -3,7 +3,7 @@ .\" .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng . -.TH "NBD-SERVER" "5" "18 August 2009" "" "" +.TH "NBD-SERVER" "5" "01 April 2010" "" "" .SH NAME /etc/nbd-server/config \- configuration file for nbd-server @@ -143,10 +143,13 @@ third argument. Optional; string If this option is set, it should contain the local IP -address (in "dotted-quad" notation) on which we should -listen to \fBnbd-client\fR(8) connections. If -it is not set, 0.0.0.0 is used (i.e., "listen on all local -IP addresses") +address on which we should listen to +\fBnbd-client\fR(8) connections. If it is not +set, \fBnbd-server\fR will listen to all +local IPv4 and IPv6 addresses. To limit to IPv6, specify the +address as "::". To limit to IPv4, specify as "0.0.0.0". It +is not possible to specify more than one IP address +here. .TP \fBmultifile\fR Optional; boolean. @@ -156,8 +159,8 @@ If this option is set to true, then form \fIexportname\fR\&.\fIinteger\fR, with \fIexportname\fR being the -filename that would otherwise have been used (after -name transformation for virtualization, if any, has been +filename that would otherwise have been used (after name +transformation for virtualization, if any, has been performed) and \fIinteger\fR an integer number, starting with 0 and ending when no more files can be found. diff --git a/nbd-server.5.sgml b/nbd-server.5.sgml index 60da891..e441244 100644 --- a/nbd-server.5.sgml +++ b/nbd-server.5.sgml @@ -238,10 +238,13 @@ manpage.1: manpage.sgml Optional; string If this option is set, it should contain the local IP - address (in "dotted-quad" notation) on which we should - listen to nbd-client(8) connections. If - it is not set, 0.0.0.0 is used (i.e., "listen on all local - IP addresses") + address on which we should listen to + nbd-client(8) connections. If it is not + set, nbd-server will listen to all + local IPv4 and IPv6 addresses. To limit to IPv6, specify the + address as "::". To limit to IPv4, specify as "0.0.0.0". It + is not possible to specify more than one IP address + here. @@ -254,8 +257,8 @@ manpage.1: manpage.sgml form exportname.integer, with exportname being the - filename that would otherwise have been used (after - name transformation for virtualization, if any, has been + filename that would otherwise have been used (after name + transformation for virtualization, if any, has been performed) and integer an integer number, starting with 0 and ending when no more files can be found. -- 1.7.10.4