Lmod icon indicating copy to clipboard operation
Lmod copied to clipboard

module.1 man page is not in the man format

Open lahwaacz opened this issue 6 months ago • 4 comments

The Makefile installs a module.1 man page which is not in the man format, but a plain-text file: https://github.com/TACC/Lmod/blob/eb3e9119ef1ec3a17f2feb693c9dba16e1c93503/Makefile.in#L245

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.

lahwaacz avatar Feb 04 '24 09:02 lahwaacz