Skip to content

Commit 9d295a5

Browse files
committed
Add a man page
1 parent a1e49eb commit 9d295a5

File tree

6 files changed

+66
-3
lines changed

6 files changed

+66
-3
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ kubernetes-backup
88
dist/*
99
katafygio
1010
profile.cov
11+
katafygio.8.gz

.goreleaser.yml

+4
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ builds:
1212
- arm
1313
- arm64
1414
- "386"
15+
hooks:
16+
post: make man
1517

1618
release:
1719
# don't autopublish
@@ -52,6 +54,8 @@ nfpm:
5254
- git
5355
config_files:
5456
"./assets/katafygio.yaml": "/etc/katafygio/katafygio.yaml"
57+
files:
58+
"./katafygio.8.gz": "/usr/share/man/man8/katafygio.8.gz"
5559
overrides:
5660
rpm:
5761
replacements:

Makefile

+3
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ lint:
2828
--enable=goimports \
2929
./...
3030

31+
man:
32+
go run assets/manpage.go
33+
3134
fmt:
3235
go fmt ./...
3336

assets/manpage.go

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
// +build ignore
2+
3+
package main
4+
5+
import (
6+
"compress/gzip"
7+
"log"
8+
"os"
9+
10+
"github.com/bpineau/katafygio/cmd"
11+
"github.com/spf13/cobra/doc"
12+
)
13+
14+
func main() {
15+
header := &doc.GenManHeader{
16+
Title: "KATAFYGIO",
17+
Section: "8",
18+
Source: "Katafygio",
19+
}
20+
21+
f, err := os.Create("katafygio.8.gz")
22+
if err != nil {
23+
log.Fatal(err)
24+
}
25+
26+
zw := gzip.NewWriter(f)
27+
28+
if err = doc.GenMan(cmd.RootCmd, header, zw); err != nil {
29+
log.Fatal(err)
30+
}
31+
32+
if err = zw.Flush(); err != nil {
33+
log.Fatal(err)
34+
}
35+
36+
if err = zw.Close(); err != nil {
37+
log.Fatal(err)
38+
}
39+
40+
if err = f.Close(); err != nil {
41+
log.Fatal(err)
42+
}
43+
}

glide.lock

+13-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

glide.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,5 @@ import:
4141
version: ^1.1.0
4242
- package: github.com/Azure/go-autorest
4343
version: v9.10.0
44+
- package: github.com/russross/blackfriday
45+
version: ~2.0.0

0 commit comments

Comments
 (0)