Mercurial > cgi-bin > hgweb.cgi > tincan

annotate doc/command_reference.rst @ 63:8867b3a5c4fa draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Some minor fixes.
author David Barts <n5jrn@me.com>
date Thu, 20 Jun 2019 21:52:30 -0700
parents fd8c558a89bb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
62
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
1 ********
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
2 Commands
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
3 ********
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
4
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
5 ======
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
6 launch
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
7 ======
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
8
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
9 Name
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
10 ----
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
11
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
12 launch — launch a simple server
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
13
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
14 Synopsis
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
15 --------
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
16
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
17 .. Ugh; ReST is sufficiently brain damaged that you can't set two glyphs
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
18 .. in different fonts up against each other with no interleaving spaces.
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
19 .. Hence this raw block.
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
20 .. raw:: html
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
21
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
22 <kbd>launch</kbd>
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
23 [ <kbd>-b</kbd><i>address</i> | <kbd>--bind=</kbd><i>address</i> ]
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
24 [ <kbd>-c</kbd> | <kbd>--compile</kbd> ]
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
25 [ <kbd>-d</kbd> | <kbd>--debug</kbd> ]<br/>
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
26 [ <kbd>-e</kbd><i>encoding</i> | <kbd>--encoding=</kbd><i>encoding</i> ]
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
27 [ <kbd>-f</kbd> | <kbd>--force</kbd> ]
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
28 [ <kbd>-h</kbd> | <kbd>--help</kbd> ]<br/>
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
29 [ <kbd>-p</kbd><i>port</i> | <kbd>--port=</kbd><i>port</i> ]
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
30 [ <kbd>-s</kbd> | <kbd>--static</kbd> ]
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
31 <i>directory</i> <i>path</i>
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
32
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
33 Description
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
34 -----------
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
35
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
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.
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
37
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
38 ==============
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
39 install-static
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
40 ==============
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
41
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
42 Name
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
43 ----
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
44
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
45 install-static — install static files from webapp
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
46
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
47 Synopsis
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
48 --------
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
49
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
50 ``install-static``
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
51 [ ``-h`` | ``--help`` ]
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
52 [ ``-m`` | ``--move`` ]
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
53 [ ``-n`` | ``--no-preserve`` ]
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
54 *source* *target*
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
55
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
56 Description
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
57 -----------
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
58
fd8c558a89bb Finished, but not finished proofreading.
David Barts <n5jrn@me.com>
parents:
diff changeset
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.