package provides for the dynamic modification of a user’s environment via modulefiles.
| INSTALL.txt (modules-5.1.1.tar.bz2) | : | INSTALL.txt (modules-5.2.0.tar.bz2) |
|---|
| | |
| skipping to change at line 13 | | skipping to change at line 13 |
|---|
| | |
| This document is an overview of building and installing Modules on a | | This document is an overview of building and installing Modules on a |
| Unix system. | | Unix system. |
| | |
| Requirements | | Requirements |
| ============ | | ============ |
| | |
| Modules consists of one Tcl script so to run it from a user shell the | | 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 | | only requirement is to have a working version of "tclsh" (version 8.5 |
| or later) available on your system. "tclsh" is a part of Tcl | | or later) 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 "modulecmd.tcl" and | | repository, a build step is there to tailor the "modulecmd.tcl" and |
| the initialization scripts to the chosen installation configuration | | the initialization scripts to the chosen installation configuration |
| and create the documentation files. This build step requires the tools | | and create the documentation files. This build step requires the tools |
| to be found on your system: | | to be found on your system: |
| | |
| * bash | | * bash |
| | |
| * make | | * make |
| | |
| skipping to change at line 72 | | skipping to change at line 72 |
|---|
| | |
| If you want to install Modules from sources, tarballs from all | | If you want to install Modules from sources, tarballs from all |
| Modules' releases can be retrieved from one of the following link: | | Modules' releases can be retrieved from one of the following link: |
| | |
| * https://github.com/cea-hpc/modules/releases/ | | * https://github.com/cea-hpc/modules/releases/ |
| | |
| * https://sourceforge.net/projects/modules/files/Modules/ | | * https://sourceforge.net/projects/modules/files/Modules/ |
| | |
| For instance to download then unpack the last release of Modules: | | For instance to download then unpack the last release of Modules: |
| | |
|
| $ curl -LJO https://github.com/cea-hpc/modules/releases/download/v5.1.1/modul | | $ curl -LJO https://github.com/cea-hpc/modules/releases/download/v5.2.0/modul |
| es-5.1.1.tar.gz | | es-5.2.0.tar.gz |
| $ tar xfz modules-5.1.1.tar.gz | | $ tar xfz modules-5.2.0.tar.gz |
| | |
| Installation instructions | | Installation instructions |
| ========================= | | ========================= |
| | |
| The simplest way to build and install Modules is: | | The simplest way to build and install Modules is: |
| | |
| $ ./configure | | $ ./configure |
| $ make | | $ make |
| $ make install | | $ make install |
| | |
| | |
| skipping to change at line 328 | | skipping to change at line 328 |
|---|
| | |
| --mandir=DIR | | --mandir=DIR |
| | |
| Directory to host man pages ["DATAROOTDIR/man"] | | Directory to host man pages ["DATAROOTDIR/man"] |
| | |
| --modulefilesdir=DIR | | --modulefilesdir=DIR |
| | |
| Directory of main modulefiles also called system modulefiles | | Directory of main modulefiles also called system modulefiles |
| ["PREFIX/modulefiles"] | | ["PREFIX/modulefiles"] |
| | |
|
| | --nagelfardatadir=DIR |
| | |
| | Directory to host Nagelfar linter addon files |
| | ["DATAROOTDIR/nagelfar"] |
| | |
| --prefix=PREFIX | | --prefix=PREFIX |
| | |
| Installation root directory ["/usr/local/Modules"] | | Installation root directory ["/usr/local/Modules"] |
| | |
| --vimdatadir=DIR | | --vimdatadir=DIR |
| | |
| Directory to host Vim addon files ["DATAROOTDIR/vim/vimfiles"] | | Directory to host Vim addon files ["DATAROOTDIR/vim/vimfiles"] |
| | |
| Optional Features (the default for each option is displayed within | | Optional Features (the default for each option is displayed within |
| parenthesis, to disable an option replace "enable" by "disable" for | | parenthesis, to disable an option replace "enable" by "disable" for |
| | |
| skipping to change at line 485 | | skipping to change at line 490 |
|---|
| initconf-in" has been set to "initdir", in a ".modulespath" file | | initconf-in" has been set to "initdir", in a ".modulespath" file |
| within the configuration directory defined by the "--initdir" | | within the configuration directory defined by the "--initdir" |
| option rather than within the "modulerc" file. (default=no) | | option rather than within the "modulerc" file. (default=no) |
| | |
| --enable-multilib-support | | --enable-multilib-support |
| | |
| Support multilib systems by looking in modulecmd.tcl at an | | Support multilib systems by looking in modulecmd.tcl at an |
| alternative location where to find the Modules Tcl extension | | alternative location where to find the Modules Tcl extension |
| library depending on current machine architecture. (default=no) | | library depending on current machine architecture. (default=no) |
| | |
|
| | --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 "--nagelfardatadir" option. |
| | (default=yes) |
| | |
| --enable-new-features | | --enable-new-features |
| | |
| Enable all new features that are disabled by default due to the | | Enable all new features that are disabled by default due to the |
| substantial behavior changes they imply on Modules 5. This option | | substantial behavior changes they imply on Modules 5. This option |
| does not enable other configuration option currently. (default=no) | | does not enable other configuration option currently. (default=no) |
| | |
| --enable-quarantine-support | | --enable-quarantine-support |
| | |
| Generate code in module function definition to add support for the | | Generate code in module function definition to add support for the |
| environment variable quarantine mechanism (default=no) | | environment variable quarantine mechanism (default=no) |
| | |
| skipping to change at line 771 | | skipping to change at line 783 |
|---|
| This installation option defines the default value of the | | This installation option defines the default value of the |
| "nearly_forbidden_days" configuration option which could be changed | | "nearly_forbidden_days" configuration option which could be changed |
| after installation with the "config" sub-command. | | after installation with the "config" sub-command. |
| | |
| --with-pager=BIN | | --with-pager=BIN |
| | |
| Name or full path of default pager program to use to paginate | | Name or full path of default pager program to use to paginate |
| informational message output (can be superseded at run-time by | | informational message output (can be superseded at run-time by |
| environment variable) (default="less") | | environment variable) (default="less") |
| | |
|
| This installation option and "--with-pager-opt" define the default | | This installation option and "--with-pager-opts" define the default |
| value of the "pager" configuration option which could be changed | | value of the "pager" configuration option which could be changed |
| after installation with the "config" sub-command. | | after installation with the "config" sub-command. |
| | |
| --with-pager-opts=OPTLIST | | --with-pager-opts=OPTLIST |
| | |
| Settings to apply to default pager program (default="-eFKRX") | | Settings to apply to default pager program (default="-eFKRX") |
| | |
| This installation option and "--with-pager" define the default | | This installation option and "--with-pager" define the default |
| value of the "pager" configuration option which could be changed | | value of the "pager" configuration option which could be changed |
| after installation with the "config" sub-command. | | after installation with the "config" sub-command. |
| | |
| skipping to change at line 849 | | skipping to change at line 861 |
|---|
| --with-tclinclude | | --with-tclinclude |
| | |
| Directory containing the Tcl header files. Useful to compile | | Directory containing the Tcl header files. Useful to compile |
| Modules Tcl extension library if these headers cannot be | | Modules Tcl extension library if these headers cannot be |
| automatically found in default locations. | | automatically found in default locations. |
| | |
| --with-tclsh=BIN | | --with-tclsh=BIN |
| | |
| Name or full path of Tcl interpreter shell (default="tclsh") | | Name or full path of Tcl interpreter shell (default="tclsh") |
| | |
|
| | --with-tcl-linter=BIN |
| | |
| | Name or full path of program to use to lint modulefile through the |
| | "lint" sub-command. (default="nagelfar.tcl") |
| | |
| | This installation option and "--with-tcl-linter-opts" define the |
| | default value of the "tcl_linter" configuration option which could |
| | be changed after installation with the "config" sub-command. |
| | |
| | --with-tcl-linter-opts=OPTLIST |
| | |
| | Settings to apply to Tcl linter program (default=) |
| | |
| | This installation option and "--with-tcl-linter" define the default |
| | value of the "tcl_linter" configuration option which could be |
| | changed after installation with the "config" sub-command. |
| | |
| --with-terminal-background=VALUE | | --with-terminal-background=VALUE |
| | |
| The terminal background color that determines the color set to | | The terminal background color that determines the color set to |
| apply by default between the "dark" background colors or the | | apply by default between the "dark" background colors or the |
| "light" background colors (default="dark") | | "light" background colors (default="dark") |
| | |
| This installation option defines the default value of the | | This installation option defines the default value of the |
| "term_background" configuration option which could be changed after | | "term_background" configuration option which could be changed after |
| installation with the "config" sub-command. | | installation with the "config" sub-command. |
| | |
| | |
| skipping to change at line 988 | | skipping to change at line 1017 |
|---|
| | |
| "MODULES_MCOOKIE_VERSION_CHECK" | |
| | | | |
| "MODULES_MCOOKIE_VERSION_CHECK" | |
| |
| +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ | | +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ |
| | "ml" | "1"
| "--enable-ml", "MODULES_ML" | X |
| | | | "ml" | "1"
| "--enable-ml", "MODULES_ML" | X |
| |
| +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ | | +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ |
| | "nearly_forbidden_days" | "14"
| "--with-nearly-forbidden-days", | |
| | | | "nearly_forbidden_days" | "14"
| "--with-nearly-forbidden-days", | |
| |
| | |
| "MODULES_NEARLY_FORBIDDEN_DAYS" | |
| | | | |
| "MODULES_NEARLY_FORBIDDEN_DAYS" | |
| |
| +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ | | +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ |
| | "pager" | "less -eFKRX"
| "--with-pager", "--with-pager-opts", | |
| | | | "pager" | "less -eFKRX"
| "--with-pager", "--with-pager-opts", | |
| |
| | |
| "MODULES_PAGER", "--paginate", " --no-pager" | |
| | | | |
| "MODULES_PAGER", "--paginate", " --no-pager" | |
| |
| +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ | | +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ |
|
| | | "protected_envvars" | *Unset by default* |
| | | "MODULES_PROTECTED_ENVVARS" | | |
| | | |
| | +-------------------------------------+----------------------------------------- |
| | -------+------------------------------------------------+----------------+------ |
| | -------+ |
| | "quarantine_support" | "0"
| "--enable-quarantine-support", | X |
| | | | "quarantine_support" | "0"
| "--enable-quarantine-support", | X |
| |
| | |
| "MODULES_QUARANTINE_SUPPORT" | |
| | | | |
| "MODULES_QUARANTINE_SUPPORT" | |
| |
| +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ | | +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ |
| | "rcfile" | *Unset by default*
| "MODULERCFILE" | |
| | | | "rcfile" | *Unset by default*
| "MODULERCFILE" | |
| |
| +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ | | +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ |
| | "redirect_output" | "1"
| "MODULES_REDIRECT_OUTPUT", "--redirect", "-- | |
| | | | "redirect_output" | "1"
| "MODULES_REDIRECT_OUTPUT", "--redirect", "-- | |
| |
| | |
| no-redirect" | |
| | | | |
| no-redirect" | |
| |
| +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ | | +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ |
| | "run_quarantine" | *Empty by default*
| "--with-quarantine-vars", | |
| | | | "run_quarantine" | *Empty by default*
| "--with-quarantine-vars", | |
| |
| | |
| "MODULES_RUN_QUARANTINE" | |
| | | | |
| "MODULES_RUN_QUARANTINE" | |
| |
| | |
| skipping to change at line 1022 | | skipping to change at line 1053 |
|---|
| | "tag_abbrev" | auto-loaded=aL:loaded=L:hidden=H:hidden-
| "--with-tag-abbrev", "MODULES_TAG_ABBREV" | |
| | | | "tag_abbrev" | auto-loaded=aL:loaded=L:hidden=H:hidden-
| "--with-tag-abbrev", "MODULES_TAG_ABBREV" | |
| |
| | | loaded=H:forbidden=F:nearly-
| | |
| | | | | loaded=H:forbidden=F:nearly-
| | |
| |
| | | forbidden=nF:sticky=S:super-sticky=sS:ke
ep- | | |
| | | | | forbidden=nF:sticky=S:super-sticky=sS:ke
ep- | | |
| |
| | | loaded=kL
| | |
| | | | | loaded=kL
| | |
| |
| +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ | | +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ |
| | "tag_color_name" | *Empty by default*
| "--with-tag-color-name", | |
| | | | "tag_color_name" | *Empty by default*
| "--with-tag-color-name", | |
| |
| | |
| "MODULES_TAG_COLOR_NAME" | |
| | | | |
| "MODULES_TAG_COLOR_NAME" | |
| |
| +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ | | +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ |
| | "tcl_ext_lib" | "/usr/share/Modules/lib64/libtclenvmodul
es.so" | | | X
| | | | "tcl_ext_lib" | "/usr/share/Modules/lib64/libtclenvmodul
es.so" | | | X
| |
| +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ | | +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ |
|
| | | "tcl_linter" | "nagelfar.tcl" |
| | | "--with-tcl-linter", "--with-tcl-linter-opts", | | |
| | | |
| | | | |
| | | "MODULES_TCL_LINTER" | | |
| | | |
| | +-------------------------------------+----------------------------------------- |
| | -------+------------------------------------------------+----------------+------ |
| | -------+ |
| | "term_background" | "dark"
| "--with-terminal-background", | |
| | | | "term_background" | "dark"
| "--with-terminal-background", | |
| |
| | |
| "MODULES_TERM_BACKGROUND" | |
| | | | |
| "MODULES_TERM_BACKGROUND" | |
| |
| +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ | | +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ |
| | "term_width" | "0"
| "MODULES_TERM_WIDTH", "--width" | |
| | | | "term_width" | "0"
| "MODULES_TERM_WIDTH", "--width" | |
| |
| +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ | | +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ |
| | "unload_match_order" | "returnlast"
| "--with-unload-match-order", | |
| | | | "unload_match_order" | "returnlast"
| "--with-unload-match-order", | |
| |
| | |
| "MODULES_UNLOAD_MATCH_ORDER" | |
| | | | |
| "MODULES_UNLOAD_MATCH_ORDER" | |
| |
| +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ | | +-------------------------------------+-----------------------------------------
-------+------------------------------------------------+----------------+------
-------+ |
| | "variant_shortcut" | *Empty by default*
| "--with-variant-shortcut", | |
| | | | "variant_shortcut" | *Empty by default*
| "--with-variant-shortcut", | |
| |
| | |
| "MODULES_VARIANT_SHORTCUT" | |
| | | | |
| "MODULES_VARIANT_SHORTCUT" | |
| |
| | | |
| End of changes. 8 change blocks. |
|---|
| 5 lines changed or deleted | | 49 lines changed or added |
|---|
"Fossies" - the Fresh Open Source Software Archive 