search

cea-hpc / modules

Environment Modules: provides dynamic modification of a user's environment
http://modules.sourceforge.net/
GNU General Public License v2.0
668 stars 102 forks source link

modulefile man page is in the wrong man section #518

Closed LaurentChardon closed 7 months ago

LaurentChardon commented 7 months ago

The modulefile man page is in section 4 of man, reserved for special files. It should really be in section 5, for config file formats.

Extract from man man:

The table below shows the section numbers of the manual followed by the types of pages they contain.

   1   Executable programs or shell commands
   2   System calls (functions provided by the kernel)
   3   Library calls (functions within program libraries)
   4   Special files (usually found in /dev)
   5   File formats and conventions, e.g. /etc/passwd
   6   Games
   7   Miscellaneous (including macro packages and conventions), e.g. man(7), groff(7), man-pages(7)
   8   System administration commands (usually only for root)
   9   Kernel routines [Non standard]

I have sent a PR for moving the man page to the proper man section.

LaurentChardon commented 7 months ago

Pull request https://github.com/cea-hpc/modules/pull/517