summaryrefslogtreecommitdiff
path: root/system/modules/README
diff options
context:
space:
mode:
Diffstat (limited to 'system/modules/README')
-rw-r--r--system/modules/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/system/modules/README b/system/modules/README
new file mode 100644
index 0000000000..4d2fe0c65e
--- /dev/null
+++ b/system/modules/README
@@ -0,0 +1,9 @@
+The Environment Modules package provides for the dynamic modification of a user's environment via modulefiles.
+
+Each modulefile contains the information needed to configure the shell for an application.
+Once the Modules package is initialized, the environment can be modified on a per-module basis
+using the module command which interprets modulefiles. Typically modulefiles instruct the module command to
+alter or set shell environment variables such as PATH, MANPATH, etc. modulefiles may be shared by many users
+on a system and users may have their own collection to supplement or replace the shared modulefiles.
+Modules are useful in managing different versions of applications. Modules can also be bundled into
+metamodules that will load an entire suite of different applications.