Module: Difference between revisions

Revision as of 13:27, 18 January 2024

Documentation / Reference Manual / Advanced Module System // RefMan:AMS Commands // module

module: version 9.421.a932b23(2024-01-17 16:15) [AMS]

Name

module

Synopsis

module [OPTIONS] [--] [action] [module1 [module2] ... ]

Description

Activate/deactivate particular software package modules. Print available software packages, versions or builds.

Arguments

Arguments:
action operation, which should be performed (avail by default)
module module name

Executive actions:
add activate modules
remove deactivate modules
activate activate modules but do not export them
reactivate reactivate all active modules
autoload activate autoloaded modules
purge deactivate all active modules

Informative actions:
avail list available modules
versions show available versions of modules
help show help for modules if present
origin show the source of the module
bundles show information about active module bundles
exported list exported modules
active list active modules
list list exported and active modules
builds show available builds of a module
disp show how module activation influences shell environment
isactive return zero if all modules in the argument list are active
getactmod return name:version if the module is active
getactver return module version if the module is active

Options

--colors MODE

control colored output, allowed values are: auto, always

(Default: auto)

-i, --incvers

print with module versions

--reexported

set reexported flag

--system

set system flag

-v, --verbose

increase output verbosity

--version

output version information and exit

-h, --help

display this help and exit

@@ Line 1: / Line 1: @@
 [[Documentation]] / [[RefMan|Reference Manual]] / [[RefMan:AMS | Advanced Module System]] // [[RefMan:AMS Commands]] // [[module]]  __NOEDITSECTION__ __NOTOC__
 ----
+<div style="text-align: center">module: version 9.421.a932b23(2024-01-17 16:15) [AMS]</div>'''Name'''
+<span style="margin-left: 15px;">module</span>
+'''Synopsis'''
+<span style="color: maroon; margin-left: 15px;">module</span> <span style="color: blue;">[OPTIONS]</span> [--] <span style="color: purple;">[action] [module1 [module2] ... ]</span>
+'''Description'''
+<p style="text-indent: 1em; text-align: justify;">Activate/deactivate particular software package modules. Print available software packages, versions or builds.</p>
+'''Arguments'''
+<div style="margin-left: 2em;"><span style="font-style: bold;">Arguments:</span><br /><span></span>   <span style="font-style: bold;"><span style="color: darkcyan;">action</span></span>          operation, which should be performed (avail by default)<br /><span></span>   <span style="font-style: bold;"><span style="color: darkcyan;">module</span></span>          module name<br /><br />Executive actions:<br /><span></span>   <span style="color: green;"><span style="font-style: bold;">add</span>             activate modules</span><br /><span></span>   <span style="color: green;"><span style="font-style: bold;">remove</span>          deactivate modules</span><br /><span></span>   <span style="color: green;">activate</span>        activate modules but do not export them<br /><span></span>   <span style="color: green;">reactivate</span>      reactivate all active modules<br /><span></span>   <span style="color: green;">autoload</span>        activate autoloaded modules<br /><span></span>   <span style="color: green;">purge</span>           deactivate all active modules<br /><br />Informative actions:<br /><span></span>   <span style="font-style: bold;"><span style="color: green;">avail</span>           list available modules</span><br /><span></span>   <span style="font-style: bold;"><span style="color: green;">versions</span>        show available versions of modules</span><br /><span></span>   <span style="font-style: bold;"><span style="color: green;">help</span>            show help for modules if present</span><br /><span></span>   <span style="font-style: bold;"><span style="color: green;">origin</span>          show the source of the module</span><br /><span></span>   <span style="font-style: bold;"><span style="color: green;">bundles</span>         show information about active module bundles</span><br /><span></span>   <span style="color: green;">exported</span>        list exported modules<br /><span></span>   <span style="color: green;">active</span>          list active modules<br /><span></span>   <span style="color: green;">list</span>            list exported and active modules<br /><span></span>   <span style="color: green;">builds</span>          show available builds of a module<br /><span></span>   <span style="color: green;">disp</span>            show how module activation influences shell environment<br /><span></span>   <span style="color: green;">isactive</span>        return zero if all modules in the argument list are active<br /><span></span>   <span style="color: green;">getactmod</span>       return name:version if the module is active<br /><span></span>   <span style="color: green;">getactver</span>       return module version if the module is active</div>
+'''Options'''
+{| style="margin-left: 2em; width: 95%;"
+|- style="vertical-align: top; background-color: #e6e6e6;"
+|<span style="color: blue;">--colors MODE</span><br/><div style="margin-left: 30px;">control colored output, allowed values are: auto, always</div><span style="color:purple; margin-left: 30px;">(Default: auto)</span>
+|- style="vertical-align: top;"
+|<span style="color: blue;">-i, --incvers</span><br/><div style="margin-left: 30px;">print with module versions</div>
+|- style="vertical-align: top; background-color: #e6e6e6;"
+|<span style="color: blue;">--reexported</span><br/><div style="margin-left: 30px;">set reexported flag</div>
+|- style="vertical-align: top;"
+|<span style="color: blue;">--system</span><br/><div style="margin-left: 30px;">set system flag</div>
+|- style="vertical-align: top; background-color: #e6e6e6;"
+|<span style="color: blue;">-v, --verbose</span><br/><div style="margin-left: 30px;">increase output verbosity</div>
+|- style="vertical-align: top;"
+|<span style="color: blue;">--version</span><br/><div style="margin-left: 30px;">output version information and exit</div>
+|- style="vertical-align: top; background-color: #e6e6e6;"
+|<span style="color: blue;">-h, --help</span><br/><div style="margin-left: 30px;">display this help and exit</div>
+|}

Module: Difference between revisions

Revision as of 13:27, 18 January 2024

Navigation menu

Search