Skip to content
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

Cross-platform manual and usage overhaul #186

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

concussious
Copy link

@concussious concussious commented Mar 30, 2024

No functionality change, except that usage is correct and consistent with the manual.

Works great on bsd.
Please test on linux.
Thank you.

Fixes: #87 , #105 and #162

@concussious concussious force-pushed the master branch 12 times, most recently from 3885b34 to 782abf4 Compare April 5, 2024 06:14
@concussious concussious changed the title Cross-platform manual page rewrite in mdoc Cross-platform manual and usage overhaul Apr 5, 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
@concussious
Copy link
Author

Polite ping

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.

Documentation about "-l" lock screen option
1 participant