AltraMayor / AltraMayor/f3

man page: mention all options, or defer to --help?

Open
#116 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
C
Stars
3.4k
Forks
177
Avg merge
2d 15h
Merged PRs (30d)
2

Description

Currently, the common man page for `f3write` and `f3read` only mentions the options `--start-at` and `--end-at` (and only in their long form).
The built-in `--help` mentions quite a few more options: `--start-at`, `--end-at`, `--show-progress`, `--help`, `--usage`, `--version` (and their respective short forms), plus `--max-write-rate` for `f3write`.

Would it be possible to document these (apparently newer) options in the man page?
Or, if you prefer not to maintain documentation in two places, could the man page be replaced/extended with a hint to read `f3{read,write} --help`?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.