Commit Graph

171 Commits

Author SHA1 Message Date
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
Xavier Delaruelle
77d604b993 doc: clarify set-alias only define shell alias 2022-08-03 20:51:52 +02:00
Xavier Delaruelle
6f9928f3bf ts/doc: add mod-to-sh test/doc on 'module-info command' 2022-07-30 16:07:28 +02:00
Xavier Delaruelle
7b2147c2e8 doc: desc. subcmd in modulefile(4) if avail from this ctx 2022-07-30 16:07:28 +02:00
Xavier Delaruelle
ccd7f1e719 doc: desc --optional option in man/changes/design 2022-06-01 07:43:17 +02:00
Xavier Delaruelle
0a8c89b487 doc: --tag update tag list if mod is loaded already 2022-04-25 18:09:35 +02:00
Xavier Delaruelle
9f8d687375 doc: desc avail module subcmds in modulefile interp ctx 2022-04-11 06:24:59 +02:00
Xavier Delaruelle
b184c67f9e doc: add mfile/rc interp diff table in modulefile man 2022-04-10 18:33:06 +02:00
Xavier Delaruelle
0eeb35c378 doc: mention use/unuse in module modulefile man section 2022-04-08 07:06:24 +02:00
Xavier Delaruelle
0cb08ffd70 doc: add Lmod Tcl mfile support section in modulefile(4) 2022-03-22 20:46:14 +01:00
Xavier Delaruelle
f8719d85b6 doc: desc. pushenv in changes/man 2022-03-15 06:31:00 +01:00
Xavier Delaruelle
c0ca0400fa doc: magic cookie means file signature
Update documentation to clarify that the Modules magic cookie
corresponds to a file signature.
2022-03-09 07:08:27 +01:00
Xavier Delaruelle
3bbac40541 doc: desc. Dependencies between modulefiles
Fixes #431.
Fixes #433.
2022-03-04 07:34:26 +01:00
Xavier Delaruelle
de572f5dc2 doc: desc. completion support on sh-to-mod/source-sh man 2022-02-11 07:16:55 +01:00
Xavier Delaruelle
f8f6e7d0de doc: desc. complete/uncomplete in man 2022-02-11 07:16:55 +01:00
Xavier Delaruelle
523713078e doc: desc. family in man/changes 2022-01-10 20:55:12 +01:00
Xavier Delaruelle
e6284a63b3 doc: desc. prestdout channel in man/changes/NEWS 2022-01-09 20:44:35 +01:00
Xavier Delaruelle
38587a777c doc: desc. puts mfcmd in man 2022-01-09 13:30:12 +01:00
Xavier Delaruelle
128a8dafc6 doc: desc auto_handling on prereq in man 2022-01-09 13:29:29 +01:00
Xavier Delaruelle
9c5b137ec4 doc: desc mcookie_check in changes/man 2022-01-03 06:38:16 +01:00
Xavier Delaruelle
71f123053b doc: desc. --not-req support on module try-load/load-any 2021-12-25 16:37:13 +01:00
Xavier Delaruelle
1c17f2e23c doc: desc. load-any in NEWS/changes/man 2021-12-25 16:37:13 +01:00
Xavier Delaruelle
8570ed7da7 doc: desc. --tag opt on load-any in NEWS/changes/man/design 2021-12-24 16:04:16 +01:00
Xavier Delaruelle
a18618ff94 ts/doc: add load-any test/doc on 'module-info command' 2021-12-24 16:04:16 +01:00
Xavier Delaruelle
45239f61ca doc: desc. always-load in NEWS/changes/man 2021-12-24 16:04:16 +01:00
Xavier Delaruelle
2a2af4c424 doc: fix missing only html directive in mans 2021-12-24 16:04:16 +01:00
Xavier Delaruelle
bf84b4c2a3 doc: desc keep-loaded tag in INSTALL/design/mans 2021-12-24 16:04:16 +01:00
Xavier Delaruelle
98252083b0 doc: desc --tag option in changes/NEWS/mans 2021-12-18 10:05:24 +01:00
Xavier Delaruelle
b44f527af1 doc: desc prereq-all in NEWS/changes/man 2021-12-03 07:29:03 +01:00
Xavier Delaruelle
d42853d3fb doc: split prereq/conflict man description 2021-12-03 07:28:16 +01:00
Xavier Delaruelle
5be8f99d58 doc: desc depends-on in NEWS/changes/man/design 2021-12-03 07:28:15 +01:00
Xavier Delaruelle
37484a3173 doc: desc. require-fullname in man/changes/NEWS 2021-12-03 07:26:03 +01:00
Xavier Delaruelle
88a26dd58e doc: desc reportError and reportWarning in man/changes/NEWS 2021-12-01 07:30:42 +01:00