package provides for the dynamic modification of a user’s environment via modulefiles.
| INSTALL.rst (modules-5.1.1.tar.bz2) | : | INSTALL.rst (modules-5.2.0.tar.bz2) |
|---|
| | |
| skipping to change at line 15 | | skipping to change at line 15 |
|---|
| | |
| This document is an overview of building and installing Modules on a Unix | | This document is an overview of building and installing Modules on a Unix |
| system. | | system. |
| | |
| Requirements | | Requirements |
| ------------ | | ------------ |
| | |
| Modules consists of one Tcl script so to run it from a user shell the only | | Modules consists of one Tcl script so to run it from a user shell the only |
| requirement is to have a working version of ``tclsh`` (version 8.5 or later) | | requirement is to have a working version of ``tclsh`` (version 8.5 or later) |
| available on your system. ``tclsh`` is a part of Tcl | | available on your system. ``tclsh`` is a part of Tcl |
|
| (http://www.tcl.tk/software/tcltk/). | | (http://www.tcl-lang.org/software/tcltk/). |
| | |
| To install Modules from a distribution tarball or a clone of the git | | To install Modules from a distribution tarball or a clone of the git |
| repository, a build step is there to tailor the :file:`modulecmd.tcl` and the | | repository, a build step is there to tailor the :file:`modulecmd.tcl` and the |
| initialization scripts to the chosen installation configuration and create the | | initialization scripts to the chosen installation configuration and create the |
| documentation files. This build step requires the tools to be found on your | | documentation files. This build step requires the tools to be found on your |
| system: | | system: |
| | |
| * bash | | * bash |
| * make | | * make |
| * sed | | * sed |
| | |
| skipping to change at line 325 | | skipping to change at line 325 |
|---|
| | |
| .. instopt:: --modulefilesdir=DIR | | .. instopt:: --modulefilesdir=DIR |
| | |
| Directory of main modulefiles also called system modulefiles | | Directory of main modulefiles also called system modulefiles |
| [``PREFIX/modulefiles``] | | [``PREFIX/modulefiles``] |
| | |
| .. only:: html | | .. only:: html |
| | |
| .. versionadded:: 4.0 | | .. versionadded:: 4.0 |
| | |
|
| | .. instopt:: --nagelfardatadir=DIR |
| | |
| | Directory to host Nagelfar linter addon files [``DATAROOTDIR/nagelfar``] |
| | |
| | .. only:: html |
| | |
| | .. versionadded:: 5.2 |
| | |
| .. instopt:: --prefix=PREFIX | | .. instopt:: --prefix=PREFIX |
| | |
| Installation root directory [``/usr/local/Modules``] | | Installation root directory [``/usr/local/Modules``] |
| | |
| .. instopt:: --vimdatadir=DIR | | .. instopt:: --vimdatadir=DIR |
| | |
| Directory to host Vim addon files [``DATAROOTDIR/vim/vimfiles``] | | Directory to host Vim addon files [``DATAROOTDIR/vim/vimfiles``] |
| | |
| .. only:: html | | .. only:: html |
| | |
| | |
| skipping to change at line 560 | | skipping to change at line 568 |
|---|
| .. instopt:: --enable-multilib-support | | .. instopt:: --enable-multilib-support |
| | |
| Support multilib systems by looking in modulecmd.tcl at an alternative | | Support multilib systems by looking in modulecmd.tcl at an alternative |
| location where to find the Modules Tcl extension library depending on current | | location where to find the Modules Tcl extension library depending on current |
| machine architecture. (default=no) | | machine architecture. (default=no) |
| | |
| .. only:: html | | .. only:: html |
| | |
| .. versionadded:: 4.6 | | .. versionadded:: 4.6 |
| | |
|
| | .. instopt:: --enable-nagelfar-addons |
| | |
| | Install the Nagelfar linter addon files (syntax databases and plugins to lint |
| | modulefiles and modulercs) in the Nagelfar addons directory defined with the |
| | :instopt:`--nagelfardatadir` option. (default=yes) |
| | |
| | .. only:: html |
| | |
| | .. versionadded:: 5.2 |
| | |
| .. instopt:: --enable-new-features | | .. instopt:: --enable-new-features |
| | |
| Enable all new features that are disabled by default due to the substantial | | Enable all new features that are disabled by default due to the substantial |
| behavior changes they imply on Modules 5. This option does not enable other | | behavior changes they imply on Modules 5. This option does not enable other |
| configuration option currently. (default=no) | | configuration option currently. (default=no) |
| | |
| .. only:: html | | .. only:: html |
| | |
| .. versionadded:: 4.7 | | .. versionadded:: 4.7 |
| | |
| | |
| skipping to change at line 992 | | skipping to change at line 1010 |
|---|
| .. only:: html | | .. only:: html |
| | |
| .. versionadded:: 4.6 | | .. versionadded:: 4.6 |
| | |
| .. instopt:: --with-pager=BIN | | .. instopt:: --with-pager=BIN |
| | |
| Name or full path of default pager program to use to paginate informational | | Name or full path of default pager program to use to paginate informational |
| message output (can be superseded at run-time by environment variable) | | message output (can be superseded at run-time by environment variable) |
| (default=\ ``less``) | | (default=\ ``less``) |
| | |
|
| This installation option and :instopt:`--with-pager-opt` define the default | | This installation option and :instopt:`--with-pager-opts` define the default |
| value of the :mconfig:`pager` configuration option which could be changed | | value of the :mconfig:`pager` configuration option which could be changed |
| after installation with the :subcmd:`config` sub-command. | | after installation with the :subcmd:`config` sub-command. |
| | |
| .. only:: html | | .. only:: html |
| | |
| .. versionadded:: 4.1 | | .. versionadded:: 4.1 |
| | |
| .. instopt:: --with-pager-opts=OPTLIST | | .. instopt:: --with-pager-opts=OPTLIST |
| | |
| Settings to apply to default pager program (default=\ ``-eFKRX``) | | Settings to apply to default pager program (default=\ ``-eFKRX``) |
| | |
| skipping to change at line 1105 | | skipping to change at line 1123 |
|---|
| locations. | | locations. |
| | |
| .. instopt:: --with-tclsh=BIN | | .. instopt:: --with-tclsh=BIN |
| | |
| Name or full path of Tcl interpreter shell (default=\ ``tclsh``) | | Name or full path of Tcl interpreter shell (default=\ ``tclsh``) |
| | |
| .. only:: html | | .. only:: html |
| | |
| .. versionadded:: 4.0 | | .. versionadded:: 4.0 |
| | |
|
| | .. instopt:: --with-tcl-linter=BIN |
| | |
| | Name or full path of program to use to lint modulefile through the |
| | :subcmd:`lint` sub-command. (default=\ ``nagelfar.tcl``) |
| | |
| | This installation option and :instopt:`--with-tcl-linter-opts` define the |
| | default value of the :mconfig:`tcl_linter` configuration option which could |
| | be changed after installation with the :subcmd:`config` sub-command. |
| | |
| | .. only:: html |
| | |
| | .. versionadded:: 5.2 |
| | |
| | .. instopt:: --with-tcl-linter-opts=OPTLIST |
| | |
| | Settings to apply to Tcl linter program (default=) |
| | |
| | This installation option and :instopt:`--with-tcl-linter` define the default |
| | value of the :mconfig:`tcl_linter` configuration option which could be |
| | changed after installation with the :subcmd:`config` sub-command. |
| | |
| | .. only:: html |
| | |
| | .. versionadded:: 5.2 |
| | |
| .. instopt:: --with-terminal-background=VALUE | | .. instopt:: --with-terminal-background=VALUE |
| | |
| The terminal background color that determines the color set to apply by | | The terminal background color that determines the color set to apply by |
| default between the ``dark`` background colors or the ``light`` background | | default between the ``dark`` background colors or the ``light`` background |
| colors (default=\ ``dark``) | | colors (default=\ ``dark``) |
| | |
| This installation option defines the default value of the | | This installation option defines the default value of the |
| :mconfig:`term_background` configuration option which could be changed after | | :mconfig:`term_background` configuration option which could be changed after |
| installation with the :subcmd:`config` sub-command. | | installation with the :subcmd:`config` sub-command. |
| | |
| | |
| skipping to change at line 1276 | | skipping to change at line 1319 |
|---|
| | |
| :envvar:`MODULES_ML` | | | | | | |
| :envvar:`MODULES_ML` | | | |
| +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ | | +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ |
| | :mconfig:`nearly_forbidden_days` | ``14``
| :instopt:`--with-nearly-forbidden-days`, | | | | | | :mconfig:`nearly_forbidden_days` | ``14``
| :instopt:`--with-nearly-forbidden-days`, | | | |
| | |
| :envvar:`MODULES_NEARLY_FORBIDDEN_DAYS` | | | | | | |
| :envvar:`MODULES_NEARLY_FORBIDDEN_DAYS` | | | |
| +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ | | +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ |
| | :mconfig:`pager` | ``less -eFKRX``
| :instopt:`--with-pager`, | | | | | | :mconfig:`pager` | ``less -eFKRX``
| :instopt:`--with-pager`, | | | |
| | |
| :instopt:`--with-pager-opts`, | | | | | | |
| :instopt:`--with-pager-opts`, | | | |
| | |
| :envvar:`MODULES_PAGER`, | | | | | | |
| :envvar:`MODULES_PAGER`, | | | |
| | |
| :option:`--paginate`, :option:`--no-pager` | | | | | | |
| :option:`--paginate`, :option:`--no-pager` | | | |
| +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ | | +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ |
|
| | | :mconfig:`protected_envvars` | *Unset by default* |
| | | :envvar:`MODULES_PROTECTED_ENVVARS` | | | |
| | +-----------------------------------+------------------------------------------- |
| | ---+----------------------------------------------+--------------+-----------+ |
| | :mconfig:`quarantine_support` | ``0``
| :instopt:`--enable-quarantine-support`, | X | | | | | :mconfig:`quarantine_support` | ``0``
| :instopt:`--enable-quarantine-support`, | X | | |
| | |
| :envvar:`MODULES_QUARANTINE_SUPPORT` | | | | | | |
| :envvar:`MODULES_QUARANTINE_SUPPORT` | | | |
| +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ | | +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ |
| | :mconfig:`rcfile` | *Unset by default*
| :envvar:`MODULERCFILE` | | | | | | :mconfig:`rcfile` | *Unset by default*
| :envvar:`MODULERCFILE` | | | |
| +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ | | +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ |
| | :mconfig:`redirect_output` | ``1``
| :envvar:`MODULES_REDIRECT_OUTPUT`, | | | | | | :mconfig:`redirect_output` | ``1``
| :envvar:`MODULES_REDIRECT_OUTPUT`, | | | |
| | |
| :option:`--redirect`, | | | | | | |
| :option:`--redirect`, | | | |
| | |
| :option:`--no-redirect` | | | | | | |
| :option:`--no-redirect` | | | |
| +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ | | +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ |
| | :mconfig:`run_quarantine` | *Empty by default*
| :instopt:`--with-quarantine-vars`, | | | | | | :mconfig:`run_quarantine` | *Empty by default*
| :instopt:`--with-quarantine-vars`, | | | |
| | |
| skipping to change at line 1314 | | skipping to change at line 1359 |
|---|
| | :mconfig:`tag_abbrev` | auto-loaded=aL:loaded=L:hidden=H:\
| :instopt:`--with-tag-abbrev`, | | | | | | :mconfig:`tag_abbrev` | auto-loaded=aL:loaded=L:hidden=H:\
| :instopt:`--with-tag-abbrev`, | | | |
| | | hidden-loaded=H:forbidden=F:nearly-\
| :envvar:`MODULES_TAG_ABBREV` | | | | | | | hidden-loaded=H:forbidden=F:nearly-\
| :envvar:`MODULES_TAG_ABBREV` | | | |
| | | forbidden=nF:sticky=S:super-sticky=sS:\
| | | | | | | | forbidden=nF:sticky=S:super-sticky=sS:\
| | | | |
| | | keep-loaded=kL
| | | | | | | | keep-loaded=kL
| | | | |
| +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ | | +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ |
| | :mconfig:`tag_color_name` | *Empty by default*
| :instopt:`--with-tag-color-name`, | | | | | | :mconfig:`tag_color_name` | *Empty by default*
| :instopt:`--with-tag-color-name`, | | | |
| | |
| :envvar:`MODULES_TAG_COLOR_NAME` | | | | | | |
| :envvar:`MODULES_TAG_COLOR_NAME` | | | |
| +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ | | +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ |
| | :mconfig:`tcl_ext_lib` | |file libdir_tcl_ext_lib|
| | | X | | | | :mconfig:`tcl_ext_lib` | |file libdir_tcl_ext_lib|
| | | X | |
| +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ | | +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ |
|
| | | :mconfig:`tcl_linter` | ``nagelfar.tcl`` |
| | | :instopt:`--with-tcl-linter`, | | | |
| | | | |
| | | :instopt:`--with-tcl-linter-opts`, | | | |
| | | | |
| | | :envvar:`MODULES_TCL_LINTER` | | | |
| | +-----------------------------------+------------------------------------------- |
| | ---+----------------------------------------------+--------------+-----------+ |
| | :mconfig:`term_background` | ``dark``
| :instopt:`--with-terminal-background`, | | | | | | :mconfig:`term_background` | ``dark``
| :instopt:`--with-terminal-background`, | | | |
| | |
| :envvar:`MODULES_TERM_BACKGROUND` | | | | | | |
| :envvar:`MODULES_TERM_BACKGROUND` | | | |
| +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ | | +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ |
| | :mconfig:`term_width` | ``0``
| :envvar:`MODULES_TERM_WIDTH`, | | | | | | :mconfig:`term_width` | ``0``
| :envvar:`MODULES_TERM_WIDTH`, | | | |
| | |
| :option:`--width` | | | | | | |
| :option:`--width` | | | |
| +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ | | +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ |
| | :mconfig:`unload_match_order` | ``returnlast``
| :instopt:`--with-unload-match-order`, | | | | | | :mconfig:`unload_match_order` | ``returnlast``
| :instopt:`--with-unload-match-order`, | | | |
| | |
| :envvar:`MODULES_UNLOAD_MATCH_ORDER` | | | | | | |
| :envvar:`MODULES_UNLOAD_MATCH_ORDER` | | | |
| +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ | | +-----------------------------------+-------------------------------------------
---+----------------------------------------------+--------------+-----------+ |
| | :mconfig:`variant_shortcut` | *Empty by default*
| :instopt:`--with-variant-shortcut`, | | | | | | :mconfig:`variant_shortcut` | *Empty by default*
| :instopt:`--with-variant-shortcut`, | | | |
| | | |
| End of changes. 7 change blocks. |
|---|
| 2 lines changed or deleted | | 57 lines changed or added |
|---|
"Fossies" - the Fresh Open Source Software Archive 