Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ACSimon33 committed Sep 6, 2024
1 parent 2323a7e commit 751ed2c
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 8 deletions.
4 changes: 2 additions & 2 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ replace the shared modulefiles.

Modules can be **loaded** and **unloaded** dynamically and atomically,
in an clean fashion. All popular shells are supported, including *bash*,
*ksh*, *zsh*, *sh*, *csh*, *tcsh*, *fish*, *cmd*, as well as some scripting
languages such as *tcl*, *perl*, *python*, *ruby*, *cmake*, *r*, and *pwsh*.
*ksh*, *zsh*, *sh*, *csh*, *tcsh*, *fish*, *cmd*, *pwsh*, as well as some
languages such as *tcl*, *perl*, *python*, *ruby*, *cmake*, and *r*.

Modules are useful in managing different versions of applications. Modules
can also be bundled into meta-modules that will load an entire suite of
Expand Down
7 changes: 7 additions & 0 deletions doc/source/module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,13 @@ Bourne Shell (sh) (and derivatives):
. \ |initdir|\ /sh
module load modulefile modulefile ...
Powershell (pwsh):

.. parsed-literal::
. \ |initdir|\ /pwsh.ps1
envmodule load modulefile modulefile ...
Perl:

.. parsed-literal::
Expand Down
14 changes: 8 additions & 6 deletions doc/source/modulefile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -775,8 +775,8 @@ the *modulefile* is being loaded.

If a *shellname* is given, returns ``1`` if :file:`modulecmd.tcl`'s current
shell is *shellname*, returns ``0`` otherwise. *shellname* can be: ``sh``,
``bash``, ``ksh``, ``zsh``, ``csh``, ``tcsh``, ``fish``, ``cmd``, ``tcl``,
``perl``, ``python``, ``ruby``, ``lisp``, ``cmake``, ``r``.
``bash``, ``ksh``, ``zsh``, ``csh``, ``tcsh``, ``fish``, ``cmd``, ``pwsh``,
``tcl``, ``perl``, ``python``, ``ruby``, ``lisp``, ``cmake``, ``r``.

**module-info shelltype** [shelltypename]

Expand All @@ -788,8 +788,8 @@ the *modulefile* is being loaded.

If a *shelltypename* is given, returns ``1`` if :file:`modulecmd.tcl`'s
current shell type is *shelltypename*, returns ``0`` otherwise.
*shelltypename* can be: ``sh``, ``csh``, ``fish``, ``cmd``, ``tcl``,
``perl``, ``python``, ``ruby``, ``lisp``, ``cmake``, ``r``.
*shelltypename* can be: ``sh``, ``csh``, ``fish``, ``cmd``, ``pwsh``,
``tcl``, ``perl``, ``python``, ``ruby``, ``lisp``, ``cmake``, ``r``.

**module-info specified**

Expand Down Expand Up @@ -2085,8 +2085,8 @@ Shell support

The :file:`modulecmd.tcl` program that evaluates *modulefiles* supports a
variety of shells or languages: *sh* family shells (*sh*, *bash*, *ksh* and
*zsh*), *csh* family shells (*csh* and *tcsh*), *fish*, *cmd*, *python*,
*perl*, *ruby*, *tcl*, *cmake*, *r*, and *lisp*.
*zsh*), *csh* family shells (*csh* and *tcsh*), *fish*, *cmd*, *pwsh*,
*python*, *perl*, *ruby*, *tcl*, *cmake*, *r*, and *lisp*.

Modulefiles produce environment changes when evaluated, like defining an
environment variable. The :file:`modulecmd.tcl` program outputs the
Expand Down Expand Up @@ -2122,6 +2122,8 @@ changes that are supported by the shells supported by :file:`modulecmd.tcl`.
+--------+-----------------------+----------------------+-------------------------+---------------------+----------------+---------------------+
| cmd ||| | || |
+--------+-----------------------+----------------------+-------------------------+---------------------+----------------+---------------------+
| pwsh |||||| |
+--------+-----------------------+----------------------+-------------------------+---------------------+----------------+---------------------+
| python || | | |||
+--------+-----------------------+----------------------+-------------------------+---------------------+----------------+---------------------+
| perl || | | |||
Expand Down

0 comments on commit 751ed2c

Please sign in to comment.