diff options
| author | Terence Lee <hone02@gmail.com> | 2012-08-29 23:58:02 -0500 |
|---|---|---|
| committer | Terence Lee <hone02@gmail.com> | 2012-08-30 00:14:48 -0500 |
| commit | ce129f11008622e62a37b27c7f4cd7b118be9de3 (patch) | |
| tree | c32ccb5a09db55c10b544aefc8e9d24eb7739f5c /man | |
| parent | 3cadcec49991cb80bab87dd68822eb0118be8523 (diff) | |
| download | bundler-ce129f11008622e62a37b27c7f4cd7b118be9de3.tar.gz | |
bundle platform man pages
Diffstat (limited to 'man')
| -rw-r--r-- | man/bundle-platform.ronn | 42 | ||||
| -rw-r--r-- | man/bundle.ronn | 3 | ||||
| -rw-r--r-- | man/index.txt | 1 |
3 files changed, 46 insertions, 0 deletions
diff --git a/man/bundle-platform.ronn b/man/bundle-platform.ronn new file mode 100644 index 0000000000..fc6a5741b4 --- /dev/null +++ b/man/bundle-platform.ronn @@ -0,0 +1,42 @@ +bundle-platform(1) -- Displays platform compatibility information +================================================================= + +## SYNOPSIS + +`bundle platform` [--ruby] + +## DESCRIPTION + +`platform` will display information from your Gemfile, Gemfile.lock, and Ruby +VM about your platform. + +For instance, using this Gemfile(5): + + source "http://rubygems.org" + + ruby "1.9.3" + + gem "rack" + +If you run `bundle platform` on Ruby 1.9.3, it will display the following output: + + Your platform is: x86_64-linux + + Your app has gems that work on these platforms: + * ruby + + Your Gemfile specifies a Ruby version requirement: + * ruby 1.9.3 + + Your current platform satisfies the Ruby version requirement. + +`platform` will list all the platforms in your `Gemfile.lock` as well as the +`ruby` directive if applicable from your Gemfile(5). It will also let you know +if the `ruby` directive requirement has been met. If `ruby` directive doesn't +match the running Ruby VM, it will tell you what part does not. + +## OPTIONS + +* `--ruby`: + It will just display the ruby directive information, so you don't have to + parse it from the Gemfile(5). diff --git a/man/bundle.ronn b/man/bundle.ronn index 04f0463832..400c3155c1 100644 --- a/man/bundle.ronn +++ b/man/bundle.ronn @@ -73,6 +73,9 @@ We divide `bundle` subcommands into primary commands and utilities. * `bundle gem(1)`: Create a simple gem, suitable for development with bundler +* `bundle platform(1)`: + Displays platform compatibility information + ## OBSOLETE These commands are obsolete and should no longer be used diff --git a/man/index.txt b/man/index.txt index 64f07cbfa2..e31afb7dff 100644 --- a/man/index.txt +++ b/man/index.txt @@ -4,3 +4,4 @@ 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 |