mandate 0.1.0

Convert Markdown or YAML manuals into roff manpages
Documentation 
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
54
55

manpage_intro: |
  # mandate(1) -- Convert Markdown or YAML manuals into roff manpages

body: |
  ## SYNOPSIS

  **mandate** -i <input> -p <program> -s <section> -t <title> [options]

  ## DESCRIPTION

  Mandate converts Markdown or YAML-with-Markdown into roff manpages.
  Use YAML input to model structured manuals, or provide Markdown directly.
  It will not write the docs for you, but it will make them look official.

  ## INPUT

  - `manual.md` or `manual.markdown` is treated as Markdown.
  - `manual.yml` or `manual.yaml` is treated as YAML.
  - `-` reads from stdin and auto-detects format.

  ## OPTIONS

  - `-i, --input` path to `manual.yml` or `manual.md` (use `-` for stdin)
  - `-p, --program` program name
  - `-s, --section` man section (default: `1`)
  - `-t, --title` manpage title
  - `-m, --manual-section` manual section label (optional)
  - `--source` source string (optional)
  - `-o, --output` output file path (default: stdout)
  - `--validate` validate YAML input against the built-in schema
  - `--schema` path to an alternate schema to use with `--validate`

  ## EXAMPLES

  Generate a manpage from Markdown:

  ```
  echo '# mytool(1) -- Example tool' | mandate -i - -p mytool -s 1 -t "Mytool Manual"
  ```

  Generate a manpage from YAML:

  ```
  mandate -i manual.yml -p mytool -s 1 -t "Mytool Manual" -o mytool.1
  ```

  ## BUGS

  Likely. Report them or discuss them at:

      https://github.com/claylo/mandate/issues

  ## Author

  Clay Loveless `<clay@loveless.net>`