Commit Graph

203 Commits

Author SHA1 Message Date
Xavier Delaruelle
2e28703378 doc: desc. haveDynamicMPATH modulefile command
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2025-05-11 10:51:36 +02:00
Xavier Delaruelle
d1fe8a41f3 doc: fix header of shell support table in modulefile man
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2025-05-08 15:49:00 +02:00
Xavier Delaruelle
126c83d63f doc: desc. --respect option support in lmod compat docs
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2025-05-03 10:47:06 +02:00
Xavier Delaruelle
177438b362 doc: desc. --mode option support in lmod compat docs
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2025-05-03 10:30:00 +02:00
Xavier Delaruelle
88dce81ced doc: update Lmod modfile compat man section for add-property
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2025-05-03 08:49:22 +02:00
Xavier Delaruelle
de5052bacb doc: desc. newline char support in env var value
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2025-04-18 09:07:21 +02:00
Xavier Delaruelle
df308108e3 doc: desc. module-warn in man/changes
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2025-04-03 22:01:32 +02:00
Xavier Delaruelle
d58e7fd7ec doc: update add-property to define tag with "value" arg
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2025-03-31 07:05:32 +02:00
Xavier Delaruelle
cbb719a8e2 doc: desc. module-help modulefile command
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2025-03-30 11:07:12 +02:00
Xavier Delaruelle
2de46ec4ab Apply modulepath label also on search and whatis output
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2025-02-18 07:02:13 +01:00
Xavier Delaruelle
c1b9f187ba doc: desc. spider sub-command in man/changes
Also take this opportunity to describe some older changes that were
forgotten.

Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2024-12-25 11:26:12 +01:00
Xavier Delaruelle
294cd1b61f doc: desc. spider{_terse,}_output config in man/changes
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2024-12-22 08:39:31 +01:00
Xavier Delaruelle
242406e9db doc: desc. depends-on-any command in NEWS/man/changes
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2024-11-23 23:28:34 -05:00
Xavier Delaruelle
688c69d2c8 doc: clarify --user/--not-user & --group/--not-group combination
Clarifies that --user prevails over --not-user if same user name is set on
both options. Same for --group/--not-group.

Thanks to Robert McLay for reporting this unclear area of the
documentation.

Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2025-03-07 07:18:57 +01:00
Xavier Delaruelle
41c0fc0831 doc: fix typos on --user/--group options desc
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2025-03-03 07:12:03 +01:00
Xavier Delaruelle
ac6ab6e86a doc: fix typo on module unuse change description
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
2025-03-03 06:15:12 +01:00
Xavier Delaruelle
d1a21a3e5f doc: desc. conflict_unload handling of modpath change 2024-11-10 20:40:16 +01:00
Xavier Delaruelle
a869338041 doc: desc. conflict_unload change for variant 2024-10-11 08:30:56 +02:00
Xavier Delaruelle
29605c61a6 doc: desc. conflict_unload change for module unload 2024-10-11 08:30:56 +02:00
Xavier Delaruelle
81dced6c9b doc: desc. conflict_unload change for conflict/family 2024-10-11 08:30:56 +02:00
Simon Lukas Märtens
738b1c1e3d doc: desc. pwsh support in man/README 2024-09-15 15:02:51 +02:00
Xavier Delaruelle
dd72ccbe32 doc: desc. when value argument was added on getenv 2024-08-19 06:50:34 +02:00
Xavier Delaruelle
18095bbcc9 doc: desc. new variant name rule in NEWS/man 2024-06-13 05:44:12 +02:00
Xavier Delaruelle
e7a6e5c66d doc: split meta info of variant/version spec in modules 2024-06-13 04:55:14 +02:00
Xavier Delaruelle
337750ecfd doc: desc. "puts log" modulefile command in man/changes 2024-06-13 04:55:13 +02:00
Xavier Delaruelle
31401de76e doc: desc. lsb-release command in NEWS/man/changes 2024-06-12 07:08:53 +02:00
Xavier Delaruelle
0b2f58b9f1 doc: desc. --modulepath option in man/changes 2024-06-12 06:43:01 +02:00
Xavier Delaruelle
bad95bfda9 doc: desc. hide-{modulefile,version} modulefile cmds 2024-06-12 06:42:35 +02:00
Xavier Delaruelle
31d96360c2 doc: desc. --user/--group options to module-{hide,forbid,tag} 2024-02-19 20:17:08 +01:00
Xavier Delaruelle
999a8b5cce doc: desc. source-sh --ignore option 2024-02-11 15:37:39 +01:00
Xavier Delaruelle
ad4923a2f0 doc: desc. bash-eval source-sh/sh-to-mod shell mode 2024-02-08 05:42:21 +01:00
Xavier Delaruelle
c1378f9e35 doc: delimiter value allowed on {ap,pre}pend-path 2024-01-29 07:24:06 +01:00
Xavier Delaruelle
a7cf78fc75 doc: desc. forced unload change when error occurs 2023-11-27 20:19:06 +01:00
Xavier Delaruelle
9ffccc2bfc doc: rename error_on_multi_load into abort_on_error
Transform configuration option "error_on_multi_load" (and its relative
environment variable and installation option) to make it more generic
to define the module sub-commands that apply a "abort on error"
behavior.

