diff --git a/.gitignore b/.gitignore index e705a8b..45a6e93 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ pkg/* *.gem .bundle Gemfile.lock +!man/*.gz ## MAC OS .DS_Store diff --git a/guard.gemspec b/guard.gemspec index 77d7328..786b1f8 100644 --- a/guard.gemspec +++ b/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 diff --git a/man/guard.1.gz b/man/guard.1.gz new file mode 100644 index 0000000..319017b Binary files /dev/null and b/man/guard.1.gz differ diff --git a/man/guard.1.html b/man/guard.1.html new file mode 100644 index 0000000..41e6181 --- /dev/null +++ b/man/guard.1.html @@ -0,0 +1,127 @@ + + + + + + guard(1) - Guard keeps an eye on your file modifications. + + + + +
+ + + +
    +
  1. guard(1)
    2. +
  2. +
  3. guard(1)
    4. +
+ +

NAME

+

+ guard - 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

+ + +
    +
  1. +
  2. June 2011
    3. +
  3. guard(1)
    4. +
+ +
+ + diff --git a/man/guard.md b/man/guard.md new file mode 100644 index 0000000..723ab6b --- /dev/null +++ b/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` , `--notify` : + 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 part can be passed to guard using true/false or t/f. + +* `-g` , `--group` : + 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