Skip to content

--help with copy-ready examples; README uses commands instead of a flag table - #4

Merged
githubflyideas merged 1 commit into
mainfrom
feat/help-examples
Sep 11, 2026
Merged

githubflyideas merged 1 commit into
mainfrom
feat/help-examples

Conversation

@githubflyideas

Copy link
Copy Markdown
Owner

See commit message. All help commands executed as printed.

…ag table

--help (also -h, help) now prints to stdout: what fogping does, where data goes,
runnable examples for every common case (first try, login, several users,
--edit workflow, --days, background run/stop, --localhost, upgrade), the ICMP
permission fixes, and a short flag list. Every command in it was executed as
printed. Previously it was the flag package's dump on stderr, which did not
mention user=/passwd= at all.

A bad flag or bad user=/passwd= now prints one line and "Run './fogping
--help' for examples" instead of the whole usage; the --edit refusal shows a
working example.

README: the argument table is replaced by a "Common commands" section that
mirrors --help; the target form table is replaced by example targets.
@githubflyideas
githubflyideas merged commit 979575a into main Sep 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant