Commit Graph

170 Commits

Author SHA1 Message Date
Xavier Delaruelle
5342f4d809 doc: fix missing only-html tag in man pages 2021-10-26 14:45:56 +02:00
Xavier Delaruelle
47611c4098 doc: desc var filtering on source-sh/sh-to-mod man 2021-10-25 14:05:36 +02:00
Xavier Delaruelle
b4c0e0f80e doc: desc. state subcmd in man/changes 2021-10-19 07:06:46 +02:00
Xavier Delaruelle
58162e1dd5 Warn if --redirect is used on unsupported shells
--redirect is only supported on sh, bash, ksh, zsh and fish shells. Emit
a warning message when used on another shells.
2021-10-17 20:10:36 +02:00
Xavier Delaruelle
422961ac88 doc: desc. --redirect/--no-redirect in man/changes 2021-10-17 20:10:36 +02:00
Xavier Delaruelle
eed719f02b doc: desc. MODULES_REDIRECT_OUTPUT in man/changes 2021-10-17 20:09:36 +02:00
Xavier Delaruelle
f8e5eac64a doc: desc. redirect_output config in man/changes 2021-10-17 20:09:36 +02:00
Xavier Delaruelle
fca921ad62 doc: desc optional variant value list in man pages 2021-10-17 20:07:35 +02:00
Xavier Delaruelle
cd32959b52 doc: desc. __MODULES_AUTOINIT_INPROGRESS in man/changes 2021-09-27 07:27:32 +02:00
Xavier Delaruelle
c62a2ad306 doc: document initrc/modulespath files in module(1) 2021-09-05 16:05:57 +02:00
Xavier Delaruelle
4fd16e9208 doc: fix some rst markup in INSTALL/NEWS/module(1) 2021-09-05 16:05:57 +02:00
Xavier Delaruelle
cf616c25c2 doc: improve config steps explanation in INSTALL 2021-09-04 15:25:54 +02:00
Xavier Delaruelle
bf4a30c61e doc: update MODULES_SILENT_SHELL_DEBUG in module(1) 2021-09-01 07:48:36 +02:00
Xavier Delaruelle
b68cb6e09f doc: desc. MODULES_QUARANTINE_SUPPORT in module(1) 2021-08-31 05:59:35 +02:00
Xavier Delaruelle
6090d3eda5 doc: desc. __MODULES_QUARANTINE_SET in module(1) 2021-08-31 05:59:35 +02:00
Xavier Delaruelle
f334210470 Enforce magic cookie in source and init/user/global rc
Enforce use of the module magic cookie (i.e., `#%Module`) at the start of
global or user rc files, `initrc` configuration file or any scriptfile
passed for evaluation to the `source` sub-command. These files are not
evaluated and an error is produced if the magic cookie is missing or if
the optional version number placed after the cookie string is higher than
the version of the `modulecmd.tcl` script in use.

Note that version 3.2 of Modules was already enforcing the magic cookie
for the user/global rc files.

This enforced back globally to ensure people understand, especially for
the source sub-command, that the script is made for module and it is not
a shell script. It will also help to protect module from automatically
evaluating files with expected file name but unrelated content.

