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

Rewrite and expand manpage #130

Merged
merged 6 commits into from
May 10, 2019
Merged

Rewrite and expand manpage #130

merged 6 commits into from
May 10, 2019

Conversation

The-King-of-Toasters
Copy link
Contributor

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.

@acrisci
Copy link
Member

acrisci commented Apr 20, 2019

Some decent changes here, but is mdoc available on all systems without installing anything?

doc/playerctl.1.in Outdated Show resolved Hide resolved
@The-King-of-Toasters
Copy link
Contributor Author

Some decent changes here, but is mdoc available on all systems without installing anything?

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.
doc/playerctl.1.in Outdated Show resolved Hide resolved
meson.build Outdated Show resolved Hide resolved
@The-King-of-Toasters
Copy link
Contributor Author

On the metadata command, the help text looks like you can pass more than one KEY to it (metadata [KEY...]), but my testing only shows that it accepts only one.

@acrisci
Copy link
Member

acrisci commented Apr 21, 2019

Probably a regression in 2.0, #68.

@acrisci
Copy link
Member

acrisci commented May 10, 2019

👍

@acrisci acrisci merged commit 6f545c9 into altdesktop:master May 10, 2019
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.

None yet

2 participants