Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

a manpage for envml command #190

Open
cmarqu opened this issue Aug 27, 2018 · 2 comments
Open

a manpage for envml command #190

cmarqu opened this issue Aug 27, 2018 · 2 comments

Comments

@cmarqu
Copy link
Contributor

cmarqu commented Aug 27, 2018

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).

@xdelaruelle
Copy link
Member

It should get its own man page: envml.1

@xdelaruelle xdelaruelle changed the title envml utility should be mentioned in documentation a manpage for envml command Sep 26, 2021
@xdelaruelle
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants