Blame
|
1 | % HELLO(1) Version 1.0 | Frivolous "Hello World" Documentation |
||||||
| 2 | ||||||||
|
3 | ## NAME |
||||||
|
4 | *** |
||||||
|
5 | |||||||
| 6 | **hello** — prints Hello, World! |
|||||||
| 7 | ||||||||
|
8 | ### SYNOPSIS |
||||||
|
9 | *** |
||||||
|
10 | |||||||
| 11 | | **hello** \[**-o**|**--out** _file_] \[_dedication_] |
|||||||
| 12 | | **hello** \[**-h**|**--help**|**-v**|**--version**] |
|||||||
| 13 | ||||||||
|
14 | ### DESCRIPTION |
||||||
|
15 | *** |
||||||
|
16 | |||||||
| 17 | Prints "Hello, _dedication_!" to the terminal. If no dedication is |
|||||||
| 18 | given, uses the default dedication. The default dedication is chosen by |
|||||||
| 19 | the following sequence: |
|||||||
| 20 | ||||||||
| 21 | 1. Using the environment variable *DEFAULT_HELLO_DEDICATION* |
|||||||
| 22 | 2. Using the per-user configuration file, *~/.hellorc* |
|||||||
| 23 | 3. Using the system-wide configuration file, */etc/hello.conf* |
|||||||
| 24 | 4. Finally, using "world". |
|||||||
| 25 | ||||||||
|
26 | #### Options |
||||||
|
27 | |||||||
| 28 | -h, --help |
|||||||
| 29 | ||||||||
| 30 | : Prints brief usage information. |
|||||||
| 31 | ||||||||
| 32 | -o, --output |
|||||||
| 33 | ||||||||
| 34 | : Outputs the greeting to the given filename. |
|||||||
| 35 | ||||||||
| 36 | The file must be an **open(2)**able and **write(2)**able file. |
|||||||
| 37 | ||||||||
| 38 | -v, --version |
|||||||
| 39 | ||||||||
| 40 | : Prints the current version number. |
|||||||
| 41 | ||||||||
|
42 | ### FILES |
||||||
| 43 | *** |
|||||||
|
44 | |||||||
| 45 | *~/.hellorc* |
|||||||
| 46 | ||||||||
| 47 | : Per-user default dedication file. |
|||||||
| 48 | ||||||||
| 49 | */etc/hello.conf* |
|||||||
| 50 | ||||||||
| 51 | : Global default dedication file. |
|||||||
| 52 | ||||||||
|
53 | ### ENVIRONMENT |
||||||
| 54 | *** |
|||||||
|
55 | |||||||
| 56 | **DEFAULT_HELLO_DEDICATION** |
|||||||
| 57 | ||||||||
| 58 | : The default dedication if none is given. Has the highest precedence |
|||||||
| 59 | if a dedication is not supplied on the command line. |
|||||||
| 60 | ||||||||
|
61 | ### BUGS |
||||||
| 62 | *** |
|||||||
|
63 | |||||||
| 64 | See GitHub Issues: <https://github.com/[owner]/[repo]/issues> |
|||||||
| 65 | ||||||||
| 66 | ### AUTHOR |
|||||||
| 67 | *** |
|||||||
| 68 | ||||||||
| 69 | Bob Green <bob@chippers.org.uk> |
|||||||
| 70 | ||||||||
|
71 | ### SEE ALSO |
||||||
| 72 | *** |
|||||||
|
73 | |||||||
| 74 | **hi(1)**, **hello(3)**, **hello.conf(5)** |
|||||||