module.1 man page is not in the man format

[lahwaacz]

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

Lmod/Makefile.in

Line 245 in eb3e911

$(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.

[rtmclay]

The branch PR686 now support a man.1 output. Please test it out to see if works for you.

[lahwaacz]

There is no pull request 686, the #686 refers to this issue...

[rtmclay]

I know that issue #686 is not a pull request. As I said, a branch named PR686 has code to generate a manpage for module.1. If you et a chance, please test this branch.

[rtmclay]

O.K. to close this issue?

[rtmclay]

This is now part of Lmod 8.7.44. I'm closing this issue. Feel free to reopen if there are issues.

[lahwaacz]

@rtmclay Thanks, it looks fine in 8.7.44.