diff options
| author | Richard Bowen <rgb.ide@gmail.com> | 2015-06-19 21:13:20 -0500 |
|---|---|---|
| committer | Richard Bowen <rgb.ide@gmail.com> | 2015-06-19 21:13:20 -0500 |
| commit | 6cefe6f233eb120d9fc754050058fc15f7e72d68 (patch) | |
| tree | 74d19ad358a8f00bfa01c7d34d05e1da97b15df9 | |
| parent | d5d0ffcb11639bfd8e5bd92c4cbe85e71ab7495c (diff) | |
| download | bundler-rgb-manpage-additions.tar.gz | |
Add documentation for bundle viz and update index.txtrgb-manpage-additions
| -rw-r--r-- | man/bundle-viz.ronn | 28 | ||||
| -rw-r--r-- | man/index.txt | 2 |
2 files changed, 30 insertions, 0 deletions
diff --git a/man/bundle-viz.ronn b/man/bundle-viz.ronn new file mode 100644 index 0000000000..102e091201 --- /dev/null +++ b/man/bundle-viz.ronn @@ -0,0 +1,28 @@ +bundle-viz -- Generate a visual representation of your dependencies +=================================================================== + +## SYNOPSIS + +`bundle viz` [--file=FILE] [--format=FORMAT] [--requirements] [--version] [--without=GROUP GROUP] + +## DESCRIPTION + +`viz` generates a by default a PNG file of the current Gemfile as a dependency graph. `viz` +requires the Graphviz visualization software package and `ruby-graphviz` gem. + +## OPTIONS + +* `-f, --file`: + The name to use for a generated file + +* `-F, --format`: + This is the output file format. Supported formats include png, jpg, svg, and many more. + +* `-r, --requirements`: + Set to show the version of each required dependency. + +* `-v, --version`: + Set to show each gem version. + +* `--without`: + Exclude gems that are part of a specified named group. diff --git a/man/index.txt b/man/index.txt index e31afb7dff..24b8bc7ae6 100644 --- a/man/index.txt +++ b/man/index.txt @@ -1,7 +1,9 @@ Gemfile(5) gemfile.5 +bundle-init bundle-init.1 bundle-install bundle-install.1 bundle-update bundle-update.1 bundle-package bundle-package.1 bundle-exec bundle-exec.1 bundle-config bundle-config.1 bundle-platform bundle-platform.1 +bundle-viz bundle-viz.1 |