envmodules/modules
1
0
Fork 0
mirror of https://github.com/envmodules/modules.git synced 2026-05-30 00:12:31 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: clarify envml man page

Browse Source 
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
This commit is contained in:
Xavier Delaruelle
2025-06-13 18:58:23 +02:00
parent c6db5358e5
commit e1ccc34cfc
1 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/envml.rst
View File

@@ -11,16 +11,15 @@ SYNOPSIS
DESCRIPTION
-----------
The :command:`envml` command is a helper script that configures the shell
environment using specified Environment Modules actions before executing a
given command.
The :command:`envml` command configures the environment using specified
Environment Modules actions and then given command.
This is useful for running a command in a modified environment without
permanently altering the current shell session.
The script first interprets arguments as module actions, then switches to
command execution after either encountering ``--`` or determining that the
remaining arguments form the actual command to run.
:command:`envml` interprets its first arguments as module actions, then
switches to command execution after either encountering ``--`` or determining
that the remaining arguments form the actual command to run.
MODULE_ACTION FORMAT
--------------------
@@ -67,8 +66,7 @@ OPTIONS
EXAMPLES
--------
Run ``command arg1 arg2`` in the environment restored from the default module
collection:
Restore default module collection then run ``command arg1 arg2``:
.. code-block:: sh