diff options
author | Liz Abinante <eabinante@gmail.com> | 2017-01-22 13:56:13 -0800 |
---|---|---|
committer | Liz Abinante <eabinante@gmail.com> | 2017-01-22 20:32:22 -0800 |
commit | 240664983bbfee2dbfe55ea6113478c3d0fc6a8e (patch) | |
tree | 2d53c117ee193f60103488b236b2198b94782c26 | |
parent | 9d29533ef06489f0b8761bc22c543012588b9536 (diff) | |
download | bundler-240664983bbfee2dbfe55ea6113478c3d0fc6a8e.tar.gz |
:tophat: add other missing commands to man pages
-rw-r--r-- | man/bundle-check.ronn (renamed from man/bundle-check.1.ronn) | 4 | ||||
-rw-r--r-- | man/bundle-clean.ronn (renamed from man/bundle-clean.1.ronn) | 2 | ||||
-rw-r--r-- | man/bundle-init.ronn | 18 | ||||
-rw-r--r-- | man/bundle-inject.ronn | 22 | ||||
-rw-r--r-- | man/bundle-open.ronn | 19 | ||||
-rw-r--r-- | man/bundle-show.ronn | 20 | ||||
-rw-r--r-- | man/bundle-viz.ronn | 30 | ||||
-rw-r--r-- | man/index.txt | 5 |
8 files changed, 118 insertions, 2 deletions
diff --git a/man/bundle-check.1.ronn b/man/bundle-check.ronn index 4bdf39ef13..b299da422f 100644 --- a/man/bundle-check.1.ronn +++ b/man/bundle-check.ronn @@ -3,7 +3,9 @@ bundle-check(1) -- Verifies if dependencies are satisfied by installed gems ## SYNOPSIS -`bundle check` [--dry-run] [--gemfile=FILE] [--path=PATH] +`bundle check` [--dry-run] + [--gemfile=FILE] + [--path=PATH] ## DESCRIPTION diff --git a/man/bundle-clean.1.ronn b/man/bundle-clean.ronn index 6c7eb3579b..de23991782 100644 --- a/man/bundle-clean.1.ronn +++ b/man/bundle-clean.ronn @@ -13,6 +13,6 @@ useful when you have made many changes to your gem dependencies. ## OPTIONS * `--dry-run`: - Print the changes, but do not actually clean the unused gems. + Print the changes, but do not clean the unused gems. * `--force`: Force a clean even if `--path` is not set. diff --git a/man/bundle-init.ronn b/man/bundle-init.ronn new file mode 100644 index 0000000000..e5dfd420e9 --- /dev/null +++ b/man/bundle-init.ronn @@ -0,0 +1,18 @@ +bundle-init(1) -- Generates a Gemfile into the current working directory +======================================================================== + +## SYNOPSIS + +`bundle init` [--gemspec=FILE] + +## DESCRIPTION + +Init generates a default `Gemfile(5)` in the current working directory. When +adding a `Gemfile(5)` to a gem with a gemspec, the `--gemspec` option will +automatically add each dependency listed in the gemspec file to the newly +created `Gemfile(5)`. + +## OPTIONS + +* `--gemspec`: + Use the specified .gemspec to create the `Gemfile(5)` diff --git a/man/bundle-inject.ronn b/man/bundle-inject.ronn new file mode 100644 index 0000000000..02f5dd8bd2 --- /dev/null +++ b/man/bundle-inject.ronn @@ -0,0 +1,22 @@ +bundle-inject(1) -- Add named gem(s) with version requirements to Gemfile +========================================================================= + +## SYNOPSIS + +`bundle inject` [GEM] [VERSION] + +## DESCRIPTION + +Adds the named gem(s) with their version requirements to the resolved +`Gemfile(5)`. + +This command will add the gem to both your `Gemfile(5)` and Gemfile.lock if it +isn't listed yet. + +Example: + + bundle install + bundle inject 'rack' '> 0' + +This will inject the 'rack' gem with a version greater than 0 in your +`Gemfile(5)` and Gemfile.lock diff --git a/man/bundle-open.ronn b/man/bundle-open.ronn new file mode 100644 index 0000000000..497beac93f --- /dev/null +++ b/man/bundle-open.ronn @@ -0,0 +1,19 @@ +bundle-open(1) -- Opens the source directory for a gem in your bundle +===================================================================== + +## SYNOPSIS + +`bundle open` [GEM] + +## DESCRIPTION + +Opens the source directory of the provided GEM in your editor. + +For this to work the `EDITOR` or `BUNDLER_EDITOR` environment variable has to +be set. + +Example: + + bundle open 'rack' + +Will open the source directory for the 'rack' gem in your bundle. diff --git a/man/bundle-show.ronn b/man/bundle-show.ronn new file mode 100644 index 0000000000..714b6067aa --- /dev/null +++ b/man/bundle-show.ronn @@ -0,0 +1,20 @@ +bundle-show(1) -- Shows all the gems in your bundle, or the path to a gem +========================================================================= + +## SYNOPSIS + +`bundle show` [GEM] + [--paths] + +## DESCRIPTION + +Without the [GEM] option, `show` will print a list of the names and versions of +all gems that are required by your `Gemfile(5)`. + +Calling show with [GEM] will list the exact location of that gem on your +machine. + +## OPTIONS + +* `--paths`: + List the paths of all gems that are required by your `Gemfile(5)`. diff --git a/man/bundle-viz.ronn b/man/bundle-viz.ronn new file mode 100644 index 0000000000..865bbf6ee3 --- /dev/null +++ b/man/bundle-viz.ronn @@ -0,0 +1,30 @@ +bundle-viz(1) -- Generates a visual dependency graph for your Gemfile +===================================================================== + +## SYNOPSIS + +`bundle viz` [--file=FILE] + [--format=FORMAT] + [--requirements] + [--version] + [--without=GROUP GROUP] + +## DESCRIPTION + +`viz` generates a PNG file of the current `Gemfile(5)` as a dependency graph. +`viz` requires the ruby-graphviz gem (and its dependencies). + +The associated gems must also be installed via `bundle install(1)`. + +## OPTIONS + +* `--file`: + The name to use for the generated file. See `--format` option +* `--format`: + This is output format option. Supported format is png, jpg, svg, dot ... +* `--requirements`: + Set to show the version of each required dependency. +* `--version`: + Set to show each gem version. +* `--without`: + Exclude gems that are part of the specified named group. diff --git a/man/index.txt b/man/index.txt index e33890d7ec..e3b38c46db 100644 --- a/man/index.txt +++ b/man/index.txt @@ -8,3 +8,8 @@ bundle-platform bundle-platform.1 bundle-gem bundle-gem.1 bundle-clean bundle-clean.1 bundle-check bundle-check.1 +bundle-init bundle-init.1 +bundle-inject bundle-inject.1 +bundle-open bundle-open.1 +bundle-show bundle-show.1 +bundle-viz bundle-viz.1 |