From e1ccc34cfce76da91bf218d1015ca5754cfb5aa1 Mon Sep 17 00:00:00 2001 From: Xavier Delaruelle Date: Fri, 13 Jun 2025 18:58:23 +0200 Subject: [PATCH] doc: clarify envml man page Signed-off-by: Xavier Delaruelle --- doc/source/envml.rst | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/doc/source/envml.rst b/doc/source/envml.rst index 1c0f2cab..01560cbc 100644 --- a/doc/source/envml.rst +++ b/doc/source/envml.rst @@ -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