bug fixes
[henge/kiak.git] / usage
diff --git a/usage b/usage
index 3d3eeee..c138a5c 100644 (file)
--- a/usage
+++ b/usage
@@ -5,46 +5,53 @@ directory specified in the requested URL.
 
 CONFIG
   -c, --config=path[:path]...
+
                           Configuration files to use.  Each file in the sequence
                           can override any of the previous file's settings.
                           (/etc/strapp.conf:~/.strapp/strapp.conf:./strapp.conf)
                           - config settings are overridden by command line opts
-                            except where noted
+
   -j, --client-js=path    Path to the client Strapp code (./client.js)
   -J, --host-js=path      Path to the host Strapp code (./host.js)
-  -T, --no-tls=bool       Don't use HTTPS and WSS protocols (false)
-                          - makes 'ca-cert' and 'ca-key' unnecessary
   -C, --ca-cert=path      Accessible location of the CA Cert (../certs/cert.pem)
-  -K, --ca-key=path       Accessible location of the CA Key (../certs/cert.pem)
-  -p, --port=number       The local port to bind HTTPS listener to (2443)
-  -i, --index=path        File serviced at the root domain (./www/index.html)
+  -K, --ca-key=path       Accessible location of the CA Key (../certs/key.pem)
+  -p, --port=number       The local port to bind HTTP/S listener to (2443)
+  -d, --file-dir=path     Path to the directory that will serve files over HTTP
+                          if a client's requested route doesn't exist and can't
+                          be created
 
 ROUTING
   -b, --bind=[string:path[,string:path]]...
-                          Bindings of routes to directories.  Any route bound to
-                          a path will, instead of distributing the strapp client,
-                          service files in that path.  Multiple bindings may be
-                          established by separating the key:value pairs with ','
-                          commas. (www:./www)
+
+                          Bindings of routes to paths.  Any route bound to a 
+                          path will, instead of distributing the strapp client,
+                          service the file at that path.  If the file is a
+                          directory, it will be mounted at that route.  Multiple
+                          bindings may be established by separating the 
+                          key:value pairs with ',' commas. (www:./www)
                           e.g. Service a typical frontpage
-                            -i./html/index.html -b js:./js,html:./html,css:./css
+                            -i ./html/index.html -b js:./js,html:./html,css:./css
                           e.g. Route-based http hosting
                             -b user1:/home/user1/www,user2:/home/user2/www
+
   -e, --electron=string   Specify a route name for the local electron render
                           window which will be launched on execution (nil)
                           - enables optional electron dependency
-  -d, --dedicated=string  Route all incoming connections to this route (nil)
+
+  -D, --dedicated=string  Route all incoming connections to this route (nil)
                           - can be used in conjunction with '-e' for single-user
-                          e.g. Set the electron window to use route 'default',
-                               Set the dedicated route to 'default'
-                          $ node strapp.js -e default -d default
-                            - All routes point to 'default' which is bound to
-                              the local electron window.  No other hosts may
-                              be established, so no remote hosts may exist
+                          e.g. Create a dedicated electron listener
+                            $ strapp -e default -d default
+                              - All routes point to 'default' which is bound to
+                                the local electron window.  No other hosts may
+                                be established, so no remote hosts may exist
 
 COMPATIBILITY
+  --no-tls=bool           Don't use HTTPS and WSS protocols (false)
+                          - makes 'ca-cert' and 'ca-key' unnecessary
+
   --legacy-socket=bool    Use Socket.io compatibility layer to enable 
                           long-polling and AJAX fallbacks (false)
                           - enables optional socket.io dependency
 
-(c)2017 jk software
+(c)2017 loljk