Skip to content

Commit

Permalink
Added ronn source for building cucumber-nagios man page
Browse files Browse the repository at this point in the history
  • Loading branch information
auxesis committed Jan 12, 2011
1 parent 59e3e89 commit 5e19a2c
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@ rdoc
pkg

## PROJECT::SPECIFIC
man/*
!man/*.ronn
49 changes: 49 additions & 0 deletions man/cucumber-nagios.1.ronn
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
cucumber-nagios
===============

## SYNOPSIS ##

`cucumber-nagios` <feature> [--debug|--pretty]

## DESCRIPTION ##

**cucumber-nagios** runs Cucumber features and outputs the result in the Nagios
plugin format.

## FILES ##

The `cucumber-nagios` command expects a path to a Cucumber feature file as the
first argument. The path can be relative or absolute, e.g.

* `cucumber-nagios features/github.com/login.feature`
* `cucumber-nagios /home/nagios/behavioural/features/example.org/navigation.feature`

## OPTIONS ##

* `--debug`:
Output the generated command line used to invoke Cucumber.
* `--pretty`:
Use Cucumber's `pretty` formatter instead of cucumber-nagios's Nagios
formatter. This is useful for debugging your scenarios as you write them.

## RETURN VALUES ##

* **0**: all scenarios passed (OK)
* **1**: missing steps (WARNING)
* **2**: scenario failure (CRITICAL)
* **4**: missing feature file (UNKNOWN)

## AUTHOR ##

Lindsay Holmwood <[email protected]>

## COPYRIGHT ##

cucumber-nagios is MIT licensed.

Portions of cucumber-nagios contain code originally contributed to Chef
(http://github.com/opscode/chef)

## SEE ALSO ##

cucumber-nagios-gen(1), nagios(8)

0 comments on commit 5e19a2c

Please sign in to comment.