aboutsummaryrefslogtreecommitdiff
path: root/internal/manpage/gen.go
blob: 90fefc6e934b114a13c4202ec4590f1f4fb31a40 (plain)
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
// Package manpage is a manpage generator based on command line flags from package flag.
package manpage

import (
	"flag"
	"html/template"
	"log"
	"os"
	"path/filepath"
	"strings"
	"time"
)

// DateFormat is the date format used in manpages.
const DateFormat = "January 02, 2006"

// Spew spews out a manpage template for this program then stops execution.
func Spew() {
	var result struct {
		Flags []*flag.Flag
		Name  string
		UName string
		Date  string
	}

	result.Name = filepath.Base(os.Args[0])
	result.UName = strings.ToUpper(result.Name)
	result.Date = time.Now().Format(DateFormat)

	flag.VisitAll(func(f *flag.Flag) {
		result.Flags = append(result.Flags, f)
	})

	var err error
	t := template.New("manpage.1")
	t, err = t.Parse(manpageTemplate)
	if err != nil {
		log.Fatal(err)
	}

	err = t.Execute(os.Stdout, result)
	if err != nil {
		log.Fatal(err)
	}

	os.Exit(0)
}

const manpageTemplate = `.Dd {{.Date}}
.Dt {{ .UName }} 1 URM


.Sh NAME
.Nm {{ .Name }}
.Nd This is a command that needs a description.


.Sh SYNOPSIS
.Nm
{{ range .Flags }}
.Op Fl {{ .Name }}
{{ end }}


.Sh DESCRIPTION
.Nm
is

TODO: FIXME

.Bl -tag -width " " -offset indent -compact

{{ range .Flags }}
.It Fl {{ .Name }}
{{ .Usage }}

The default value for this is {{ .DefValue }}
{{ end }}

.El


.Sh EXAMPLES

.Li {{ .Name }}

.Li {{ .Name }} -license


.Sh DIAGNOSTICS

.Ex -std {{ .Name }}


.Sh SEE ALSO

.Bl -bullet

.It
.Lk hyperlink: http://some.domain Some Text

.El
`