.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Required to disable full justification in groff 1.23.0. .if n .ds AD l .\" ======================================================================== .\" .IX Title "MODULE 1" .TH MODULE 1 2026-08-03 "perl v5.42.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh module .SH SYNOPSIS .IX Header "SYNOPSIS" module [options] sub\-command [args ...] .SH DESCRIPTION .IX Header "DESCRIPTION" This tool allow a user to control their environment by load and unloading modulefiles. See https://lmod.readthedocs.org for more details. .SH OPTIONS .IX Header "OPTIONS" .IP "\fI\-h \-? \-H \-\-help\fR" 4 .IX Item "-h -? -H --help" This help message .IP "\fI\-s availStyle \-\-style=availStyle\fR" 4 .IX Item "-s availStyle --style=availStyle" Site controlled avail style: system (default: system) .IP \fI\-\-regression_testing\fR 4 .IX Item "--regression_testing" Lmod regression testing .IP "\fI\-b \-\-brief\fR" 4 .IX Item "-b --brief" brief listing with only user specified modules .IP \fI\-D\fR 4 .IX Item "-D" Program tracing written to stderr .IP \fI\-\-debug=dbglvl\fR 4 .IX Item "--debug=dbglvl" Program tracing written to stderr (where dbglvl is a number 1,2,3) .IP \fI\-\-pin_versions\fR 4 .IX Item "--pin_versions" When doing a restore use specified version, do not follow defaults .IP "\fI\-d \-\-default\fR" 4 .IX Item "-d --default" List default modules only when used with avail .IP "\fI\-q \-\-quiet\fR" 4 .IX Item "-q --quiet" Do not print out warnings .IP \fI\-\-expert\fR 4 .IX Item "--expert" Expert mode .IP "\fI\-t \-\-terse\fR" 4 .IX Item "-t --terse" Write out in machine readable format for commands: list, avail, spider, savelist .IP \fI\-\-initial_load\fR 4 .IX Item "--initial_load" loading Lmod for first time in a user shell .IP \fI\-\-latest\fR 4 .IX Item "--latest" Load latest (ignore default) .IP "\fI\-I \-\-ignore_cache\fR" 4 .IX Item "-I --ignore_cache" Treat the cache file(s) as out\-of\-date .IP \fI\-\-novice\fR 4 .IX Item "--novice" Turn off expert and quiet flag .IP \fI\-\-raw\fR 4 .IX Item "--raw" Print modulefile in raw output when used with show .IP "\fI\-w twidth \-\-width=twidth\fR" 4 .IX Item "-w twidth --width=twidth" Use this as max term width .IP "\fI\-v \-\-version\fR" 4 .IX Item "-v --version" Print version info and quit .IP "\fI\-r \-\-regexp\fR" 4 .IX Item "-r --regexp" use regular expression match .IP \fI\-\-gitversion\fR 4 .IX Item "--gitversion" Dump git version in a machine readable way and quit .IP \fI\-\-dumpversion\fR 4 .IX Item "--dumpversion" Dump version in a machine readable way and quit .IP \fI\-\-dumpname\fR 4 .IX Item "--dumpname" Dump the name Lmod in a machine readable way and quit .IP "\fI\-\-check_syntax \-\-checkSyntax\fR" 4 .IX Item "--check_syntax --checkSyntax" Checking module command syntax: do not load .IP \fI\-\-config\fR 4 .IX Item "--config" Report Lmod Configuration .IP \fI\-\-miniConfig\fR 4 .IX Item "--miniConfig" Report Lmod Configuration differences .IP \fI\-\-config_json\fR 4 .IX Item "--config_json" Report Lmod Configuration in json format .IP \fI\-\-mt\fR 4 .IX Item "--mt" Report Module Table State .IP \fI\-\-timer\fR 4 .IX Item "--timer" report run times .IP "\fI\-f \-\-force\fR" 4 .IX Item "-f --force" force removal of a sticky module or save an empty collection .IP \fI\-\-redirect\fR 4 .IX Item "--redirect" Send the output of list, avail, spider to stdout (not stderr) .IP \fI\-\-no_redirect\fR 4 .IX Item "--no_redirect" Force output of list, avail and spider to stderr .IP "\fI\-\-show_hidden \-A \-\-all\fR" 4 .IX Item "--show_hidden -A --all" Avail and spider will report hidden modules .IP \fI\-\-spider_timeout=timeout\fR 4 .IX Item "--spider_timeout=timeout" a timeout for spider .IP "\fI\-T \-\-trace\fR" 4 .IX Item "-T --trace" trace major changes such as loads .IP "\fI\-\-nx \-\-no_extensions\fR" 4 .IX Item "--nx --no_extensions" Do not print extensions .IP \fI\-\-protected_vars\fR 4 .IX Item "--protected_vars" (Interal Use Only) When Lmod is protecting LD_PRELOAD and LD_LIBRARY_PATH .IP "\fI\-\-loc \-\-location\fR" 4 .IX Item "--loc --location" Just print the file location when using show .IP \fI\-\-terse_show_extensions\fR 4 .IX Item "--terse_show_extensions" report extensions when doing a terse avail .IP \fI\-\-pod\fR 4 .IX Item "--pod" Generate pod format .SH "COMMAND OVERVIEW" .IX Header "COMMAND OVERVIEW" module [options] sub\-command [args ...] .PP Help sub\-commands: .PP .Vb 2 \& help prints this message \& help module [...] print help message from module(s) .Ve .PP Loading/Unloading sub\-commands: .PP .Vb 10 \& load | add module [...] load module(s) \& try\-load | try\-add module [...] Add module(s), do not complain if not \& found \& del | unload module [...] Remove module(s), do not complain if not \& found \& swap | sw | switch m1 m2 unload m1 and load m2 \& purge unload all modules \& refresh reload aliases from current list of \& modules. \& update reload all currently loaded modules. .Ve .PP Listing / Searching sub\-commands: .PP .Vb 10 \& list List loaded modules \& list s1 s2 ... List loaded modules that match the \& pattern \& avail | av List available modules \& avail | av string List available modules that contain \& "string". \& category | cat List all categories \& category | cat s1 s2 ... List all categories that match the \& pattern and display their modules \& overview | ov List all available modules by short \& names with number of versions \& overview | ov string List available modules by short names \& with number of versions that contain \& "string" \& spider List all possible modules \& spider module List all possible version of that module \& file \& spider string List all module that contain the \& "string". \& spider name/version Detailed information about that version \& of the module. \& whatis module Print whatis information about module \& keyword | key string Search all name and whatis that contain \& "string". .Ve .PP Searching with Lmod: .PP .Vb 1 \& All searching (spider, list, avail, keyword) support regular expressions: \& \& \& \-r spider \*(Aq^p\*(Aq Finds all the modules that start with \& \`p\*(Aq or \`P\*(Aq \& \-r spider mpi Finds all modules that have "mpi" in \& their name. \& \-r spider \*(Aqmpi$ Finds all modules that end with "mpi" in \& their name. .Ve .PP Handling a collection of modules: .PP .Vb 10 \& save | s Save the current list of modules to a \& user defined "default" collection. \& save | s name Save the current list of modules to \& "name" collection. \& reset The same as "restore system" \& restore | r Restore modules from the user\*(Aqs \& "default" or system default. \& restore | r name Restore modules from "name" collection. \& restore system Restore module state to system defaults. \& savelist List of saved collections. \& describe | mcc name Describe the contents of a module \& collection. \& disable name Disable (i.e. remove) a collection. .Ve .PP Deprecated commands: .PP .Vb 7 \& getdefault [name] load name collection of modules or \& user\*(Aqs "default" if no name given. \& ===> Use "restore" instead <==== \& setdefault [name] Save current list of modules to name if \& given, otherwise save as the default \& list for you the user. \& ===> Use "save" instead. <==== .Ve .PP Miscellaneous sub\-commands: .PP .Vb 8 \& is\-loaded modulefile return a true status if module is loaded \& is\-avail modulefile return a true status if module can be \& loaded \& show modulefile show the commands in the module file. \& use [\-a] path Prepend or Append path to MODULEPATH. \& unuse path remove path from MODULEPATH. \& tablelist output list of active modules as a lua \& table. .Ve .PP Important Environment Variables: .PP .Vb 2 \& LMOD_COLORIZE If defined to be "YES" then Lmod prints \& properties and warning in color. .Ve .PP Lmod Web Sites .PP .Vb 4 \& Documentation: https://lmod.readthedocs.org \& GitHub: https://github.com/TACC/Lmod \& SourceForge: https://lmod.sf.net \& TACC Homepage: https://www.tacc.utexas.edu/research\-development/tacc\-projects/lmod \& \& To report a bug please read https://lmod.readthedocs.io/en/latest/075_bug_reporting.html .Ve .SH AUTHOR .IX Header "AUTHOR" Robert McLay mclay@tacc.utexas.edu