Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

It is a little difficult to see, but we do have specific notation rules for PBS commands. (Some of our man pages and command descriptions vary, and are not a reliable guide.)  The rules we use are below:


  • To indicate that an argument is optional, use square brackets. For example, in the qstat man
    page, the -E option is shown this way:
     qstat [-E]
  • For an argument that is required but may take more than one value, such as a job ID or vnode name, use angle brackets.
    Here's an example from the pbsnodes man page:
     pbsnodes -v <vnode>
  • To show that something is both optional and variable, use angle brackets inside the square
    brackets. In this example from the qstat man page, the job ID is optional:
     qstat [<job ID>]


Here's a good resource: http://docopt.org

  • No labels