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

[Feature Request] Better documentation for Unix/Linux command line arguments? #360

Open
mdhall272 opened this issue Jun 19, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@mdhall272
Copy link

mdhall272 commented Jun 19, 2023

The Unix/Linux command line help for rb is as follows:

$ rb-mpi --help
Usage: rb [OPTIONS]
       rb [OPTIONS] <file1> [<file2> ...]
Bayesian phylogenetic inference using probabilistic graphical models and an interpreted language

Options:
  -h [ --help ]         Show information on flags.
  -v [ --version ]      Show version and exit.
  -b [ --batch ]        Run in batch mode.
  -j [ --jupyter ]      Run in jupyter mode.
  --args arg            Command line arguments to initialize RevBayes
                        variables.
  --cmd arg             Script and command line arguments to initialize
                        RevBayes variables.
  --file arg            File(s) to source.
  --setOption arg       Set an option key=value.

See http://revbayes.github.io for more information.

As far as I can tell this is the limit of the documentation for these flags, anywhere. It took me quite some time to work out that --args simply fills a vector called args (which is not mentioned in https://revbayes.github.io/documentation/) and that if you do that then rb [OPTIONS] <file1> [<file2> ...] does not actually work (because everything after --args is used to fill args) and you need to specify --file instead. I do not need it right now, but I also have no idea how to approach using --cmd. It seems like these could use some elaboration.

Apologies if there is actually a tutorial for these somewhere, but I certainly could not find it.

@mdhall272 mdhall272 changed the title Better documentation for Unix/Linux command line arguments? [Feature Request] Better documentation for Unix/Linux command line arguments? Jun 19, 2023
@bjoelle bjoelle added the enhancement New feature or request label Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants