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

man page missing #334

Closed
ole-tange opened this issue Mar 21, 2021 · 6 comments · Fixed by #975
Closed

man page missing #334

ole-tange opened this issue Mar 21, 2021 · 6 comments · Fixed by #975
Labels
documentation Missing or wrong documentation enhancement New feature or request

Comments

@ole-tange
Copy link

$ man reuse
No manual entry for reuse
@mxmehl mxmehl added the enhancement New feature or request label Mar 29, 2021
@mxmehl
Copy link
Member

mxmehl commented Mar 29, 2021

Ideally this would be generated automatically from the existing docu in some sort.

@stephanlachnit
Copy link

help2man reuse --no-info > reuse.1 is probably enough here and easy to implement. And it can be done at build time.

Note: For reproducibility, you might need to set SOURCE_DATE_EPOCH (see https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=787444), but reproducible build servers should do that automatically.

@ole-tange
Copy link
Author

To me just converting the help text would not be enough: The man page should contain all information that is needed to run this version, and not just refer to online documentation.

There are several problems with online documentation:

  • They often only refer to the newest version and not the version you have installed.
  • They do not work if the hosting provider no longer wants to host them (you will be surprised how common this is after just 10 years).

But I agree with @mxmehl that it ought to be possible to generate it from the existing documentation.

@stephanlachnit
Copy link

A full documentation should be installed sperately, at least that's what Debian does everywhere. Man pages usually for cli programs, offline html for full docs.

@stephanlachnit
Copy link

Maybe useful: https://pypi.org/project/click-man/

@mxmehl mxmehl added the documentation Missing or wrong documentation label Jun 2, 2022
@jonasstein
Copy link

We generate man from .rst and included a git workflow and makefiles https://github.com/scsitape/stenc
and it works very well. Perhaps you can reuse some ideas here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Missing or wrong documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants