Debian Codegraph @

doc/build/INSTALL.txt

raw
1 Installing Modules on Unix
2 **************************
3
4 This document is an overview of building and installing Modules on a
5 Unix system.
6
7
8 Requirements
9 ============
10
11 Modules consists of one Tcl script so to run it from a user shell the
12 only requirement is to have a working version of "tclsh" (version 8.5
13 or later) available on your system. "tclsh" is a part of Tcl
14 (http://www.tcl-lang.org/software/tcltk/).
15
16 To install Modules from a distribution tarball or a clone of the git
17 repository, a build step is there to tailor the "modulecmd.tcl" and
18 the initialization scripts to the chosen installation configuration
19 and create the documentation files. This build step requires the tools
20 to be found on your system:
21
22 * bash
23
24 * make
25
26 * sed
27
28 * runtest
29
30 When also installing Modules Tcl extension library (enabled by
31 default), these additional tools are needed:
32
33 * grep
34
35 * gcc
36
37 * tcl-devel >= 8.5
38
39 When installing from a distribution tarball, documentation is pre-
40 built and scripts to configure Modules Tcl extension library build are
41 already generated. Thus no additional software is required. When
42 installing from a clone of the git repository or from a git archive
43 export, documentation and scripts to prepare for compilation have to
44 be built and the following tools are required:
45
46 * autoconf
47
48 * automake
49
50 * autopoint
51
52 * m4
53
54 * python
55
56 * sphinx >= 1.0
57
58 * gzip
59
60 The following features of Modules rely on external tools. Default tool
61 may be changed or their location on target system may be specified.
62 Alternatively these features may also be disabled.
63
64 +------------------+-------------------------+---------------------------------+
65 | Feature option | Default external tool | Installation options |
66 |==================|=========================|=================================|
67 | pager | "less" | "--with-pager", "--without- |
68 | | | pager" |
69 +------------------+-------------------------+---------------------------------+
70 | logger | "logger" | "--with-logger", "--without- |
71 | | | logger" |
72 +------------------+-------------------------+---------------------------------+
73 | tcl_linter | "nagelfar.tcl" | "--with-tcl-linter", "-- |
74 | | | without-linter" |
75 +------------------+-------------------------+---------------------------------+
76
77
78 Get Modules
79 ===========
80
81 Modules can usually be installed with the package manager of your Unix
82 system. It it is available by default on most Linux distributions, on
83 OS X and FreeBSD either under the name of "modules" or "environment-
84 modules".
85
86 If you want to install Modules from sources, tarballs from all
87 Modules' releases can be retrieved from one of the following link:
88
89 * https://github.com/envmodules/modules/releases/
90
91 * https://sourceforge.net/projects/modules/files/Modules/
92
93 For instance to download then unpack the last release of Modules:
94
95 $ curl -LJO https://github.com/envmodules/modules/releases/download/v5.6.2/modules-5.6.2.tar.gz
96 $ tar xfz modules-5.6.2.tar.gz
97
98
99 Installation instructions
100 =========================
101
102 The simplest way to build and install Modules is:
103
104 $ ./configure
105 $ make
106 $ make install
107
108 Some explanation, step by step:
109
110 1. "cd" to the directory containing the package's source code. Your
111 system must have the above requirements installed to properly build
112 scripts, and documentation if build occurs from a clone of the git
113 repository.
114
115 2. Type "./configure" to adapt the installation for your system. At
116 this step you can choose the installation paths and the features
117 you want to enable in the initialization scripts (see Build and
118 installation options section below for a complete overview of the
119 available options)
120
121 3. Type "make" to adapt scripts to the configuration, build Tcl
122 extension library if enabled and build documentation if working
123 from git repository.
124
125 4. Optionally, type "make test QUICKTEST=1" to run the lightweight
126 version of the non-regression test suite.
127
128 5. Type "make install" to install modulecmd.tcl, initialization
129 scripts and documentation.
130
131 6. Optionally, type "make testinstall" to run the installation test
132 suite.
133
134 7. You can remove the built files from the source code directory by
135 typing "make clean". To also remove the files that "configure"
136 created, type "make distclean".
137
138 A default installation process like described above will install
139 Modules under "/usr/local/Modules". You can change this with the "--
140 prefix" option. By default, "/usr/local/Modules/modulefiles" will be
141 setup as the default directory containing modulefiles. "--
142 modulefilesdir" option enables to change this directory location. For
143 example:
144
145 $ ./configure --prefix=/usr/share/Modules \
146 --modulefilesdir=/etc/modulefiles
147
148 See Build and installation options section to discover all
149 "./configure" option available.
150
151 Note:
152
153 GNU Make is excepted to be used for this build and installation
154 process. On non-Linux systems, the "gmake" should be called instead
155 of "make".
156
157
158 Enable Modules in shells
159 ========================
160
161 Shell initialization scripts should be adapted to enable Modules
162 during their startup. Enabling Modules means defining the "module"
163 shell function and applying its configuration.
164
165 An easy way to achieve that is to make Modules initialization scripts
166 part of the system-wide environment setup in "/etc/profile.d".To do
167 so, make a link in this directory to the profile scripts that can be
168 found in your Modules installation init directory. For instance, if
169 Modules has been installed in "/usr/share/modules":
170
171 $ ln -s /usr/share/modules/init/profile.sh /etc/profile.d/modules.sh
172 $ ln -s /usr/share/modules/init/profile.csh /etc/profile.d/modules.csh
173
174 These profile scripts will automatically adapt to the kind of "sh" or
175 "csh" shell you are running.
176
177 Another approach is to get the Modules initialization script sourced
178 from the shell configuration startup file. For instance following line
179 could be added to the end of the "~/.bashrc" file if running Bash
180 shell:
181
182 . /usr/share/modules/init/bash
183
184 Beware that shells have multiple ways to initialize depending if they
185 are a login shell or not and if they are launched in interactive mode
186 or not.
187
188 Depending on your OS distribution system-wide profile scripts may be
189 ignored when initializing non-interactive shells. This is for instance
190 the case on Debian distribution and its derivatives like Ubuntu. On
191 such system, Modules initialization script should be sourced by shell
192 initialization files to get "module" function defined when executing a
193 command through "ssh" or running a script. Add the following code
194 snippets to the initialization files of the shell you use.
195
196 * For **Bash**, update either system-wide ("/etc/bash.bashrc" on
197 Debian-like systems) or personal ("~/.bashrc") initialization file:
198
199 # enable module command in non-login shells
200 if ! shopt -q login_shell; then
201 . /usr/share/modules/init/bash
202 fi
203
204 * For **Csh**/**Tcsh**, add Modules initialization file into Csh rc
205 directory ("/etc/csh/cshrc.d" on Debian-like systems):
206
207 ln -s /usr/share/modules/init/csh /etc/csh/cshrc.d/modules
208
209 Or update personal ("~/.cshrc") initialization file:
210
211 # enable module command in non-login shells
212 if (! $?loginsh) then
213 source /usr/share/modules/init/csh
214 endif
215
216 * For **Zsh**, update either system-wide ("/etc/zsh/zshenv" on Debian-
217 like systems) or personal ("~/.zshenv") initialization file:
218
219 # enable module command
220 . /usr/share/modules/init/zsh
221
222 * For **Ksh**, update personal ("~/.kshrc") initialization file:
223
224 # enable module command
225 . /usr/share/modules/init/ksh
226
227 * For **Fish**, add Modules initialization file into Fish system-wide
228 config directory ("/etc/fish/conf.d"):
229
230 ln -s /usr/share/modules/init/fish /etc/fish/conf.d/modules.fish
231
232 Or into Fish personal config directory ("~/.config/fish/conf.d"):
233
234 ln -s /usr/share/modules/init/fish ~/.config/fish/conf.d/modules.fish
235
236
237 Configuration
238 =============
239
240 Once installed you should review and adapt the configuration to make
241 it fit your needs. The following steps are provided for example. They
242 are not necessarily mandatory as it depends of the kind of setup you
243 want to achieve.
244
245 1. Define module paths to enable by default. Edit "initrc"
246 configuration file in the directory designated by the "--etcdir"
247 option or edit "modulespath" in the same directory.
248
249 If you use "modulespath" configuration file, add one line
250 mentioning each modulefile directory:
251
252 /path/to/regular/modulefiles
253 /path/to/other/modulefiles
254
255 If you use "initrc" configuration file, add one line mentioning
256 each modulefile directory prefixed by the "module use" command:
257
258 module use /path/to/regular/modulefiles
259 module use /path/to/other/modulefiles
260
261 In case both configuration files "initrc" and "modulespath" are
262 present, Modules initialization process will first evaluate
263 "modulespath" then "initrc".
264
265 By default, the modulepaths specified on the "--with-modulepath"
266 installation option are automatically defined for use in "initrc"
267 (or in "modulespath" if the "--enable-modulespath" installation
268 option has been set).
269
270 Note:
271
272 If you have set "--with-initconf-in" to "initdir" to install the
273 Modules initialization configurations in the configuration
274 directory designated by the "--initdir" option, the configuration
275 files "initrc" and "modulespath" are respectively named
276 "modulerc" and ".modulespath".
277
278 2. Define modulefiles to load by default. Edit "initrc" configuration
279 file. Modulefiles to load cannot be specified in "modulespath"
280 file. Add there all the modulefiles you want to load by default at
281 Modules initialization time.
282
283 Add one line mentioning each modulefile to load prefixed by the
284 "module load" command:
285
286 module load foo
287 module load bar
288
289 By default, the modules specified on the "--with-loadedmodules"
290 installation option are automatically defined for load in "initrc".
291
292 Alternatively, if users have module collections saved in their
293 "HOME" directory, you may prefer restoring their default collection
294 when Modules initializes rather loading the default module list:
295
296 if {[is-saved default]} {
297 module restore
298 } else {
299 module load foo
300 module load bar
301 }
302
303 In fact you can add to the "initrc" configuration file any kind of
304 supported module command, like "module config" commands to tune
305 **module**'s default behaviors. This configuration way is
306 recommended over directly modifying the shell initialization
307 scripts.
308
309 See the Configuration options section to discover all Modules "config"
310 options available, their default value and the installation options
311 linked to them.
312
313 If you go through the above steps you should have a valid setup tuned
314 to your needs. After that you still have to write modulefiles to get
315 something to load and unload in your newly configured Modules setup.
316 In case you want to achieve a specific setup, some additional steps
317 may be required:
318
319 3. In case the configuration you expect cannot be achieved through the
320 "initrc" configuration file, you may review and tune the
321 initialization scripts. These files are located in the directory
322 designated by the "--initdir" option. Beware that these scripts
323 could be overwritten when upgrading to a newer version of Modules,
324 so configuration should be done through the "initrc" file as far as
325 possible.
326
327 4. If you want to alter the way the "modulecmd.tcl" script operates,
328 the "siteconfig.tcl" script may be used. This Tcl file is located
329 in the directory designated by the "--etcdir" option. Every time
330 the **module** command is called, it executes the "modulecmd.tcl"
331 script which in turns sources the "siteconfig.tcl" script during
332 its startup phase. The site-specific configuration script could
333 override default configuration values and more largely could
334 supersede all procedures defined in "modulecmd.tcl" to obtain
335 specific behaviors.
336
337 5. Prior running the module sub-command specified as argument, the
338 "modulecmd.tcl" script evaluates the global run-command files.
339 These files are either the "rc" file in the directory designated by
340 the "--etcdir" option, the file(s) designated in the "MODULERCFILE"
341 environment variable or the user-specific RC file located in
342 "$HOME/.modulerc". The RC files are modulefiles (limited to a
343 subset of the modulefile Tcl commands) that could define global
344 module aliases, virtual modules or module properties such as tags,
345 forbidding rules, etc.
346
347 Note:
348
349 Run-command files are intended to set parameters for modulefiles,
350 not to configure the **module** command itself.
351
352 To learn more about siteconfig and run-command files, see the
353 Modulecmd startup section in module reference manual. You may also
354 look at the available setup recipes to get concrete deployment
355 examples of these files.
356
357
358 Upgrading
359 =========
360
361 In case you want to upgrade a pre-existing Modules installation, it is
362 suggested to:
363
364 1. Backup configuration files stored in *etcdir* (like
365 "siteconfig.tcl" or "initrc");
366
367 2. Remove previous Modules installation;
368
369 3. Install new Modules version;
370
371 4. Review specific configuration of previous installation and adapt
372 configuration files of new version.
373
374 It is advised to look at the different documents describing changes
375 and new features appearing between versions. By reading these
376 documents you will be able to determine the specific configuration
377 options to apply to satisfy your use cases.
378
379 * Changes between versions
380
381 * Release notes
382
383 * New features
384
385 In case you install Modules with the "--enable-versioning" option set,
386 you may be able to install a new version of Modules alongside existing
387 ones (if they also have been installed with this option set).
388
389
390 Build and installation options
391 ==============================
392
393 Options available at the "./configure" installation step are described
394 below. These options enable to choose the installation paths and the
395 features to enable or disable. You can also get a description of these
396 options by typing "./configure --help".
397
398 Fine tuning of the installation directories (the default value for
399 each option is displayed within brackets):
400
401 --bindir=DIR
402
403 Directory for executables reachable by users ["PREFIX/bin"]
404
405 --datarootdir=DIR
406
407 Base directory to set the man and doc directories ["PREFIX/share"]
408
409 --docdir=DIR
410
411 Directory to host documentation other than man pages like README,
412 license file, etc ["DATAROOTDIR/doc"]
413
414 --emacsdatadir=DIR
415
416 Directory to host Emacs addon files ["DATAROOTDIR/emacs/lisp"]
417
418 --etcdir=DIR
419
420 Directory for the executable configuration scripts ["PREFIX/etc"]
421
422 --initdir=DIR
423
424 Directory for the per-shell environment initialization scripts
425 ["PREFIX/init"]
426
427 --libdir=DIR
428
429 Directory for object code libraries like libtclenvmodules.so
430 ["PREFIX/lib"]
431
432 --libexecdir=DIR
433
434 Directory for executables called by other executables like
435 modulecmd.tcl ["PREFIX/libexec"]
436
437 --mandir=DIR
438
439 Directory to host man pages ["DATAROOTDIR/man"]
440
441 --modulefilesdir=DIR
442
443 Directory of main modulefiles also called system modulefiles
444 ["PREFIX/modulefiles"]
445
446 --nagelfardatadir=DIR
447
448 Directory to host Nagelfar linter addon files
449 ["DATAROOTDIR/nagelfar"]
450
451 --prefix=PREFIX
452
453 Installation root directory ["/usr/local/Modules"]
454
455 --vimdatadir=DIR
456
457 Directory to host Vim addon files ["DATAROOTDIR/vim/vimfiles"]
458
459 Optional Features (the default for each option is displayed within
460 parenthesis, to disable an option replace "enable" by "disable" for
461 instance "--disable-set-manpath"):
462
463 --enable-advanced-version-spec
464
465 Activate the advanced module version specifiers which enables to
466 finely select module versions by specifying after the module name a
467 version constraint prefixed by the "@" character. This option also
468 allows to specify module variants. (default=yes)
469
470 This installation option defines the default value of the
471 "advanced_version_spec" configuration option which could be changed
472 after installation with the "config" sub-command.
473
474 --enable-append-binpath
475
476 Append rather prepend binary directory to the PATH environment
477 variable when the "--enable-set-binpath" option is enabled.
478 (default=no)
479
480 --enable-append-manpath
481
482 Append rather prepend man page directory to the MANPATH environment
483 variable when the "--enable-set-manpath" option is enabled.
484 (default=no)
485
486 --enable-auto-handling
487
488 Set modulecmd.tcl to automatically apply automated modulefiles
489 handling actions, like loading the pre-requisites of a modulefile
490 when loading this modulefile. (default=yes)
491
492 This installation option defines the default value of the
493 "auto_handling" configuration option which could be changed after
494 installation with the "config" sub-command.
495
496 --enable-avail-indepth
497
498 When performing an "avail" sub-command, include in search results
499 the matching modulefiles and directories and recursively the
500 modulefiles and directories contained in these matching directories
501 when enabled or limit search results to the matching modulefiles
502 and directories found at the depth level expressed by the search
503 query if disabled. (default=yes)
504
505 This installation option defines the default value of the
506 "avail_indepth" configuration option which could be changed after
507 installation with the "config" sub-command.
508
509 --enable-color
510
511 Control if output should be colored by default or not. A value of
512 "yes" equals to the "auto" color mode. "no" equals to the "never"
513 color mode. (default=yes)
514
515 This installation option defines the default value of the "color"
516 configuration option which could be changed after installation with
517 the "config" sub-command.
518
519 --enable-conflict-unload
520
521 Apply automated unload of conflicting modulefiles when loading a
522 module. (default=no)
523
524 This installation option defines the default value of the
525 "conflict_unload" configuration option which could be changed after
526 installation with the "config" sub-command.
527
528 --enable-doc-install
529
530 Install the documentation files in the documentation directory
531 defined with the "--docdir" option. This feature has no impact on
532 manual pages installation. Disabling documentation file
533 installation is useful in case of installation process handled via
534 a package manager which handles by itself the installation of this
535 kind of documents. (default=yes)
536
537 --enable-emacs-addons
538
539 Install the Emacs addon files in the Emacs addons directory defined
540 with the "--emacsdatadir" option. (default=yes)
541
542 --enable-example-modulefiles
543
544 Install some modulefiles provided as example in the system
545 modulefiles directory defined with the "--modulefilesdir" option.
546 (default=yes)
547
548 --enable-extended-default
549
550 Allow to specify module versions by their starting part, i.e.
551 substring separated from the rest of the version string by a "."
552 character. (default=yes)
553
554 This installation option defines the default value of the
555 "extended_default" configuration option which could be changed
556 after installation with the "config" sub-command.
557
558 --enable-implicit-default
559
560 Define an implicit default version, for modules with none
561 explicitly defined, to select when the name of the module to
562 evaluate is passed without the mention of a specific version. When
563 this option is disabled the name of the module passed for
564 evaluation should be fully qualified elsewhere an error is
565 returned. (default=yes)
566
567 This installation option defines the default value of the
568 "implicit_default" configuration option which could be changed
569 after installation with the "config" sub-command.
570
571 --enable-implicit-requirement
572
573 Implicitly define a prereq or a conflict requirement toward modules
574 specified respectively on "module load" or "module unload" commands
575 in modulefile. (default=yes)
576
577 This installation option defines the default value of the
578 "implicit_requirement" configuration option which could be changed
579 after installation with the "config" sub-command.
580
581 --enable-libtclenvmodules
582
583 Build and install the Modules Tcl extension library which provides
584 optimized Tcl commands for the modulecmd.tcl script. (default=yes)
585
586 --enable-mcookie-version-check
587
588 Enable check of the version specified right after Modules magic
589 cookie (i.e., "#%Module" file signature) in modulefiles, which
590 defines the minimal version of the Modules tool to use in order to
591 evaluate the modulefile. (default=yes)
592
593 This installation option defines the default value of the
594 "mcookie_version_check" configuration option which could be changed
595 after installation with the "config" sub-command.
596
597 --enable-ml
598
599 Define the **ml** command, a handy frontend to the module command,
600 when Modules initializes. (default=yes)
601
602 This installation option defines the default value of the "ml"
603 configuration option which could be changed after installation with
604 the "config" sub-command.
605
606 --enable-modulespath, --enable-dotmodulespath
607
608 Set the module paths defined by "--with-modulepath" option in a
609 "modulespath" file (following C version fashion) within the
610 initialization directory defined by the "--etcdir" option rather
611 than within the "initrc" file. Or respectively, if option "--with-
612 initconf-in" has been set to "initdir", in a ".modulespath" file
613 within the configuration directory defined by the "--initdir"
614 option rather than within the "modulerc" file. (default=no)
615
616 --enable-multilib-support
617
618 Support multilib systems by looking in modulecmd.tcl at an
619 alternative location where to find the Modules Tcl extension
620 library depending on current machine architecture. (default=no)
621
622 --enable-nagelfar-addons
623
624 Install the Nagelfar linter addon files (syntax databases and
625 plugins to lint modulefiles and modulercs) in the Nagelfar addons
626 directory defined with the "--nagelfardatadir" option.
627 (default=yes)
628
629 --enable-new-features
630
631 Enable all new features that are disabled by default due to the
632 substantial behavior changes they imply on Modules 5. This option
633 is equivalent to the cumulative use of "--with-abort-on-
634 error=load:ml:reload:switch", "--enable-conflict-unload" and "--
635 enable-require-via". (default=no)
636
637 --enable-quarantine-support
638
639 Generate code in module function definition to add support for the
640 environment variable quarantine mechanism (default=no)
641
642 This installation option defines the default value of the
643 "quarantine_support" configuration option which could be changed
644 after installation with the "config" sub-command.
645
646 --enable-require-via
647
648 Consider loaded module that enables a modulepath, a requirement of
649 loaded modules stored in this modulepath. (default=no)
650
651 This installation option defines the default value of the
652 "require_via" configuration option which could be changed after
653 installation with the "config" sub-command.
654
655 --enable-set-binpath
656
657 Prepend binary directory defined by the "--bindir" option to the
658 PATH environment variable in the shell initialization scripts.
659 (default=yes)
660
661 --enable-set-manpath
662
663 Prepend man page directory defined by the "--mandir" option to the
664 MANPATH environment variable in the shell initialization scripts.
665 (default=yes)
666
667 --enable-set-shell-startup
668
669 Set when module function is defined the shell startup file to
670 ensure that the module function is still defined in sub-shells.
671 (default=no)
672
673 This installation option defines the default value of the
674 "set_shell_startup" configuration option which could be changed
675 after installation with the "config" sub-command.
676
677 --enable-silent-shell-debug-support
678
679 Generate code in module function definition to add support for
680 silencing shell debugging properties (default=no)
681
682 This installation option defines the default value of the
683 "silent_shell_debug" configuration option which could be changed
684 after installation with the "config" sub-command.
685
686 --enable-source-cache
687
688 Cache content of files evaluated through *source(n)* Tcl command in
689 modulefile. When same file is sourced multiple times, cached
690 content is reused rather reading file again.
691
692 This installation option defines the default value of the
693 "source_cache" configuration option which could be changed after
694 installation with the "config" sub-command.
695
696 --enable-spider-indepth
697
698 When performing an "spider" sub-command, include in search results
699 the matching modulefiles and directories and recursively the
700 modulefiles and directories contained in these matching directories
701 when enabled or limit search results to the matching modulefiles
702 and directories found at the depth level expressed by the search
703 query if disabled. (default=yes)
704
705 This installation option defines the default value of the
706 "spider_indepth" configuration option which could be changed after
707 installation with the "config" sub-command.
708
709 --enable-versioning
710
711 Append Modules version to installation prefix and deploy a
712 "versions" modulepath shared between all versioning enabled Modules
713 installation. A modulefile corresponding to Modules version is
714 added to the shared modulepath and enables to switch from one
715 Modules version to another. (default=no)
716
717 --enable-unique-name-loaded
718
719 Only allow one module loaded per module name. A conflict is raised
720 when loading a module whose name or alternative names are shared by
721 an already loaded module. (default=no)
722
723 This installation option defines the default value of the
724 "unique_name_loaded" configuration option which could be changed
725 after installation with the "config" sub-command.
726
727 --enable-vim-addons
728
729 Install the Vim addon files in the Vim addons directory defined
730 with the "--vimdatadir" option. (default=yes)
731
732 --enable-wa-277
733
734 Activate workaround for issue #277 related to Tcsh history
735 mechanism which does not cope well with default module alias
736 definition. Note that enabling this workaround solves Tcsh history
737 issue but weakens shell evaluation of the code produced by
738 modulefiles. (default=no)
739
740 This installation option defines the default value of the "wa_277"
741 configuration option which could be changed after installation with
742 the "config" sub-command.
743
744 --enable-windows-support
745
746 Install all required files for Windows platform (**module**, **ml**
747 and **envml** command batch file and "cmd.cmd" initialization
748 script). (default=no)
749
750 Optional Packages (the default for each option is displayed within
751 parenthesis, to disable an option replace "with" by "without" for
752 instance "--without-modulepath"):
753
754 --with-abort-on-error=LIST
755
756 When evaluating multiple modulefiles, if one fails abort evaluation
757 sequence and withdraw already evaluated modulefiles for listed
758 module sub-commands. Sub-commands accepted in LIST are: "load",
759 **ml**, "mod-to-sh", "purge", "reload", "switch", "switch_unload",
760 "try-load" and "unload" (elements in LIST are separated by ":").
761 (default="ml:reload:switch_unload")
762
763 This installation option defines the default value of the
764 "abort_on_error" configuration option which could be changed after
765 installation with the "config" sub-command.
766
767 --with-avail-output=LIST
768
769 Specify the content to report on avail sub-command regular output
770 in addition to the available module names. Elements accepted in
771 LIST are: "modulepath", "alias", "provided-alias", "dirwsym",
772 "indesym", "sym", "tag", "key", "hidden", "variant",
773 "variantifspec" and "via" (elements in LIST are separated by ":").
774 The order of the elements in LIST does not matter.
775 (default="modulepath:alias:dirwsym:sym:tag:variantifspec:key")
776
777 This installation option defines the default value of the
778 "avail_output" configuration option which could be changed after
779 installation with the "config" sub-command.
780
781 --with-avail-terse-output=LIST
782
783 Specify the content to report on avail sub-command terse output in
784 addition addition to the available module names. Elements accepted
785 in LIST are: "modulepath", "alias", "provided-alias", "dirwsym",
786 "indesym", "sym", "tag", "key", "hidden", "variant" and
787 "variantifspec" (elements in LIST are separated by ":"). The order
788 of the elements in LIST does not matter.
789 (default="modulepath:alias:dirwsym:sym:tag:variantifspec")
790
791 This installation option defines the default value of the
792 "avail_terse_output" configuration option which could be changed
793 after installation with the "config" sub-command.
794
795 --with-bashcompletiondir=DIR
796
797 Directory for Bash completion scripts. When this option is not set
798 Bash completion script for Modules is installed in the
799 initialization script directory and is sourced from Modules Bash
800 initialization script. (default=)
801
802 --with-bin-search-path=PATHLIST
803
804 List of paths to look at when searching the location of tools
805 required to build and configure Modules
806 (default="/usr/bin:/bin:/usr/local/bin")
807
808 --with-dark-background-colors=SGRLIST
809
810 Default color set to apply if terminal background color is defined
811 to "dark". SGRLIST follows the same syntax than used in
812 "LS_COLORS". Each element in SGRLIST is an output item associated
813 to a Select Graphic Rendition (SGR) code. Elements in SGRLIST are
814 separated by ":". Output items are designated by keys.
815
816 Items able to be colorized are: highlighted element ("hi"), debug
817 information ("db"), trace information ("tr") tag separator ("se");
818 Error ("er"), warning ("wa"), module error ("me") and info ("in")
819 message prefixes; Modulepath ("mp"), directory ("di"), module alias
820 ("al"), module variant ("va"), module symbolic version ("sy") and
821 module "default" version ("de").
822
823 Module tags can also be colorized. The key to set in the color
824 palette to get a graphical rendering of a tag is the tag name or
825 the tag abbreviation if one is defined for tag. The SGR code
826 applied to a tag name is ignored if an abbreviation is set for this
827 tag thus the SGR code should be defined for this abbreviation to
828 get a graphical rendering. Each basic tag has by default a key set
829 in the color palette, based on its abbreviated string: auto-loaded
830 ("aL"), forbidden ("F"), hidden and hidden-loaded ("H"), loaded
831 ("L"), nearly-forbidden ("nF"), sticky ("S"), super-sticky ("sS"),
832 keep-loaded ("kL") and warning ("W").
833
834 For a complete SGR code reference, see https://en.wikipedia.org/wik
835 i/ANSI_escape_code#Select_Graphic_Rendition_parameters. (default="h
836 i=1:db=2:tr=2:se=2:er=91:wa=93:me=95:in=94:mp=1;94:di=94:al=96:va=9
837 3:sy=95:de=4:cm=92:aL=100:L=90;47:H=2:F=41:nF=31;43:S=46:sS=44:kL=3
838 0;48;5;109:W=30;43")
839
840 This installation option defines the default value of the "colors"
841 configuration option when "term_background" configuration option
842 equals "dark". "colors" could be changed after installation with
843 the "config" sub-command.
844
845 --with-editor=BIN
846
847 Name or full path of default editor program to use to open
848 modulefile through the "edit" sub-command. (default="vi")
849
850 This installation option defines the default value of the "editor"
851 configuration option which could be changed after installation with
852 the "config" sub-command.
853
854 --with-fishcompletiondir=DIR
855
856 Directory for Fish completion scripts. When this option is not set
857 Fish completion script for Modules is installed in the
858 initialization script directory and is sourced from Modules Fish
859 initialization script. (default=)
860
861 --with-icase=VALUE
862
863 Apply a case insensitive match to module specification on "avail",
864 "whatis" and "paths" sub-commands (when set to "search") or on all
865 module sub-commands and modulefile Tcl commands for the module
866 specification they receive as argument (when set to "always"). Case
867 insensitive match is disabled when this option is set to "never".
868 (default="search")
869
870 This installation option defines the default value of the "icase"
871 configuration option which could be changed after installation with
872 the "config" sub-command.
873
874 --with-initconf-in=VALUE
875
876 Location where to install Modules initialization configuration
877 files. Either "initdir" or "etcdir" (default="etcdir")
878
879 --with-light-background-colors=SGRLIST
880
881 Default color set to apply if terminal background color is defined
882 to "light". Expect the same syntax than described for "--with-dark-
883 background-colors". (default="hi=1:db=2:tr=2:se=2:er=31:wa=33:me=35
884 :in=34:mp=1;34:di=34:al=36:va=33:sy=35:de=4:cm=32:aL=107:L=47:H=2:F
885 =101:nF=91;103:S=106:sS=104:kL=48;5;109:W=103")
886
887 This installation option defines the default value of the "colors"
888 configuration option when "term_background" configuration option
889 equals "light". "colors" could be changed after installation with
890 the "config" sub-command.
891
892 --with-list-output=LIST
893
894 Specify the content to report on list sub-command regular output in
895 addition to the loaded module names. Elements accepted in LIST are:
896 "header", "idx", "variant", "alias", "indesym", "sym", "tag",
897 "hidden" and "key" (elements in LIST are separated by ":"). The
898 order of the elements in LIST does not matter.
899 (default="header:idx:variant:sym:tag:key")
900
901 This installation option defines the default value of the
902 "list_output" configuration option which could be changed after
903 installation with the "config" sub-command.
904
905 --with-list-terse-output=LIST
906
907 Specify the content to report on list sub-command terse output in
908 addition to the loaded module names. Elements accepted in LIST are:
909 "header", "idx", "variant", "alias", "indesym", "sym", "tag",
910 "hidden" and "key" (elements in LIST are separated by ":"). The
911 order of the elements in LIST does not matter. (default="header")
912
913 This installation option defines the default value of the
914 "list_terse_output" configuration option which could be changed
915 after installation with the "config" sub-command.
916
917 --with-loadedmodules=MODLIST
918
919 Default modulefiles to load at Modules initialization time. Each
920 modulefile in this list should be separated by ":". Defined value
921 is registered in the "initrc" configuration file or in the
922 "modulerc" file if "--with-initconf-in" is set to "initdir".
923 (default=)
924
925 --with-locked-configs=CONFIGLIST
926
927 Ignore environment variable superseding value for the listed
928 configuration options. Accepted option names in CONFIGLIST are
929 "extra_siteconfig" , "implicit_default", "logged_events" and
930 "logger" (each option name should be separated by whitespace
931 character). (default=)
932
933 This installation option defines the default value of the
934 "locked_configs" configuration option which cannot not be changed
935 after installation.
936
937 --with-logged-events=EVENTLIST
938
939 Events to log. Accepted event names in EVENTLIST are "auto_eval",
940 "requested_eval" and "requested_cmd" (each event name in this list
941 should be separated by ":"). The order of the elements in EVENTLIST
942 does not matter. (default=)
943
944 This installation option defines the default value of the
945 "logged_events" configuration option which cannot not be changed
946 after installation.
947
948 --with-logger=BIN
949
950 Name or full path of default logger program to use to log
951 information (can be superseded at run-time by environment variable)
952 (default="logger")
953
954 This installation option and "--with-logger-opts" define the
955 default value of the "logger" configuration option which could be
956 changed after installation with the "config" sub-command.
957
958 --with-logger-opts=OPTLIST
959
960 Settings to apply to default logger program (default="-t modules")
961
962 This installation option and "--with-logger" define the default
963 value of the "logger" configuration option which could be changed
964 after installation with the "config" sub-command.
965
966 --with-modulepath=PATHLIST
967
968 Default path list to setup as the default modulepaths. Each path in
969 this list should be separated by ":". Defined value is registered
970 in the "initrc" or "modulespath" configuration file, depending on
971 the "--enable-modulespath" option. These files are respectively
972 called "modulerc" and ".modulespath" if "--with-initconf-in" is set
973 to "initdir". The path list value is read at initialization time to
974 populate the MODULEPATH environment variable. By default, this
975 modulepath is composed of the directory set for the system
976 modulefiles (default="PREFIX/modulefiles" or
977 "BASEPREFIX/$MODULE_VERSION/modulefiles" if versioning installation
978 mode enabled)
979
980 --with-moduleshome
981
982 Location of the main Modules package file directory
983 (default="PREFIX")
984
985 This installation option defines the default value of the "home"
986 configuration option which could be changed after installation with
987 the "config" sub-command.
988
989 --with-nearly-forbidden-days=VALUE
990
991 Define the number of days a module is considered nearly forbidden
992 prior reaching its expiry date. VALUE should be an integer
993 comprised between 0 and 365. (default="14")
994
995 This installation option defines the default value of the
996 "nearly_forbidden_days" configuration option which could be changed
997 after installation with the "config" sub-command.
998
999 --with-pager=BIN
1000
1001 Name or full path of default pager program to use to paginate
1002 informational message output (can be superseded at run-time by
1003 environment variable) (default="less")
1004
1005 This installation option and "--with-pager-opts" define the default
1006 value of the "pager" configuration option which could be changed
1007 after installation with the "config" sub-command.
1008
1009 --with-pager-opts=OPTLIST
1010
1011 Settings to apply to default pager program (default="-eFKRX")
1012
1013 This installation option and "--with-pager" define the default
1014 value of the "pager" configuration option which could be changed
1015 after installation with the "config" sub-command.
1016
1017 --with-python=BIN
1018
1019 Name or full path of Python interpreter command to set as shebang
1020 for helper scripts. (default="python")
1021
1022 --with-quarantine-vars=<VARNAME[=VALUE] ...>
1023
1024 Environment variables to put in quarantine when running the module
1025 command to ensure it a sane execution environment (each variable
1026 should be separated by space character). A value can eventually be
1027 set to a quarantine variable instead of emptying it. (default=)
1028
1029 This installation option defines the default value of the
1030 "MODULES_RUN_QUARANTINE" and "MODULES_RUNENV_<VAR>" environment
1031 variables which could be changed after installation with the
1032 "config" sub-command on "run_quarantine" configuration option.
1033
1034 --with-search-match=VALUE
1035
1036 When searching for a module with "avail" sub-command, match query
1037 string against module name start ("starts_with") or any part of
1038 module name string ("contains"). (default="starts_with")
1039
1040 This installation option defines the default value of the
1041 "search_match" configuration option which could be changed after
1042 installation with the "config" sub-command.
1043
1044 --with-spider-output=LIST
1045
1046 Specify the content to report on spider sub-command regular output
1047 in addition to the available module names. Elements accepted in
1048 LIST are: "modulepath", "alias", "provided-alias", "dirwsym",
1049 "indesym", "sym", "tag", "key", "hidden", "variant",
1050 "variantifspec" and "via" (elements in LIST are separated by ":").
1051 The order of the elements in LIST does not matter.
1052 (default="modulepath:alias:dirwsym:sym:tag:variantifspec:via:key")
1053
1054 This installation option defines the default value of the
1055 "spider_output" configuration option which could be changed after
1056 installation with the "config" sub-command.
1057
1058 --with-spider-terse-output=LIST
1059
1060 Specify the content to report on spider sub-command terse output in
1061 addition addition to the available module names. Elements accepted
1062 in LIST are: "modulepath", "alias", "provided-alias", "dirwsym",
1063 "indesym", "sym", "tag", "key", "hidden", "variant" and
1064 "variantifspec" (elements in LIST are separated by ":"). The order
1065 of the elements in LIST does not matter.
1066 (default="modulepath:alias:dirwsym:sym:tag:variantifspec")
1067
1068 This installation option defines the default value of the
1069 "spider_terse_output" configuration option which could be changed
1070 after installation with the "config" sub-command.
1071
1072 --with-sticky-purge=VALUE
1073
1074 When unloading a sticky or super-sticky module during a module
1075 purge, raise an "error" or emit a "warning" message or be "silent".
1076 (default="error")
1077
1078 This installation option defines the default value of the
1079 "sticky_purge" configuration option which could be changed after
1080 installation with the "config" sub-command.
1081
1082 --with-tag-abbrev=ABBRVLIST
1083
1084 Define the abbreviation to use when reporting each module tag. Each
1085 element in ABBRVLIST is a tag name associated to an abbreviation
1086 string (elements in ABBRVLIST are separated by ":"). (default
1087 ="auto-loaded=aL:loaded=L:hidden=H:hidden-loaded=H:forbidden=F
1088 :nearly-forbidden=nF:sticky=S:super-sticky=sS:keep-
1089 loaded=kL:warning=W")
1090
1091 This installation option defines the default value of the
1092 "tag_abbrev" configuration option which could be changed after
1093 installation with the "config" sub-command.
1094
1095 --with-tag-color-name=TAGLIST
1096
1097 Define the tags whose graphical rendering should be applied over
1098 their name instead of over the name of the module they are attached
1099 to. Each element in TAGLIST is a tag name or abbreviation (elements
1100 in TAGLIST are separated by ":"). (default=)
1101
1102 This installation option defines the default value of the
1103 "tag_color_name" configuration option which could be changed after
1104 installation with the "config" sub-command.
1105
1106 --with-tcl
1107
1108 Directory containing the Tcl configuration script "tclConfig.sh".
1109 Useful to compile Modules Tcl extension library if this file cannot
1110 be automatically found in default locations.
1111
1112 --with-tclinclude
1113
1114 Directory containing the Tcl header files. Useful to compile
1115 Modules Tcl extension library if these headers cannot be
1116 automatically found in default locations.
1117
1118 --with-tclsh=BIN
1119
1120 Name or full path of Tcl interpreter shell (default="tclsh")
1121
1122 --with-tcl-linter=BIN
1123
1124 Name or full path of program to use to lint modulefile through the
1125 "lint" sub-command. (default="nagelfar.tcl")
1126
1127 This installation option and "--with-tcl-linter-opts" define the
1128 default value of the "tcl_linter" configuration option which could
1129 be changed after installation with the "config" sub-command.
1130
1131 --with-tcl-linter-opts=OPTLIST
1132
1133 Settings to apply to Tcl linter program (default=)
1134
1135 This installation option and "--with-tcl-linter" define the default
1136 value of the "tcl_linter" configuration option which could be
1137 changed after installation with the "config" sub-command.
1138
1139 --with-terminal-background=VALUE
1140
1141 The terminal background color that determines the color set to
1142 apply by default between the "dark" background colors or the
1143 "light" background colors (default="dark")
1144
1145 This installation option defines the default value of the
1146 "term_background" configuration option which could be changed after
1147 installation with the "config" sub-command.
1148
1149 --with-unload-match-order=VALUE
1150
1151 When unloading a module if multiple loaded modules match the
1152 request, unload module loaded first ("returnfirst") or module
1153 loaded last ("returnlast") (default="returnlast")
1154
1155 This installation option defines the default value of the
1156 "unload_match_order" configuration option which could be changed
1157 after installation with the "config" sub-command.
1158
1159 --with-variant-shortcut=SHORTCUTLIST
1160
1161 Define the shortcut characters that could be used to specify
1162 variant names. Each element in SHORTCUTLIST is a variant name
1163 associated to a shortcut character (e.g., "foo=%"). Shortcuts
1164 cannot exceed a length of 1 character and cannot be alphanumeric
1165 characters ([A-Za-z0-9]) or characters with already a special
1166 meaning ([+~/@=-]). Elements in SHORTCUTLIST are separated by ":".
1167 (default=)
1168
1169 This installation option defines the default value of the
1170 "variant_shortcut" configuration option which could be changed
1171 after installation with the "config" sub-command.
1172
1173 --with-verbosity=VALUE
1174
1175 Specify default message verbosity. accepted values are "silent",
1176 "concise", "normal", "verbose", "verbose2", "trace", "debug" and
1177 "debug2". (default="normal")
1178
1179 This installation option defines the default value of the
1180 "verbosity" configuration option which could be changed after
1181 installation with the "config" sub-command.
1182
1183 --with-zshcompletiondir=DIR
1184
1185 Directory for Zsh completion scripts. When this option is not set
1186 Zsh completion script for Modules is installed in the
1187 initialization script directory and "FPATH" is set in Zsh
1188 initialization script to point to this location. (default=)
1189
1190
1191 Configuration options
1192 =====================
1193
1194 Options available through the "config" sub-command are described
1195 below. In addition to their default value, the related installation
1196 option, environment variable and command-line switch are listed for
1197 each configuration option. This table also describes if each
1198 configuration option needs to be set prior or during Modules
1199 initialization and if it can be modified after installation.
1200
1201 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1202 | Configuration option | Default value | Related installation option, environment | Set prior or | Cannot be |
1203 | | | variable and command-line switch | during | altered |
1204 | | | | initialization | |
1205 |=====================================|================================================|================================================|================|=============|
1206 | "abort_on_error" | "ml:reload:switch_unload" | "--with-abort-on-error", | | |
1207 | | | "MODULES_ABORT_ON_ERROR" | | |
1208 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1209 | "advanced_version_spec" | "1" | "--enable-advanced-version-spec", | | |
1210 | | | "MODULES_ADVANCED_VERSION_SPEC" | | |
1211 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1212 | "auto_handling" | "1" | "--enable-auto-handling", | | |
1213 | | | "MODULES_AUTO_HANDLING", "--auto", "--no- | | |
1214 | | | auto" | | |
1215 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1216 | "avail_indepth" | "1" | "--enable-avail-indepth", | | |
1217 | | | "MODULES_AVAIL_INDEPTH", "--indepth", "--no- | | |
1218 | | | indepth" | | |
1219 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1220 | "avail_output" | modulepath:alias:dirwsym:sym:tag:variantifspec | "--with-avail-output", "MODULES_AVAIL_OUTPUT", | | |
1221 | | :key | "--output" | | |
1222 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1223 | "avail_terse_output" | modulepath:alias:dirwsym:sym:tag:variantifspec | "--with-avail-terse-output", | | |
1224 | | | "MODULES_AVAIL_TERSE_OUTPUT", "--output" | | |
1225 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1226 | "cache_buffer_bytes" | "32768" | "MODULES_CACHE_BUFFER_BYTES" | | |
1227 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1228 | "cache_expiry_secs" | "0" | "MODULES_CACHE_EXPIRY_SECS" | | |
1229 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1230 | "collection_pin_version" | "0" | "MODULES_COLLECTION_PIN_VERSION" | | |
1231 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1232 | "collection_pin_tag" | "0" | "MODULES_COLLECTION_PIN_TAG" | | |
1233 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1234 | "collection_target" | *Unset by default* | "MODULES_COLLECTION_TARGET" | | |
1235 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1236 | "color" | "auto" | "--enable-color", "MODULES_COLOR", "--color" | | |
1237 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1238 | "colors" | hi=1:db=2:tr=2:se=2:er=91:wa=93:me=95:in=94:mp | "--with-dark-background-colors", "--with- | | |
1239 | | =1;94:di=94:al=96:va=93: sy=95:de=4:cm=92:aL=1 | light-background-colors", "MODULES_COLORS" | | |
1240 | | 00:L=90;47:H=2:F=41:nF=31;43:S=46:sS=44:kL=30; | | | |
1241 | | 48; 5;109:W=30;43 | | | |
1242 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1243 | "conflict_unload" | "0" | "--enable-conflict-unload", | | |
1244 | | | "MODULES_CONFLICT_UNLOAD" | | |
1245 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1246 | "contact" | "root@localhost" | "MODULECONTACT" | | |
1247 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1248 | "extended_default" | "1" | "--enable-extended-default", | | |
1249 | | | "MODULES_EXTENDED_DEFAULT" | | |
1250 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1251 | "editor" | "vi" | "--with-editor", "MODULES_EDITOR" | | |
1252 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1253 | "extra_siteconfig" | *Unset by default* | "MODULES_SITECONFIG" | | |
1254 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1255 | "hide_auto_loaded" | "0" | "MODULES_HIDE_AUTO_LOADED" | | |
1256 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1257 | "home" | "/usr/share/Modules" | "--prefix", "--with-moduleshome", | | |
1258 | | | "MODULESHOME" | | |
1259 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1260 | "icase" | "search" | "--with-icase", "MODULES_ICASE", "--icase" | | |
1261 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1262 | "ignore_cache" | "0" | "MODULES_IGNORE_CACHE", "--ignore-cache" | | |
1263 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1264 | "ignore_user_rc" | "0" | "MODULES_IGNORE_USER_RC", "--ignore-user-rc" | | |
1265 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1266 | "ignored_dirs" | "CVS RCS SCCS .svn .git .SYNC .sos" | | | X |
1267 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1268 | "implicit_default" | "1" | "--enable-implicit-default", | | |
1269 | | | "MODULES_IMPLICIT_DEFAULT" | | |
1270 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1271 | "implicit_requirement" | "1" | "--enable-implicit-requirement", | | |
1272 | | | "MODULES_IMPLICIT_REQUIREMENT" | | |
1273 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1274 | "list_output" | "header:idx:variant:sym:tag:key" | "--with-list-output", "MODULES_LIST_OUTPUT", " | | |
1275 | | | --output" | | |
1276 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1277 | "list_terse_output" | "header" | "--with-list-terse-output", | | |
1278 | | | "MODULES_LIST_TERSE_OUTPUT", "--output" | | |
1279 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1280 | "locked_configs" | *Empty by default* | "--with-locked-configs" | | X |
1281 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1282 | "logged_events" | *Empty by default* | "--with-logged-events", | | |
1283 | | | "MODULES_LOGGED_EVENTS" | | |
1284 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1285 | "logger" | "logger -t modules" | "--with-logger", "--with-logger-opts", | | |
1286 | | | "MODULES_LOGGER" | | |
1287 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1288 | "mcookie_check" | "always" | "MODULES_MCOOKIE_CHECK" | | |
1289 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1290 | "mcookie_version_check" | "1" | "--enable-mcookie-version-check", | | |
1291 | | | "MODULES_MCOOKIE_VERSION_CHECK" | | |
1292 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1293 | "ml" | "1" | "--enable-ml", "MODULES_ML" | X | |
1294 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1295 | "nearly_forbidden_days" | "14" | "--with-nearly-forbidden-days", | | |
1296 | | | "MODULES_NEARLY_FORBIDDEN_DAYS" | | |
1297 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1298 | "pager" | "less -eFKRX" | "--with-pager", "--with-pager-opts", | | |
1299 | | | "MODULES_PAGER", "--paginate", " --no-pager" | | |
1300 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1301 | "protected_envvars" | *Unset by default* | "MODULES_PROTECTED_ENVVARS" | | |
1302 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1303 | "quarantine_support" | "0" | "--enable-quarantine-support", | X | |
1304 | | | "MODULES_QUARANTINE_SUPPORT" | | |
1305 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1306 | "rcfile" | *Unset by default* | "MODULERCFILE" | | |
1307 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1308 | "redirect_output" | "1" | "MODULES_REDIRECT_OUTPUT", "--redirect", "-- | | |
1309 | | | no-redirect" | | |
1310 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1311 | "require_via" | "0" | "--enable-require-via", "MODULES_REQUIRE_VIA" | | |
1312 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1313 | "reset_target_state" | "__init__" | "MODULES_RESET_TARGET_STATE", | | |
1314 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1315 | "run_quarantine" | *Empty by default* | "--with-quarantine-vars", | | |
1316 | | | "MODULES_RUN_QUARANTINE" | | |
1317 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1318 | "search_match" | "starts_with" | "--with-search-match", "MODULES_SEARCH_MATCH", | | |
1319 | | | "--contains", "-- starts-with" | | |
1320 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1321 | "set_shell_startup" | "0" | "--enable-set-shell-startup", | X | |
1322 | | | "MODULES_SET_SHELL_STARTUP" | | |
1323 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1324 | "shells_with_ksh_fpath" | *Empty by default* | "MODULES_SHELLS_WITH_KSH_FPATH" | X | |
1325 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1326 | "silent_shell_debug" | "0" | "--enable-silent-shell-debug-support", | X | |
1327 | | | "MODULES_SILENT_SHELL_DEBUG" | | |
1328 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1329 | "siteconfig" | "/etc/environment-modules/siteconfig.tcl" | "--prefix", "--etcdir" | | X |
1330 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1331 | "source_cache" | "0" | "--enable-source-cache", | | |
1332 | | | "MODULES_SOURCE_CACHE" | | |
1333 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1334 | "spider_indepth" | "1" | "--enable-spider-indepth", | | |
1335 | | | "MODULES_SPIDER_INDEPTH", "--indepth", "-- no- | | |
1336 | | | indepth" | | |
1337 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1338 | "spider_output" | modulepath:alias:dirwsym:sym:tag:variantifspec | "--with-spider-output", | | |
1339 | | :via:key | "MODULES_SPIDER_OUTPUT", "--output" | | |
1340 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1341 | "spider_terse_output" | modulepath:alias:dirwsym:sym:tag:variantifspec | "--with-spider-terse-output", | | |
1342 | | | "MODULES_SPIDER_TERSE_OUTPUT", "-- output" | | |
1343 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1344 | "sticky_purge" | "error" | "--with-sticky-purge", "MODULES_STICKY_PURGE" | | |
1345 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1346 | "tag_abbrev" | auto-loaded=aL:loaded=L:hidden=H:hidden- | "--with-tag-abbrev", "MODULES_TAG_ABBREV" | | |
1347 | | loaded=H:forbidden=F:nearly- | | | |
1348 | | forbidden=nF:sticky=S:super-sticky=sS:keep- | | | |
1349 | | loaded=kL:warning=W | | | |
1350 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1351 | "tag_color_name" | *Empty by default* | "--with-tag-color-name", | | |
1352 | | | "MODULES_TAG_COLOR_NAME" | | |
1353 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1354 | "tcl_ext_lib" | "/usr/share/Modules/lib64/libtclenvmodules.so" | | | X |
1355 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1356 | "tcl_linter" | "nagelfar.tcl" | "--with-tcl-linter", "--with-tcl-linter-opts", | | |
1357 | | | "MODULES_TCL_LINTER" | | |
1358 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1359 | "term_background" | "dark" | "--with-terminal-background", | | |
1360 | | | "MODULES_TERM_BACKGROUND" | | |
1361 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1362 | "term_width" | "0" | "MODULES_TERM_WIDTH", "--width" | | |
1363 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1364 | "unique_name_loaded" | "0" | "--enable-unique-name-loaded", | | |
1365 | | | "MODULES_UNIQUE_NAME_LOADED" | | |
1366 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1367 | "unload_match_order" | "returnlast" | "--with-unload-match-order", | | |
1368 | | | "MODULES_UNLOAD_MATCH_ORDER" | | |
1369 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1370 | "variant_shortcut" | *Empty by default* | "--with-variant-shortcut", | | |
1371 | | | "MODULES_VARIANT_SHORTCUT" | | |
1372 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1373 | "verbosity" | "normal" | "--with-verbosity", "MODULES_VERBOSITY", "-- | | |
1374 | | | debug", "--silent", "-- trace", "--verbose" | | |
1375 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1376 | "wa_277" | "1" | "--enable-wa-277", "MODULES_WA_277" | X | |
1377 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+