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
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
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
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
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
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
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
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
504
505 .. versionadded:: 4.2
506
507 .. instopt:: --enable-auto-handling
508
509 Set modulecmd.tcl to automatically apply automated modulefiles handling
510 actions, like loading the pre-requisites of a modulefile when loading this
511 modulefile. (default=yes)
512
513 This installation option defines the default value of the
514 :mconfig:`auto_handling` configuration option which could be changed after
515 installation with the :subcmd:`config` sub-command.
516
517 .. only:: html
518
519 .. versionadded:: 4.2
520
521 .. versionchanged:: 5.0
522 Configuration option default set to ``yes``
523
524 .. instopt:: --enable-avail-indepth
525
526 When performing an :subcmd:`avail` sub-command, include in search results the
527 matching modulefiles and directories and recursively the modulefiles and
528 directories contained in these matching directories when enabled or limit
529 search results to the matching modulefiles and directories found at the depth
530 level expressed by the search query if disabled. (default=yes)
531
532 This installation option defines the default value of the
533 :mconfig:`avail_indepth` configuration option which could be changed after
534 installation with the :subcmd:`config` sub-command.
535
536 .. only:: html
537
538 .. versionadded:: 4.3
539
540 .. instopt:: --enable-color
541
542 Control if output should be colored by default or not. A value of ``yes``
543 equals to the ``auto`` color mode. ``no`` equals to the ``never`` color
544 mode. (default=yes)
545
546 This installation option defines the default value of the
547 :mconfig:`color` configuration option which could be changed after
548 installation with the :subcmd:`config` sub-command.
549
550 .. only:: html
551
552 .. versionadded:: 4.3
553
554 .. versionchanged:: 5.0
555 Configuration option default set to ``yes``
556
557 .. instopt:: --enable-conflict-unload
558
559 Apply automated unload of conflicting modulefiles when loading a module.
560 (default=no)
561
562 This installation option defines the default value of the
563 :mconfig:`conflict_unload` configuration option which could be changed after
564 installation with the :subcmd:`config` sub-command.
565
566 .. only:: html
567
568 .. versionadded:: 5.5
569
570 .. instopt:: --enable-doc-install
571
572 Install the documentation files in the documentation directory defined with
573 the :instopt:`--docdir` option. This feature has no impact on manual pages
574 installation. Disabling documentation file installation is useful in case of
575 installation process handled via a package manager which handles by itself
576 the installation of this kind of documents. (default=yes)
577
578 .. only:: html
579
580 .. versionadded:: 4.0
581
582 .. instopt:: --enable-emacs-addons
583
584 Install the Emacs addon files in the Emacs addons directory defined with the
585 :instopt:`--emacsdatadir` option. (default=yes)
586
587 .. only:: html
588
589 .. versionadded:: 5.6
590
591 .. instopt:: --enable-example-modulefiles
592
593 Install some modulefiles provided as example in the system modulefiles
594 directory defined with the :instopt:`--modulefilesdir` option. (default=yes)
595
596 .. only:: html
597
598 .. versionadded:: 4.0
599
600 .. instopt:: --enable-extended-default
601
602 Allow to specify module versions by their starting part, i.e. substring
603 separated from the rest of the version string by a ``.`` character.
604 (default=yes)
605
606 This installation option defines the default value of the
607 :mconfig:`extended_default` configuration option which could be changed after
608 installation with the :subcmd:`config` sub-command.
609
610 .. only:: html
611
612 .. versionadded:: 4.4
613
614 .. versionchanged:: 5.0
615 Configuration option default set to ``yes``
616
617 .. instopt:: --enable-implicit-default
618
619 Define an implicit default version, for modules with none explicitly defined,
620 to select when the name of the module to evaluate is passed without the
621 mention of a specific version. When this option is disabled the name of the
622 module passed for evaluation should be fully qualified elsewhere an error is
623 returned. (default=yes)
624
625 This installation option defines the default value of the
626 :mconfig:`implicit_default` configuration option which could be changed after
627 installation with the :subcmd:`config` sub-command.
628
629 .. only:: html
630
631 .. versionadded:: 4.3
632
633 .. instopt:: --enable-implicit-requirement
634
635 Implicitly define a prereq or a conflict requirement toward modules specified
636 respectively on :mfcmd:`module load<module>` or :mfcmd:`module
637 unload<module>` commands in modulefile. (default=yes)
638
639 This installation option defines the default value of the
640 :mconfig:`implicit_requirement` configuration option which could be changed
641 after installation with the :subcmd:`config` sub-command.
642
643 .. only:: html
644
645 .. versionadded:: 4.7
646
647 .. instopt:: --enable-libtclenvmodules
648
649 Build and install the Modules Tcl extension library which provides optimized
650 Tcl commands for the modulecmd.tcl script. (default=yes)
651
652 .. only:: html
653
654 .. versionadded:: 4.3
655
656 .. instopt:: --enable-mcookie-version-check
657
658 Enable check of the version specified right after Modules magic cookie
659 (i.e., ``#%Module`` file signature) in modulefiles, which defines the minimal
660 version of the Modules tool to use in order to evaluate the modulefile.
661 (default=yes)
662
663 This installation option defines the default value of the
664 :mconfig:`mcookie_version_check` configuration option which could be changed
665 after installation with the :subcmd:`config` sub-command.
666
667 .. only:: html
668
669 .. versionadded:: 4.7
670
671 .. instopt:: --enable-ml
672
673 Define the :command:`ml` command, a handy frontend to the module command,
674 when Modules initializes. (default=yes)
675
676 This installation option defines the default value of the :mconfig:`ml`
677 configuration option which could be changed after installation with the
678 :subcmd:`config` sub-command.
679
680 .. only:: html
681
682 .. versionadded:: 4.5
683
684 .. instopt:: --enable-modulespath, --enable-dotmodulespath
685
686 Set the module paths defined by :instopt:`--with-modulepath` option in a
687 :file:`modulespath` file (following C version fashion) within the
688 initialization directory defined by the :instopt:`--etcdir` option rather
689 than within the :file:`initrc` file. Or respectively, if option
690 :instopt:`--with-initconf-in` has been set to ``initdir``, in a
691 ``.modulespath`` file within the configuration directory defined by the
692 :instopt:`--initdir` option rather than within the ``modulerc`` file.
693 (default=no)
694
695 .. only:: html
696
697 .. versionadded:: 4.0
698
699 .. versionchanged:: 4.3
700 Option ``--enable-modulespath`` added
701
702 .. instopt:: --enable-multilib-support
703
704 Support multilib systems by looking in modulecmd.tcl at an alternative
705 location where to find the Modules Tcl extension library depending on current
706 machine architecture. (default=no)
707
708 .. only:: html
709
710 .. versionadded:: 4.6
711
712 .. instopt:: --enable-nagelfar-addons
713
714 Install the Nagelfar linter addon files (syntax databases and plugins to lint
715 modulefiles and modulercs) in the Nagelfar addons directory defined with the
716 :instopt:`--nagelfardatadir` option. (default=yes)
717
718 .. only:: html
719
720 .. versionadded:: 5.2
721
722 .. instopt:: --enable-new-features
723
724 Enable all new features that are disabled by default due to the substantial
725 behavior changes they imply on Modules 5. This option is equivalent to the
726 cumulative use of
727 :instopt:`--with-abort-on-error=load:ml:reload:switch<--with-abort-on-error>`,
728 :instopt:`--enable-conflict-unload` and :instopt:`--enable-require-via`.
729 (default=no)
730
731 .. only:: html
732
733 .. versionadded:: 4.7
734
735 .. versionchanged:: 5.0
736 Configuration option has been reset following major version change as
737 :instopt:`--enable-auto-handling`, :instopt:`--enable-color`,
738 :instopt:`--with-icase=search<--with-icase>`,
739 :instopt:`--enable-extended-default` and
740 :instopt:`--enable-advanced-version-spec` are set by default on Modules
741 5.
742
743 .. versionchanged:: 5.4
744 Enables *abort on error* behavior on :subcmd:`load` and
745 :subcmd:`switch` sub-commands.
746
747 .. versionchanged:: 5.5
748 Enables automated *conflict unload* mechanism
749
750 .. versionchanged:: 5.6
751 Enables automated *require via* mechanism
752
753
754 .. instopt:: --enable-quarantine-support
755
756 Generate code in module function definition to add support for the
757 environment variable quarantine mechanism (default=no)
758
759 This installation option defines the default value of the
760 :mconfig:`quarantine_support` configuration option which could be changed
761 after installation with the :subcmd:`config` sub-command.
762
763 .. only:: html
764
765 .. versionadded:: 4.1
766
767 .. versionchanged:: 5.0
768 Configuration option default set to ``no``
769
770 .. instopt:: --enable-require-via
771
772 Consider loaded module that enables a modulepath, a requirement of loaded
773 modules stored in this modulepath. (default=no)
774
775 This installation option defines the default value of the
776 :mconfig:`require_via` configuration option which could be changed after
777 installation with the :subcmd:`config` sub-command.
778
779 .. only:: html
780
781 .. versionadded:: 5.6
782
783 .. instopt:: --enable-set-binpath
784
785 Prepend binary directory defined by the :instopt:`--bindir` option to the
786 PATH environment variable in the shell initialization scripts. (default=yes)
787
788 .. only:: html
789
790 .. versionadded:: 4.0
791
792 .. instopt:: --enable-set-manpath
793
794 Prepend man page directory defined by the :instopt:`--mandir` option to the
795 MANPATH environment variable in the shell initialization scripts.
796 (default=yes)
797
798 .. only:: html
799
800 .. versionadded:: 4.0
801
802 .. instopt:: --enable-set-shell-startup
803
804 Set when module function is defined the shell startup file to ensure that the
805 module function is still defined in sub-shells. (default=no)
806
807 This installation option defines the default value of the
808 :mconfig:`set_shell_startup` configuration option which could be changed
809 after installation with the :subcmd:`config` sub-command.
810
811 .. only:: html
812
813 .. versionadded:: 4.3
814
815 .. versionchanged:: 5.0
816 Configuration option default set to ``no``
817
818 .. instopt:: --enable-silent-shell-debug-support
819
820 Generate code in module function definition to add support for silencing
821 shell debugging properties (default=no)
822
823 This installation option defines the default value of the
824 :mconfig:`silent_shell_debug` configuration option which could be changed
825 after installation with the :subcmd:`config` sub-command.
826
827 .. only:: html
828
829 .. versionadded:: 4.2
830
831 .. versionchanged:: 5.0
832 Configuration option default set to ``no``
833
834 .. instopt:: --enable-source-cache
835
836 Cache content of files evaluated through :manpage:`source(n)` Tcl command in
837 modulefile. When same file is sourced multiple times, cached content is
838 reused rather reading file again.
839
840 This installation option defines the default value of the
841 :mconfig:`source_cache` configuration option which could be changed
842 after installation with the :subcmd:`config` sub-command.
843
844 .. only:: html
845
846 .. versionadded:: 5.4
847
848 .. instopt:: --enable-spider-indepth
849
850 When performing an :subcmd:`spider` sub-command, include in search results
851 the matching modulefiles and directories and recursively the modulefiles and
852 directories contained in these matching directories when enabled or limit
853 search results to the matching modulefiles and directories found at the depth
854 level expressed by the search query if disabled. (default=yes)
855
856 This installation option defines the default value of the
857 :mconfig:`spider_indepth` configuration option which could be changed after
858 installation with the :subcmd:`config` sub-command.
859
860 .. only:: html
861
862 .. versionadded:: 5.6
863
864 .. instopt:: --enable-versioning
865
866 Append Modules version to installation prefix and deploy a ``versions``
867 modulepath shared between all versioning enabled Modules installation. A
868 modulefile corresponding to Modules version is added to the shared modulepath
869 and enables to switch from one Modules version to another. (default=no)
870
871 .. instopt:: --enable-unique-name-loaded
872
873 Only allow one module loaded per module name. A conflict is raised when
874 loading a module whose name or alternative names are shared by an already
875 loaded module. (default=no)
876
877 This installation option defines the default value of the
878 :mconfig:`unique_name_loaded` configuration option which could be changed
879 after installation with the :subcmd:`config` sub-command.
880
881 .. only:: html
882
883 .. versionadded:: 5.4
884
885 .. instopt:: --enable-vim-addons
886
887 Install the Vim addon files in the Vim addons directory defined with the
888 :instopt:`--vimdatadir` option. (default=yes)
889
890 .. only:: html
891
892 .. versionadded:: 4.3
893
894 .. instopt:: --enable-wa-277
895
896 Activate workaround for issue #277 related to Tcsh history mechanism which
897 does not cope well with default module alias definition. Note that enabling
898 this workaround solves Tcsh history issue but weakens shell evaluation of the
899 code produced by modulefiles. (default=no)
900
901 This installation option defines the default value of the :mconfig:`wa_277`
902 configuration option which could be changed after installation with the
903 :subcmd:`config` sub-command.
904
905 .. only:: html
906
907 .. versionadded:: 4.3
908
909 .. instopt:: --enable-windows-support
910
911 Install all required files for Windows platform (:command:`module`,
912 :command:`ml` and :command:`envml` command batch file and ``cmd.cmd``
913 initialization script). (default=no)
914
915 .. only:: html
916
917 .. versionadded:: 4.5
918
919
920 Optional Packages (the default for each option is displayed within
921 parenthesis, to disable an option replace ``with`` by ``without`` for
922 instance :instopt:`--without-modulepath<--with-modulepath>`):
923
924 .. instopt:: --with-abort-on-error=LIST
925
926 When evaluating multiple modulefiles, if one fails abort evaluation sequence
927 and withdraw already evaluated modulefiles for listed module sub-commands.
928 Sub-commands accepted in LIST are: :subcmd:`load`, :command:`ml`,
929 :subcmd:`mod-to-sh`, :subcmd:`purge`, :subcmd:`reload`, :subcmd:`switch`,
930 :subcmd:`switch_unload<switch>`, :subcmd:`try-load` and :subcmd:`unload`
931 (elements in LIST are separated by ``:``).
932 (default=\ ``ml:reload:switch_unload``)
933
934 This installation option defines the default value of the
935 :mconfig:`abort_on_error` configuration option which could be changed after
936 installation with the :subcmd:`config` sub-command.
937
938 .. only:: html
939
940 .. versionadded:: 5.4
941
942 .. instopt:: --with-avail-output=LIST
943
944 Specify the content to report on avail sub-command regular output in addition
945 to the available module names. Elements accepted in LIST are: ``modulepath``,
946 ``alias``, ``provided-alias``, ``dirwsym``, ``indesym``, ``sym``, ``tag``,
947 ``key``, ``hidden``, ``variant``, ``variantifspec`` and ``via`` (elements in
948 LIST are separated by ``:``). The order of the elements in LIST does not
949 matter. (default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec:key``)
950
951 This installation option defines the default value of the
952 :mconfig:`avail_output` configuration option which could be changed after
953 installation with the :subcmd:`config` sub-command.
954
955 .. only:: html
956
957 .. versionadded:: 4.7
958
959 .. versionchanged:: 5.3
960 Element ``variant`` added
961
962 .. versionchanged:: 5.3
963 Element ``variantifspec`` added and set by default
964
965 .. versionchanged:: 5.3.1
966 Element ``indesym`` added
967
968 .. versionchanged:: 5.6
969 Elements ``hidden``, ``provided-alias`` and ``via`` added
970
971 .. instopt:: --with-avail-terse-output=LIST
972
973 Specify the content to report on avail sub-command terse output in addition
974 addition to the available module names. Elements accepted in LIST are:
975 ``modulepath``, ``alias``, ``provided-alias``, ``dirwsym``, ``indesym``,
976 ``sym``, ``tag``, ``key``, ``hidden``, ``variant`` and ``variantifspec``
977 (elements in LIST are separated by ``:``). The order of the elements in LIST
978 does not matter.
979 (default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec``)
980
981 This installation option defines the default value of the
982 :mconfig:`avail_terse_output` configuration option which could be changed
983 after installation with the :subcmd:`config` sub-command.
984
985 .. only:: html
986
987 .. versionadded:: 4.7
988
989 .. versionchanged:: 5.3
990 Element ``variant`` added
991
992 .. versionchanged:: 5.3
993 Element ``variantifspec`` added and set by default
994
995 .. versionchanged:: 5.3.1
996 Element ``indesym`` added
997
998 .. versionchanged:: 5.6
999 Elements ``hidden`` and ``provided-alias`` added
1000
1001 .. instopt:: --with-bashcompletiondir=DIR
1002
1003 Directory for Bash completion scripts. When this option is not set Bash
1004 completion script for Modules is installed in the initialization script
1005 directory and is sourced from Modules Bash initialization script. (default=)
1006
1007 .. only:: html
1008
1009 .. versionadded:: 5.1
1010
1011 .. instopt:: --with-bin-search-path=PATHLIST
1012
1013 List of paths to look at when searching the location of tools required to
1014 build and configure Modules (default=\ ``/usr/bin:/bin:/usr/local/bin``)
1015
1016 .. only:: html
1017
1018 .. versionadded:: 4.2
1019
1020 .. instopt:: --with-dark-background-colors=SGRLIST
1021
1022 Default color set to apply if terminal background color is defined to
1023 ``dark``. SGRLIST follows the same syntax than used in ``LS_COLORS``. Each
1024 element in SGRLIST is an output item associated to a Select Graphic Rendition
1025 (SGR) code. Elements in SGRLIST are separated by ``:``. Output items are
1026 designated by keys.
1027
1028 Items able to be colorized are: highlighted element (``hi``), debug
1029 information (``db``), trace information (``tr``) tag separator (``se``);
1030 Error (``er``), warning (``wa``), module error (``me``) and info (``in``)
1031 message prefixes; Modulepath (``mp``), directory (``di``), module alias
1032 (``al``), module variant (``va``), module symbolic version (``sy``) and
1033 module ``default`` version (``de``).
1034
1035 :ref:`Module tags` can also be colorized. The key to set in the color palette
1036 to get a graphical rendering of a tag is the tag name or the tag abbreviation
1037 if one is defined for tag. The SGR code applied to a tag name is ignored if
1038 an abbreviation is set for this tag thus the SGR code should be defined for
1039 this abbreviation to get a graphical rendering. Each basic tag has by default
1040 a key set in the color palette, based on its abbreviated string: auto-loaded
1041 (``aL``), forbidden (``F``), hidden and hidden-loaded (``H``), loaded
1042 (``L``), nearly-forbidden (``nF``), sticky (``S``), super-sticky (``sS``),
1043 keep-loaded (``kL``) and warning (``W``).
1044
1045 For a complete SGR code reference, see
1046 https://en.wikipedia.org/wiki/ANSI_escape_code#Select_Graphic_Rendition_parameters.
1047 (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``)
1048
1049 This installation option defines the default value of the :mconfig:`colors`
1050 configuration option when :mconfig:`term_background` configuration option
1051 equals ``dark``. :mconfig:`colors` could be changed after installation with
1052 the :subcmd:`config` sub-command.
1053
1054 .. only:: html
1055
1056 .. versionadded:: 4.3
1057
1058 .. versionchanged:: 4.6
1059 Output item for trace information (``tr``) added
1060
1061 .. versionchanged:: 4.7
1062 Output items for module tags auto-loaded (``aL``), forbidden (``F``),
1063 hidden and hidden-loaded (``H``), loaded (``L``), nearly-forbidden
1064 (``nF``), sticky (``S``) and super-sticky (``sS``) added
1065
1066 .. versionchanged:: 4.8
1067 Output item for module variant (``va``) added
1068
1069 .. versionchanged:: 5.1
1070 Output item for keep-loaded module tag (``kL``) added
1071
1072 .. versionchanged:: 5.6
1073 Output item for warning module tag (``W``) added
1074
1075 .. versionchanged:: 5.6
1076 Default ``nearly-forbidden`` tag color changed
1077
1078 .. instopt:: --with-editor=BIN
1079
1080 Name or full path of default editor program to use to open modulefile through
1081 the :subcmd:`edit` sub-command. (default=\ ``vi``)
1082
1083 This installation option defines the default value of the :mconfig:`editor`
1084 configuration option which could be changed after installation with the
1085 :subcmd:`config` sub-command.
1086
1087 .. only:: html
1088
1089 .. versionadded:: 4.8
1090
1091 .. instopt:: --with-fishcompletiondir=DIR
1092
1093 Directory for Fish completion scripts. When this option is not set Fish
1094 completion script for Modules is installed in the initialization script
1095 directory and is sourced from Modules Fish initialization script. (default=)
1096
1097 .. only:: html
1098
1099 .. versionadded:: 5.1
1100
1101 .. instopt:: --with-icase=VALUE
1102
1103 Apply a case insensitive match to module specification on :subcmd:`avail`,
1104 :subcmd:`whatis` and :subcmd:`paths` sub-commands (when set to ``search``) or
1105 on all module sub-commands and modulefile Tcl commands for the module
1106 specification they receive as argument (when set to ``always``). Case
1107 insensitive match is disabled when this option is set to ``never``.
1108 (default=\ ``search``)
1109
1110 This installation option defines the default value of the :mconfig:`icase`
1111 configuration option which could be changed after installation with the
1112 :subcmd:`config` sub-command.
1113
1114 .. only:: html
1115
1116 .. versionadded:: 4.4
1117
1118 .. versionchanged:: 5.0
1119 Configuration option default set to ``search``
1120
1121 .. instopt:: --with-initconf-in=VALUE
1122
1123 Location where to install Modules initialization configuration files. Either
1124 ``initdir`` or ``etcdir`` (default=\ ``etcdir``)
1125
1126 .. only:: html
1127
1128 .. versionadded:: 4.1
1129
1130 .. versionchanged:: 5.0
1131 Configuration option default set to ``etcdir``
1132
1133 .. instopt:: --with-light-background-colors=SGRLIST
1134
1135 Default color set to apply if terminal background color is defined to
1136 ``light``. Expect the same syntax than described for
1137 :instopt:`--with-dark-background-colors`.
1138 (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``)
1139
1140 This installation option defines the default value of the :mconfig:`colors`
1141 configuration option when :mconfig:`term_background` configuration option
1142 equals ``light``. :mconfig:`colors` could be changed after installation with
1143 the :subcmd:`config` sub-command.
1144
1145 .. only:: html
1146
1147 .. versionadded:: 4.3
1148
1149 .. versionchanged:: 4.6
1150 Output item for trace information (``tr``) added
1151
1152 .. versionchanged:: 4.7
1153 Output items for module tags auto-loaded (``aL``), forbidden (``F``),
1154 hidden and hidden-loaded (``H``), loaded (``L``), nearly-forbidden
1155 (``nF``), sticky (``S``) and super-sticky (``sS``) added
1156
1157 .. versionchanged:: 4.8
1158 Output item for module variant (``va``) added
1159
1160 .. versionchanged:: 5.1
1161 Output item for keep-loaded module tag (``kL``) added
1162
1163 .. versionchanged:: 5.6
1164 Output item for warning module tag (``W``) added
1165
1166 .. versionchanged:: 5.6
1167 Default ``nearly-forbidden`` tag color changed
1168
1169 .. instopt:: --with-list-output=LIST
1170
1171 Specify the content to report on list sub-command regular output in addition
1172 to the loaded module names. Elements accepted in LIST are: ``header``,
1173 ``idx``, ``variant``, ``alias``, ``indesym``, ``sym``, ``tag``, ``hidden``
1174 and ``key`` (elements in LIST are separated by ``:``). The order of the
1175 elements in LIST does not matter. (default=\ ``header:idx:variant:sym:tag:key``)
1176
1177 This installation option defines the default value of the
1178 :mconfig:`list_output` configuration option which could be changed after
1179 installation with the :subcmd:`config` sub-command.
1180
1181 .. only:: html
1182
1183 .. versionadded:: 4.7
1184
1185 .. versionchanged:: 4.8
1186 Element ``variant`` added and set by default
1187
1188 .. versionchanged:: 5.4
1189 Elements ``alias`` and ``indesym`` added
1190
1191 .. versionchanged:: 5.6
1192 Element ``hidden`` added
1193
1194 .. instopt:: --with-list-terse-output=LIST
1195
1196 Specify the content to report on list sub-command terse output in addition
1197 to the loaded module names. Elements accepted in LIST are: ``header``,
1198 ``idx``, ``variant``, ``alias``, ``indesym``, ``sym``, ``tag``, ``hidden``
1199 and ``key`` (elements in LIST are separated by ``:``). The order of the
1200 elements in LIST does not matter. (default=\ ``header``)
1201
1202 This installation option defines the default value of the
1203 :mconfig:`list_terse_output` configuration option which could be changed
1204 after installation with the :subcmd:`config` sub-command.
1205
1206 .. only:: html
1207
1208 .. versionadded:: 4.7
1209
1210 .. versionchanged:: 4.8
1211 Element ``variant`` added
1212
1213 .. versionchanged:: 5.4
1214 Elements ``alias`` and ``indesym`` added
1215
1216 .. versionchanged:: 5.6
1217 Element ``hidden`` added
1218
1219 .. instopt:: --with-loadedmodules=MODLIST
1220
1221 Default modulefiles to load at Modules initialization time. Each modulefile
1222 in this list should be separated by ``:``. Defined value is registered in the
1223 :file:`initrc` configuration file or in the ``modulerc`` file if
1224 :instopt:`--with-initconf-in` is set to ``initdir``. (default=)
1225
1226 .. only:: html
1227
1228 .. versionadded:: 4.0
1229
1230 .. instopt:: --with-locked-configs=CONFIGLIST
1231
1232 Ignore environment variable superseding value for the listed configuration
1233 options. Accepted option names in CONFIGLIST are :mconfig:`extra_siteconfig`
1234 , :mconfig:`implicit_default`, :mconfig:`logged_events` and :mconfig:`logger`
1235 (each option name should be separated by whitespace character). (default=)
1236
1237 This installation option defines the default value of the
1238 :mconfig:`locked_configs` configuration option which cannot not be changed
1239 after installation.
1240
1241 .. only:: html
1242
1243 .. versionadded:: 4.3
1244
1245 .. versionchanged:: 5.5
1246 Configs ``logged_events`` and ``logger`` added
1247
1248 .. instopt:: --with-logged-events=EVENTLIST
1249
1250 Events to log. Accepted event names in EVENTLIST are ``auto_eval``,
1251 ``requested_eval`` and ``requested_cmd`` (each event name in this list should
1252 be separated by ``:``). The order of the elements in EVENTLIST does not
1253 matter. (default=)
1254
1255 This installation option defines the default value of the
1256 :mconfig:`logged_events` configuration option which cannot not be changed
1257 after installation.
1258
1259 .. only:: html
1260
1261 .. versionadded:: 5.5
1262
1263 .. instopt:: --with-logger=BIN
1264
1265 Name or full path of default logger program to use to log information (can be
1266 superseded at run-time by environment variable) (default=\ ``logger``)
1267
1268 This installation option and :instopt:`--with-logger-opts` define the default
1269 value of the :mconfig:`logger` configuration option which could be changed
1270 after installation with the :subcmd:`config` sub-command.
1271
1272 .. only:: html
1273
1274 .. versionadded:: 5.5
1275
1276 .. instopt:: --with-logger-opts=OPTLIST
1277
1278 Settings to apply to default logger program (default=\ ``-t modules``)
1279
1280 This installation option and :instopt:`--with-logger` define the default
1281 value of the :mconfig:`logger` configuration option which could be changed
1282 after installation with the :subcmd:`config` sub-command.
1283
1284 .. only:: html
1285
1286 .. versionadded:: 5.5
1287
1288 .. instopt:: --with-modulepath=PATHLIST
1289
1290 Default path list to setup as the default modulepaths. Each path in this list
1291 should be separated by ``:``. Defined value is registered in the
1292 :file:`initrc` or :file:`modulespath` configuration file, depending on the
1293 :instopt:`--enable-modulespath` option. These files are respectively called
1294 ``modulerc`` and ``.modulespath`` if :instopt:`--with-initconf-in` is set to
1295 ``initdir``. The path list value is read at initialization time to populate
1296 the MODULEPATH environment variable. By default, this modulepath is composed
1297 of the directory set for the system modulefiles
1298 (default=\ ``PREFIX/modulefiles`` or
1299 ``BASEPREFIX/$MODULE_VERSION/modulefiles`` if versioning installation mode
1300 enabled)
1301
1302 .. only:: html
1303
1304 .. versionadded:: 4.0
1305
1306 .. instopt:: --with-moduleshome
1307
1308 Location of the main Modules package file directory (default=\ ``PREFIX``)
1309
1310 This installation option defines the default value of the :mconfig:`home`
1311 configuration option which could be changed after installation with the
1312 :subcmd:`config` sub-command.
1313
1314 .. only:: html
1315
1316 .. versionadded:: 4.4
1317
1318 .. instopt:: --with-nearly-forbidden-days=VALUE
1319
1320 Define the number of days a module is considered nearly forbidden prior
1321 reaching its expiry date. VALUE should be an integer comprised between 0 and
1322 365. (default=\ ``14``)
1323
1324 This installation option defines the default value of the
1325 :mconfig:`nearly_forbidden_days` configuration option which could be changed
1326 after installation with the :subcmd:`config` sub-command.
1327
1328 .. only:: html
1329
1330 .. versionadded:: 4.6
1331
1332 .. instopt:: --with-pager=BIN
1333
1334 Name or full path of default pager program to use to paginate informational
1335 message output (can be superseded at run-time by environment variable)
1336 (default=\ ``less``)
1337
1338 This installation option and :instopt:`--with-pager-opts` define the default
1339 value of the :mconfig:`pager` configuration option which could be changed
1340 after installation with the :subcmd:`config` sub-command.
1341
1342 .. only:: html
1343
1344 .. versionadded:: 4.1
1345
1346 .. instopt:: --with-pager-opts=OPTLIST
1347
1348 Settings to apply to default pager program (default=\ ``-eFKRX``)
1349
1350 This installation option and :instopt:`--with-pager` define the default value
1351 of the :mconfig:`pager` configuration option which could be changed after
1352 installation with the :subcmd:`config` sub-command.
1353
1354 .. only:: html
1355
1356 .. versionadded:: 4.1
1357
1358 .. instopt:: --with-python=BIN
1359
1360 Name or full path of Python interpreter command to set as shebang for helper
1361 scripts. (default=\ ``python``)
1362
1363 .. only:: html
1364
1365 .. versionadded:: 4.5
1366
1367 .. instopt:: --with-quarantine-vars=<VARNAME[=VALUE] ...>
1368
1369 Environment variables to put in quarantine when running the module command to
1370 ensure it a sane execution environment (each variable should be separated by
1371 space character). A value can eventually be set to a quarantine variable
1372 instead of emptying it. (default=)
1373
1374 This installation option defines the default value of the
1375 :envvar:`MODULES_RUN_QUARANTINE` and :envvar:`MODULES_RUNENV_\<VAR\>`
1376 environment variables which could be changed after installation with the
1377 :subcmd:`config` sub-command on :mconfig:`run_quarantine` configuration
1378 option.
1379
1380 .. only:: html
1381
1382 .. versionadded:: 4.1
1383
1384 .. instopt:: --with-search-match=VALUE
1385
1386 When searching for a module with :subcmd:`avail` sub-command, match query
1387 string against module name start (``starts_with``) or any part of module name
1388 string (``contains``). (default=\ ``starts_with``)
1389
1390 This installation option defines the default value of the
1391 :mconfig:`search_match` configuration option which could be changed after
1392 installation with the :subcmd:`config` sub-command.
1393
1394 .. only:: html
1395
1396 .. versionadded:: 4.3
1397
1398 .. instopt:: --with-spider-output=LIST
1399
1400 Specify the content to report on spider sub-command regular output in
1401 addition to the available module names. Elements accepted in LIST are:
1402 ``modulepath``, ``alias``, ``provided-alias``, ``dirwsym``, ``indesym``,
1403 ``sym``, ``tag``, ``key``, ``hidden``, ``variant``, ``variantifspec`` and
1404 ``via`` (elements in LIST are separated by ``:``). The order of the elements
1405 in LIST does not matter.
1406 (default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec:via:key``)
1407
1408 This installation option defines the default value of the
1409 :mconfig:`spider_output` configuration option which could be changed after
1410 installation with the :subcmd:`config` sub-command.
1411
1412 .. only:: html
1413
1414 .. versionadded:: 5.6
1415
1416 .. instopt:: --with-spider-terse-output=LIST
1417
1418 Specify the content to report on spider sub-command terse output in addition
1419 addition to the available module names. Elements accepted in LIST are:
1420 ``modulepath``, ``alias``, ``provided-alias``, ``dirwsym``, ``indesym``,
1421 ``sym``, ``tag``, ``key``, ``hidden``, ``variant`` and ``variantifspec``
1422 (elements in LIST are separated by ``:``). The order of the elements in LIST
1423 does not matter.
1424 (default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec``)
1425
1426 This installation option defines the default value of the
1427 :mconfig:`spider_terse_output` configuration option which could be changed
1428 after installation with the :subcmd:`config` sub-command.
1429
1430 .. only:: html
1431
1432 .. versionadded:: 5.6
1433
1434 .. instopt:: --with-sticky-purge=VALUE
1435
1436 When unloading a sticky or super-sticky module during a module purge, raise
1437 an ``error`` or emit a ``warning`` message or be ``silent``.
1438 (default=\ ``error``)
1439
1440 This installation option defines the default value of the
1441 :mconfig:`sticky_purge` configuration option which could be changed after
1442 installation with the :subcmd:`config` sub-command.
1443
1444 .. only:: html
1445
1446 .. versionadded:: 5.4
1447
1448 .. instopt:: --with-tag-abbrev=ABBRVLIST
1449
1450 Define the abbreviation to use when reporting each module tag. Each element
1451 in ABBRVLIST is a tag name associated to an abbreviation string (elements in
1452 ABBRVLIST are separated by ``:``).
1453 (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``)
1454
1455 This installation option defines the default value of the
1456 :mconfig:`tag_abbrev` configuration option which could be changed after
1457 installation with the :subcmd:`config` sub-command.
1458
1459 .. only:: html
1460
1461 .. versionadded:: 4.7
1462
1463 .. versionchanged:: 5.1
1464 Abbreviation for ``keep-loaded`` tag added
1465
1466 .. versionchanged:: 5.6
1467 Abbreviation for ``warning`` tag added
1468
1469 .. instopt:: --with-tag-color-name=TAGLIST
1470
1471 Define the tags whose graphical rendering should be applied over their name
1472 instead of over the name of the module they are attached to. Each element in
1473 TAGLIST is a tag name or abbreviation (elements in TAGLIST are separated by
1474 ``:``). (default=)
1475
1476 This installation option defines the default value of the
1477 :mconfig:`tag_color_name` configuration option which could be changed after
1478 installation with the :subcmd:`config` sub-command.
1479
1480 .. only:: html
1481
1482 .. versionadded:: 4.7
1483
1484 .. instopt:: --with-tcl
1485
1486 Directory containing the Tcl configuration script ``tclConfig.sh``. Useful to
1487 compile Modules Tcl extension library if this file cannot be automatically
1488 found in default locations.
1489
1490 .. instopt:: --with-tclinclude
1491
1492 Directory containing the Tcl header files. Useful to compile Modules Tcl
1493 extension library if these headers cannot be automatically found in default
1494 locations.
1495
1496 .. instopt:: --with-tclsh=BIN
1497
1498 Name or full path of Tcl interpreter shell (default=\ ``tclsh``)
1499
1500 .. only:: html
1501
1502 .. versionadded:: 4.0
1503
1504 .. instopt:: --with-tcl-linter=BIN
1505
1506 Name or full path of program to use to lint modulefile through the
1507 :subcmd:`lint` sub-command. (default=\ ``nagelfar.tcl``)
1508
1509 This installation option and :instopt:`--with-tcl-linter-opts` define the
1510 default value of the :mconfig:`tcl_linter` configuration option which could
1511 be changed after installation with the :subcmd:`config` sub-command.
1512
1513 .. only:: html
1514
1515 .. versionadded:: 5.2
1516
1517 .. instopt:: --with-tcl-linter-opts=OPTLIST
1518
1519 Settings to apply to Tcl linter program (default=)
1520
1521 This installation option and :instopt:`--with-tcl-linter` define the default
1522 value of the :mconfig:`tcl_linter` configuration option which could be
1523 changed after installation with the :subcmd:`config` sub-command.
1524
1525 .. only:: html
1526
1527 .. versionadded:: 5.2
1528
1529 .. instopt:: --with-terminal-background=VALUE
1530
1531 The terminal background color that determines the color set to apply by
1532 default between the ``dark`` background colors or the ``light`` background
1533 colors (default=\ ``dark``)
1534
1535 This installation option defines the default value of the
1536 :mconfig:`term_background` configuration option which could be changed after
1537 installation with the :subcmd:`config` sub-command.
1538
1539 .. only:: html
1540
1541 .. versionadded:: 4.3
1542
1543 .. instopt:: --with-unload-match-order=VALUE
1544
1545 When unloading a module if multiple loaded modules match the request, unload
1546 module loaded first (``returnfirst``) or module loaded last (``returnlast``)
1547 (default=\ ``returnlast``)
1548
1549 This installation option defines the default value of the
1550 :mconfig:`unload_match_order` configuration option which could be changed
1551 after installation with the :subcmd:`config` sub-command.
1552
1553 .. only:: html
1554
1555 .. versionadded:: 4.3
1556
1557 .. instopt:: --with-variant-shortcut=SHORTCUTLIST
1558
1559 Define the shortcut characters that could be used to specify variant names.
1560 Each element in SHORTCUTLIST is a variant name associated to a shortcut
1561 character (e.g., ``foo=%``). Shortcuts cannot exceed a length of 1 character
1562 and cannot be alphanumeric characters ([A-Za-z0-9]) or characters with
1563 already a special meaning ([+~/@=-]). Elements in SHORTCUTLIST are separated
1564 by ``:``. (default=)
1565
1566 This installation option defines the default value of the
1567 :mconfig:`variant_shortcut` configuration option which could be changed after
1568 installation with the :subcmd:`config` sub-command.
1569
1570 .. only:: html
1571
1572 .. versionadded:: 4.8
1573
1574 .. instopt:: --with-verbosity=VALUE
1575
1576 Specify default message verbosity. accepted values are ``silent``,
1577 ``concise``, ``normal``, ``verbose``, ``verbose2``, ``trace``, ``debug`` and
1578 ``debug2``. (default=\ ``normal``)
1579
1580 This installation option defines the default value of the
1581 :mconfig:`verbosity` configuration option which could be changed after
1582 installation with the :subcmd:`config` sub-command.
1583
1584 .. only:: html
1585
1586 .. versionadded:: 4.3
1587
1588 .. instopt:: --with-zshcompletiondir=DIR
1589
1590 Directory for Zsh completion scripts. When this option is not set Zsh
1591 completion script for Modules is installed in the initialization script
1592 directory and :envvar:`FPATH` is set in Zsh initialization script to point to
1593 this location. (default=)
1594
1595 .. only:: html
1596
1597 .. versionadded:: 5.1
1598
1599
1600 Configuration options
1601 ---------------------
1602
1603 Options available through the :subcmd:`config` sub-command are described
1604 below. In addition to their default value, the related installation option,
1605 environment variable and command-line switch are listed for each configuration
1606 option. This table also describes if each configuration option needs to be set
1607 prior or during Modules initialization and if it can be modified after
1608 installation.
1609
1610 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1611 | Configuration option | Default value | Related installation option, environment | Set prior or | Cannot be |
1612 | | | variable and command-line switch | during init\ | altered |
1613 | | | | ialization | |
1614 +===================================+==============================================+==============================================+==============+===========+
1615 | :mconfig:`abort_on_error` | ``ml:reload:switch_unload`` | :instopt:`--with-abort-on-error`, | | |
1616 | | | :envvar:`MODULES_ABORT_ON_ERROR` | | |
1617 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1618 | :mconfig:`advanced_version_spec` | ``1`` | :instopt:`--enable-advanced-version-spec`, | | |
1619 | | | :envvar:`MODULES_ADVANCED_VERSION_SPEC` | | |
1620 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1621 | :mconfig:`auto_handling` | ``1`` | :instopt:`--enable-auto-handling`, | | |
1622 | | | :envvar:`MODULES_AUTO_HANDLING`, | | |
1623 | | | :option:`--auto`, :option:`--no-auto` | | |
1624 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1625 | :mconfig:`avail_indepth` | ``1`` | :instopt:`--enable-avail-indepth`, | | |
1626 | | | :envvar:`MODULES_AVAIL_INDEPTH`, | | |
1627 | | | :option:`--indepth`, :option:`--no-indepth` | | |
1628 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1629 | :mconfig:`avail_output` | modulepath:alias:dirwsym:sym:tag:\ | :instopt:`--with-avail-output`, | | |
1630 | | variantifspec:key | :envvar:`MODULES_AVAIL_OUTPUT`, | | |
1631 | | | :option:`--output` | | |
1632 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1633 | :mconfig:`avail_terse_output` | modulepath:alias:dirwsym:sym:tag:\ | :instopt:`--with-avail-terse-output`, | | |
1634 | | variantifspec | :envvar:`MODULES_AVAIL_TERSE_OUTPUT`, | | |
1635 | | | :option:`--output` | | |
1636 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1637 | :mconfig:`cache_buffer_bytes` | ``32768`` | :envvar:`MODULES_CACHE_BUFFER_BYTES` | | |
1638 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1639 | :mconfig:`cache_expiry_secs` | ``0`` | :envvar:`MODULES_CACHE_EXPIRY_SECS` | | |
1640 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1641 | :mconfig:`collection_pin_version` | ``0`` | :envvar:`MODULES_COLLECTION_PIN_VERSION` | | |
1642 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1643 | :mconfig:`collection_pin_tag` | ``0`` | :envvar:`MODULES_COLLECTION_PIN_TAG` | | |
1644 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1645 | :mconfig:`collection_target` | *Unset by default* | :envvar:`MODULES_COLLECTION_TARGET` | | |
1646 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1647 | :mconfig:`color` | ``auto`` | :instopt:`--enable-color`, | | |
1648 | | | :envvar:`MODULES_COLOR`, | | |
1649 | | | :option:`--color` | | |
1650 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1651 | :mconfig:`colors` | hi=1:db=2:tr=2:se=2:er=91:wa=93:\ | :instopt:`--with-dark-background-colors`, | | |
1652 | | me=95:in=94:mp=1;94:di=94:al=96:va=93:sy=95\ | :instopt:`--with-light-background-colors`, | | |
1653 | | :de=4:cm=92:aL=100:L=90;47:H=2:F=41:\ | :envvar:`MODULES_COLORS` | | |
1654 | | nF=31;43:S=46:sS=44:kL=30;48;5;109:W=30;43 | | | |
1655 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1656 | :mconfig:`conflict_unload` | ``0`` | :instopt:`--enable-conflict-unload`, | | |
1657 | | | :envvar:`MODULES_CONFLICT_UNLOAD` | | |
1658 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1659 | :mconfig:`contact` | ``root@localhost`` | :envvar:`MODULECONTACT` | | |
1660 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1661 | :mconfig:`extended_default` | ``1`` | :instopt:`--enable-extended-default`, | | |
1662 | | | :envvar:`MODULES_EXTENDED_DEFAULT` | | |
1663 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1664 | :mconfig:`editor` | ``vi`` | :instopt:`--with-editor`, | | |
1665 | | | :envvar:`MODULES_EDITOR` | | |
1666 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1667 | :mconfig:`extra_siteconfig` | *Unset by default* | :envvar:`MODULES_SITECONFIG` | | |
1668 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1669 | :mconfig:`hide_auto_loaded` | ``0`` | :envvar:`MODULES_HIDE_AUTO_LOADED` | | |
1670 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1671 | :mconfig:`home` | |file prefix| | :instopt:`--prefix`, | | |
1672 | | | :instopt:`--with-moduleshome`, | | |
1673 | | | :envvar:`MODULESHOME` | | |
1674 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1675 | :mconfig:`icase` | ``search`` | :instopt:`--with-icase`, | | |
1676 | | | :envvar:`MODULES_ICASE`, | | |
1677 | | | :option:`--icase` | | |
1678 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1679 | :mconfig:`ignore_cache` | ``0`` | :envvar:`MODULES_IGNORE_CACHE`, | | |
1680 | | | :option:`--ignore-cache` | | |
1681 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1682 | :mconfig:`ignore_user_rc` | ``0`` | :envvar:`MODULES_IGNORE_USER_RC`, | | |
1683 | | | :option:`--ignore-user-rc` | | |
1684 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1685 | :mconfig:`ignored_dirs` | ``CVS RCS SCCS .svn .git .SYNC .sos`` | | | X |
1686 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1687 | :mconfig:`implicit_default` | ``1`` | :instopt:`--enable-implicit-default`, | | |
1688 | | | :envvar:`MODULES_IMPLICIT_DEFAULT` | | |
1689 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1690 | :mconfig:`implicit_requirement` | ``1`` | :instopt:`--enable-implicit-requirement`, | | |
1691 | | | :envvar:`MODULES_IMPLICIT_REQUIREMENT` | | |
1692 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1693 | :mconfig:`list_output` | ``header:idx:variant:sym:tag:key`` | :instopt:`--with-list-output`, | | |
1694 | | | :envvar:`MODULES_LIST_OUTPUT`, | | |
1695 | | | :option:`--output` | | |
1696 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1697 | :mconfig:`list_terse_output` | ``header`` | :instopt:`--with-list-terse-output`, | | |
1698 | | | :envvar:`MODULES_LIST_TERSE_OUTPUT`, | | |
1699 | | | :option:`--output` | | |
1700 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1701 | :mconfig:`locked_configs` | *Empty by default* | :instopt:`--with-locked-configs` | | X |
1702 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1703 | :mconfig:`logged_events` | *Empty by default* | :instopt:`--with-logged-events`, | | |
1704 | | | :envvar:`MODULES_LOGGED_EVENTS` | | |
1705 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1706 | :mconfig:`logger` | ``logger -t modules`` | :instopt:`--with-logger`, | | |
1707 | | | :instopt:`--with-logger-opts`, | | |
1708 | | | :envvar:`MODULES_LOGGER` | | |
1709 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1710 | :mconfig:`mcookie_check` | ``always`` | :envvar:`MODULES_MCOOKIE_CHECK` | | |
1711 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1712 | :mconfig:`mcookie_version_check` | ``1`` | :instopt:`--enable-mcookie-version-check`, | | |
1713 | | | :envvar:`MODULES_MCOOKIE_VERSION_CHECK` | | |
1714 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1715 | :mconfig:`ml` | ``1`` | :instopt:`--enable-ml`, | X | |
1716 | | | :envvar:`MODULES_ML` | | |
1717 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1718 | :mconfig:`nearly_forbidden_days` | ``14`` | :instopt:`--with-nearly-forbidden-days`, | | |
1719 | | | :envvar:`MODULES_NEARLY_FORBIDDEN_DAYS` | | |
1720 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1721 | :mconfig:`pager` | ``less -eFKRX`` | :instopt:`--with-pager`, | | |
1722 | | | :instopt:`--with-pager-opts`, | | |
1723 | | | :envvar:`MODULES_PAGER`, | | |
1724 | | | :option:`--paginate`, :option:`--no-pager` | | |
1725 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1726 | :mconfig:`protected_envvars` | *Unset by default* | :envvar:`MODULES_PROTECTED_ENVVARS` | | |
1727 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1728 | :mconfig:`quarantine_support` | ``0`` | :instopt:`--enable-quarantine-support`, | X | |
1729 | | | :envvar:`MODULES_QUARANTINE_SUPPORT` | | |
1730 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1731 | :mconfig:`rcfile` | *Unset by default* | :envvar:`MODULERCFILE` | | |
1732 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1733 | :mconfig:`redirect_output` | ``1`` | :envvar:`MODULES_REDIRECT_OUTPUT`, | | |
1734 | | | :option:`--redirect`, | | |
1735 | | | :option:`--no-redirect` | | |
1736 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1737 | :mconfig:`require_via` | ``0`` | :instopt:`--enable-require-via`, | | |
1738 | | | :envvar:`MODULES_REQUIRE_VIA` | | |
1739 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1740 | :mconfig:`reset_target_state` | ``__init__`` | :envvar:`MODULES_RESET_TARGET_STATE`, | | |
1741 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1742 | :mconfig:`run_quarantine` | *Empty by default* | :instopt:`--with-quarantine-vars`, | | |
1743 | | | :envvar:`MODULES_RUN_QUARANTINE` | | |
1744 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1745 | :mconfig:`search_match` | ``starts_with`` | :instopt:`--with-search-match`, | | |
1746 | | | :envvar:`MODULES_SEARCH_MATCH`, | | |
1747 | | | :option:`--contains`, | | |
1748 | | | :option:`--starts-with` | | |
1749 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1750 | :mconfig:`set_shell_startup` | ``0`` | :instopt:`--enable-set-shell-startup`, | X | |
1751 | | | :envvar:`MODULES_SET_SHELL_STARTUP` | | |
1752 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1753 | :mconfig:`shells_with_ksh_fpath` | *Empty by default* | :envvar:`MODULES_SHELLS_WITH_KSH_FPATH` | X | |
1754 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1755 | :mconfig:`silent_shell_debug` | ``0`` | :instopt:`--enable-silent-shell-debug-\ | X | |
1756 | | | support`, | | |
1757 | | | :envvar:`MODULES_SILENT_SHELL_DEBUG` | | |
1758 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1759 | :mconfig:`siteconfig` | |file etcdir_siteconfig| | :instopt:`--prefix`, :instopt:`--etcdir` | | X |
1760 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1761 | :mconfig:`source_cache` | ``0`` | :instopt:`--enable-source-cache`, | | |
1762 | | | :envvar:`MODULES_SOURCE_CACHE` | | |
1763 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1764 | :mconfig:`spider_indepth` | ``1`` | :instopt:`--enable-spider-indepth`, | | |
1765 | | | :envvar:`MODULES_SPIDER_INDEPTH`, | | |
1766 | | | :option:`--indepth`, :option:`--no-indepth` | | |
1767 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1768 | :mconfig:`spider_output` | modulepath:alias:dirwsym:sym:tag:\ | :instopt:`--with-spider-output`, | | |
1769 | | variantifspec:via:key | :envvar:`MODULES_SPIDER_OUTPUT`, | | |
1770 | | | :option:`--output` | | |
1771 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1772 | :mconfig:`spider_terse_output` | modulepath:alias:dirwsym:sym:tag:\ | :instopt:`--with-spider-terse-output`, | | |
1773 | | variantifspec | :envvar:`MODULES_SPIDER_TERSE_OUTPUT`, | | |
1774 | | | :option:`--output` | | |
1775 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1776 | :mconfig:`sticky_purge` | ``error`` | :instopt:`--with-sticky-purge`, | | |
1777 | | | :envvar:`MODULES_STICKY_PURGE` | | |
1778 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1779 | :mconfig:`tag_abbrev` | auto-loaded=aL:loaded=L:hidden=H:\ | :instopt:`--with-tag-abbrev`, | | |
1780 | | hidden-loaded=H:forbidden=F:nearly-\ | :envvar:`MODULES_TAG_ABBREV` | | |
1781 | | forbidden=nF:sticky=S:super-sticky=sS:\ | | | |
1782 | | keep-loaded=kL:warning=W | | | |
1783 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1784 | :mconfig:`tag_color_name` | *Empty by default* | :instopt:`--with-tag-color-name`, | | |
1785 | | | :envvar:`MODULES_TAG_COLOR_NAME` | | |
1786 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1787 | :mconfig:`tcl_ext_lib` | |file libdir_tcl_ext_lib| | | | X |
1788 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1789 | :mconfig:`tcl_linter` | ``nagelfar.tcl`` | :instopt:`--with-tcl-linter`, | | |
1790 | | | :instopt:`--with-tcl-linter-opts`, | | |
1791 | | | :envvar:`MODULES_TCL_LINTER` | | |
1792 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1793 | :mconfig:`term_background` | ``dark`` | :instopt:`--with-terminal-background`, | | |
1794 | | | :envvar:`MODULES_TERM_BACKGROUND` | | |
1795 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1796 | :mconfig:`term_width` | ``0`` | :envvar:`MODULES_TERM_WIDTH`, | | |
1797 | | | :option:`--width` | | |
1798 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1799 | :mconfig:`unique_name_loaded` | ``0`` | :instopt:`--enable-unique-name-loaded`, | | |
1800 | | | :envvar:`MODULES_UNIQUE_NAME_LOADED` | | |
1801 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1802 | :mconfig:`unload_match_order` | ``returnlast`` | :instopt:`--with-unload-match-order`, | | |
1803 | | | :envvar:`MODULES_UNLOAD_MATCH_ORDER` | | |
1804 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1805 | :mconfig:`variant_shortcut` | *Empty by default* | :instopt:`--with-variant-shortcut`, | | |
1806 | | | :envvar:`MODULES_VARIANT_SHORTCUT` | | |
1807 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1808 | :mconfig:`verbosity` | ``normal`` | :instopt:`--with-verbosity`, | | |
1809 | | | :envvar:`MODULES_VERBOSITY`, | | |
1810 | | | :option:`--debug`, :option:`--silent`, | | |
1811 | | | :option:`--trace`, :option:`--verbose` | | |
1812 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1813 | :mconfig:`wa_277` | ``1`` | :instopt:`--enable-wa-277`, | X | |
1814 | | | :envvar:`MODULES_WA_277` | | |
1815 +-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+