Skip to content
Browse files

Guard has now a (basic) man page! :)

  • Loading branch information...
1 parent 63c61e2 commit 5f8880f2708bca26c83b0a28f441530844eb339d Rémy Coutable committed Jun 19, 2011
Showing with 177 additions and 1 deletion.
  1. +1 −0 .gitignore
  2. +1 −1 guard.gemspec
  3. BIN man/guard.1.gz
  4. +127 −0 man/guard.1.html
  5. +48 −0 man/guard.md
View
1 .gitignore
@@ -2,6 +2,7 @@ pkg/*
*.gem
.bundle
Gemfile.lock
+!man/*.gz
## MAC OS
.DS_Store
View
2 guard.gemspec
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
s.add_dependency 'thor', '~> 0.14.6'
- s.files = Dir.glob('{bin,images,lib}/**/*') + %w[LICENSE README.md CHANGELOG.md]
+ s.files = Dir.glob('{bin,images,lib}/**/*') + %w[CHANGELOG.md LICENSE man/guard.1.gz man/guard.1.html README.md]
s.executable = 'guard'
s.require_path = 'lib'
end
View
BIN man/guard.1.gz
Binary file not shown.
View
127 man/guard.1.html
@@ -0,0 +1,127 @@
+<!DOCTYPE html>
+<html>
+<head>
+ <meta http-equiv='content-type' value='text/html;charset=utf8'>
+ <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+ <title>guard(1) - Guard keeps an eye on your file modifications.</title>
+ <style type='text/css' media='all'>
+ /* style: man */
+ body#manpage {margin:0}
+ .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+ .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+ .mp h2 {margin:10px 0 0 0}
+ .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+ .mp h3 {margin:0 0 0 4ex}
+ .mp dt {margin:0;clear:left}
+ .mp dt.flush {float:left;width:8ex}
+ .mp dd {margin:0 0 0 9ex}
+ .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+ .mp pre {margin-bottom:20px}
+ .mp pre+h2,.mp pre+h3 {margin-top:22px}
+ .mp h2+pre,.mp h3+pre {margin-top:5px}
+ .mp img {display:block;margin:auto}
+ .mp h1.man-title {display:none}
+ .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+ .mp h2 {font-size:16px;line-height:1.25}
+ .mp h1 {font-size:20px;line-height:2}
+ .mp {text-align:justify;background:#fff}
+ .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+ .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+ .mp u {text-decoration:underline}
+ .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+ .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+ .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+ .mp b.man-ref {font-weight:normal;color:#434241}
+ .mp pre {padding:0 4ex}
+ .mp pre code {font-weight:normal;color:#434241}
+ .mp h2+pre,h3+pre {padding-left:0}
+ ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+ ol.man-decor {width:100%}
+ ol.man-decor li.tl {text-align:left}
+ ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+ ol.man-decor li.tr {text-align:right;float:right}
+ </style>
+</head>
+<!--
+ The following styles are deprecated and will be removed at some point:
+ div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+ The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+ .man-navigation should be used instead.
+-->
+<body id='manpage'>
+ <div class='mp' id='man'>
+
+ <div class='man-navigation' style='display:none'>
+ <a href="#NAME">NAME</a>
+ <a href="#SYNOPSIS">SYNOPSIS</a>
+ <a href="#DESCRIPTION">DESCRIPTION</a>
+ <a href="#HOMEPAGE">HOMEPAGE</a>
+ <a href="#OPTIONS">OPTIONS</a>
+ <a href="#EXAMPLES">EXAMPLES</a>
+ <a href="#AUTHORS-CONTRIBUTORS">AUTHORS / CONTRIBUTORS</a>
+ </div>
+
+ <ol class='man-decor man-head man head'>
+ <li class='tl'>guard(1)</li>
+ <li class='tc'></li>
+ <li class='tr'>guard(1)</li>
+ </ol>
+
+ <h2 id="NAME">NAME</h2>
+<p class="man-name">
+ <code>guard</code> - <span class="man-whatis">Guard keeps an eye on your file modifications.</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p>guard <a href="#OPTIONS" title="OPTIONS" data-bare-link="true">options</a></p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p>Guard is a command line tool that easily handle events on files modifications.</p>
+
+<h2 id="HOMEPAGE">HOMEPAGE</h2>
+
+<p>https://github.com/guard/guard</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<dl>
+<dt><code>-c</code>, <code>--clear</code></dt><dd><p>Clears the Shell after each change.</p></dd>
+<dt><code>-n</code> <var>flag</var>, <code>--notify</code> <var>flag</var></dt><dd><p>Disable notifications (Growl or Libnotify depending on your system).
+Note that notifications can also be disabled globally by setting a GUARD_NOTIFY environment variable to false.
+The <var>flag</var> part can be passed to guard using true/false or t/f.</p></dd>
+<dt><code>-g</code> <var>list of groups</var>, <code>--group</code> <var>list of groups</var></dt><dd><p>Runs only the groups specified.</p></dd>
+<dt><code>-d</code>, <code>--debug</code></dt><dd><p>Runs Guard in debug mode.</p></dd>
+</dl>
+
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<p><code>[bundle exec] guard --clear --group backend frontend --notify false --debug</code></p>
+
+<p>or in a more concise way:</p>
+
+<p><code>[bundle exec] guard -c -g backend frontend -n f -d</code></p>
+
+<h2 id="AUTHORS-CONTRIBUTORS">AUTHORS / CONTRIBUTORS</h2>
+
+<p>Thibaud Guillaume-Gentil is the main author.</p>
+
+<p>A list of contributors based on all commits can be found here:
+https://github.com/guard/guard/contributors</p>
+
+<p>For an exhaustive list of all the contributors, please see the CHANGELOG:
+https://github.com/guard/guard/blob/master/CHANGELOG.md</p>
+
+
+ <ol class='man-decor man-foot man foot'>
+ <li class='tl'></li>
+ <li class='tc'>June 2011</li>
+ <li class='tr'>guard(1)</li>
+ </ol>
+
+ </div>
+</body>
+</html>
View
48 man/guard.md
@@ -0,0 +1,48 @@
+guard(1) -- Guard keeps an eye on your file modifications.
+========================================================
+
+## SYNOPSIS
+
+guard [options]
+
+## DESCRIPTION
+
+Guard is a command line tool that easily handle events on files modifications.
+
+## HOMEPAGE
+
+https://github.com/guard/guard
+
+## OPTIONS
+
+* `-c`, `--clear`:
+ Clears the Shell after each change.
+
+* `-n` <flag>, `--notify` <flag>:
+ Disable notifications (Growl or Libnotify depending on your system).
+ Note that notifications can also be disabled globally by setting a GUARD_NOTIFY environment variable to false.
+ The <flag> part can be passed to guard using true/false or t/f.
+
+* `-g` <list of groups>, `--group` <list of groups>:
+ Runs only the groups specified.
+
+* `-d`, `--debug`:
+ Runs Guard in debug mode.
+
+## EXAMPLES
+
+`[bundle exec] guard --clear --group backend frontend --notify false --debug`
+
+or in a more concise way:
+
+`[bundle exec] guard -c -g backend frontend -n f -d`
+
+## AUTHORS / CONTRIBUTORS
+
+Thibaud Guillaume-Gentil is the main author.
+
+A list of contributors based on all commits can be found here:
+https://github.com/guard/guard/contributors
+
+For an exhaustive list of all the contributors, please see the CHANGELOG:
+https://github.com/guard/guard/blob/master/CHANGELOG.md

0 comments on commit 5f8880f

Please sign in to comment.
Something went wrong with that request. Please try again.