diff doc/command_reference.rst @ 62:fd8c558a89bb draft

Finished, but not finished proofreading.
author David Barts <n5jrn@me.com>
date Sun, 09 Jun 2019 14:16:17 -0700
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/command_reference.rst	Sun Jun 09 14:16:17 2019 -0700
@@ -0,0 +1,59 @@
+********
+Commands
+********
+
+======
+launch
+======
+
+Name
+----
+
+launch — launch a simple server
+
+Synopsis
+--------
+
+.. Ugh; ReST is sufficiently brain damaged that you can't set two glyphs
+.. in different fonts up against each other with no interleaving spaces.
+.. Hence this raw block.
+.. raw:: html
+
+    <kbd>launch</kbd> 
+    [ <kbd>-b</kbd><i>address</i> | <kbd>--bind=</kbd><i>address</i> ]
+    [ <kbd>-c</kbd> | <kbd>--compile</kbd> ]
+    [ <kbd>-d</kbd> | <kbd>--debug</kbd> ]<br/>
+    [ <kbd>-e</kbd><i>encoding</i> | <kbd>--encoding=</kbd><i>encoding</i> ]
+    [ <kbd>-f</kbd> | <kbd>--force</kbd> ]
+    [ <kbd>-h</kbd> | <kbd>--help</kbd> ]<br/>
+    [ <kbd>-p</kbd><i>port</i> | <kbd>--port=</kbd><i>port</i> ]
+    [ <kbd>-s</kbd> | <kbd>--static</kbd> ]
+    <i>directory</i> <i>path</i>
+
+Description
+-----------
+
+This command launches a simple WSGI server (or, with ``launch --compile``, pre-compiles all Python source code to byte code) for the webapp in the specified *directory* on the specified URL *path*. Run ``launch --help`` for an explanation of what each option does.
+
+==============
+install-static
+==============
+
+Name
+----
+
+install-static — install static files from webapp
+
+Synopsis
+--------
+
+``install-static``
+[ ``-h`` | ``--help`` ]
+[ ``-m`` | ``--move`` ]
+[ ``-n`` | ``--no-preserve`` ]
+*source* *target*
+
+Description
+-----------
+
+This command copies (or moves, if so specified) the static files found in the *source* directory to the *target* one. Run ``install-static --help`` for an explanation of what each option does.
\ No newline at end of file