rm/gc: update README and mention testing in bup-gc(1)

[bup.git] / Documentation / bup-web.md

diff --git a/Documentation/bup-web.md b/Documentation/bup-web.md
index 706fab0566f9a80cb43394bb16563147a1fb624b..2f7750f66f49b0022711b00c63a0c95fbb1b0fe9 100644 (file)
--- a/Documentation/bup-web.md
+++ b/Documentation/bup-web.md
@@ -10,6 +10,8 @@ bup-web - Start web server to browse bup repositiory
 
 bup web [[hostname]:port]
 
+bup web unix://path
+
 # DESCRIPTION
 
 `bup web` starts a web server that can browse bup repositories. The file
@@ -21,20 +23,52 @@ hierarchy is the same as that shown by `bup-fuse`(1), `bup-ls`(1) and
 you'd like to expose the web server to anyone on your network (dangerous!) you
 can omit the bind address to bind to all available interfaces: `:8080`.
 
-# EXAMPLE
+When `unix://path` is specified, the server will listen on the
+filesystem socket at `path` rather than a network socket.
+
+A `SIGTERM` signal may be sent to the server to request an orderly
+shutdown.
+
+# OPTIONS
+
+--human-readable
+:   display human readable file sizes (i.e. 3.9K, 4.7M)
+
+--browser
+:   open the site in the default browser
+
+# EXAMPLES
 
     $ bup web
     Serving HTTP on 127.0.0.1:8080...
     ^C
+    Interrupted.
 
     $ bup web :8080
     Serving HTTP on 0.0.0.0:8080...
     ^C
+    Interrupted.
+
+    $ bup web unix://socket &
+    Serving HTTP on filesystem socket 'socket'
+    $ curl --unix-socket ./socket http://localhost/
+    $ fg
+    bup web unix://socket
+    ^C
+    Interrupted.
 
+    $ bup web &
+    [1] 30980
+    Serving HTTP on 127.0.0.1:8080...
+    $ kill -s TERM 30980
+    Shutdown requested
+    $ wait 30980
+    $ echo $?
+    0
 
 # SEE ALSO
 
-`bup-fuse`(1), `bup-ls`(1), `bup-ftp`(1), `bup-restore`(1)
+`bup-fuse`(1), `bup-ls`(1), `bup-ftp`(1), `bup-restore`(1), `kill`(1)
 
 
 # BUP