From ebfb28c0acaf12e03ff608fd7948a23f633f0aa1 Mon Sep 17 00:00:00 2001 From: Xavier Delaruelle Date: Sat, 15 Aug 2020 10:08:31 +0200 Subject: [PATCH] doc: desc. --before/--after in modulefile(4) man --- doc/source/modulefile.rst | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/doc/source/modulefile.rst b/doc/source/modulefile.rst index adc3dfb3..40555d63 100644 --- a/doc/source/modulefile.rst +++ b/doc/source/modulefile.rst @@ -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,