This commit among things reverts 3fe71c0d.
2021-08-22 09:53:32 +02:00
Xavier Delaruelle
26678c8fe2 doc: desc. refresh subcmd in module(1) 2021-08-13 07:53:54 +02:00
Xavier Delaruelle
7e962617e5 doc: clarify already defined path on use/{append,prepend}-path
Fixes #60.
2021-08-11 17:02:06 +02:00
Xavier Delaruelle
243729e9f6 Fix unuse when multiple paths are passed as single arg
Fix unuse sub-command when sereval modulepaths are specified as a single
argument (i.e., `/path/to/dir1:/path/to/dir2`). Enabled modulepaths were
not correctly detected when specified this way.
2021-08-11 15:28:39 +02:00
Xavier Delaruelle
c6ce9f600e doc: ignore ref count from *use/*-path subcmds 2021-08-11 14:07:16 +02:00
Xavier Delaruelle
47556d96da doc: desc removal from ref count var of elts added once 2021-08-08 17:56:23 +02:00
Xavier Delaruelle
579aad3e70 doc: update reference to renamed __MODULES_SHARE_* vars 2021-08-08 13:27:53 +02:00
Xavier Delaruelle
97447d40a3 doc: remove ref of __MODULES_LMNOTUASKED env var 2021-08-01 20:25:46 +02:00
Xavier Delaruelle
8adeee327d doc: update reference to renamed __MODULES_QUAR_* vars 2021-07-25 10:17:04 +02:00
Xavier Delaruelle
b31c0c7a61 doc: update reference to renamed __MODULES_LM* vars 2021-07-24 14:06:09 +02:00
Xavier Delaruelle
289e1a6348 Remove MODULES_USE_COMPAT_VERSION env variable 2021-07-24 14:06:09 +02:00
Xavier Delaruelle
16a8ccce76 Accept non-existent modulepath on use subcmd
Allow non-existent directory to be specified to use sub-command so
directory that does not exist yet could be added to MODULEPATH prior
being created.

Also it may allow a shared module configuration to define all existing
paths across the network but only some of these paths are enabled on a
given host.
2021-07-16 15:56:28 +02:00
Xavier Delaruelle
54721d65ab doc: add 'Module variants' section in module(1) 2021-07-12 07:55:12 +02:00
Xavier Delaruelle
b77aa68984 doc: desc. variant specification in module(1)/modulefile(4) 2021-07-11 18:35:57 +02:00
Xavier Delaruelle
056a179766 doc: fix syntax of edit subcmd desc. in module(1) 2021-07-11 13:47:50 +02:00
Xavier Delaruelle
f77cde3eeb doc: desc. MODULES_VARIANT_SHORTCUT in module(1) 2021-07-11 13:47:50 +02:00
Xavier Delaruelle
54a510e373 doc: desc. MODULES_LMVARIANT in module(1) 2021-07-11 13:47:50 +02:00
Xavier Delaruelle
1a2de0570c doc: fix options on subcmd aliases in module(1) 2021-07-04 20:34:57 +02:00
Xavier Delaruelle
297cc4d04e doc: desc try-load in module(1) man 2021-07-04 20:34:57 +02:00
Xavier Delaruelle
e893e8f686 install/doc: add va color key
Add the `va` color key in default light and dark color palettes to
graphically enhance the report of variant value.
2021-06-21 20:43:10 +02:00
Xavier Delaruelle
1c5bbd6c90 install/doc: add variant element on list_*output configs
Add the element `variant` in the allow list of the list_output and
list_terse_output configuration options. Set this new element in the
default value list of the list_output configuration option.
2021-06-21 20:43:10 +02:00
Xavier Delaruelle
1217877b80 doc: desc. when new concepts were added in module(1) 2021-05-11 19:43:26 +02:00
Xavier Delaruelle
a04ec85549 doc: desc use of version range in version list in manpages 2021-05-11 19:43:26 +02:00
Xavier Delaruelle
2ea84fd5e6 doc: desc. edit/MODULES_EDITOR in module(1) 2021-04-25 22:22:01 +02:00
Xavier Delaruelle
9109044879 doc: desc. changes on MODULES_COLORS/--with-*-background-colors
Add description of changes that occurred on version 4.6 and 4.7 for the
--with-dark-background-colors and --with-light-background-colors
installation options and for the MODULES_COLORS environment variable.
2021-04-05 22:31:54 +02:00
Xavier Delaruelle
796c2ddb36 doc: fixes few typos in module.1 and modulefile.4 2021-02-28 21:36:37 +01:00
Anais GAERTNER
d54739eb25 doc: desc. term_width/--witdh/-w in module(1) man 2021-02-18 09:45:58 +01:00
Xavier Delaruelle
8cd34a05c9 doc: desc. --output/-o cmd line switches 2021-02-17 16:04:05 +01:00
Xavier Delaruelle
a394c4e452 doc: desc {avail,list}_*output configs with related envar 2021-02-17 16:04:04 +01:00
Xavier Delaruelle
abfb34399e doc: remove avail_report_{dir,mfile}_sym configs 2021-02-17 16:04:04 +01:00
Xavier Delaruelle
8885ec2a31 Validate elements in shells_with_ksh_fpath value list
The shells_with_ksh_fpath configuration option and its relative
environment variable MODULES_SHELLS_WITH_KSH_FPATH accept a list of
shell each of them separated by colon character. Accepted shell names
are sh, bash, csh, tcsh and fish.
2021-02-08 07:17:38 +01:00
Xavier Delaruelle
aa9f14e150 Restrict accepted values for nearly_forbidden_days config
Restrict the value accepted by nearly_forbidden_days configuration
option to integer comprised between 0 and 365.
2021-02-08 07:17:38 +01:00
Xavier Delaruelle
af3c816fab doc: desc. MODULES_MCOOKIE_VERSION_CHECK in config section 2021-01-27 07:55:20 +01:00
Xavier Delaruelle
48196465e3 doc: desc. mcookie_version_check in module(1)/modulefile(4) 2021-01-25 06:08:21 +01:00
Xavier Delaruelle
54e4b3bee6 doc: desc. key section in module(1) man 2021-01-17 20:59:06 +01:00