Configuration option is renamed "abort_on_error", environment variable
"MODULES_ERROR_ON_MULTI_LOAD" and installation option
"--with-abort-on-error".
2023-11-27 20:19:05 +01:00
Laurent
ac158798ff Modulefile man page moved from man4 to man5
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 #518
2023-11-15 15:37:00 +01:00
Xavier Delaruelle
e85e33dee7 doc: desc. --glob option of remove-path 2023-09-13 07:54:45 +02:00
Xavier Delaruelle
e072167ce3 doc: modernize modulefile code examples
Modernize and simplify modulefile code examples in documentation:

* Follow coding convention defined for the project
* Use simple "#%Module" file signature, no "1.0" suffix needed
2023-09-02 09:22:49 +02:00
Xavier Delaruelle
517c8ea59c doc: desc. error_on_multi_load on exit/break mfcmd 2023-09-02 09:22:49 +02:00
Xavier Delaruelle
4d0b166ece doc: better desc. try-load modfile cmd in design/man 2023-09-02 09:22:49 +02:00
Xavier Delaruelle
671eb508c8 doc: desc. modulepath-label in NEWS/man/changes 2023-07-09 21:14:30 +02:00
Xavier Delaruelle
863e16c909 doc: desc. tag set over full path mod in NEWS/man/changes 2023-06-28 07:25:03 +02:00
Xavier Delaruelle
2f443deba2 doc: fix duplicate white-spaces in docs 2023-05-30 21:34:28 +02:00
Xavier Delaruelle
ce5a07bcea doc: desc. scan string returned by module-info mode 2023-04-27 21:02:51 +02:00
Xavier Delaruelle
f387664ac4 doc: desc. limited-access & cache in NEWS/man 2022-12-27 19:22:30 +01:00
Xavier Delaruelle
81b201f315 doc: desc cache in man pages 2022-12-27 18:43:58 +01:00
Xavier Delaruelle
145462a864 ts/doc: add stashpop test/doc on 'module-info command' 2022-09-28 07:20:54 +02:00
Xavier Delaruelle
ec835353b2 ts/doc: add stash test/doc on 'module-info command' 2022-09-28 06:42:59 +02:00
Xavier Delaruelle
d391d31d57 ts/doc: add reset test/doc on 'module-info command' 2022-08-25 08:10:01 +02:00
Xavier Delaruelle
b202ea8a53 doc: add shell support section in modulefile man 2022-08-07 11:25:34 +02:00
Xavier Delaruelle
108caec3ad doc: fix missing ref to cmd shell support 2022-08-06 08:06:18 +02:00