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

Build instructions for man pages #1329

Closed
ryanthomas-org opened this issue Aug 31, 2024 · 2 comments
Closed

Build instructions for man pages #1329

ryanthomas-org opened this issue Aug 31, 2024 · 2 comments

Comments

@ryanthomas-org
Copy link

Just successfully built picom-12-rc3 on Linux Mint 21,1 5.15.0-91-generic

Can you please provide specific instructions for building the man pages? "No manual entry for picom"

  1. The instructions in the main readme say "to build the documents, you need asciidoc" but it looks like "asciidoctor" is needed and this seems to be a different program.

  2. I have now installed asciidoctor but that does not install the man pages automatically. It may be super obvious to people who work with ninja often but it's not spelled out anywhere here. I see the *.adoc files in the man directory but can anyone provide precise step-by-step instructions for how to convert them properly?

Thanks

@yshui
Copy link
Owner

yshui commented Aug 31, 2024

oh right, i need to update readme to say asciidoctor.

to enable man page, pass -Dwith_docs=true to meson

@ryanthomas-org
Copy link
Author

That did the trick, thanks a bunch

@yshui yshui closed this as completed in 61361ad Sep 8, 2024
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

No branches or pull requests

2 participants