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

Add man page #225

Open
dvzrv opened this issue Oct 18, 2022 · 3 comments
Open

Add man page #225

dvzrv opened this issue Oct 18, 2022 · 3 comments

Comments

@dvzrv
Copy link

dvzrv commented Oct 18, 2022

Hi! I'm packaging desync for Arch Linux.

I noticed that this project does not offer a man page for the desync executable.
This would be very helpful to have, so that people do not have to call the actual executable to read about its options.
Additionally, we (and other distributions, too) have a man page indexing service, which allows to read the man pages of packages online: https://man.archlinux.org
The man page for desync would automatically end up there and can serve as a reference point for further documentation (e.g. in our wiki or in other places).

@folbricht
Copy link
Owner

Great, that would be a good addition to have for sure. I haven't written man pages before but initially we could use the content of the various help texts. Is there a certain layout/structure that would help you package them? I wouldn't mind if you made a PR just for the outline of what it should look like and I fill in the content.

@dvzrv
Copy link
Author

dvzrv commented Nov 22, 2022

Sorry, I'm swamped with so many other things...

Generally, I guess it would be great if the man page is either generated (e.g. from markdown or something similar) or available statically (far less readable) and can be installed to the default locations using a Makefile.

A Makefile should honor $DESTDIR (default to nothing) and allow configuring $PREFIX (default to /usr/local).
The man page can then be installed to $(DESTDIR)/$(PREFIX)/share/man/man1/.

@folbricht
Copy link
Owner

#232 adds a new 'manpage' command which lets you generate them. Does that work for your build-system? Or would you prefer I generate a set and commit into the code?

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