Debian Codegraph @

INSTALL.rst

raw
1 .. _INSTALL:
2
3
4
5
6 Installing Modules on Unix
7 ==========================
8
9 This document is an overview of building and installing Modules on a Unix
10 system.
11
12
13 Requirements
14 ------------
15
16 Modules consists of one Tcl script so to run it from a user shell the only
17 requirement is to have a working version of ``tclsh`` (version 8.5 or later)
18 available on your system. ``tclsh`` is a part of Tcl
19 (http://www.tcl-lang.org/software/tcltk/).
20
21 To install Modules from a distribution tarball or a clone of the git
22 repository, a build step is there to tailor the :file:`modulecmd.tcl` and the
23 initialization scripts to the chosen installation configuration and create the
24 documentation files. This build step requires the tools to be found on your
25 system:
26
27 * bash
28 * make
29 * sed
30 * runtest
31
32 When also installing Modules Tcl extension library (enabled by default), these
33 additional tools are needed:
34
35 * grep
36 * gcc
37 * tcl-devel >= 8.5
38
39 When installing from a distribution tarball, documentation is pre-built and
40 scripts to configure Modules Tcl extension library build are already
41 generated. Thus no additional software is required. When installing from a
42 clone of the git repository or from a git archive export, documentation and
43 scripts to prepare for compilation have to be built and the following tools
44 are required:
45
46 * autoconf
47 * automake
48 * autopoint
49 * m4
50 * python
51 * sphinx >= 1.0
52 * gzip
53
54 The following features of Modules rely on external tools. Default tool may be
55 changed or their location on target system may be specified. Alternatively
56 these features may also be disabled.
57
58 +----------------+-----------------------+-------------------------------+
59 | Feature option | Default external tool | Installation options |
60 +================+=======================+===============================+
61 | pager | ``less`` | :instopt:`--with-pager`, |
62 | | | ``--without-pager`` |
63 +----------------+-----------------------+-------------------------------+
64 | logger | ``logger`` | :instopt:`--with-logger`, |
65 | | | ``--without-logger`` |
66 +----------------+-----------------------+-------------------------------+
67 | tcl_linter | ``nagelfar.tcl`` | :instopt:`--with-tcl-linter`, |
68 | | | ``--without-linter`` |
69 +----------------+-----------------------+-------------------------------+
70
71 Get Modules
72 -----------
73
74 Modules can usually be installed with the package manager of your Unix system.
75 It it is available by default `on most Linux distributions, on OS X and
76 FreeBSD <https://repology.org/project/environment-modules/versions>`_ either
77 under the name of ``modules`` or ``environment-modules``.
78
79 If you want to install Modules from sources, tarballs from all Modules'
80 releases can be retrieved from one of the following link:
81
82 * https://github.com/envmodules/modules/releases/
83 * https://sourceforge.net/projects/modules/files/Modules/
84
85 For instance to download then unpack the last release of Modules:
86
87 .. parsed-literal::
88
89 :ps:`$` curl -LJO |gh_tgz_dl_url|
90 :ps:`$` tar xfz modules-\ |version|\ .tar.gz
91
92 Installation instructions
93 -------------------------
94
95 The simplest way to build and install Modules is:
96
97 .. parsed-literal::
98
99 :ps:`$` ./configure
100 :ps:`$` make
101 :ps:`$` make install
102
103 Some explanation, step by step:
104
105 1. ``cd`` to the directory containing the package's source code. Your system
106 must have the above requirements installed to properly build scripts, and
107 documentation if build occurs from a clone of the git repository.
108
109 2. Type ``./configure`` to adapt the installation for your system. At this
110 step you can choose the installation paths and the features you want to
111 enable in the initialization scripts (see `Build and installation options`_
112 section below for a complete overview of the available options)
113
114 3. Type ``make`` to adapt scripts to the configuration, build Tcl extension
115 library if enabled and build documentation if working from git repository.
116
117 4. Optionally, type ``make test QUICKTEST=1`` to run the lightweight version
118 of the non-regression test suite.
119
120 5. Type ``make install`` to install modulecmd.tcl, initialization scripts and
121 documentation.
122
123 6. Optionally, type ``make testinstall`` to run the installation test suite.
124
125 7. You can remove the built files from the source code directory by typing
126 ``make clean``. To also remove the files that ``configure`` created, type
127 ``make distclean``.
128
129 A default installation process like described above will install Modules
130 under ``/usr/local/Modules``. You can change this with the :instopt:`--prefix`
131 option. By default, ``/usr/local/Modules/modulefiles`` will be setup as
132 the default directory containing modulefiles. :instopt:`--modulefilesdir`
133 option enables to change this directory location. For example:
134
135 .. parsed-literal::
136
137 :ps:`$` ./configure --prefix=/usr/share/Modules \\
138 --modulefilesdir=/etc/modulefiles
139
140 See `Build and installation options`_ section to discover all ``./configure``
141 option available.
142
143 .. note:: GNU Make is excepted to be used for this build and installation
144 process. On non-Linux systems, the ``gmake`` should be called instead of
145 ``make``.
146
147 .. _enable-modules-in-shells:
148
149 Enable Modules in shells
150 ------------------------
151
152 Shell initialization scripts should be adapted to enable Modules during their
153 startup. Enabling Modules means defining the ``module`` shell function and
154 applying its configuration.
155
156 An easy way to achieve that is to make Modules initialization scripts part of
157 the system-wide environment setup in ``/etc/profile.d``.To do so, make a link
158 in this directory to the profile scripts that can be found in your Modules
159 installation init directory. For instance, if Modules has been installed in
160 ``/usr/share/modules``:
161
162 .. parsed-literal::
163
164 :ps:`$` ln -s /usr/share/modules/init/profile.sh /etc/profile.d/modules.sh
165 :ps:`$` ln -s /usr/share/modules/init/profile.csh /etc/profile.d/modules.csh
166
167 These profile scripts will automatically adapt to the kind of ``sh`` or
168 ``csh`` shell you are running.
169
170 Another approach is to get the Modules initialization script sourced from the
171 shell configuration startup file. For instance following line could be added
172 to the end of the ``~/.bashrc`` file if running Bash shell::
173
174 . /usr/share/modules/init/bash
175
176 Beware that shells have multiple ways to initialize depending if they are a
177 login shell or not and if they are launched in interactive mode or not.
178
179 Depending on your OS distribution system-wide profile scripts may be ignored
180 when initializing non-interactive shells. This is for instance the case on
181 Debian distribution and its derivatives like Ubuntu. On such system, Modules
182 initialization script should be sourced by shell initialization files to get
183 ``module`` function defined when executing a command through ``ssh`` or
184 running a script. Add the following code snippets to the initialization files
185 of the shell you use.
186
187 * For **Bash**, update either system-wide (``/etc/bash.bashrc`` on Debian-like
188 systems) or personal (``~/.bashrc``) initialization file:
189
190 .. code-block:: sh
191
192 # enable module command in non-login shells
193 if ! shopt -q login_shell; then
194 . /usr/share/modules/init/bash
195 fi
196
197 * For **Csh**/**Tcsh**, add Modules initialization file into Csh rc directory
198 (``/etc/csh/cshrc.d`` on Debian-like systems)::
199
200 ln -s /usr/share/modules/init/csh /etc/csh/cshrc.d/modules
201
202 Or update personal (``~/.cshrc``) initialization file:
203
204 .. code-block:: csh
205
206 # enable module command in non-login shells
207 if (! $?loginsh) then
208 source /usr/share/modules/init/csh
209 endif
210
211 * For **Zsh**, update either system-wide (``/etc/zsh/zshenv`` on Debian-like
212 systems) or personal (``~/.zshenv``) initialization file:
213
214 .. code-block:: sh
215
216 # enable module command
217 . /usr/share/modules/init/zsh
218
219 * For **Ksh**, update personal (``~/.kshrc``) initialization file:
220
221 .. code-block:: sh
222
223 # enable module command
224 . /usr/share/modules/init/ksh
225
226 * For **Fish**, add Modules initialization file into Fish system-wide config
227 directory (``/etc/fish/conf.d``)::
228
229 ln -s /usr/share/modules/init/fish /etc/fish/conf.d/modules.fish
230
231 Or into Fish personal config directory (``~/.config/fish/conf.d``)::
232
233 ln -s /usr/share/modules/init/fish ~/.config/fish/conf.d/modules.fish
234
235 Configuration
236 -------------
237
238 Once installed you should review and adapt the configuration to make it fit
239 your needs. The following steps are provided for example. They are not
240 necessarily mandatory as it depends of the kind of setup you want to achieve.
241
242 1. Define module paths to enable by default. Edit :file:`initrc` configuration
243 file in the directory designated by the :instopt:`--etcdir` option or edit
244 :file:`modulespath` in the same directory.
245
246 If you use :file:`modulespath` configuration file, add one line mentioning
247 each modulefile directory::
248
249 /path/to/regular/modulefiles
250 /path/to/other/modulefiles
251
252 If you use :file:`initrc` configuration file, add one line mentioning each
253 modulefile directory prefixed by the :subcmd:`module use<use>` command:
254
255 .. code-block:: tcl
256
257 module use /path/to/regular/modulefiles
258 module use /path/to/other/modulefiles
259
260 In case both configuration files :file:`initrc` and :file:`modulespath` are
261 present, Modules initialization process will first evaluate
262 :file:`modulespath` then :file:`initrc`.
263
264 By default, the modulepaths specified on the :instopt:`--with-modulepath`
265 installation option are automatically defined for use in :file:`initrc` (or
266 in :file:`modulespath` if the :instopt:`--enable-modulespath` installation
267 option has been set).
268
269 .. note:: If you have set :instopt:`--with-initconf-in` to ``initdir`` to
270 install the Modules initialization configurations in the configuration
271 directory designated by the :instopt:`--initdir` option, the configuration
272 files :file:`initrc` and :file:`modulespath` are respectively named
273 ``modulerc`` and ``.modulespath``.
274
275 2. Define modulefiles to load by default. Edit :file:`initrc` configuration
276 file. Modulefiles to load cannot be specified in :file:`modulespath` file.
277 Add there all the modulefiles you want to load by default at Modules
278 initialization time.
279
280 Add one line mentioning each modulefile to load prefixed by the
281 :subcmd:`module load<load>` command:
282
283 .. code-block:: tcl
284
285 module load foo
286 module load bar
287
288 By default, the modules specified on the :instopt:`--with-loadedmodules`
289 installation option are automatically defined for load in :file:`initrc`.
290
291 Alternatively, if users have :ref:`module collections<collections>` saved
292 in their :envvar:`HOME` directory, you may prefer restoring their default
293 collection when Modules initializes rather loading the default module list:
294
295 .. code-block:: tcl
296
297 if {[is-saved default]} {
298 module restore
299 } else {
300 module load foo
301 module load bar
302 }
303
304 In fact you can add to the :file:`initrc` configuration file any kind of
305 supported module command, like :subcmd:`module config<config>` commands to
306 tune :command:`module`'s default behaviors. This configuration way is
307 recommended over directly modifying the shell initialization scripts.
308
309 See the `Configuration options`_ section to discover all Modules
310 :subcmd:`config` options available, their default value and the installation
311 options linked to them.
312
313 If you go through the above steps you should have a valid setup tuned to your
314 needs. After that you still have to write modulefiles to get something to
315 load and unload in your newly configured Modules setup. In case you want to
316 achieve a specific setup, some additional steps may be required:
317
318 3. In case the configuration you expect cannot be achieved through the
319 :file:`initrc` configuration file, you may review and tune the
320 initialization scripts. These files are located in the directory designated
321 by the :instopt:`--initdir` option. Beware that these scripts could be
322 overwritten when upgrading to a newer version of Modules, so configuration
323 should be done through the :file:`initrc` file as far as possible.
324
325 4. If you want to alter the way the :file:`modulecmd.tcl` script operates, the
326 :file:`siteconfig.tcl` script may be used. This Tcl file is located in the
327 directory designated by the :instopt:`--etcdir` option. Every time the
328 :command:`module` command is called, it executes the :file:`modulecmd.tcl`
329 script which in turns sources the :file:`siteconfig.tcl` script during its
330 startup phase. The site-specific configuration script could override
331 default configuration values and more largely could supersede all
332 procedures defined in :file:`modulecmd.tcl` to obtain specific behaviors.
333
334 5. Prior running the module sub-command specified as argument, the
335 :file:`modulecmd.tcl` script evaluates the global run-command files. These
336 files are either the :file:`rc` file in the directory designated by the
337 :instopt:`--etcdir` option, the file(s) designated in the
338 :envvar:`MODULERCFILE` environment variable or the user-specific RC file
339 located in :file:`$HOME/.modulerc`. The RC files are modulefiles (limited
340 to a subset of the :ref:`modulefile Tcl
341 commands<Modules specific Tcl commands>`) that could define global module
342 aliases, virtual modules or module properties such as tags, forbidding
343 rules, etc.
344
345 .. note:: Run-command files are intended to set parameters for
346 modulefiles, not to configure the :command:`module` command itself.
347
348 To learn more about siteconfig and run-command files, see the
349 :ref:`Modulecmd startup` section in :ref:`module(1)` reference manual. You may
350 also look at the available :ref:`setup recipes<cookbook>` to get concrete
351 deployment examples of these files.
352
353 Upgrading
354 ---------
355
356 In case you want to upgrade a pre-existing Modules installation, it is
357 suggested to:
358
359 1. Backup configuration files stored in *etcdir* (like :file:`siteconfig.tcl`
360 or :file:`initrc`);
361 2. Remove previous Modules installation;
362 3. Install new Modules version;
363 4. Review specific configuration of previous installation and adapt
364 configuration files of new version.
365
366 It is advised to look at the different documents describing changes and new
367 features appearing between versions. By reading these documents you will be
368 able to determine the specific configuration options to apply to satisfy your
369 use cases.
370
371 * :ref:`changes`
372 * :ref:`NEWS`
373 * :ref:`MIGRATING`
374
375 In case you install Modules with the :instopt:`--enable-versioning` option
376 set, you may be able to install a new version of Modules alongside existing
377 ones (if they also have been installed with this option set).
378
379 Build and installation options
380 ------------------------------
381
382 Options available at the ``./configure`` installation step are described
383 below. These options enable to choose the installation paths and the features
384 to enable or disable. You can also get a description of these options by
385 typing ``./configure --help``.
386
387 Fine tuning of the installation directories (the default value for each option
388 is displayed within brackets):
389
390 .. instopt:: --bindir=DIR
391
392 Directory for executables reachable by users [``PREFIX/bin``]
393
394 .. instopt:: --datarootdir=DIR
395
396 Base directory to set the man and doc directories [``PREFIX/share``]
397
398 .. instopt:: --docdir=DIR
399
400 Directory to host documentation other than man pages like README, license
401 file, etc [``DATAROOTDIR/doc``]
402
403 .. instopt:: --emacsdatadir=DIR
404
405 Directory to host Emacs addon files [``DATAROOTDIR/emacs/lisp``]
406
407 .. only:: html or latex
408
409 .. versionadded:: 5.6
410
411 .. instopt:: --etcdir=DIR
412
413 Directory for the executable configuration scripts
414 [``PREFIX/etc``]
415
416 .. only:: html or latex
417
418 .. versionadded:: 4.1
419
420 .. instopt:: --initdir=DIR
421
422 Directory for the per-shell environment initialization scripts
423 [``PREFIX/init``]
424
425 .. instopt:: --libdir=DIR
426
427 Directory for object code libraries like libtclenvmodules.so [``PREFIX/lib``]
428
429 .. instopt:: --libexecdir=DIR
430
431 Directory for executables called by other executables like modulecmd.tcl
432 [``PREFIX/libexec``]
433
434 .. instopt:: --mandir=DIR
435
436 Directory to host man pages [``DATAROOTDIR/man``]
437
438 .. instopt:: --modulefilesdir=DIR
439
440 Directory of main modulefiles also called system modulefiles
441 [``PREFIX/modulefiles``]
442
443 .. only:: html or latex
444
445 .. versionadded:: 4.0
446
447 .. instopt:: --nagelfardatadir=DIR
448
449 Directory to host Nagelfar linter addon files [``DATAROOTDIR/nagelfar``]
450
451 .. only:: html or latex
452
453 .. versionadded:: 5.2
454
455 .. instopt:: --prefix=PREFIX
456
457 Installation root directory [``/usr/local/Modules``]
458
459 .. instopt:: --vimdatadir=DIR
460
461 Directory to host Vim addon files [``DATAROOTDIR/vim/vimfiles``]
462
463 .. only:: html or latex
464
465 .. versionadded:: 4.3
466
467 Optional Features (the default for each option is displayed within
468 parenthesis, to disable an option replace ``enable`` by ``disable`` for
469 instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
470
471 .. instopt:: --enable-advanced-version-spec
472
473 Activate the advanced module version specifiers which enables to finely
474 select module versions by specifying after the module name a version
475 constraint prefixed by the ``@`` character. This option also allows to
476 specify module variants. (default=yes)
477
478 This installation option defines the default value of the
479 :mconfig:`advanced_version_spec` configuration option which could be changed
480 after installation with the :subcmd:`config` sub-command.
481
482 .. only:: html or latex
483
484 .. versionadded:: 4.4
485
486 .. versionchanged:: 5.0
487 Configuration option default set to ``yes``
488
489 .. instopt:: --enable-append-binpath
490
491 Append rather prepend binary directory to the PATH environment variable when
492 the :instopt:`--enable-set-binpath` option is enabled. (default=no)
493
494 .. only:: html or latex
495
496 .. versionadded:: 4.2
497
498 .. instopt:: --enable-append-manpath
499
500 Append rather prepend man page directory to the MANPATH environment variable
501 when the :instopt:`--enable-set-manpath` option is enabled. (default=no)
502
503 .. only:: html or latex
504
505 .. versionadded:: 4.2
506
507 .. instopt:: --enable-append-pythonpath
508
509 Append rather prepend the ``env_modules`` Python module directory to the
510 PYTHONPATH environment variable when the :instopt:`--enable-set-pythonpath`
511 option is enabled. (default=no)
512
513 .. only:: html or latex
514
515 .. versionadded:: 5.7
516
517 .. instopt:: --enable-auto-handling
518
519 Set modulecmd.tcl to automatically apply automated modulefiles handling
520 actions, like loading the pre-requisites of a modulefile when loading this
521 modulefile. (default=yes)
522
523 This installation option defines the default value of the
524 :mconfig:`auto_handling` configuration option which could be changed after
525 installation with the :subcmd:`config` sub-command.
526
527 .. only:: html or latex
528
529 .. versionadded:: 4.2
530
531 .. versionchanged:: 5.0
532 Configuration option default set to ``yes``
533
534 .. instopt:: --enable-avail-indepth
535
536 When performing an :subcmd:`avail` sub-command, include in search results the
537 matching modulefiles and directories and recursively the modulefiles and
538 directories contained in these matching directories when enabled or limit
539 search results to the matching modulefiles and directories found at the depth
540 level expressed by the search query if disabled. (default=yes)
541
542 This installation option defines the default value of the
543 :mconfig:`avail_indepth` configuration option which could be changed after
544 installation with the :subcmd:`config` sub-command.
545
546 .. only:: html or latex
547
548 .. versionadded:: 4.3
549
550 .. instopt:: --enable-color
551
552 Control if output should be colored by default or not. A value of ``yes``
553 equals to the ``auto`` color mode. ``no`` equals to the ``never`` color
554 mode. (default=yes)
555
556 This installation option defines the default value of the
557 :mconfig:`color` configuration option which could be changed after
558 installation with the :subcmd:`config` sub-command.
559
560 .. only:: html or latex
561
562 .. versionadded:: 4.3
563
564 .. versionchanged:: 5.0
565 Configuration option default set to ``yes``
566
567 .. instopt:: --enable-compressed-changelog
568
569 Control if ``ChangeLog`` documentation file should be installed in a
570 compressed format or not. (default=yes)
571
572 .. only:: html or latex
573
574 .. versionadded:: 5.7
575
576 .. instopt:: --enable-conflict-unload
577
578 Apply automated unload of conflicting modulefiles when loading a module.
579 (default=no)
580
581 This installation option defines the default value of the
582 :mconfig:`conflict_unload` configuration option which could be changed after
583 installation with the :subcmd:`config` sub-command.
584
585 .. only:: html or latex
586
587 .. versionadded:: 5.5
588
589 .. instopt:: --enable-doc-install
590
591 Install the documentation files in the documentation directory defined with
592 the :instopt:`--docdir` option. This feature has no impact on manual pages
593 installation. Disabling documentation file installation is useful in case of
594 installation process handled via a package manager which handles by itself
595 the installation of this kind of documents. (default=yes)
596
597 .. only:: html or latex
598
599 .. versionadded:: 4.0
600
601 .. instopt:: --enable-emacs-addons
602
603 Install the Emacs addon files in the Emacs addons directory defined with the
604 :instopt:`--emacsdatadir` option. (default=yes)
605
606 .. only:: html or latex
607
608 .. versionadded:: 5.6
609
610 .. instopt:: --enable-example-modulefiles
611
612 Install some modulefiles provided as example in the system modulefiles
613 directory defined with the :instopt:`--modulefilesdir` option. (default=yes)
614
615 .. only:: html or latex
616
617 .. versionadded:: 4.0
618
619 .. instopt:: --enable-extended-default
620
621 Allow to specify module versions by their starting part, i.e. substring
622 separated from the rest of the version string by a ``.`` character.
623 (default=yes)
624
625 This installation option defines the default value of the
626 :mconfig:`extended_default` configuration option which could be changed after
627 installation with the :subcmd:`config` sub-command.
628
629 .. only:: html or latex
630
631 .. versionadded:: 4.4
632
633 .. versionchanged:: 5.0
634 Configuration option default set to ``yes``
635
636 .. instopt:: --enable-implicit-default
637
638 Define an implicit default version, for modules with none explicitly defined,
639 to select when the name of the module to evaluate is passed without the
640 mention of a specific version. When this option is disabled the name of the
641 module passed for evaluation should be fully qualified elsewhere an error is
642 returned. (default=yes)
643
644 This installation option defines the default value of the
645 :mconfig:`implicit_default` configuration option which could be changed after
646 installation with the :subcmd:`config` sub-command.
647
648 .. only:: html or latex
649
650 .. versionadded:: 4.3
651
652 .. instopt:: --enable-implicit-requirement
653
654 Implicitly define a prereq or a conflict requirement toward modules specified
655 respectively on :mfcmd:`module load<module>` or :mfcmd:`module
656 unload<module>` commands in modulefile. (default=yes)
657
658 This installation option defines the default value of the
659 :mconfig:`implicit_requirement` configuration option which could be changed
660 after installation with the :subcmd:`config` sub-command.
661
662 .. only:: html or latex
663
664 .. versionadded:: 4.7
665
666 .. instopt:: --enable-libtclenvmodules
667
668 Build and install the Modules Tcl extension library which provides optimized
669 Tcl commands for the modulecmd.tcl script. (default=yes)
670
671 .. only:: html or latex
672
673 .. versionadded:: 4.3
674
675 .. instopt:: --enable-mcookie-version-check
676
677 Enable check of the version specified right after Modules magic cookie
678 (i.e., ``#%Module`` file signature) in modulefiles, which defines the minimal
679 version of the Modules tool to use in order to evaluate the modulefile.
680 (default=yes)
681
682 This installation option defines the default value of the
683 :mconfig:`mcookie_version_check` configuration option which could be changed
684 after installation with the :subcmd:`config` sub-command.
685
686 .. only:: html or latex
687
688 .. versionadded:: 4.7
689
690 .. instopt:: --enable-ml
691
692 Define the :command:`ml` command, a handy frontend to the module command,
693 when Modules initializes. (default=yes)
694
695 This installation option defines the default value of the :mconfig:`ml`
696 configuration option which could be changed after installation with the
697 :subcmd:`config` sub-command.
698
699 .. only:: html or latex
700
701 .. versionadded:: 4.5
702
703 .. instopt:: --enable-modulespath, --enable-dotmodulespath
704
705 Set the module paths defined by :instopt:`--with-modulepath` option in a
706 :file:`modulespath` file (following C version fashion) within the
707 initialization directory defined by the :instopt:`--etcdir` option rather
708 than within the :file:`initrc` file. Or respectively, if option
709 :instopt:`--with-initconf-in` has been set to ``initdir``, in a
710 ``.modulespath`` file within the configuration directory defined by the
711 :instopt:`--initdir` option rather than within the ``modulerc`` file.
712 (default=no)
713
714 .. only:: html or latex
715
716 .. versionadded:: 4.0
717
718 .. versionchanged:: 4.3
719 Option ``--enable-modulespath`` added
720
721 .. instopt:: --enable-multilib-support
722
723 Support multilib systems by looking in modulecmd.tcl at an alternative
724 location where to find the Modules Tcl extension library depending on current
725 machine architecture. (default=no)
726
727 .. only:: html or latex
728
729 .. versionadded:: 4.6
730
731 .. instopt:: --enable-nagelfar-addons
732
733 Install the Nagelfar linter addon files (syntax databases and plugins to lint
734 modulefiles and modulercs) in the Nagelfar addons directory defined with the
735 :instopt:`--nagelfardatadir` option. (default=yes)
736
737 .. only:: html or latex
738
739 .. versionadded:: 5.2
740
741 .. instopt:: --enable-new-features
742
743 Enable all new features that are disabled by default due to the substantial
744 behavior changes they imply on Modules 5. This option is equivalent to the
745 cumulative use of
746 :instopt:`--with-abort-on-error=load:ml:reload:switch<--with-abort-on-error>`,
747 :instopt:`--enable-conflict-unload` and :instopt:`--enable-require-via`.
748 (default=no)
749
750 .. only:: html or latex
751
752 .. versionadded:: 4.7
753
754 .. versionchanged:: 5.0
755 Configuration option has been reset following major version change as
756 :instopt:`--enable-auto-handling`, :instopt:`--enable-color`,
757 :instopt:`--with-icase=search<--with-icase>`,
758 :instopt:`--enable-extended-default` and
759 :instopt:`--enable-advanced-version-spec` are set by default on Modules
760 5.
761
762 .. versionchanged:: 5.4
763 Enables *abort on error* behavior on :subcmd:`load` and
764 :subcmd:`switch` sub-commands.
765
766 .. versionchanged:: 5.5
767 Enables automated *conflict unload* mechanism
768
769 .. versionchanged:: 5.6
770 Enables automated *require via* mechanism
771
772 .. instopt:: --enable-paginate
773
774 Control if output of module command should be piped into a pager by default
775 or not. (default=yes)
776
777 .. only:: html or latex
778
779 .. versionadded:: 5.7
780
781 .. instopt:: --enable-path-entry-reorder
782
783 Change order of entry in a path-like environment variable, when
784 :mfcmd:`prepend-path`, :mfcmd:`append-path` or :subcmd:`use` target a path
785 entry that is already defined in the environment variable. (default=no)
786
787 This installation option defines the default value of the
788 :mconfig:`path_entry_reorder` configuration option which could be changed
789 after installation with the :subcmd:`config` sub-command.
790
791 .. only:: html or latex
792
793 .. versionadded:: 5.7
794
795 .. instopt:: --enable-quarantine-support
796
797 Generate code in module function definition to add support for the
798 environment variable quarantine mechanism (default=no)
799
800 This installation option defines the default value of the
801 :mconfig:`quarantine_support` configuration option which could be changed
802 after installation with the :subcmd:`config` sub-command.
803
804 .. only:: html or latex
805
806 .. versionadded:: 4.1
807
808 .. versionchanged:: 5.0
809 Configuration option default set to ``no``
810
811 .. instopt:: --enable-require-via
812
813 Consider loaded module that enables a modulepath, a requirement of loaded
814 modules stored in this modulepath. (default=no)
815
816 This installation option defines the default value of the
817 :mconfig:`require_via` configuration option which could be changed after
818 installation with the :subcmd:`config` sub-command.
819
820 .. only:: html or latex
821
822 .. versionadded:: 5.6
823
824 .. instopt:: --enable-set-binpath
825
826 Prepend binary directory defined by the :instopt:`--bindir` option to the
827 PATH environment variable in the shell initialization scripts. (default=yes)
828
829 .. only:: html or latex
830
831 .. versionadded:: 4.0
832
833 .. instopt:: --enable-set-manpath
834
835 Prepend man page directory defined by the :instopt:`--mandir` option to the
836 MANPATH environment variable in the shell initialization scripts.
837 (default=yes)
838
839 .. only:: html or latex
840
841 .. versionadded:: 4.0
842
843 .. instopt:: --enable-set-pythonpath
844
845 Prepend directory where the ``env_modules`` Python module is installed (see
846 :instopt:`--with-pythondir` option) to the PYTHONPATH environment
847 variable in the shell initialization scripts. (default=yes)
848
849 .. only:: html or latex
850
851 .. versionadded:: 5.7
852
853 .. instopt:: --enable-set-shell-startup
854
855 Set when module function is defined the shell startup file to ensure that the
856 module function is still defined in sub-shells. (default=no)
857
858 This installation option defines the default value of the
859 :mconfig:`set_shell_startup` configuration option which could be changed
860 after installation with the :subcmd:`config` sub-command.
861
862 .. only:: html or latex
863
864 .. versionadded:: 4.3
865
866 .. versionchanged:: 5.0
867 Configuration option default set to ``no``
868
869 .. instopt:: --enable-silent-shell-debug-support
870
871 Generate code in module function definition to add support for silencing
872 shell debugging properties (default=no)
873
874 This installation option defines the default value of the
875 :mconfig:`silent_shell_debug` configuration option which could be changed
876 after installation with the :subcmd:`config` sub-command.
877
878 .. only:: html or latex
879
880 .. versionadded:: 4.2
881
882 .. versionchanged:: 5.0
883 Configuration option default set to ``no``
884
885 .. instopt:: --enable-source-cache
886
887 Cache content of files evaluated through :manpage:`source(n)` Tcl command in
888 modulefile. When same file is sourced multiple times, cached content is
889 reused rather reading file again.
890
891 This installation option defines the default value of the
892 :mconfig:`source_cache` configuration option which could be changed
893 after installation with the :subcmd:`config` sub-command.
894
895 .. only:: html or latex
896
897 .. versionadded:: 5.4
898
899 .. instopt:: --enable-spider-indepth
900
901 When performing an :subcmd:`spider` sub-command, include in search results
902 the matching modulefiles and directories and recursively the modulefiles and
903 directories contained in these matching directories when enabled or limit
904 search results to the matching modulefiles and directories found at the depth
905 level expressed by the search query if disabled. (default=yes)
906
907 This installation option defines the default value of the
908 :mconfig:`spider_indepth` configuration option which could be changed after
909 installation with the :subcmd:`config` sub-command.
910
911 .. only:: html or latex
912
913 .. versionadded:: 5.6
914
915 .. instopt:: --enable-versioning
916
917 Append Modules version to installation prefix and deploy a ``versions``
918 modulepath shared between all versioning enabled Modules installation. A
919 modulefile corresponding to Modules version is added to the shared modulepath
920 and enables to switch from one Modules version to another. (default=no)
921
922 .. instopt:: --enable-unique-name-loaded
923
924 Only allow one module loaded per module name. A conflict is raised when
925 loading a module whose name or alternative names are shared by an already
926 loaded module. (default=no)
927
928 This installation option defines the default value of the
929 :mconfig:`unique_name_loaded` configuration option which could be changed
930 after installation with the :subcmd:`config` sub-command.
931
932 .. only:: html or latex
933
934 .. versionadded:: 5.4
935
936 .. instopt:: --enable-vim-addons
937
938 Install the Vim addon files in the Vim addons directory defined with the
939 :instopt:`--vimdatadir` option. (default=yes)
940
941 .. only:: html or latex
942
943 .. versionadded:: 4.3
944
945 .. instopt:: --enable-wa-277
946
947 Activate workaround for issue #277 related to Tcsh history mechanism which
948 does not cope well with default module alias definition. Note that enabling
949 this workaround solves Tcsh history issue but weakens shell evaluation of the
950 code produced by modulefiles. (default=no)
951
952 This installation option defines the default value of the :mconfig:`wa_277`
953 configuration option which could be changed after installation with the
954 :subcmd:`config` sub-command.
955
956 .. only:: html or latex
957
958 .. versionadded:: 4.3
959
960 .. instopt:: --enable-windows-support
961
962 Install all required files for Windows platform (:command:`module`,
963 :command:`ml` and :command:`envml` command batch file and ``cmd.cmd``
964 initialization script). (default=no)
965
966 .. only:: html or latex
967
968 .. versionadded:: 4.5
969
970
971 Optional Packages (the default for each option is displayed within
972 parenthesis, to disable an option replace ``with`` by ``without`` for
973 instance :instopt:`--without-modulepath<--with-modulepath>`):
974
975 .. instopt:: --with-abort-on-error=LIST
976
977 When evaluating multiple modulefiles, if one fails abort evaluation sequence
978 and withdraw already evaluated modulefiles for listed module sub-commands.
979 Sub-commands accepted in LIST are: :subcmd:`load`, :command:`ml`,
980 :subcmd:`mod-to-sh`, :subcmd:`purge`, :subcmd:`reload`, :subcmd:`switch`,
981 :subcmd:`switch_unload<switch>`, :subcmd:`try-load` and :subcmd:`unload`
982 (elements in LIST are separated by ``:``).
983 (default=\ ``ml:reload:switch_unload``)
984
985 This installation option defines the default value of the
986 :mconfig:`abort_on_error` configuration option which could be changed after
987 installation with the :subcmd:`config` sub-command.
988
989 .. only:: html or latex
990
991 .. versionadded:: 5.4
992
993 .. instopt:: --with-avail-output=LIST
994
995 Specify the content to report on avail sub-command regular output in addition
996 to the available module names. Elements accepted in LIST are: ``modulepath``,
997 ``alias``, ``provided-alias``, ``dirwsym``, ``indesym``, ``sym``, ``tag``,
998 ``key``, ``hidden``, ``variant``, ``variantifspec`` and ``via`` (elements in
999 LIST are separated by ``:``). The order of the elements in LIST does not
1000 matter. (default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec:key``)
1001
1002 This installation option defines the default value of the
1003 :mconfig:`avail_output` configuration option which could be changed after
1004 installation with the :subcmd:`config` sub-command.
1005
1006 .. only:: html or latex
1007
1008 .. versionadded:: 4.7
1009
1010 .. versionchanged:: 5.3
1011 Element ``variant`` added
1012
1013 .. versionchanged:: 5.3
1014 Element ``variantifspec`` added and set by default
1015
1016 .. versionchanged:: 5.3.1
1017 Element ``indesym`` added
1018
1019 .. versionchanged:: 5.6
1020 Elements ``hidden``, ``provided-alias`` and ``via`` added
1021
1022 .. instopt:: --with-avail-terse-output=LIST
1023
1024 Specify the content to report on avail sub-command terse output in addition
1025 addition to the available module names. Elements accepted in LIST are:
1026 ``modulepath``, ``alias``, ``provided-alias``, ``dirwsym``, ``indesym``,
1027 ``sym``, ``tag``, ``key``, ``hidden``, ``variant`` and ``variantifspec``
1028 (elements in LIST are separated by ``:``). The order of the elements in LIST
1029 does not matter.
1030 (default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec``)
1031
1032 This installation option defines the default value of the
1033 :mconfig:`avail_terse_output` configuration option which could be changed
1034 after installation with the :subcmd:`config` sub-command.
1035
1036 .. only:: html or latex
1037
1038 .. versionadded:: 4.7
1039
1040 .. versionchanged:: 5.3
1041 Element ``variant`` added
1042
1043 .. versionchanged:: 5.3
1044 Element ``variantifspec`` added and set by default
1045
1046 .. versionchanged:: 5.3.1
1047 Element ``indesym`` added
1048
1049 .. versionchanged:: 5.6
1050 Elements ``hidden`` and ``provided-alias`` added
1051
1052 .. instopt:: --with-bashcompletiondir=DIR
1053
1054 Directory for Bash completion scripts. When this option is not set Bash
1055 completion script for Modules is installed in the initialization script
1056 directory and is sourced from Modules Bash initialization script. (default=)
1057
1058 .. only:: html or latex
1059
1060 .. versionadded:: 5.1
1061
1062 .. instopt:: --with-bin-search-path=PATHLIST
1063
1064 List of paths to look at when searching the location of tools required to
1065 build and configure Modules (default=\ ``/usr/bin:/bin:/usr/local/bin``)
1066
1067 .. only:: html or latex
1068
1069 .. versionadded:: 4.2
1070
1071 .. instopt:: --with-dark-background-colors=SGRLIST
1072
1073 Default color set to apply if terminal background color is defined to
1074 ``dark``. SGRLIST follows the same syntax than used in ``LS_COLORS``. Each
1075 element in SGRLIST is an output item associated to a Select Graphic Rendition
1076 (SGR) code. Elements in SGRLIST are separated by ``:``. Output items are
1077 designated by keys.
1078
1079 Items able to be colorized are: highlighted element (``hi``), debug
1080 information (``db``), trace information (``tr``) tag separator (``se``);
1081 Error (``er``), warning (``wa``), module error (``me``) and info (``in``)
1082 message prefixes; Modulepath (``mp``), directory (``di``), module alias
1083 (``al``), module variant (``va``), module symbolic version (``sy``) and
1084 module ``default`` version (``de``).
1085
1086 :ref:`Module tags` can also be colorized. The key to set in the color palette
1087 to get a graphical rendering of a tag is the tag name or the tag abbreviation
1088 if one is defined for tag. The SGR code applied to a tag name is ignored if
1089 an abbreviation is set for this tag thus the SGR code should be defined for
1090 this abbreviation to get a graphical rendering. Each basic tag has by default
1091 a key set in the color palette, based on its abbreviated string: auto-loaded
1092 (``aL``), forbidden (``F``), hidden and hidden-loaded (``H``), loaded
1093 (``L``), nearly-forbidden (``nF``), sticky (``S``), super-sticky (``sS``),
1094 keep-loaded (``kL``) and warning (``W``).
1095
1096 For a complete SGR code reference, see
1097 https://en.wikipedia.org/wiki/ANSI_escape_code#Select_Graphic_Rendition_parameters.
1098 (default=\ ``hi=1:db=2:tr=2:se=2:er=91:wa=93:me=95:in=94:mp=1;94:di=94:al=96:va=93:sy=95:de=4:cm=92:aL=100:L=90;47:H=2:F=41:nF=31;43:S=46:sS=44:kL=30;48;5;109:W=30;43``)
1099
1100 This installation option defines the default value of the :mconfig:`colors`
1101 configuration option when :mconfig:`term_background` configuration option
1102 equals ``dark``. :mconfig:`colors` could be changed after installation with
1103 the :subcmd:`config` sub-command.
1104
1105 .. only:: html or latex
1106
1107 .. versionadded:: 4.3
1108
1109 .. versionchanged:: 4.6
1110 Output item for trace information (``tr``) added
1111
1112 .. versionchanged:: 4.7
1113 Output items for module tags auto-loaded (``aL``), forbidden (``F``),
1114 hidden and hidden-loaded (``H``), loaded (``L``), nearly-forbidden
1115 (``nF``), sticky (``S``) and super-sticky (``sS``) added
1116
1117 .. versionchanged:: 4.8
1118 Output item for module variant (``va``) added
1119
1120 .. versionchanged:: 5.1
1121 Output item for keep-loaded module tag (``kL``) added
1122
1123 .. versionchanged:: 5.6
1124 Output item for warning module tag (``W``) added
1125
1126 .. versionchanged:: 5.6
1127 Default ``nearly-forbidden`` tag color changed
1128
1129 .. instopt:: --with-domainname=BIN
1130
1131 Name or full path of default domainname program to use to fetch domain name
1132 (can be superseded at run-time by environment variable)
1133 (default=\ ``domainname``)
1134
1135 This installation option and :instopt:`--with-domainname-opts` define the
1136 default value of the :mconfig:`domainname` configuration option which could
1137 be changed after installation with the :subcmd:`config` sub-command.
1138
1139 .. only:: html or latex
1140
1141 .. versionadded:: 5.7
1142
1143 .. instopt:: --with-domainname-opts=OPTLIST
1144
1145 Settings to apply to default domainname program (default=)
1146
1147 This installation option and :instopt:`--with-domainname` define the default
1148 value of the :mconfig:`domainname` configuration option which could be
1149 changed after installation with the :subcmd:`config` sub-command.
1150
1151 .. only:: html or latex
1152
1153 .. versionadded:: 5.7
1154
1155 .. instopt:: --with-editor=BIN
1156
1157 Name or full path of default editor program to use to open modulefile through
1158 the :subcmd:`edit` sub-command. (default=\ ``vi``)
1159
1160 This installation option defines the default value of the :mconfig:`editor`
1161 configuration option which could be changed after installation with the
1162 :subcmd:`config` sub-command.
1163
1164 .. only:: html or latex
1165
1166 .. versionadded:: 4.8
1167
1168 .. instopt:: --with-fishcompletiondir=DIR
1169
1170 Directory for Fish completion scripts. When this option is not set Fish
1171 completion script for Modules is installed in the initialization script
1172 directory and is sourced from Modules Fish initialization script. (default=)
1173
1174 .. only:: html or latex
1175
1176 .. versionadded:: 5.1
1177
1178 .. instopt:: --with-icase=VALUE
1179
1180 Apply a case insensitive match to module specification on :subcmd:`avail`,
1181 :subcmd:`whatis` and :subcmd:`paths` sub-commands (when set to ``search``) or
1182 on all module sub-commands and modulefile Tcl commands for the module
1183 specification they receive as argument (when set to ``always``). Case
1184 insensitive match is disabled when this option is set to ``never``.
1185 (default=\ ``search``)
1186
1187 This installation option defines the default value of the :mconfig:`icase`
1188 configuration option which could be changed after installation with the
1189 :subcmd:`config` sub-command.
1190
1191 .. only:: html or latex
1192
1193 .. versionadded:: 4.4
1194
1195 .. versionchanged:: 5.0
1196 Configuration option default set to ``search``
1197
1198 .. instopt:: --with-initconf-in=VALUE
1199
1200 Location where to install Modules initialization configuration files. Either
1201 ``initdir`` or ``etcdir`` (default=\ ``etcdir``)
1202
1203 .. only:: html or latex
1204
1205 .. versionadded:: 4.1
1206
1207 .. versionchanged:: 5.0
1208 Configuration option default set to ``etcdir``
1209
1210 .. instopt:: --with-init-envvars=LIST
1211
1212 Initial values to assign to environment variables before they are modified
1213 for the first time. Each entry in LIST must use the format
1214 ``VARIABLE_NAME=initial_value``. Entries are separated by ``:``.
1215
1216 This installation option defines the default value of the
1217 :mconfig:`init_envvars` configuration option which could be changed after
1218 installation with the :subcmd:`config` sub-command.
1219
1220 .. only:: html or latex
1221
1222 .. versionadded:: 5.7
1223
1224 .. instopt:: --with-light-background-colors=SGRLIST
1225
1226 Default color set to apply if terminal background color is defined to
1227 ``light``. Expect the same syntax than described for
1228 :instopt:`--with-dark-background-colors`.
1229 (default=\ ``hi=1:db=2:tr=2:se=2:er=31:wa=33:me=35:in=34:mp=1;34:di=34:al=36:va=33:sy=35:de=4:cm=32:aL=107:L=47:H=2:F=101:nF=91;103:S=106:sS=104:kL=48;5;109:W=103``)
1230
1231 This installation option defines the default value of the :mconfig:`colors`
1232 configuration option when :mconfig:`term_background` configuration option
1233 equals ``light``. :mconfig:`colors` could be changed after installation with
1234 the :subcmd:`config` sub-command.
1235
1236 .. only:: html or latex
1237
1238 .. versionadded:: 4.3
1239
1240 .. versionchanged:: 4.6
1241 Output item for trace information (``tr``) added
1242
1243 .. versionchanged:: 4.7
1244 Output items for module tags auto-loaded (``aL``), forbidden (``F``),
1245 hidden and hidden-loaded (``H``), loaded (``L``), nearly-forbidden
1246 (``nF``), sticky (``S``) and super-sticky (``sS``) added
1247
1248 .. versionchanged:: 4.8
1249 Output item for module variant (``va``) added
1250
1251 .. versionchanged:: 5.1
1252 Output item for keep-loaded module tag (``kL``) added
1253
1254 .. versionchanged:: 5.6
1255 Output item for warning module tag (``W``) added
1256
1257 .. versionchanged:: 5.6
1258 Default ``nearly-forbidden`` tag color changed
1259
1260 .. instopt:: --with-list-output=LIST
1261
1262 Specify the content to report on list sub-command regular output in addition
1263 to the loaded module names. Elements accepted in LIST are: ``header``,
1264 ``idx``, ``variant``, ``alias``, ``indesym``, ``sym``, ``tag``, ``hidden``
1265 and ``key`` (elements in LIST are separated by ``:``). The order of the
1266 elements in LIST does not matter. (default=\ ``header:idx:variant:sym:tag:key``)
1267
1268 This installation option defines the default value of the
1269 :mconfig:`list_output` configuration option which could be changed after
1270 installation with the :subcmd:`config` sub-command.
1271
1272 .. only:: html or latex
1273
1274 .. versionadded:: 4.7
1275
1276 .. versionchanged:: 4.8
1277 Element ``variant`` added and set by default
1278
1279 .. versionchanged:: 5.4
1280 Elements ``alias`` and ``indesym`` added
1281
1282 .. versionchanged:: 5.6
1283 Element ``hidden`` added
1284
1285 .. instopt:: --with-list-terse-output=LIST
1286
1287 Specify the content to report on list sub-command terse output in addition
1288 to the loaded module names. Elements accepted in LIST are: ``header``,
1289 ``idx``, ``variant``, ``alias``, ``indesym``, ``sym``, ``tag``, ``hidden``
1290 and ``key`` (elements in LIST are separated by ``:``). The order of the
1291 elements in LIST does not matter. (default=\ ``header``)
1292
1293 This installation option defines the default value of the
1294 :mconfig:`list_terse_output` configuration option which could be changed
1295 after installation with the :subcmd:`config` sub-command.
1296
1297 .. only:: html or latex
1298
1299 .. versionadded:: 4.7
1300
1301 .. versionchanged:: 4.8
1302 Element ``variant`` added
1303
1304 .. versionchanged:: 5.4
1305 Elements ``alias`` and ``indesym`` added
1306
1307 .. versionchanged:: 5.6
1308 Element ``hidden`` added
1309
1310 .. instopt:: --with-loadedmodules=MODLIST
1311
1312 Default modulefiles to load at Modules initialization time. Each modulefile
1313 in this list should be separated by ``:``. Defined value is registered in the
1314 :file:`initrc` configuration file or in the ``modulerc`` file if
1315 :instopt:`--with-initconf-in` is set to ``initdir``. (default=)
1316
1317 .. only:: html or latex
1318
1319 .. versionadded:: 4.0
1320
1321 .. instopt:: --with-locked-configs=CONFIGLIST
1322
1323 Ignore environment variable superseding value for the listed configuration
1324 options. Accepted option names in CONFIGLIST are :mconfig:`extra_siteconfig`
1325 , :mconfig:`implicit_default`, :mconfig:`logged_events` and :mconfig:`logger`
1326 (each option name should be separated by whitespace character). (default=)
1327
1328 This installation option defines the default value of the
1329 :mconfig:`locked_configs` configuration option which cannot not be changed
1330 after installation.
1331
1332 .. only:: html or latex
1333
1334 .. versionadded:: 4.3
1335
1336 .. versionchanged:: 5.5
1337 Configs ``logged_events`` and ``logger`` added
1338
1339 .. instopt:: --with-logged-events=EVENTLIST
1340
1341 Events to log. Accepted event names in EVENTLIST are ``auto_eval``,
1342 ``requested_eval`` and ``requested_cmd`` (each event name in this list should
1343 be separated by ``:``). The order of the elements in EVENTLIST does not
1344 matter. (default=)
1345
1346 This installation option defines the default value of the
1347 :mconfig:`logged_events` configuration option which cannot not be changed
1348 after installation.
1349
1350 .. only:: html or latex
1351
1352 .. versionadded:: 5.5
1353
1354 .. instopt:: --with-logger=BIN
1355
1356 Name or full path of default logger program to use to log information (can be
1357 superseded at run-time by environment variable) (default=\ ``logger``)
1358
1359 This installation option and :instopt:`--with-logger-opts` define the default
1360 value of the :mconfig:`logger` configuration option which could be changed
1361 after installation with the :subcmd:`config` sub-command.
1362
1363 .. only:: html or latex
1364
1365 .. versionadded:: 5.5
1366
1367 .. instopt:: --with-logger-opts=OPTLIST
1368
1369 Settings to apply to default logger program (default=\ ``-t modules``)
1370
1371 This installation option and :instopt:`--with-logger` define the default
1372 value of the :mconfig:`logger` configuration option which could be changed
1373 after installation with the :subcmd:`config` sub-command.
1374
1375 .. only:: html or latex
1376
1377 .. versionadded:: 5.5
1378
1379 .. instopt:: --with-modulepath=PATHLIST
1380
1381 Default path list to setup as the default modulepaths. Each path in this list
1382 should be separated by ``:``. Defined value is registered in the
1383 :file:`initrc` or :file:`modulespath` configuration file, depending on the
1384 :instopt:`--enable-modulespath` option. These files are respectively called
1385 ``modulerc`` and ``.modulespath`` if :instopt:`--with-initconf-in` is set to
1386 ``initdir``. The path list value is read at initialization time to populate
1387 the MODULEPATH environment variable. By default, this modulepath is composed
1388 of the directory set for the system modulefiles
1389 (default=\ ``PREFIX/modulefiles`` or
1390 ``BASEPREFIX/$MODULE_VERSION/modulefiles`` if versioning installation mode
1391 enabled)
1392
1393 .. only:: html or latex
1394
1395 .. versionadded:: 4.0
1396
1397 .. instopt:: --with-moduleshome
1398
1399 Location of the main Modules package file directory (default=\ ``PREFIX``)
1400
1401 This installation option defines the default value of the :mconfig:`home`
1402 configuration option which could be changed after installation with the
1403 :subcmd:`config` sub-command.
1404
1405 .. only:: html or latex
1406
1407 .. versionadded:: 4.4
1408
1409 .. instopt:: --with-nearly-forbidden-days=VALUE
1410
1411 Define the number of days a module is considered nearly forbidden prior
1412 reaching its expiry date. VALUE should be an integer comprised between 0 and
1413 365. (default=\ ``14``)
1414
1415 This installation option defines the default value of the
1416 :mconfig:`nearly_forbidden_days` configuration option which could be changed
1417 after installation with the :subcmd:`config` sub-command.
1418
1419 .. only:: html or latex
1420
1421 .. versionadded:: 4.6
1422
1423 .. instopt:: --with-pager=BIN
1424
1425 Name or full path of default pager program to use to paginate informational
1426 message output (can be superseded at run-time by environment variable)
1427 (default=\ ``less``)
1428
1429 This installation option and :instopt:`--with-pager-opts` define the default
1430 value of the :mconfig:`pager` configuration option which could be changed
1431 after installation with the :subcmd:`config` sub-command.
1432
1433 .. only:: html or latex
1434
1435 .. versionadded:: 4.1
1436
1437 .. instopt:: --with-pager-opts=OPTLIST
1438
1439 Settings to apply to default pager program (default=\ ``-eFKRX``)
1440
1441 This installation option and :instopt:`--with-pager` define the default value
1442 of the :mconfig:`pager` configuration option which could be changed after
1443 installation with the :subcmd:`config` sub-command.
1444
1445 .. only:: html or latex
1446
1447 .. versionadded:: 4.1
1448
1449 .. instopt:: --with-python=BIN
1450
1451 Name or full path of Python interpreter command to set as shebang for helper
1452 scripts. (default=\ ``python``)
1453
1454 .. only:: html or latex
1455
1456 .. versionadded:: 4.5
1457
1458 .. instopt:: --with-pythondir=DIR
1459
1460 Installation directory of the ``env_modules`` Python module. When this
1461 option is not set, :file:`env_modules.py` is installed in the initialization
1462 script directory. Whatever the installation directory of this Python module,
1463 the :file:`python.py` symbolic link created in the initialization script
1464 directory points to its location. (default=)
1465
1466 If this option is set to the ``site-packages`` directory of the Python
1467 installation available on the system, the ``env_modules`` module can be
1468 imported without requiring the PYTHONPATH environment variable to be set.
1469 In this case the :instopt:`--disable-set-pythonpath<--enable-set-pythonpath>`
1470 option may be used.
1471
1472 .. only:: html or latex
1473
1474 .. versionadded:: 5.7
1475
1476 .. instopt:: --with-quarantine-vars=<VARNAME[=VALUE] ...>
1477
1478 Environment variables to put in quarantine when running the module command to
1479 ensure it a sane execution environment (each variable should be separated by
1480 space character). A value can eventually be set to a quarantine variable
1481 instead of emptying it. (default=)
1482
1483 This installation option defines the default value of the
1484 :envvar:`MODULES_RUN_QUARANTINE` and :envvar:`MODULES_RUNENV_\<VAR\>`
1485 environment variables which could be changed after installation with the
1486 :subcmd:`config` sub-command on :mconfig:`run_quarantine` configuration
1487 option.
1488
1489 .. only:: html or latex
1490
1491 .. versionadded:: 4.1
1492
1493 .. instopt:: --with-search-match=VALUE
1494
1495 When searching for a module with :subcmd:`avail` sub-command, match query
1496 string against module name start (``starts_with``) or any part of module name
1497 string (``contains``). (default=\ ``starts_with``)
1498
1499 This installation option defines the default value of the
1500 :mconfig:`search_match` configuration option which could be changed after
1501 installation with the :subcmd:`config` sub-command.
1502
1503 .. only:: html or latex
1504
1505 .. versionadded:: 4.3
1506
1507 .. instopt:: --with-spider-output=LIST
1508
1509 Specify the content to report on spider sub-command regular output in
1510 addition to the available module names. Elements accepted in LIST are:
1511 ``modulepath``, ``alias``, ``provided-alias``, ``dirwsym``, ``indesym``,
1512 ``sym``, ``tag``, ``key``, ``hidden``, ``variant``, ``variantifspec`` and
1513 ``via`` (elements in LIST are separated by ``:``). The order of the elements
1514 in LIST does not matter.
1515 (default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec:via:key``)
1516
1517 This installation option defines the default value of the
1518 :mconfig:`spider_output` configuration option which could be changed after
1519 installation with the :subcmd:`config` sub-command.
1520
1521 .. only:: html or latex
1522
1523 .. versionadded:: 5.6
1524
1525 .. instopt:: --with-spider-terse-output=LIST
1526
1527 Specify the content to report on spider sub-command terse output in addition
1528 addition to the available module names. Elements accepted in LIST are:
1529 ``modulepath``, ``alias``, ``provided-alias``, ``dirwsym``, ``indesym``,
1530 ``sym``, ``tag``, ``key``, ``hidden``, ``variant`` and ``variantifspec``
1531 (elements in LIST are separated by ``:``). The order of the elements in LIST
1532 does not matter.
1533 (default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec``)
1534
1535 This installation option defines the default value of the
1536 :mconfig:`spider_terse_output` configuration option which could be changed
1537 after installation with the :subcmd:`config` sub-command.
1538
1539 .. only:: html or latex
1540
1541 .. versionadded:: 5.6
1542
1543 .. instopt:: --with-sticky-purge=VALUE
1544
1545 When unloading a sticky or super-sticky module during a module purge, raise
1546 an ``error`` or emit a ``warning`` message or be ``silent``.
1547 (default=\ ``error``)
1548
1549 This installation option defines the default value of the
1550 :mconfig:`sticky_purge` configuration option which could be changed after
1551 installation with the :subcmd:`config` sub-command.
1552
1553 .. only:: html or latex
1554
1555 .. versionadded:: 5.4
1556
1557 .. instopt:: --with-tag-abbrev=ABBRVLIST
1558
1559 Define the abbreviation to use when reporting each module tag. Each element
1560 in ABBRVLIST is a tag name associated to an abbreviation string (elements in
1561 ABBRVLIST are separated by ``:``).
1562 (default=\ ``auto-loaded=aL:loaded=L:hidden=H:hidden-loaded=H:forbidden=F:nearly-forbidden=nF:sticky=S:super-sticky=sS:keep-loaded=kL:warning=W``)
1563
1564 This installation option defines the default value of the
1565 :mconfig:`tag_abbrev` configuration option which could be changed after
1566 installation with the :subcmd:`config` sub-command.
1567
1568 .. only:: html or latex
1569
1570 .. versionadded:: 4.7
1571
1572 .. versionchanged:: 5.1
1573 Abbreviation for ``keep-loaded`` tag added
1574
1575 .. versionchanged:: 5.6
1576 Abbreviation for ``warning`` tag added
1577
1578 .. instopt:: --with-tag-color-name=TAGLIST
1579
1580 Define the tags whose graphical rendering should be applied over their name
1581 instead of over the name of the module they are attached to. Each element in
1582 TAGLIST is a tag name or abbreviation (elements in TAGLIST are separated by
1583 ``:``). (default=)
1584
1585 This installation option defines the default value of the
1586 :mconfig:`tag_color_name` configuration option which could be changed after
1587 installation with the :subcmd:`config` sub-command.
1588
1589 .. only:: html or latex
1590
1591 .. versionadded:: 4.7
1592
1593 .. instopt:: --with-tcl
1594
1595 Directory containing the Tcl configuration script ``tclConfig.sh``. Useful to
1596 compile Modules Tcl extension library if this file cannot be automatically
1597 found in default locations.
1598
1599 .. instopt:: --with-tclinclude
1600
1601 Directory containing the Tcl header files. Useful to compile Modules Tcl
1602 extension library if these headers cannot be automatically found in default
1603 locations.
1604
1605 .. instopt:: --with-tclsh=BIN
1606
1607 Name or full path of Tcl interpreter shell (default=\ ``tclsh``)
1608
1609 .. only:: html or latex
1610
1611 .. versionadded:: 4.0
1612
1613 .. instopt:: --with-tcl-linter=BIN
1614
1615 Name or full path of program to use to lint modulefile through the
1616 :subcmd:`lint` sub-command. (default=\ ``nagelfar.tcl``)
1617
1618 This installation option and :instopt:`--with-tcl-linter-opts` define the
1619 default value of the :mconfig:`tcl_linter` configuration option which could
1620 be changed after installation with the :subcmd:`config` sub-command.
1621
1622 .. only:: html or latex
1623
1624 .. versionadded:: 5.2
1625
1626 .. instopt:: --with-tcl-linter-opts=OPTLIST
1627
1628 Settings to apply to Tcl linter program (default=)
1629
1630 This installation option and :instopt:`--with-tcl-linter` define the default
1631 value of the :mconfig:`tcl_linter` configuration option which could be
1632 changed after installation with the :subcmd:`config` sub-command.
1633
1634 .. only:: html or latex
1635
1636 .. versionadded:: 5.2
1637
1638 .. instopt:: --with-terminal-background=VALUE
1639
1640 The terminal background color that determines the color set to apply by
1641 default between the ``dark`` background colors or the ``light`` background
1642 colors (default=\ ``dark``)
1643
1644 This installation option defines the default value of the
1645 :mconfig:`term_background` configuration option which could be changed after
1646 installation with the :subcmd:`config` sub-command.
1647
1648 .. only:: html or latex
1649
1650 .. versionadded:: 4.3
1651
1652 .. instopt:: --with-unload-match-order=VALUE
1653
1654 When unloading a module if multiple loaded modules match the request, unload
1655 module loaded first (``returnfirst``) or module loaded last (``returnlast``)
1656 (default=\ ``returnlast``)
1657
1658 This installation option defines the default value of the
1659 :mconfig:`unload_match_order` configuration option which could be changed
1660 after installation with the :subcmd:`config` sub-command.
1661
1662 .. only:: html or latex
1663
1664 .. versionadded:: 4.3
1665
1666 .. instopt:: --with-variant-shortcut=SHORTCUTLIST
1667
1668 Define the shortcut characters that could be used to specify variant names.
1669 Each element in SHORTCUTLIST is a variant name associated to a shortcut
1670 character (e.g., ``foo=%``). Shortcuts cannot exceed a length of 1 character
1671 and cannot be alphanumeric characters ([A-Za-z0-9]) or characters with
1672 already a special meaning ([+~/@=-]). Elements in SHORTCUTLIST are separated
1673 by ``:``. (default=)
1674
1675 This installation option defines the default value of the
1676 :mconfig:`variant_shortcut` configuration option which could be changed after
1677 installation with the :subcmd:`config` sub-command.
1678
1679 .. only:: html or latex
1680
1681 .. versionadded:: 4.8
1682
1683 .. instopt:: --with-verbosity=VALUE
1684
1685 Specify default message verbosity. accepted values are ``silent``,
1686 ``concise``, ``normal``, ``verbose``, ``verbose2``, ``trace``, ``debug`` and
1687 ``debug2``. (default=\ ``normal``)
1688
1689 This installation option defines the default value of the
1690 :mconfig:`verbosity` configuration option which could be changed after
1691 installation with the :subcmd:`config` sub-command.
1692
1693 .. only:: html or latex
1694
1695 .. versionadded:: 4.3
1696
1697 .. instopt:: --with-zshcompletiondir=DIR
1698
1699 Directory for Zsh completion scripts. When this option is not set Zsh
1700 completion script for Modules is installed in the initialization script
1701 directory and :envvar:`FPATH` is set in Zsh initialization script to point to
1702 this location. (default=)
1703
1704 .. only:: html or latex
1705
1706 .. versionadded:: 5.1
1707
1708
1709 Configuration options
1710 ---------------------
1711
1712 Options available through the :subcmd:`config` sub-command are described
1713 below. In addition to their default value, the related installation option,
1714 environment variable and command-line switch are listed for each configuration
1715 option. This table also describes if each configuration option needs to be set
1716 prior or during Modules initialization and if it can be modified after
1717 installation.
1718
1719 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1720 | Configuration option | Default value | Related installation option, environment | Set prior or | Cannot be |
1721 | | | variable and command-line switch | during init\ | altered |
1722 | | | | ialization | |
1723 +===================================+==============================================+==============================================+==============+===========+
1724 | :mconfig:`abort_on_error` | ``ml:reload:switch_unload`` | :instopt:`--with-abort-on-error`, | | |
1725 | | | :envvar:`MODULES_ABORT_ON_ERROR` | | |
1726 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1727 | :mconfig:`advanced_version_spec` | ``1`` | :instopt:`--enable-advanced-version-spec`, | | |
1728 | | | :envvar:`MODULES_ADVANCED_VERSION_SPEC` | | |
1729 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1730 | :mconfig:`auto_handling` | ``1`` | :instopt:`--enable-auto-handling`, | | |
1731 | | | :envvar:`MODULES_AUTO_HANDLING`, | | |
1732 | | | :option:`--auto`, :option:`--no-auto` | | |
1733 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1734 | :mconfig:`avail_indepth` | ``1`` | :instopt:`--enable-avail-indepth`, | | |
1735 | | | :envvar:`MODULES_AVAIL_INDEPTH`, | | |
1736 | | | :option:`--indepth`, :option:`--no-indepth` | | |
1737 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1738 | :mconfig:`avail_output` | modulepath:alias:dirwsym:sym:tag:\ | :instopt:`--with-avail-output`, | | |
1739 | | variantifspec:key | :envvar:`MODULES_AVAIL_OUTPUT`, | | |
1740 | | | :option:`--output` | | |
1741 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1742 | :mconfig:`avail_terse_output` | modulepath:alias:dirwsym:sym:tag:\ | :instopt:`--with-avail-terse-output`, | | |
1743 | | variantifspec | :envvar:`MODULES_AVAIL_TERSE_OUTPUT`, | | |
1744 | | | :option:`--output` | | |
1745 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1746 | :mconfig:`cache_buffer_bytes` | ``32768`` | :envvar:`MODULES_CACHE_BUFFER_BYTES` | | |
1747 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1748 | :mconfig:`cache_expiry_secs` | ``0`` | :envvar:`MODULES_CACHE_EXPIRY_SECS` | | |
1749 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1750 | :mconfig:`collection_pin_version` | ``0`` | :envvar:`MODULES_COLLECTION_PIN_VERSION` | | |
1751 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1752 | :mconfig:`collection_pin_tag` | ``0`` | :envvar:`MODULES_COLLECTION_PIN_TAG` | | |
1753 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1754 | :mconfig:`collection_target` | *Unset by default* | :envvar:`MODULES_COLLECTION_TARGET` | | |
1755 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1756 | :mconfig:`color` | ``auto`` | :instopt:`--enable-color`, | | |
1757 | | | :envvar:`MODULES_COLOR`, | | |
1758 | | | :option:`--color` | | |
1759 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1760 | :mconfig:`colors` | hi=1:db=2:tr=2:se=2:er=91:wa=93:\ | :instopt:`--with-dark-background-colors`, | | |
1761 | | me=95:in=94:mp=1;94:di=94:al=96:va=93:sy=95\ | :instopt:`--with-light-background-colors`, | | |
1762 | | :de=4:cm=92:aL=100:L=90;47:H=2:F=41:\ | :envvar:`MODULES_COLORS` | | |
1763 | | nF=31;43:S=46:sS=44:kL=30;48;5;109:W=30;43 | | | |
1764 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1765 | :mconfig:`conflict_unload` | ``0`` | :instopt:`--enable-conflict-unload`, | | |
1766 | | | :envvar:`MODULES_CONFLICT_UNLOAD` | | |
1767 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1768 | :mconfig:`contact` | ``root@localhost`` | :envvar:`MODULECONTACT` | | |
1769 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1770 | :mconfig:`extended_default` | ``1`` | :instopt:`--enable-extended-default`, | | |
1771 | | | :envvar:`MODULES_EXTENDED_DEFAULT` | | |
1772 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1773 | :mconfig:`domainname` | ``domainname`` | :instopt:`--with-domainname`, | | |
1774 | | | :instopt:`--with-domainname-opts`, | | |
1775 | | | :envvar:`MODULES_DOMAINNAME` | | |
1776 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1777 | :mconfig:`editor` | ``vi`` | :instopt:`--with-editor`, | | |
1778 | | | :envvar:`MODULES_EDITOR` | | |
1779 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1780 | :mconfig:`extra_siteconfig` | *Unset by default* | :envvar:`MODULES_SITECONFIG` | | |
1781 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1782 | :mconfig:`hide_auto_loaded` | ``0`` | :envvar:`MODULES_HIDE_AUTO_LOADED` | | |
1783 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1784 | :mconfig:`home` | |file prefix| | :instopt:`--prefix`, | | |
1785 | | | :instopt:`--with-moduleshome`, | | |
1786 | | | :envvar:`MODULESHOME` | | |
1787 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1788 | :mconfig:`icase` | ``search`` | :instopt:`--with-icase`, | | |
1789 | | | :envvar:`MODULES_ICASE`, | | |
1790 | | | :option:`--icase` | | |
1791 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1792 | :mconfig:`ignore_cache` | ``0`` | :envvar:`MODULES_IGNORE_CACHE`, | | |
1793 | | | :option:`--ignore-cache` | | |
1794 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1795 | :mconfig:`ignore_cache_subcmds` | *Empty by default* | :envvar:`MODULES_IGNORE_CACHE_SUBCMDS` | | |
1796 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1797 | :mconfig:`ignore_user_rc` | ``0`` | :envvar:`MODULES_IGNORE_USER_RC`, | | |
1798 | | | :option:`--ignore-user-rc` | | |
1799 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1800 | :mconfig:`ignored_dirs` | ``CVS RCS SCCS .svn .git .SYNC .sos`` | | | X |
1801 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1802 | :mconfig:`implicit_default` | ``1`` | :instopt:`--enable-implicit-default`, | | |
1803 | | | :envvar:`MODULES_IMPLICIT_DEFAULT` | | |
1804 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1805 | :mconfig:`implicit_requirement` | ``1`` | :instopt:`--enable-implicit-requirement`, | | |
1806 | | | :envvar:`MODULES_IMPLICIT_REQUIREMENT` | | |
1807 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1808 | :mconfig:`info_extension` | ``0`` | :envvar:`MODULES_INFO_EXTENSION` | | |
1809 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1810 | :mconfig:`init_envvars` | *Empty by default* | :instopt:`--with-init-envvars` | | |
1811 | | | :envvar:`MODULES_INIT_ENVVARS` | | |
1812 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1813 | :mconfig:`linked_envvars` | *Empty by default* | :envvar:`MODULES_LINKED_ENVVARS` | | |
1814 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1815 | :mconfig:`list_output` | ``header:idx:variant:sym:tag:key`` | :instopt:`--with-list-output`, | | |
1816 | | | :envvar:`MODULES_LIST_OUTPUT`, | | |
1817 | | | :option:`--output` | | |
1818 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1819 | :mconfig:`list_terse_output` | ``header`` | :instopt:`--with-list-terse-output`, | | |
1820 | | | :envvar:`MODULES_LIST_TERSE_OUTPUT`, | | |
1821 | | | :option:`--output` | | |
1822 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1823 | :mconfig:`locked_configs` | *Empty by default* | :instopt:`--with-locked-configs` | | X |
1824 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1825 | :mconfig:`logged_events` | *Empty by default* | :instopt:`--with-logged-events`, | | |
1826 | | | :envvar:`MODULES_LOGGED_EVENTS` | | |
1827 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1828 | :mconfig:`logger` | ``logger -t modules`` | :instopt:`--with-logger`, | | |
1829 | | | :instopt:`--with-logger-opts`, | | |
1830 | | | :envvar:`MODULES_LOGGER` | | |
1831 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1832 | :mconfig:`mcookie_check` | ``always`` | :envvar:`MODULES_MCOOKIE_CHECK` | | |
1833 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1834 | :mconfig:`mcookie_version_check` | ``1`` | :instopt:`--enable-mcookie-version-check`, | | |
1835 | | | :envvar:`MODULES_MCOOKIE_VERSION_CHECK` | | |
1836 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1837 | :mconfig:`ml` | ``1`` | :instopt:`--enable-ml`, | X | |
1838 | | | :envvar:`MODULES_ML` | | |
1839 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1840 | :mconfig:`modulepath_ignore` | ``1`` | :envvar:`MODULES_MODULEPATH_IGNORE`, | | |
1841 | | | :option:`--no-modulepath-ignore` | | |
1842 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1843 | :mconfig:`nearly_forbidden_days` | ``14`` | :instopt:`--with-nearly-forbidden-days`, | | |
1844 | | | :envvar:`MODULES_NEARLY_FORBIDDEN_DAYS` | | |
1845 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1846 | :mconfig:`non_exportable_tags` | *Empty by default* | :envvar:`MODULES_NON_EXPORTABLE_TAGS` | | |
1847 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1848 | :mconfig:`pager` | ``less -eFKRX`` | :instopt:`--with-pager`, | | |
1849 | | | :instopt:`--with-pager-opts`, | | |
1850 | | | :envvar:`MODULES_PAGER`, | | |
1851 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1852 | :mconfig:`paginate` | ``1`` | :instopt:`--enable-paginate`, | | |
1853 | | | :envvar:`MODULES_PAGINATE`, | | |
1854 | | | :option:`--paginate`, :option:`--no-pager` | | |
1855 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1856 | :mconfig:`path_entry_reorder` | ``0`` | :instopt:`--enable-path-entry-reorder`, | | |
1857 | | | :envvar:`MODULES_PATH_ENTRY_REORDER` | | |
1858 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1859 | :mconfig:`protected_envvars` | *Unset by default* | :envvar:`MODULES_PROTECTED_ENVVARS` | | |
1860 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1861 | :mconfig:`quarantine_support` | ``0`` | :instopt:`--enable-quarantine-support`, | X | |
1862 | | | :envvar:`MODULES_QUARANTINE_SUPPORT` | | |
1863 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1864 | :mconfig:`rcfile` | *Unset by default* | :envvar:`MODULERCFILE` | | |
1865 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1866 | :mconfig:`redirect_output` | ``1`` | :envvar:`MODULES_REDIRECT_OUTPUT`, | | |
1867 | | | :option:`--redirect`, | | |
1868 | | | :option:`--no-redirect` | | |
1869 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1870 | :mconfig:`require_via` | ``0`` | :instopt:`--enable-require-via`, | | |
1871 | | | :envvar:`MODULES_REQUIRE_VIA` | | |
1872 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1873 | :mconfig:`reset_target_state` | ``__init__`` | :envvar:`MODULES_RESET_TARGET_STATE`, | | |
1874 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1875 | :mconfig:`run_quarantine` | *Empty by default* | :instopt:`--with-quarantine-vars`, | | |
1876 | | | :envvar:`MODULES_RUN_QUARANTINE` | | |
1877 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1878 | :mconfig:`search_match` | ``starts_with`` | :instopt:`--with-search-match`, | | |
1879 | | | :envvar:`MODULES_SEARCH_MATCH`, | | |
1880 | | | :option:`--contains`, | | |
1881 | | | :option:`--starts-with` | | |
1882 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1883 | :mconfig:`set_shell_startup` | ``0`` | :instopt:`--enable-set-shell-startup`, | X | |
1884 | | | :envvar:`MODULES_SET_SHELL_STARTUP` | | |
1885 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1886 | :mconfig:`shells_with_ksh_fpath` | *Empty by default* | :envvar:`MODULES_SHELLS_WITH_KSH_FPATH` | X | |
1887 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1888 | :mconfig:`silent_shell_debug` | ``0`` | :instopt:`--enable-silent-shell-debug-\ | X | |
1889 | | | support`, | | |
1890 | | | :envvar:`MODULES_SILENT_SHELL_DEBUG` | | |
1891 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1892 | :mconfig:`siteconfig` | |file etcdir_siteconfig| | :instopt:`--prefix`, :instopt:`--etcdir` | | X |
1893 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1894 | :mconfig:`source_cache` | ``0`` | :instopt:`--enable-source-cache`, | | |
1895 | | | :envvar:`MODULES_SOURCE_CACHE` | | |
1896 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1897 | :mconfig:`spider_indepth` | ``1`` | :instopt:`--enable-spider-indepth`, | | |
1898 | | | :envvar:`MODULES_SPIDER_INDEPTH`, | | |
1899 | | | :option:`--indepth`, :option:`--no-indepth` | | |
1900 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1901 | :mconfig:`spider_output` | modulepath:alias:dirwsym:sym:tag:\ | :instopt:`--with-spider-output`, | | |
1902 | | variantifspec:via:key | :envvar:`MODULES_SPIDER_OUTPUT`, | | |
1903 | | | :option:`--output` | | |
1904 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1905 | :mconfig:`spider_terse_output` | modulepath:alias:dirwsym:sym:tag:\ | :instopt:`--with-spider-terse-output`, | | |
1906 | | variantifspec | :envvar:`MODULES_SPIDER_TERSE_OUTPUT`, | | |
1907 | | | :option:`--output` | | |
1908 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1909 | :mconfig:`sticky_purge` | ``error`` | :instopt:`--with-sticky-purge`, | | |
1910 | | | :envvar:`MODULES_STICKY_PURGE` | | |
1911 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1912 | :mconfig:`tag_abbrev` | auto-loaded=aL:loaded=L:hidden=H:\ | :instopt:`--with-tag-abbrev`, | | |
1913 | | hidden-loaded=H:forbidden=F:nearly-\ | :envvar:`MODULES_TAG_ABBREV` | | |
1914 | | forbidden=nF:sticky=S:super-sticky=sS:\ | | | |
1915 | | keep-loaded=kL:warning=W | | | |
1916 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1917 | :mconfig:`tag_color_name` | *Empty by default* | :instopt:`--with-tag-color-name`, | | |
1918 | | | :envvar:`MODULES_TAG_COLOR_NAME` | | |
1919 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1920 | :mconfig:`tcl_ext_lib` | |file libdir_tcl_ext_lib| | | | X |
1921 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1922 | :mconfig:`tcl_linter` | ``nagelfar.tcl`` | :instopt:`--with-tcl-linter`, | | |
1923 | | | :instopt:`--with-tcl-linter-opts`, | | |
1924 | | | :envvar:`MODULES_TCL_LINTER` | | |
1925 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1926 | :mconfig:`term_background` | ``dark`` | :instopt:`--with-terminal-background`, | | |
1927 | | | :envvar:`MODULES_TERM_BACKGROUND` | | |
1928 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1929 | :mconfig:`term_width` | ``0`` | :envvar:`MODULES_TERM_WIDTH`, | | |
1930 | | | :option:`--width` | | |
1931 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1932 | :mconfig:`unique_name_loaded` | ``0`` | :instopt:`--enable-unique-name-loaded`, | | |
1933 | | | :envvar:`MODULES_UNIQUE_NAME_LOADED` | | |
1934 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1935 | :mconfig:`unload_match_order` | ``returnlast`` | :instopt:`--with-unload-match-order`, | | |
1936 | | | :envvar:`MODULES_UNLOAD_MATCH_ORDER` | | |
1937 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1938 | :mconfig:`variant_shortcut` | *Empty by default* | :instopt:`--with-variant-shortcut`, | | |
1939 | | | :envvar:`MODULES_VARIANT_SHORTCUT` | | |
1940 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1941 | :mconfig:`verbosity` | ``normal`` | :instopt:`--with-verbosity`, | | |
1942 | | | :envvar:`MODULES_VERBOSITY`, | | |
1943 | | | :option:`--debug`, :option:`--silent`, | | |
1944 | | | :option:`--trace`, :option:`--verbose` | | |
1945 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1946 | :mconfig:`wa_277` | ``1`` | :instopt:`--enable-wa-277`, | X | |
1947 | | | :envvar:`MODULES_WA_277` | | |
1948 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+