comparison 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
comparison
equal deleted inserted replaced
61:55828c01e38f 62:fd8c558a89bb
1 ********
2 Commands
3 ********
4
5 ======
6 launch
7 ======
8
9 Name
10 ----
11
12 launch — launch a simple server
13
14 Synopsis
15 --------
16
17 .. Ugh; ReST is sufficiently brain damaged that you can't set two glyphs
18 .. in different fonts up against each other with no interleaving spaces.
19 .. Hence this raw block.
20 .. raw:: html
21
22 <kbd>launch</kbd>
23 [ <kbd>-b</kbd><i>address</i> | <kbd>--bind=</kbd><i>address</i> ]
24 [ <kbd>-c</kbd> | <kbd>--compile</kbd> ]
25 [ <kbd>-d</kbd> | <kbd>--debug</kbd> ]<br/>
26 [ <kbd>-e</kbd><i>encoding</i> | <kbd>--encoding=</kbd><i>encoding</i> ]
27 [ <kbd>-f</kbd> | <kbd>--force</kbd> ]
28 [ <kbd>-h</kbd> | <kbd>--help</kbd> ]<br/>
29 [ <kbd>-p</kbd><i>port</i> | <kbd>--port=</kbd><i>port</i> ]
30 [ <kbd>-s</kbd> | <kbd>--static</kbd> ]
31 <i>directory</i> <i>path</i>
32
33 Description
34 -----------
35
36 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.
37
38 ==============
39 install-static
40 ==============
41
42 Name
43 ----
44
45 install-static — install static files from webapp
46
47 Synopsis
48 --------
49
50 ``install-static``
51 [ ``-h`` | ``--help`` ]
52 [ ``-m`` | ``--move`` ]
53 [ ``-n`` | ``--no-preserve`` ]
54 *source* *target*
55
56 Description
57 -----------
58
59 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.