Rewrite and expand manpage #130
Merged
Conversation
This file contains hidden or 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
Member
|
Some decent changes here, but is mdoc available on all systems without installing anything? |
acrisci
reviewed
Apr 20, 2019
Contributor
Author
Yes, mdoc is an old macro set made to markup manpages on the BSD's. Its been expanded over time, but vitually any modern troff supports it (including groff/man-db and mandoc). |
The manpage now uses mdoc(7), structuring info and making it easier to write. Some other things: - Expanded the section on format strings: - List all variables that can be included. - Add the emoji() function to the list. - Split the example over two lines for brevity. - Change the meson var PLAYERCTL_RELEASE_MONTH to PLAYERCTL_RELEASE_DATE. The date is formatted as 'Mon d, yyyy', which is required by mdoc.
cf5ea41 to
dd51e67
Compare
acrisci
reviewed
Apr 20, 2019
acrisci
reviewed
Apr 20, 2019
Contributor
Author
|
On the |
Member
|
Probably a regression in 2.0, #68. |
Member
|
👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The manpage now uses mdoc(7), structuring info and making it easier to
write. Some other things:
emoji()function to the list.PLAYERCTL_RELEASE_MONTHtoPLAYERCTL_RELEASE_DATE. The date is formatted asMon d, yyyy, whichis required by mdoc.