summaryrefslogtreecommitdiff
path: root/man/bundle-viz.1.txt
diff options
context:
space:
mode:
authorDavid Rodríguez <deivid.rodriguez@riseup.net>2019-07-10 17:26:55 +0200
committerDavid Rodríguez <deivid.rodriguez@riseup.net>2019-08-10 12:05:10 +0200
commit23de1d0177646ab73bd9ed193e29335c3a64dd5c (patch)
treecc4303301dc728d71e48183f42dac9be1cc67b41 /man/bundle-viz.1.txt
parent27b95a172c9200e77034bb113fe1633d2150552f (diff)
downloadbundler-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.txt')
-rw-r--r--man/bundle-viz.1.txt39
1 files changed, 39 insertions, 0 deletions
diff --git a/man/bundle-viz.1.txt b/man/bundle-viz.1.txt
new file mode 100644
index 0000000000..d9f68e0ecd
--- /dev/null
+++ b/man/bundle-viz.1.txt
@@ -0,0 +1,39 @@
+BUNDLE-VIZ(1) BUNDLE-VIZ(1)
+
+
+
+NAME
+ bundle-viz - 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) bun-
+ dle-install.1.html.
+
+OPTIONS
+ --file, -f
+ The name to use for the generated file. See --format option
+
+ --format, -F
+ This is output format option. Supported format is png, jpg, svg,
+ dot ...
+
+ --requirements, -R
+ Set to show the version of each required dependency.
+
+ --version, -v
+ Set to show each gem version.
+
+ --without, -W
+ Exclude gems that are part of the specified named group.
+
+
+
+
+ August 2019 BUNDLE-VIZ(1)