-
-
Notifications
You must be signed in to change notification settings - Fork 416
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Help and man page inconsistencies #105
Labels
Comments
ghost
added
the
Bug
label
Jun 21, 2020
ghost
changed the title
Help page and man page inconsistencies
Help and man page inconsistencies
Jun 21, 2020
FYI, this is being worked on (and is already complete in my fork.) |
Get in a PR then ;) |
concussious
added a commit
to concussious/cmatrix
that referenced
this issue
Apr 1, 2024
concussious
added a commit
to concussious/cmatrix
that referenced
this issue
Apr 1, 2024
concussious
added a commit
to concussious/cmatrix
that referenced
this issue
Apr 1, 2024
concussious
added a commit
to concussious/cmatrix
that referenced
this issue
Apr 1, 2024
concussious
added a commit
to concussious/cmatrix
that referenced
this issue
Apr 2, 2024
concussious
added a commit
to concussious/cmatrix
that referenced
this issue
Apr 2, 2024
concussious
added a commit
to concussious/cmatrix
that referenced
this issue
Apr 5, 2024
- cmatrix.1 > cmatrix.6 (screensavers traditionally filed as games) - rewrite in mdoc(7) - write document description for visibility in manual searches - maintain synopsis, options, and keystrokes - write vendor neutral description of the program - add examples including vendor neutral examples - move homepage to SEE ALSE and link it as well as relevant pages - add terse HISTORY - make program usage output consistent with the maintenance above Fixes: abishekvashok#87 , abishekvashok#105 and abishekvashok#162
concussious
added a commit
to concussious/cmatrix
that referenced
this issue
Apr 5, 2024
- cmatrix.1 > cmatrix.6 (screensavers traditionally filed as games) - rewrite in mdoc(7) - write document description for visibility in manual searches - maintain synopsis, options, and keystrokes - write vendor neutral description of the program - add examples including vendor neutral examples - move homepage to SEE ALSO, link it, and relevant pages - add terse HISTORY - make program usage output consistent with the maintenance above Fixes: abishekvashok#87, abishekvashok#105, and abishekvashok#162
concussious
added a commit
to concussious/cmatrix
that referenced
this issue
Apr 5, 2024
- cmatrix.1 > cmatrix.6 (screensavers traditionally filed as games) - rewrite in mdoc(7) - write document description for visibility in manual searches - maintain synopsis, options, and keystrokes (consisency, organization) -do this in cmatrix.c logic and usage as well - write vendor neutral description of the program - add examples including vendor neutral examples - move homepage to SEE ALSO, link it, and relevant pages - add terse HISTORY Fixes: abishekvashok#87, abishekvashok#105, and abishekvashok#162
concussious
added a commit
to concussious/cmatrix
that referenced
this issue
Apr 12, 2024
- cmatrix.1 > cmatrix.6 (other screensavers seem filed as games) - rewrite manual in mdoc(7) according to its best practices - write document description for visibility in manual searches - maintain synopsis, options, and keystrokes (consisency, organization, nits) -do this in cmatrix.c usage for consistency - do this in cmatrix.c logic for maintainability - write vendor neutral description of the program - add EXAMPLES including updated readme and vendor neutral examples - add SEE ALSO, including homepage as well as relevant manual pages - add HISTORY mentioning original author, date, and vendor - add CAVEATS mentioning trademarks - revise BUGS, black doesn't work, and cmatrix no longer has high utilization Fixes: abishekvashok#87, abishekvashok#105, and abishekvashok#162
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
cmatrix/cmatrix.c
Line 140 in 3ed4d00
cmatrix/cmatrix.1
Line 6 in 3ed4d00
A few switches do not appear in help page printed with
cmatrix -h
, which is inconsistent.The following are omitted:
-L
-o
-n
-r
-k
Additionally, the usage instructions within cmatrix and the man page do not appear to be synchronized.
To Reproduce
Run
man cmatrix
orcmatrix -h
Expected behavior
The man page and help page are identical, or at least consistent. Additionally, all the switches are listed at the top, or the switches are outright removed and replaced with a generic placeholder.
The text was updated successfully, but these errors were encountered: