doc: rework module-{hide,forbid} option description

This commit is contained in:
Xavier Delaruelle
2020-10-06 20:28:50 +02:00
parent 9ee458b087
commit 384ddc50bd

View File

@@ -240,12 +240,21 @@ the *modulefile* is being loaded.
* another *modulefile* alias
.. mfcmd:: module-forbid [--after datetime] [--before datetime] [--not-user {user...}] [--not-group {group...}] [--message {text message}] [--nearly-message {text message}] modulefile...
.. mfcmd:: module-forbid [options] modulefile...
Forbid use of *modulefile*. An error is obtained when trying to evaluate a
forbidden module. This command should be placed in one of the
:file:`modulecmd.tcl` rc files.
:mfcmd:`module-forbid` command accepts the following options:
* ``--after datetime``
* ``--before datetime``
* ``--not-user {user...}``
* ``--not-group {group...}``
* ``--message {text message}``
* ``--nearly-message {text message}``
If ``--after`` option is set, forbidding is only effective after specified
date time. Following the same principle, if ``--before`` option is set,
forbidding is only effective before specified date time. Accepted date time
@@ -283,12 +292,20 @@ the *modulefile* is being loaded.
.. versionadded:: 4.6
.. mfcmd:: module-hide [--soft|--hard] [--after datetime] [--before datetime] [--not-user {user...}] [--not-group {group...}] modulefile...
.. mfcmd:: module-hide [options] modulefile...
Hide *modulefile* to exclude it from available module search or module
selection unless query refers to *modulefile* by its exact name. This command
should be placed in one of the :file:`modulecmd.tcl` rc files.
:mfcmd:`module-hide` command accepts the following options:
* ``--soft|--hard``
* ``--after datetime``
* ``--before datetime``
* ``--not-user {user...}``
* ``--not-group {group...}``
When ``--soft`` option is set, *modulefile* is also set hidden, but hiding is
disabled when search or selection query's root name matches module's root
name. This soft hiding mode enables to hide modulefiles from bare module