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

module.1 man page is not in the man format #686

Open
lahwaacz opened this issue Feb 4, 2024 · 0 comments
Open

module.1 man page is not in the man format #686

lahwaacz opened this issue Feb 4, 2024 · 0 comments

Comments

@lahwaacz
Copy link

lahwaacz commented Feb 4, 2024

The Makefile installs a module.1 man page which is not in the man format, but a plain-text file:

$(PATH_TO_LUA) $(srcdir)/src/lmod.in.lua bash --help 2> $(DESTDIR)$(MAN_PAGES)/module.1

This results in suboptimal formatting when viewed with the man utility from man-db:

Usage: module [options] sub‐command [args ...]

Options:
  ‐h ‐? ‐H ‐‐help                   This help message
  ‐s  availStyle ‐‐style=availStyle  Site controlled avail style:
system
                                    (default: system)
  ‐‐regression_testing              Lmod regression testing
  ‐b ‐‐brief                        brief listing with only  user
specified
                                    modules
  ‐D                                 Program  tracing  written to
stderr
  ‐‐debug=dbglvl                    Program  tracing  written  to
stderr (where
                                    dbglvl is a number 1,2,3)
  ‐‐pin_versions=pinVersions         When  doing  a  restore  use
specified
                                    version, do  not  follow  de‐
faults
  ‐d  ‐‐default                       List  default  modules only
when used with
                                    avail
...

mandoc can't even parse it and displays unreadable "binary data".

Please write a proper man page in a supported format.

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

1 participant