Skip to content

Commit e1ccc34

Browse files
committed
doc: clarify envml man page
Signed-off-by: Xavier Delaruelle <[email protected]>
1 parent c6db535 commit e1ccc34

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

doc/source/envml.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,15 @@ SYNOPSIS
1111
DESCRIPTION
1212
-----------
1313

14-
The :command:`envml` command is a helper script that configures the shell
15-
environment using specified Environment Modules actions before executing a
16-
given command.
14+
The :command:`envml` command configures the environment using specified
15+
Environment Modules actions and then given command.
1716

1817
This is useful for running a command in a modified environment without
1918
permanently altering the current shell session.
2019

21-
The script first interprets arguments as module actions, then switches to
22-
command execution after either encountering ``--`` or determining that the
23-
remaining arguments form the actual command to run.
20+
:command:`envml` interprets its first arguments as module actions, then
21+
switches to command execution after either encountering ``--`` or determining
22+
that the remaining arguments form the actual command to run.
2423

2524
MODULE_ACTION FORMAT
2625
--------------------
@@ -67,8 +66,7 @@ OPTIONS
6766
EXAMPLES
6867
--------
6968

70-
Run ``command arg1 arg2`` in the environment restored from the default module
71-
collection:
69+
Restore default module collection then run ``command arg1 arg2``:
7270

7371
.. code-block:: sh
7472

0 commit comments

Comments
 (0)