rfdonnelly / jobrnr

Jobrnr runs jobs.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Formal job description help

rfdonnelly opened this issue · comments

Add features to allow job descriptions to produce man page like output.
Jobrnr can already produce the OPTIONS section.

  • Add pre-option text
  • Add post-option test
  • Add support for +help plus option. (c42761b)

Example Output

SYNOPSIS

  jobrnr index.jr 

DESCRIPTION

  My job description.

OPTIONS

  +bool-option[=<value>]
    This is a Boolean option. Default: false

  +iter=<value>
    Number of iterations Default: 2

  +test=<value>
    Name of test to run. Default: 'default'

EXAMPLES

  Run all basic regression.

    jobrnr file.jr

  Run more iterations.

    jobrnr file.jr +iter=50