diff options
| author | David RodrÃguez <deivid.rodriguez@riseup.net> | 2019-07-10 17:26:55 +0200 |
|---|---|---|
| committer | David RodrÃguez <deivid.rodriguez@riseup.net> | 2019-08-10 12:05:10 +0200 |
| commit | 23de1d0177646ab73bd9ed193e29335c3a64dd5c (patch) | |
| tree | cc4303301dc728d71e48183f42dac9be1cc67b41 /man/bundle-viz.1 | |
| parent | 27b95a172c9200e77034bb113fe1633d2150552f (diff) | |
| download | bundler-23de1d0177646ab73bd9ed193e29335c3a64dd5c.tar.gz | |
Commit man pages to source control
This has the benefit that:
* Allows the installation of bundler as a default gem from rubygems to
include man pages.
* Removes the need to build man pages during our tests.
* Makes working with the manifest easier, because we only have source
controlled files, and not a mix of source control and generated files.
To make sure they never fall out of sync, we replace the previous
`man:build` CI task with a `man:check` task that makes sure the
generated man pages are up to date.
Diffstat (limited to 'man/bundle-viz.1')
| -rw-r--r-- | man/bundle-viz.1 | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/man/bundle-viz.1 b/man/bundle-viz.1 new file mode 100644 index 0000000000..458b6e1a65 --- /dev/null +++ b/man/bundle-viz.1 @@ -0,0 +1,39 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "BUNDLE\-VIZ" "1" "August 2019" "" "" +. +.SH "NAME" +\fBbundle\-viz\fR \- Generates a visual dependency graph for your Gemfile +. +.SH "SYNOPSIS" +\fBbundle viz\fR [\-\-file=FILE] [\-\-format=FORMAT] [\-\-requirements] [\-\-version] [\-\-without=GROUP GROUP] +. +.SH "DESCRIPTION" +\fBviz\fR generates a PNG file of the current \fBGemfile(5)\fR as a dependency graph\. \fBviz\fR requires the ruby\-graphviz gem (and its dependencies)\. +. +.P +The associated gems must also be installed via \fBbundle install(1)\fR \fIbundle\-install\.1\.html\fR\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-file\fR, \fB\-f\fR +The name to use for the generated file\. See \fB\-\-format\fR option +. +.TP +\fB\-\-format\fR, \fB\-F\fR +This is output format option\. Supported format is png, jpg, svg, dot \.\.\. +. +.TP +\fB\-\-requirements\fR, \fB\-R\fR +Set to show the version of each required dependency\. +. +.TP +\fB\-\-version\fR, \fB\-v\fR +Set to show each gem version\. +. +.TP +\fB\-\-without\fR, \fB\-W\fR +Exclude gems that are part of the specified named group\. + |