-
Notifications
You must be signed in to change notification settings - Fork 46
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
Add man page #56
Merged
Merged
Add man page #56
Conversation
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
- Add a simple man page (roff) to be generated by scdoc that contains example usages for users. Avoids the need to refer to the Github page for concrete examples, and is mostly relevant to users who decide to use ULWGL directly from the CLI instead from a client application.
- scdoc will be a new required make build dependency
- Related to Open-Wine-Components#56 (comment)
- Install configuration documentation to man5 directory
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a simple man page to the project that contains some example usages for users, which avoids the need to refer to the Github page for concrete examples. Targeted for system package installations, and for users who use ULWGL directly from the CLI instead from a client application.
The man page will be generated by scdoc, thus will be a build dependency.