doc: Consolidate NetRestrict format docmentation
authorAndrew Deason <adeason@sinenomine.net>
Mon, 18 Jun 2012 20:06:49 +0000 (15:06 -0500)
committerDerrick Brashear <shadow@dementix.org>
Wed, 27 Jun 2012 12:35:21 +0000 (05:35 -0700)
We were specifying exactly the same format in two different places;
consolidate them into one place. In addition, explicitly say there are
is no way to specify a range of addresses, in case some people are
confused by the previous versions of this man page that erroneously
said you could use 255 as a wildcard.

Change-Id: I18d96ee9e6c43dfb62719323fa7eb8d9f254e273
Reviewed-on: http://gerrit.openafs.org/7565
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Derrick Brashear <shadow@dementix.org>

doc/man-pages/pod5/NetRestrict.pod

index 42086da..471b025 100644 (file)
@@ -11,6 +11,13 @@ File Servers it connects to.  The server F<NetRestrict> file specifies
 what interfaces should not be registered with AFS Database Servers or used
 to talk to other database servers.
 
+=head2 FORMAT
+
+The F<NetRestrict> file is in ASCII format. One IP address appears on each
+line, in dotted decimal format. The order of the addresses is not
+significant. There is currently no mechanism to specify a range of
+addresses or a wildcard; each IP address must be listed individually.
+
 =head2 Client NetRestrict
 
 The F<NetRestrict> file, if present in a client machine's F</usr/vice/etc>
@@ -26,10 +33,6 @@ Cache Manager then removes from the list any addresses that appear in the
 F<NetRestrict> file, if it exists. The Cache Manager records the resulting
 list in kernel memory.
 
-The F<NetRestrict> file is in ASCII format. One IP address appears on each
-line, in dotted decimal format. The order of the addresses is not
-significant.
-
 To display the addresses the Cache Manager is currently registering with
 File Servers, use the B<fs getclientaddrs> command.
 
@@ -64,10 +67,6 @@ the VLDB. The database server processes use a similar procedure when
 initializing, to determine which interfaces to use for communication with
 the peer processes on other database machines in the cell.
 
-The F<NetRestrict> file is in ASCII format. One IP address appears on each
-line, in dotted decimal format. The order of the addresses is not
-significant. 
-
 To display the File Server interface addresses registered in the VLDB, use
 the B<vos listaddrs> command.