Skip to content

a manpage for envml command #190

Closed
Closed

Description

@cmarqu

The envml tool that ends up in Modules/bin/ seems quite useful but does not show up in the documentation (apart from the Release Notes: https://modules.readthedocs.io/en/latest/NEWS.html?highlight=envml).

Activity

  1. xdelaruelle commented on Jun 2, 2019

    @xdelaruelle
    Collaborator

    It should get its own man page: envml.1

  2. changed the title [-]envml utility should be mentioned in documentation[/-] [+]a manpage for `envml` command[/+] on Sep 26, 2021
  3. xdelaruelle commented on Sep 26, 2021

    @xdelaruelle
    Collaborator

    Some guidelines for people willing to contribute on this issue:

    • a envml.rst documentation file should be added to the doc/source repository
    • this file should have the same structure as doc/source/ml.rst document (with a SYNOPSIS, DESCRIPTION, EXAMPLE, EXIT STATUS, ENVIRONMENT and SEE ALSO sections)
    • look at script/envml script to learn how this shell command (similar to env command) operates
    • script/envml script also provides some examples in its help message
  4. added a commit that references this issue on Jun 14, 2025
    c6db535
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions