]> arthur.barton.de Git - bup.git/blobdiff - Documentation/bup-web.md
man pages: fix some formatting
[bup.git] / Documentation / bup-web.md
index 624c9aabff74d2b874c65e6fa16324fe0a7f3aa7..03a0a77d1e9c275fe6f41b15132d51ba8d0bdd09 100644 (file)
@@ -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,25 +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`.
 
+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
+\--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