Skip to content

Commit

Permalink
fix: treat extra_install as a string so that goman.1 does not get mis…
Browse files Browse the repository at this point in the history
…-interpreted as a floating-point number.

Add missing goman.1.md (?!)
  • Loading branch information
christophberger committed Dec 14, 2024
1 parent 5b15291 commit fa19bea
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
42 changes: 42 additions & 0 deletions goman.1.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit fa19bea

Please sign in to comment.