diff --git a/doc/source/module.rst b/doc/source/module.rst index f47b703a..872c1b7b 100644 --- a/doc/source/module.rst +++ b/doc/source/module.rst @@ -379,7 +379,7 @@ Module Sub-Commands **use** [-a|--append] directory... Prepend one or more *directories* to the :envvar:`MODULEPATH` environment - variable. The *--append* flag will append the *directory* to + variable. The ``--append`` flag will append the *directory* to :envvar:`MODULEPATH`. Reference counter environment variable :envvar:`MODULEPATH_modshare<\_modshare>` is @@ -428,7 +428,7 @@ Module Sub-Commands **clear** [-f] Force the Modules package to believe that no modules are currently loaded. A - confirmation is requested if command-line switch *-f* (or *--force*) is not + confirmation is requested if command-line switch :option:`-f` (or :option:`--force`) is not passed. Typed confirmation should equal to *yes* or *y* in order to proceed. .. _source: @@ -734,7 +734,7 @@ Module Sub-Commands Gets or sets :file:`modulecmd.tcl` options. Reports the currently set value of passed option *name* or all existing options if no *name* passed. If a *name* and a *value* are provided, the value of option *name* is set to *value*. If - command-line switch *--reset* is passed in addition to a *name*, overridden + command-line switch ``--reset`` is passed in addition to a *name*, overridden overridden value for option *name* is cleared. When a reported option value differs from default value a mention is added @@ -745,7 +745,7 @@ Module Sub-Commands If no value is currently set for an option *name*, the mention ** is reported. - When command-line switch *--dump-state* is passed, current :file:`modulecmd.tcl` + When command-line switch ``--dump-state`` is passed, current :file:`modulecmd.tcl` state and Modules-related environment variables are reported in addition to currently set :file:`modulecmd.tcl` options. @@ -975,10 +975,10 @@ ENVIRONMENT load of the switched-to modulefile. Automated module handling mode enablement is defined in the following order - of preference: **--auto**/**--no-auto** command line switches, + of preference: :option:`--auto`/:option:`--no-auto` command line switches, then :envvar:`MODULES_AUTO_HANDLING` environment variable, then the default set in :file:`modulecmd.tcl` script configuration. Which means :envvar:`MODULES_AUTO_HANDLING` - overrides default configuration and **--auto**/**--no-auto** command line + overrides default configuration and :option:`--auto`/:option:`--no-auto` command line switches override every other ways to enable or disable this mode. .. envvar:: MODULES_AVAIL_INDEPTH @@ -993,10 +993,10 @@ ENVIRONMENT are excluded. **avail** sub-command in depth mode enablement is defined in the following - order of preference: **--indepth**/**--no-indepth** command line switches, + order of preference: :option:`--indepth`/:option:`--no-indepth` command line switches, then :envvar:`MODULES_AVAIL_INDEPTH` environment variable, then the default set in :file:`modulecmd.tcl` script configuration. Which means :envvar:`MODULES_AVAIL_INDEPTH` - overrides default configuration and **--indepth**/**--no-indepth** command + overrides default configuration and :option:`--indepth`/:option:`--no-indepth` command line switches override every other ways to enable or disable this mode. .. envvar:: MODULES_CMD @@ -1040,11 +1040,11 @@ ENVIRONMENT error output channel is attached to a terminal. Colored output enablement is defined in the following order of preference: - **--color** command line switch, then :envvar:`MODULES_COLOR` environment variable, + :option:`--color` command line switch, then :envvar:`MODULES_COLOR` environment variable, then :envvar:`CLICOLOR` and :envvar:`CLICOLOR_FORCE` environment variables, then the default set in :file:`modulecmd.tcl` script configuration. Which means :envvar:`MODULES_COLOR` overrides default configuration and the - :envvar:`CLICOLOR`/:envvar:`CLICOLOR_FORCE` variables. **--color** command line switch + :envvar:`CLICOLOR`/:envvar:`CLICOLOR_FORCE` variables. :option:`--color` command line switch overrides every other ways to enable or disable this mode. :envvar:`CLICOLOR` and :envvar:`CLICOLOR_FORCE` environment variables are also honored to @@ -1115,10 +1115,10 @@ ENVIRONMENT receive as argument. Case sensitiveness behavior is defined in the following order of preference: - **--icase** command line switch, which corresponds to the **always** mode, + :option:`--icase` command line switch, which corresponds to the **always** mode, then :envvar:`MODULES_ICASE` environment variable, then the default set in :file:`modulecmd.tcl` script configuration. Which means :envvar:`MODULES_ICASE` - overrides default configuration and **--icase** command line switch overrides + overrides default configuration and :option:`--icase` command line switch overrides every other ways to set case sensitiveness behavior. .. envvar:: MODULES_IMPLICIT_DEFAULT @@ -1243,10 +1243,10 @@ ENVIRONMENT search query string are returned. Module search match style is defined in the following order of preference: - **--starts-with** and **--contains** command line switches, then + :option:`--starts-with` and :option:`--contains` command line switches, then :envvar:`MODULES_SEARCH_MATCH` environment variable, then the default set in :file:`modulecmd.tcl` script configuration. Which means :envvar:`MODULES_SEARCH_MATCH` - overrides default configuration and **--starts-with**/**--contains** command + overrides default configuration and :option:`--starts-with`/:option:`--contains` command line switches override every other ways to set search match style. .. envvar:: MODULES_SET_SHELL_STARTUP @@ -1311,10 +1311,10 @@ ENVIRONMENT * debug: print debugging messages about module command execution. Module command verbosity is defined in the following order of preference: - **--silent**, **--verbose** and **--debug** command line switches, then + :option:`--silent`, :option:`--verbose` and :option:`--debug` command line switches, then :envvar:`MODULES_VERBOSITY` environment variable, then the default set in :file:`modulecmd.tcl` script configuration. Which means :envvar:`MODULES_VERBOSITY` - overrides default configuration and **--silent**/**--verbose**/**--debug** + overrides default configuration and :option:`--silent`/:option:`--verbose`/:option:`--debug` command line switches overrides every other ways to set verbosity level. .. envvar:: MODULES_WA_277 diff --git a/doc/source/modulefile.rst b/doc/source/modulefile.rst index 22b46f64..76b40bfb 100644 --- a/doc/source/modulefile.rst +++ b/doc/source/modulefile.rst @@ -172,7 +172,7 @@ the *modulefile* is being loaded. Append or prepend *value* to environment *variable*. The *variable* is a colon, or *delimiter*, separated list such as ``PATH=directory:directory:directory``. The default delimiter is a colon - ':', but an arbitrary one can be given by the *--delim* option. For + ':', but an arbitrary one can be given by the ``--delim`` option. For example a space can be used instead (which will need to be handled in the Tcl specially by enclosing it in " " or { }). A space, however, can not be specified by the *--delim=C* form. @@ -183,7 +183,7 @@ the *modulefile* is being loaded. by *_modshare*. When *value* is already defined in environement *variable*, it is not added - again except if *--duplicates* option is set. + again except if ``--duplicates`` option is set. If the *variable* is not set, it is created. When a *modulefile* is unloaded, **append-path** and **prepend-path** become **remove-path**. @@ -201,7 +201,7 @@ the *modulefile* is being loaded. in *variable* is compared to *value*. If the two match, *value* is removed from *variable* if its reference counter is equal to 1 or unknown. - When *--index* option is set, *value* refers to an index in *variable* list. + When ``--index`` option is set, *value* refers to an index in *variable* list. The string element pointed by this index is set for removal. Reference counter of *value* in *variable* denotes the number of times @@ -313,7 +313,7 @@ the *modulefile* is being loaded. requires a basic set of applications loaded, then a core *modulefile* would contain the necessary **module load** commands. - Command line switches **--auto**, **--no-auto** and **--force** are ignored + Command line switches :option:`--auto`, :option:`--no-auto` and :option:`--force` are ignored when passed to a **module** command set in a *modulefile*. .. _module-info: