diff --git a/.goreleaser.yml b/.goreleaser.yml index 33ed687..6ede44d 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -58,4 +58,5 @@ brews: description: "The missing man pages for Go binaries" license: "BSD-3-Clause" skip_upload: auto - extra_install: man1.install goman.1 + extra_install: | + man1.install goman.1 diff --git a/goman.1.md b/goman.1.md new file mode 100644 index 0000000..5034941 --- /dev/null +++ b/goman.1.md @@ -0,0 +1,42 @@ +% GOMAN(1) Goman User Manual +% Christoph Berger +% 2024-12-14 + +# NAME + +goman - find a Go binary's README and display it in the terminal like a man page + +# SYNOSPIS + +goman <path to Go binary file> + +goman <path to Go binary file> | less -R + + +# DESCRIPTION + +goman inspects the provided Go binary file to find the originating repository. It then searches the repository for a README file and displays its content in the terminal. + +# OPTIONS + +-r +: Skip local search (as the local file may be outdated) +-v +: Verbose error output + + +# EXAMPLES + +goman goman + +goman hugo | less + +goman docker | less -R + +# LIMITATIONS + +Some Go binaries are built with `ldflags` that shave some information from the binary, or are post-processed with `upx` to minimize their size. In such cases, goman may not be able to find the path to the repository. + +# SEE ALSO + +man(1)