envmodules/modules
1
0
Fork 0
mirror of https://github.com/envmodules/modules.git synced 2026-06-14 00:42:43 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: desc. --before/--after in modulefile(4) man

Browse Source
This commit is contained in:
Xavier Delaruelle
2020-08-15 10:08:31 +02:00
parent e3b8b3c643
commit ebfb28c0ac
1 changed files with 17 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
doc/source/modulefile.rst
View File

@@ -240,7 +240,7 @@ the *modulefile* is being loaded.
* another *modulefile* alias
.. mfcmd:: module-forbid [--not-user {user...}] [--not-group {group...}] modulefile...
.. mfcmd:: module-forbid [--after datetime] [--before datetime] [--not-user {user...}] [--not-group {group...}] modulefile...
Forbid *modulefile* to exclude it from available module search or module
selection even if query refers to *modulefile* by its exact name. An error is
@@ -248,6 +248,14 @@ the *modulefile* is being loaded.
module. This command should be placed in one of the :file:`modulecmd.tcl` rc
files.
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
format is ``YYYY-MM-DD[THH:MM]``. If no time (``HH:MM``) is specified,
``00:00`` is assumed. ``--after`` and ``--before`` options are not supported
on Tcl versions prior to 8.5.
If ``--not-user`` option is set, forbidding is not applied if the username of
the user currently running :file:`modulecmd.tcl` is part of the list of
username specified. Following the same approach, if ``--not-group`` option is
@@ -271,7 +279,7 @@ the *modulefile* is being loaded.
.. versionadded:: 4.6
.. mfcmd:: module-hide [--soft] [--not-user {user...}] [--not-group {group...}] modulefile...
.. mfcmd:: module-hide [--soft] [--after datetime] [--before datetime] [--not-user {user...}] [--not-group {group...}] modulefile...
Hide *modulefile* to exclude it from available module search or module
selection unless query refers to *modulefile* by its exact name. This command
@@ -284,6 +292,13 @@ the *modulefile* is being loaded.
with the regular resolution mechanism (i.e., no need to use module exact name
to select it)
If ``--after`` option is set, hiding is only effective after specified date
time. Following the same principle, if ``--before`` option is set, hiding is
only effective before specified date time. Accepted date time format is
``YYYY-MM-DD[THH:MM]``. If no time (``HH:MM``) is specified, ``00:00`` is
assumed. ``--after`` and ``--before`` options are not supported on Tcl
versions prior to 8.5.
If ``--not-user`` option is set, hiding is not applied if the username of the
user currently running :file:`modulecmd.tcl` is part of the list of username
specified. Following the same approach, if ``--not-group`` option is set,