Updating docs for code review (refs #2463)
authorTim Pierce <twp@curoverse.com>
Fri, 11 Apr 2014 18:48:14 +0000 (14:48 -0400)
committerTim Pierce <twp@curoverse.com>
Fri, 11 Apr 2014 18:48:14 +0000 (14:48 -0400)
services/keep/keep.go

index 85e2aea5ef2007408cadbfcc1cc555ab6867221e..7981bb9db4340b4d0bfaf808918834890f66cc70 100644 (file)
@@ -51,7 +51,25 @@ func (e *KeepError) Error() string {
 }
 
 func main() {
-       // Parse command-line flags.
+       // Parse command-line flags:
+       //
+       // -listen=ipaddr:port
+       //    Interface on which to listen for requests. Use :port without
+       //    an ipaddr to listen on all network interfaces.
+       //    Examples:
+       //      -listen=127.0.0.1:4949
+       //      -listen=10.0.1.24:8000
+       //      -listen=:25107 (to listen to port 25107 on all interfaces)
+       //
+       // -volumes
+       //    A comma-separated list of directories to use as Keep volumes.
+       //    Example:
+       //      -volumes=/var/keep01,/var/keep02,/var/keep03/subdir
+       //
+       //    If -volumes is empty or is not present, Keep will select volumes
+       //    by looking at currently mounted filesystems for /keep top-level
+       //    directories.
+
        var listen, keepvols string
        flag.StringVar(&listen, "listen", DEFAULT_ADDR,
                "interface on which to listen for requests")