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

modulefile man page is in the wrong man section #518

Closed
LaurentChardon opened this issue Nov 14, 2023 · 1 comment
Closed

modulefile man page is in the wrong man section #518

LaurentChardon opened this issue Nov 14, 2023 · 1 comment
Labels
Milestone

Comments

@LaurentChardon
Copy link
Contributor

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
Copy link
Contributor Author

Pull request #517

@xdelaruelle xdelaruelle added this to the 5.4.0 milestone Nov 15, 2023
xdelaruelle pushed a commit to LaurentChardon/modules that referenced this issue Nov 15, 2023
modulefile man page is currently in the section 4 of man. According to
"man man", this is incorrect, as section 4 is for "Special files (usually
found in /dev)". The man page for modulefile should be in section 5,
"File formats and conventions, e.g. /etc/passwd".

This patch moves modulefile(4) to modulefile(5).

Fixes cea-hpc#518
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants