r271: update this document, too

[nbd.git] / README

diff --git a/README b/README
index 98251fa..a53024a 100644 (file)
--- a/README
+++ b/README
@@ -33,7 +33,7 @@ Note that the filename must be an absolute path; i.e., something like
 /path/to/file, not ../file. See the nbd-server manpage for details on
 any available options.
 
-Finally, you'll be able to star the client:
+Finally, you'll be able to start the client:
 
 nbd-client <hostname> <port> <nbd device>
 
@@ -52,18 +52,24 @@ This configuration file is expected to be found at
 
 # This is a comment
 [generic]
-       # The [generic] section is required, but can not currently
-       # contain any options. This section name is reserved for future
-       # use.
+       # The [generic] section is required, even if nothing is specified
+       # there.
+       # When either of these options are specified, nbd-server drops
+       # privileges to the given user and group after opening ports, but
+       # _before_ opening files.
+       user = nbd
+       group = nbd
 [export1]
        exportname = /export/nbd/export1-file
        port = 12345
        authfile = /export/nbd/export1-authfile
        timeout = 30
        filesize = 10000000
-       readonly = no
+       readonly = false
        multifile = false
-       copyonwrite = no
+       copyonwrite = false
+       prerun = dd if=/dev/zero of=%s bs=1k count=500
+       postrun = rm -f %s
 [otherexport]
        exportname = /export/nbd/experiment
        port = 12346