-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: treat extra_install as a string so that goman.1 does not get mis…
…-interpreted as a floating-point number. Add missing goman.1.md (?!)
- Loading branch information
1 parent
5b15291
commit fa19bea
Showing
2 changed files
with
44 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |