1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
# Wilderness Examples
This directory contains a few examples of how [wilderness][wilderness] can be
used to create command line applications with man pages.
- FakeDF: Illustrates how to create an application without subcommands and
mimicks the Unix ``df`` command.
- FakeGit: Illustrates how to create multi-level command line applications
with subcommands, similar to Git.
Building the examples can be done as follows, for each package:
```bash
# Build the man pages
$ python setup.py build_manpages
# Build the source and wheel distributions
$ python setup.py sdist bdist_wheel
# Install the package
$ pip install --user ./dist/*.whl
```
After that, you should be able to run the examples:
* fakedf:
```bash
# Show the man page for fakedf
$ man fakedf
# Show the help
$ fakedf --help
```
* fakegit:
```bash
# Show the man page for fakegit
$ man fakegit
# Show the man page for a subcommand
$ fakegit help clone
# Show the help for the application
$ fakegit
# Show short help for a subcommand
$ fakegit init -h
```
[wilderness]: https://github.com/GjjvdBurg/wilderness
|
