Skip to content

Instantly share code, notes, and snippets.

@gvalkov
Created May 15, 2012 13:11
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save gvalkov/2701636 to your computer and use it in GitHub Desktop.
Save gvalkov/2701636 to your computer and use it in GitHub Desktop.
Attachment to request #532
------ cabal --help ------
This program is the command line interface to the Haskell Cabal infrastructure.
See http://www.haskell.org/cabal/ for more information.
Usage: cabal COMMAND [FLAGS]
or: cabal [GLOBAL FLAGS]
Global flags:
-h --help Show this help text
-V --version Print version information
--numeric-version Print just the version number
Commands:
install Installs a list of packages.
update Updates list of known packages
list List packages matching a search string.
info Display detailed information about a particular package.
fetch Downloads packages for later installation.
unpack Unpacks packages for user inspection.
check Check the package for common mistakes
sdist Generate a source distribution file (.tar.gz).
upload Uploads source packages to Hackage
report Upload build reports to a remote server.
init Interactively create a .cabal file.
configure Prepare to build the package.
build Make this package ready for installation.
copy Copy the files into the install locations.
haddock Generate Haddock HTML documentation.
clean Clean up after a build.
hscolour Generate HsColour colourised code, in HTML format.
register Register this package with the compiler.
test Run the test suite, if any (configure with UserHooks).
upgrade (command disabled, use install instead)
help Help about commands
For more information about a command use:
cabal COMMAND --help
To install Cabal packages from hackage use:
cabal install foo [--dry-run]
Occasionally you need to update the list of available packages:
cabal update
You can edit the cabal configuration file to set defaults:
/home/gv/.cabal/config
------ cabal install --help ------
Usage: cabal install [FLAGS]
or: cabal install [PACKAGES]
Flags for install:
-h --help Show this help text
-v --verbose[=n] Control verbosity (n is 0--3, default
verbosity level is 1)
--builddir=DIR The directory where Cabal puts generated
build files (default dist)
-g --ghc compile with GHC
--nhc98 compile with NHC
--jhc compile with JHC
--lhc compile with LHC
--hugs compile with Hugs
--uhc compile with UHC
-w --with-compiler=PATH give the path to a particular compiler
--with-hc-pkg=PATH give the path to the package tool
--prefix=DIR bake this prefix in preparation of
installation
--bindir=DIR installation directory for executables
--libdir=DIR installation directory for libraries
--libsubdir=DIR subdirectory of libdir in which libs are
installed
--libexecdir=DIR installation directory for program
executables
--datadir=DIR installation directory for read-only data
--datasubdir=DIR subdirectory of datadir in which data files
are installed
--docdir=DIR installation directory for documentation
--htmldir=DIR installation directory for HTML
documentation
--haddockdir=DIR installation directory for haddock
interfaces
-b --scratchdir=DIR directory to receive the built package
(hugs-only)
--program-prefix=PREFIX prefix to be applied to installed
executables
--program-suffix=SUFFIX suffix to be applied to installed
executables
--enable-library-vanilla Enable Vanilla libraries
--disable-library-vanilla Disable Vanilla libraries
-p --enable-library-profiling Enable Library profiling
--disable-library-profiling Disable Library profiling
--enable-shared Enable Shared library
--disable-shared Disable Shared library
--enable-executable-profiling Enable Executable profiling
--disable-executable-profiling Disable Executable profiling
-O --enable-optimization[=n] Build with optimization (n is 0--2, default
is 1)
--disable-optimization Build without optimization
--enable-library-for-ghci Enable compile library for use with GHCi
--disable-library-for-ghci Disable compile library for use with GHCi
--enable-split-objs Enable split library into smaller objects to
reduce binary sizes (GHC 6.6+)
--disable-split-objs Disable split library into smaller objects
to reduce binary sizes (GHC 6.6+)
--enable-executable-stripping Enable strip executables upon installation
to reduce binary sizes
--disable-executable-stripping Disable strip executables upon installation
to reduce binary sizes
--configure-option=OPT Extra option for configure
--user Enable doing a per-user installation
--global Disable doing a per-user installation
--package-db=PATH Use a specific package database (to satisfy
dependencies and register in)
-f --flags=FLAGS Force values for the given flags in Cabal
conditionals in the .cabal file. E.g.,
--flags="debug -usebytestrings" forces the
flag "debug" to true and "usebytestrings" to
false.
--extra-include-dirs=PATH A list of directories to search for header
files
--extra-lib-dirs=PATH A list of directories to search for external
libraries
--constraint=DEPENDENCY A list of additional constraints on the
dependencies.
--enable-tests Enable dependency checking and compilation
for test suites listed in the package
description file.
--disable-tests Disable dependency checking and compilation
for test suites listed in the package
description file.
--with-PROG=PATH give the path to PROG
--PROG-options=OPTS give extra options to PROG
--PROG-option=OPT give an extra option to PROG (no need to
quote options containing spaces)
--cabal-lib-version=VERSION Select which version of the Cabal lib to use
to build packages (useful for testing).
--preference=DEPENDENCY Specify preferences (soft constraints) on
the version of a package
--enable-documentation Enable building of documentation
--disable-documentation Disable building of documentation
--doc-index-file=TEMPLATE A central index of haddock API documentation
(template cannot use $pkgid)
--dry-run Do not install anything, only print what
would be installed.
--reinstall Install even if it means installing the same
version again.
--upgrade-dependencies Pick the latest version for all
dependencies, rather than trying to pick an
installed version.
--only-dependencies Install only the dependencies necessary to
build the given packages
--root-cmd=COMMAND Command used to gain root privileges, when
installing with --global.
--symlink-bindir=DIR Add symlinks to installed executables into
this directory.
--build-summary=TEMPLATE Save build summaries to file (name template
can use $pkgid, $compiler, $os, $arch)
--build-log=TEMPLATE Log all builds to file (name template can
use $pkgid, $compiler, $os, $arch)
--remote-build-reporting=LEVEL Generate build reports to send to a remote
server (none, anonymous or detailed).
--one-shot Do not record the packages in the world
file.
The flags --with-PROG and --PROG-option(s) can be used with the following programs:
alex ar c2hs cpphs ffihugs gcc ghc ghc-pkg greencard haddock happy hmake
hsc2hs hscolour hugs jhc ld lhc lhc-pkg nhc98 pkg-config ranlib strip tar
uhc
Examples:
cabal install Package in the current directory
cabal install foo Package from the hackage server
cabal install foo-1.0 Specific version of a package
cabal install 'foo < 2' Constrained package version
---- gem help -----
RubyGems is a sophisticated package manager for Ruby. This is a
basic help message containing pointers to more information.
Usage:
gem -h/--help
gem -v/--version
gem command [arguments...] [options...]
Examples:
gem install rake
gem list --local
gem build package.gemspec
gem help install
Further help:
gem help commands list all 'gem' commands
gem help examples show some examples of usage
gem help platforms show information about platforms
gem help <COMMAND> show help on COMMAND
(e.g. 'gem help install')
gem server present a web page at
http://localhost:8808/
with info about installed gems
Further information:
http://rubygems.rubyforge.org
---- gem help install -----
Usage: gem install GEMNAME [GEMNAME ...] [options] -- --build-flags [options]
Options:
--platform PLATFORM Specify the platform of gem to install
-v, --version VERSION Specify version of gem to install
--[no-]prerelease Allow prerelease versions of a gem
to be installed. (Only for listed gems)
Deprecated Options:
-u, --[no-]update-sources Update local source cache
Install/Update Options:
-i, --install-dir DIR Gem repository directory to get installed
gems
-n, --bindir DIR Directory where binary files are
located
-d, --[no-]rdoc Generate RDoc documentation for the gem on
install
--[no-]ri Generate RI documentation for the gem on
install
-E, --[no-]env-shebang Rewrite the shebang line on installed
scripts to use /usr/bin/env
-f, --[no-]force Force gem to install, bypassing dependency
checks
-w, --[no-]wrappers Use bin wrappers for executables
Not available on dosish platforms
-P, --trust-policy POLICY Specify gem trust policy
--ignore-dependencies Do not install any required dependent gems
-y, --include-dependencies Unconditionally install the required
dependent gems
--[no-]format-executable Make installed executable names match ruby.
If ruby is ruby18, foo_exec will be
foo_exec18
--[no-]user-install Install in user's home directory instead
of GEM_HOME.
--development Install any additional development
dependencies
--conservative Don't attempt to upgrade gems already
meeting version requirement
Local/Remote Options:
-l, --local Restrict operations to the LOCAL domain
-r, --remote Restrict operations to the REMOTE domain
-b, --both Allow LOCAL and REMOTE operations
-B, --bulk-threshold COUNT Threshold for switching to bulk
synchronization (default 1000)
--clear-sources Clear the gem sources
--source URL Add URL as a remote source for gems
-p, --[no-]http-proxy [URL] Use HTTP proxy for remote operations
Common Options:
-h, --help Get help on this command
-V, --[no-]verbose Set the verbose level of output
-q, --quiet Silence commands
--config-file FILE Use this config file instead of default
--backtrace Show stack backtrace on errors
--debug Turn on Ruby debugging
Arguments:
GEMNAME name of gem to install
Summary:
Install a gem into the local repository
Description:
The install command installs local or remote gem into a gem repository.
For gems with executables ruby installs a wrapper file into the executable
directory by default. This can be overridden with the --no-wrappers option.
The wrapper allows you to choose among alternate gem versions using
_version_.
For example `rake _0.7.3_ --version` will run rake version 0.7.3 if a newer
version is also installed.
If an extension fails to compile during gem installation the gem
specification is not written out, but the gem remains unpacked in the
repository. You may need to specify the path to the library's headers and
libraries to continue. You can do this by adding a -- between RubyGems'
options and the extension's build options:
$ gem install some_extension_gem
[build fails]
Gem files will remain installed in \
/path/to/gems/some_extension_gem-1.0 for inspection.
Results logged to /path/to/gems/some_extension_gem-1.0/gem_make.out
$ gem install some_extension_gem -- --with-extension-lib=/path/to/lib
[build succeeds]
$ gem list some_extension_gem
*** LOCAL GEMS ***
some_extension_gem (1.0)
$
If you correct the compilation errors by editing the gem files you will need
to write the specification by hand. For example:
$ gem install some_extension_gem
[build fails]
Gem files will remain installed in \
/path/to/gems/some_extension_gem-1.0 for inspection.
Results logged to /path/to/gems/some_extension_gem-1.0/gem_make.out
$ [cd /path/to/gems/some_extension_gem-1.0]
$ [edit files or what-have-you and run make]
$ gem spec ../../cache/some_extension_gem-1.0.gem --ruby > \
../../specifications/some_extension_gem-1.0.gemspec
$ gem list some_extension_gem
*** LOCAL GEMS ***
some_extension_gem (1.0)
$
Defaults:
--both --version '>= 0' --rdoc --ri --no-force
--install-dir /var/lib/gems/1.8
-------------- pip help --------------
Usage: pip help
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
-------------- pip help bundle --------------
Usage: pip bundle [options] <bundle name>.pybundle <package name> ...
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
Package Index Options:
--no-index ignore package index (only look at --find-links <url> instead)
-M, --use-mirrors use the PyPI mirrors as a fallback in case the main index is down
--mirrors <url> specific mirror <url> to query when --use-mirrors is used
-f, --find-links <url> <url> to look for packages at
-i, --index-url <url> base <url> of Python Package Index
--extra-index-url <url>
extra <url> of package indexes to use in addition to --index-url
Command options:
-U, --upgrade upgrade all packages to the newest available version
-F, --force-reinstall reinstall all packages even if they are already up-to-date
-I, --ignore-installed ignore installed packages (reinstall instead)
--no-deps ignore package dependencies
--no-install download and unpack packages only
--no-download install only already downloaded packages
--user install to user site-packages
-r, --requirement <fn> install packages from requirements file
-e, --editable <wc> install a package directly from a checkout
-t, --target <dir> install packages into <dir>
-b, --build <dir> unpack packages into <dir> and build from there
-d, --download <dir> download packages into <dir> (implies --no-download)
--download-cache <dir> cache downloaded packages in <dir>
--src <dir> checkout --editable packages into <dir>
--global-option <opts> extra global options to be supplied to setup.py (before install)
--install-option <opts>
extra arguments to pass to 'setup.py install'
-------------- pip help freeze --------------
Usage: pip freeze [options]
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
Command options:
-l, --local do not report globally-installed packages if in a virtualenv
-r, --requirement <fn> use requirements file <fn> as a hint for the new frozen requirements
-f, --find-links <url> <url> for finding packages, which will be added to the frozen
requirements file
-------------- pip help install --------------
Usage: pip install [options] <package name> ...
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
Package Index Options:
--no-index ignore package index (only look at --find-links <url> instead)
-M, --use-mirrors use the PyPI mirrors as a fallback in case the main index is down
--mirrors <url> specific mirror <url> to query when --use-mirrors is used
-f, --find-links <url> <url> to look for packages at
-i, --index-url <url> base <url> of Python Package Index
--extra-index-url <url>
extra <url> of package indexes to use in addition to --index-url
Command options:
-U, --upgrade upgrade all packages to the newest available version
-F, --force-reinstall reinstall all packages even if they are already up-to-date
-I, --ignore-installed ignore installed packages (reinstall instead)
--no-deps ignore package dependencies
--no-install download and unpack packages only
--no-download install only already downloaded packages
--user install to user site-packages
-r, --requirement <fn> install packages from requirements file
-e, --editable <wc> install a package directly from a checkout
-b, --build <dir> unpack packages into <dir> and build from there
-t, --target <dir> install packages into <dir>
-d, --download <dir> download packages into <dir> (implies --no-download)
--download-cache <dir> cache downloaded packages in <dir>
--src <dir> checkout --editable packages into <dir>
--global-option <opts> extra global options to be supplied to setup.py (before install)
--install-option <opts>
extra arguments to pass to 'setup.py install'
-------------- pip help search --------------
Usage: pip search <query>
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
Command options:
--index <url> base <url> of Python Package Index (default
http://pypi.python.org/pypi)
-------------- pip help uninstall --------------
Usage: pip uninstall [options] <package name> ...
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
Command options:
-r, --requirement <fn> uninstall all the packages listed in the given requirements file
-y, --yes assume 'yes' on all confirmation prompts
-------------- pip help unzip --------------
Usage: pip unzip [options] <package name> ...
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
Command options:
--zip zip (rather than unzip) a package
--no-pyc do not include .pyc files in zip files (useful on Google App Engine)
-l, --list list the packages available, and their zip status
--sort-files with --list, sort packages according to how many files they contain
--path <paths> restrict operations to the given paths (may include wildcards)
-n, --simulate do not actually perform the zip/unzip operation
-------------- pip help zip --------------
Usage: pip zip [options] <package name> ...
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
Command options:
--unzip unzip (rather than zip) a package
--no-pyc do not include .pyc files in zip files (useful on Google App Engine)
-l, --list list the packages available, and their zip status
--sort-files with --list, sort packages according to how many files they contain
--path <paths> restrict operations to the given paths (may include wildcards)
-n, --simulate do not actually perform the zip/unzip operation
-------------- pip help --------------
Usage: pip help
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
-------------- pip help bundle --------------
Usage: pip bundle [options] <bundle name>.pybundle <package name> ...
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
Package Index Options:
--no-index ignore package index (only look at --find-links <url> instead)
-M, --use-mirrors use the PyPI mirrors as a fallback in case the main index is down
--mirrors <url> specific mirror <url> to query when --use-mirrors is used
-f, --find-links <url> <url> to look for packages at
-i, --index-url <url> base <url> of Python Package Index
--extra-index-url <url>
extra <url> of package indexes to use in addition to --index-url
Command options:
-U, --upgrade upgrade all packages to the newest available version
-F, --force-reinstall reinstall all packages even if they are already up-to-date
-I, --ignore-installed ignore installed packages (reinstall instead)
--no-deps ignore package dependencies
--no-install download and unpack packages only
--no-download install only already downloaded packages
--user install to user site-packages
-r, --requirement <fn> install packages from requirements file
-e, --editable <wc> install a package directly from a checkout
-t, --target <dir> install packages into <dir>
-b, --build <dir> unpack packages into <dir> and build from there
-d, --download <dir> download packages into <dir> (implies --no-download)
--download-cache <dir> cache downloaded packages in <dir>
--src <dir> checkout --editable packages into <dir>
--global-option <opts> extra global options to be supplied to setup.py (before install)
--install-option <opts>
extra arguments to pass to 'setup.py install'
-------------- pip help freeze --------------
Usage: pip freeze [options]
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
Command options:
-l, --local do not report globally-installed packages if in a virtualenv
-r, --requirement <fn> use requirements file <fn> as a hint for the new frozen requirements
-f, --find-links <url> <url> for finding packages, which will be added to the frozen
requirements file
-------------- pip help install --------------
Usage: pip install [options] <package name> ...
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
Package Index Options:
--no-index ignore package index (only look at --find-links <url> instead)
-M, --use-mirrors use the PyPI mirrors as a fallback in case the main index is down
--mirrors <url> specific mirror <url> to query when --use-mirrors is used
-f, --find-links <url> <url> to look for packages at
-i, --index-url <url> base <url> of Python Package Index
--extra-index-url <url>
extra <url> of package indexes to use in addition to --index-url
Command options:
-U, --upgrade upgrade all packages to the newest available version
-F, --force-reinstall reinstall all packages even if they are already up-to-date
-I, --ignore-installed ignore installed packages (reinstall instead)
--no-deps ignore package dependencies
--no-install download and unpack packages only
--no-download install only already downloaded packages
--user install to user site-packages
-r, --requirement <fn> install packages from requirements file
-e, --editable <wc> install a package directly from a checkout
-b, --build <dir> unpack packages into <dir> and build from there
-t, --target <dir> install packages into <dir>
-d, --download <dir> download packages into <dir> (implies --no-download)
--download-cache <dir> cache downloaded packages in <dir>
--src <dir> checkout --editable packages into <dir>
--global-option <opts> extra global options to be supplied to setup.py (before install)
--install-option <opts>
extra arguments to pass to 'setup.py install'
-------------- pip help search --------------
Usage: pip search <query>
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
Command options:
--index <url> base <url> of Python Package Index (default
http://pypi.python.org/pypi)
-------------- pip help uninstall --------------
Usage: pip uninstall [options] <package name> ...
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
Command options:
-r, --requirement <fn> uninstall all the packages listed in the given requirements file
-y, --yes assume 'yes' on all confirmation prompts
-------------- pip help unzip --------------
Usage: pip unzip [options] <package name> ...
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
Command options:
--zip zip (rather than unzip) a package
--no-pyc do not include .pyc files in zip files (useful on Google App Engine)
-l, --list list the packages available, and their zip status
--sort-files with --list, sort packages according to how many files they contain
--path <paths> restrict operations to the given paths (may include wildcards)
-n, --simulate do not actually perform the zip/unzip operation
-------------- pip help zip --------------
Usage: pip zip [options] <package name> ...
General options:
-V, --version show version and exit
-v, --verbose increase verbosity
-q, --quiet decrease verbosity
--log <fn> log file (implies maximum verbosity)
--proxy <proxy> specify proxy as user:pswd@proxy.server:port
--timeout <sec> socket timeout (default 15 seconds)
--exists-action <(s)witch,(i)gnore,(w)ipe,(b)ackup>
default action for already existing paths
Command options:
--unzip unzip (rather than zip) a package
--no-pyc do not include .pyc files in zip files (useful on Google App Engine)
-l, --list list the packages available, and their zip status
--sort-files with --list, sort packages according to how many files they contain
--path <paths> restrict operations to the given paths (may include wildcards)
-n, --simulate do not actually perform the zip/unzip operation
-------------- pip help --------------
Usage: /usr/bin/pip help
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
-------------- pip help bundle --------------
Usage: /usr/bin/pip bundle [OPTIONS] BUNDLE_NAME.pybundle PACKAGE_NAMES...
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
-e VCS+REPOS_URL[@REV]#egg=PACKAGE, --editable=VCS+REPOS_URL[@REV]#egg=PACKAGE
Install a package directly from a checkout. Source
will be checked out into src/PACKAGE (lower-case) and
installed in-place (using setup.py develop). You can
run this on an existing directory/checkout (like pip
install -e src/mycheckout). This option may be
provided multiple times. Possible values for VCS are:
svn, git, hg and bzr.
-r FILENAME, --requirement=FILENAME
Install all the packages listed in the given
requirements file. This option can be used multiple
times.
-f URL, --find-links=URL
URL to look for packages at
-i URL, --index-url=URL, --pypi-url=URL
Base URL of Python Package Index (default
http://pypi.python.org/simple/)
--extra-index-url=URL
Extra URLs of package indexes to use in addition to
--index-url
--no-index Ignore package index (only looking at --find-links
URLs instead)
-M, --use-mirrors Use the PyPI mirrors as a fallback in case the main
index is down.
--mirrors=URL Specific mirror URLs to query when --use-mirrors is
used
-b DIR, --build=DIR, --build-dir=DIR, --build-directory=DIR
Unpack packages into DIR (default
/home/gv/source/pip/tests/build) and build from there
-d DIR, --download=DIR, --download-dir=DIR, --download-directory=DIR
Download packages into DIR instead of installing them
--download-cache=DIR Cache downloaded packages in DIR
--src=DIR, --source=DIR, --source-dir=DIR, --source-directory=DIR
Check out --editable packages into DIR (default
/home/gv/source/pip/tests/src)
-U, --upgrade Upgrade all packages to the newest available version
-I, --ignore-installed
Ignore the installed packages (reinstalling instead)
--no-deps, --no-dependencies
Ignore package dependencies
--no-install Download and unpack all packages, but don't actually
install them
--no-download Don't download any packages, just install the ones
already downloaded (completes an install run with
--no-install)
--install-option=INSTALL_OPTIONS
Extra arguments to be supplied to the setup.py install
command (use like --install-option="--install-
scripts=/usr/local/bin"). Use multiple --install-
option options to pass multiple options to setup.py
install. If you are using an option with a directory
path, be sure to use absolute path.
--global-option=GLOBAL_OPTIONS
Extra global options to be supplied to the
setup.pycall before the install command
--user Install to user-site
-------------- pip help freeze --------------
Usage: /usr/bin/pip freeze [OPTIONS]
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
-r FILENAME, --requirement=FILENAME
Use the given requirements file as a hint about how to
generate the new frozen requirements
-f URL, --find-links=URL
URL for finding packages, which will be added to the
frozen requirements file
-l, --local If in a virtualenv, do not report globally-installed
packages
-------------- pip help install --------------
Usage: /usr/bin/pip install [OPTIONS] PACKAGE_NAMES...
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
-e VCS+REPOS_URL[@REV]#egg=PACKAGE, --editable=VCS+REPOS_URL[@REV]#egg=PACKAGE
Install a package directly from a checkout. Source
will be checked out into src/PACKAGE (lower-case) and
installed in-place (using setup.py develop). You can
run this on an existing directory/checkout (like pip
install -e src/mycheckout). This option may be
provided multiple times. Possible values for VCS are:
svn, git, hg and bzr.
-r FILENAME, --requirement=FILENAME
Install all the packages listed in the given
requirements file. This option can be used multiple
times.
-f URL, --find-links=URL
URL to look for packages at
-i URL, --index-url=URL, --pypi-url=URL
Base URL of Python Package Index (default
http://pypi.python.org/simple/)
--extra-index-url=URL
Extra URLs of package indexes to use in addition to
--index-url
--no-index Ignore package index (only looking at --find-links
URLs instead)
-M, --use-mirrors Use the PyPI mirrors as a fallback in case the main
index is down.
--mirrors=URL Specific mirror URLs to query when --use-mirrors is
used
-b DIR, --build=DIR, --build-dir=DIR, --build-directory=DIR
Unpack packages into DIR (default
/home/gv/source/pip/tests/build) and build from there
-d DIR, --download=DIR, --download-dir=DIR, --download-directory=DIR
Download packages into DIR instead of installing them
--download-cache=DIR Cache downloaded packages in DIR
--src=DIR, --source=DIR, --source-dir=DIR, --source-directory=DIR
Check out --editable packages into DIR (default
/home/gv/source/pip/tests/src)
-U, --upgrade Upgrade all packages to the newest available version
-I, --ignore-installed
Ignore the installed packages (reinstalling instead)
--no-deps, --no-dependencies
Ignore package dependencies
--no-install Download and unpack all packages, but don't actually
install them
--no-download Don't download any packages, just install the ones
already downloaded (completes an install run with
--no-install)
--install-option=INSTALL_OPTIONS
Extra arguments to be supplied to the setup.py install
command (use like --install-option="--install-
scripts=/usr/local/bin"). Use multiple --install-
option options to pass multiple options to setup.py
install. If you are using an option with a directory
path, be sure to use absolute path.
--global-option=GLOBAL_OPTIONS
Extra global options to be supplied to the
setup.pycall before the install command
--user Install to user-site
-------------- pip help search --------------
Usage: /usr/bin/pip search QUERY
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
--index=URL Base URL of Python Package Index (default
http://pypi.python.org/pypi)
-------------- pip help uninstall --------------
Usage: /usr/bin/pip uninstall [OPTIONS] PACKAGE_NAMES ...
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
-r FILENAME, --requirement=FILENAME
Uninstall all the packages listed in the given
requirements file. This option can be used multiple
times.
-y, --yes Don't ask for confirmation of uninstall deletions.
-------------- pip help unzip --------------
Usage: /usr/bin/pip unzip [OPTIONS] PACKAGE_NAMES...
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
--zip Zip (rather than unzip) a package
--no-pyc Do not include .pyc files in zip files (useful on
Google App Engine)
-l, --list List the packages available, and their zip status
--sort-files With --list, sort packages according to how many files
they contain
--path=PATHS Restrict operations to the given paths (may include
wildcards)
-n, --simulate Do not actually perform the zip/unzip operation
-------------- pip help zip --------------
Usage: /usr/bin/pip zip [OPTIONS] PACKAGE_NAMES...
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
--unzip Unzip (rather than zip) a package
--no-pyc Do not include .pyc files in zip files (useful on
Google App Engine)
-l, --list List the packages available, and their zip status
--sort-files With --list, sort packages according to how many files
they contain
--path=PATHS Restrict operations to the given paths (may include
wildcards)
-n, --simulate Do not actually perform the zip/unzip operation
-------------- pip help --------------
Usage: /usr/bin/pip help
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
-------------- pip help bundle --------------
Usage: /usr/bin/pip bundle [OPTIONS] BUNDLE_NAME.pybundle PACKAGE_NAMES...
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
-e VCS+REPOS_URL[@REV]#egg=PACKAGE, --editable=VCS+REPOS_URL[@REV]#egg=PACKAGE
Install a package directly from a checkout. Source
will be checked out into src/PACKAGE (lower-case) and
installed in-place (using setup.py develop). You can
run this on an existing directory/checkout (like pip
install -e src/mycheckout). This option may be
provided multiple times. Possible values for VCS are:
svn, git, hg and bzr.
-r FILENAME, --requirement=FILENAME
Install all the packages listed in the given
requirements file. This option can be used multiple
times.
-f URL, --find-links=URL
URL to look for packages at
-i URL, --index-url=URL, --pypi-url=URL
Base URL of Python Package Index (default
http://pypi.python.org/simple/)
--extra-index-url=URL
Extra URLs of package indexes to use in addition to
--index-url
--no-index Ignore package index (only looking at --find-links
URLs instead)
-M, --use-mirrors Use the PyPI mirrors as a fallback in case the main
index is down.
--mirrors=URL Specific mirror URLs to query when --use-mirrors is
used
-b DIR, --build=DIR, --build-dir=DIR, --build-directory=DIR
Unpack packages into DIR (default
/home/gv/source/pip/tests/build) and build from there
-d DIR, --download=DIR, --download-dir=DIR, --download-directory=DIR
Download packages into DIR instead of installing them
--download-cache=DIR Cache downloaded packages in DIR
--src=DIR, --source=DIR, --source-dir=DIR, --source-directory=DIR
Check out --editable packages into DIR (default
/home/gv/source/pip/tests/src)
-U, --upgrade Upgrade all packages to the newest available version
-I, --ignore-installed
Ignore the installed packages (reinstalling instead)
--no-deps, --no-dependencies
Ignore package dependencies
--no-install Download and unpack all packages, but don't actually
install them
--no-download Don't download any packages, just install the ones
already downloaded (completes an install run with
--no-install)
--install-option=INSTALL_OPTIONS
Extra arguments to be supplied to the setup.py install
command (use like --install-option="--install-
scripts=/usr/local/bin"). Use multiple --install-
option options to pass multiple options to setup.py
install. If you are using an option with a directory
path, be sure to use absolute path.
--global-option=GLOBAL_OPTIONS
Extra global options to be supplied to the
setup.pycall before the install command
--user Install to user-site
-------------- pip help freeze --------------
Usage: /usr/bin/pip freeze [OPTIONS]
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
-r FILENAME, --requirement=FILENAME
Use the given requirements file as a hint about how to
generate the new frozen requirements
-f URL, --find-links=URL
URL for finding packages, which will be added to the
frozen requirements file
-l, --local If in a virtualenv, do not report globally-installed
packages
-------------- pip help install --------------
Usage: /usr/bin/pip install [OPTIONS] PACKAGE_NAMES...
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
-e VCS+REPOS_URL[@REV]#egg=PACKAGE, --editable=VCS+REPOS_URL[@REV]#egg=PACKAGE
Install a package directly from a checkout. Source
will be checked out into src/PACKAGE (lower-case) and
installed in-place (using setup.py develop). You can
run this on an existing directory/checkout (like pip
install -e src/mycheckout). This option may be
provided multiple times. Possible values for VCS are:
svn, git, hg and bzr.
-r FILENAME, --requirement=FILENAME
Install all the packages listed in the given
requirements file. This option can be used multiple
times.
-f URL, --find-links=URL
URL to look for packages at
-i URL, --index-url=URL, --pypi-url=URL
Base URL of Python Package Index (default
http://pypi.python.org/simple/)
--extra-index-url=URL
Extra URLs of package indexes to use in addition to
--index-url
--no-index Ignore package index (only looking at --find-links
URLs instead)
-M, --use-mirrors Use the PyPI mirrors as a fallback in case the main
index is down.
--mirrors=URL Specific mirror URLs to query when --use-mirrors is
used
-b DIR, --build=DIR, --build-dir=DIR, --build-directory=DIR
Unpack packages into DIR (default
/home/gv/source/pip/tests/build) and build from there
-d DIR, --download=DIR, --download-dir=DIR, --download-directory=DIR
Download packages into DIR instead of installing them
--download-cache=DIR Cache downloaded packages in DIR
--src=DIR, --source=DIR, --source-dir=DIR, --source-directory=DIR
Check out --editable packages into DIR (default
/home/gv/source/pip/tests/src)
-U, --upgrade Upgrade all packages to the newest available version
-I, --ignore-installed
Ignore the installed packages (reinstalling instead)
--no-deps, --no-dependencies
Ignore package dependencies
--no-install Download and unpack all packages, but don't actually
install them
--no-download Don't download any packages, just install the ones
already downloaded (completes an install run with
--no-install)
--install-option=INSTALL_OPTIONS
Extra arguments to be supplied to the setup.py install
command (use like --install-option="--install-
scripts=/usr/local/bin"). Use multiple --install-
option options to pass multiple options to setup.py
install. If you are using an option with a directory
path, be sure to use absolute path.
--global-option=GLOBAL_OPTIONS
Extra global options to be supplied to the
setup.pycall before the install command
--user Install to user-site
-------------- pip help search --------------
Usage: /usr/bin/pip search QUERY
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
--index=URL Base URL of Python Package Index (default
http://pypi.python.org/pypi)
-------------- pip help uninstall --------------
Usage: /usr/bin/pip uninstall [OPTIONS] PACKAGE_NAMES ...
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
-r FILENAME, --requirement=FILENAME
Uninstall all the packages listed in the given
requirements file. This option can be used multiple
times.
-y, --yes Don't ask for confirmation of uninstall deletions.
-------------- pip help unzip --------------
Usage: /usr/bin/pip unzip [OPTIONS] PACKAGE_NAMES...
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
--zip Zip (rather than unzip) a package
--no-pyc Do not include .pyc files in zip files (useful on
Google App Engine)
-l, --list List the packages available, and their zip status
--sort-files With --list, sort packages according to how many files
they contain
--path=PATHS Restrict operations to the given paths (may include
wildcards)
-n, --simulate Do not actually perform the zip/unzip operation
-------------- pip help zip --------------
Usage: /usr/bin/pip zip [OPTIONS] PACKAGE_NAMES...
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-E DIR, --environment=DIR
virtualenv environment to run pip in (either give the
interpreter or the environment base directory)
-s, --enable-site-packages
Include site-packages in virtualenv if one is to be
created. Ignored if --environment is not used or the
virtualenv already exists.
-v, --verbose Give more output
-q, --quiet Give less output
--log=FILENAME Log file where a complete (maximum verbosity) record
will be kept
--proxy=PROXY Specify a proxy in the form
user:passwd@proxy.server:port. Note that the
user:password@ is optional and required only if you
are behind an authenticated proxy. If you provide
user@proxy.server:port then you will be prompted for a
password.
--timeout=SECONDS, --default-timeout=SECONDS
Set the socket timeout (default 15 seconds)
--unzip Unzip (rather than zip) a package
--no-pyc Do not include .pyc files in zip files (useful on
Google App Engine)
-l, --list List the packages available, and their zip status
--sort-files With --list, sort packages according to how many files
they contain
--path=PATHS Restrict operations to the given paths (may include
wildcards)
-n, --simulate Do not actually perform the zip/unzip operation
@gvalkov
Copy link
Author

gvalkov commented Nov 10, 2012

$ gem
RubyGems is a sophisticated package manager for Ruby. This is a
basic help message containing pointers to more information.

Usage:
gem -h/--help
gem -v/--version
gem command [arguments...] [options...]

Examples:
gem install rake
gem list --local
gem build package.gemspec
gem help install

Further help:
gem help commands list all 'gem' commands
gem help examples show some examples of usage
gem help platforms show information about platforms
gem help show help on COMMAND
(e.g. 'gem help install')
gem server present a web page at
http://localhost:8808/
with info about installed gems
Further information:
http://rubygems.rubyforge.org

$ gem help install
Usage: gem install GEMNAME [GEMNAME ...] [options] -- --build-flags [options]

Options:
--platform PLATFORM Specify the platform of gem to install
-v, --version VERSION Specify version of gem to install
--[no-]prerelease Allow prerelease versions of a gem
to be installed. (Only for listed gems)

Deprecated Options:
-u, --[no-]update-sources Update local source cache

Install/Update Options:
-i, --install-dir DIR Gem repository directory to get installed
gems
-n, --bindir DIR Directory where binary files are
located
-d, --[no-]rdoc Generate RDoc documentation for the gem on
install
--[no-]ri Generate RI documentation for the gem on
install
-E, --[no-]env-shebang Rewrite the shebang line on installed
scripts to use /usr/bin/env
-f, --[no-]force Force gem to install, bypassing dependency
checks
-w, --[no-]wrappers Use bin wrappers for executables
Not available on dosish platforms
-P, --trust-policy POLICY Specify gem trust policy
--ignore-dependencies Do not install any required dependent gems
-y, --include-dependencies Unconditionally install the required
dependent gems
--[no-]format-executable Make installed executable names match ruby.
If ruby is ruby18, foo_exec will be
foo_exec18
--[no-]user-install Install in user's home directory instead
of GEM_HOME.
--development Install any additional development
dependencies
--conservative Don't attempt to upgrade gems already
meeting version requirement

Local/Remote Options:
-l, --local Restrict operations to the LOCAL domain
-r, --remote Restrict operations to the REMOTE domain
-b, --both Allow LOCAL and REMOTE operations
-B, --bulk-threshold COUNT Threshold for switching to bulk
synchronization (default 1000)
--clear-sources Clear the gem sources
--source URL Add URL as a remote source for gems
-p, --[no-]http-proxy [URL] Use HTTP proxy for remote operations

Common Options:
-h, --help Get help on this command
-V, --[no-]verbose Set the verbose level of output
-q, --quiet Silence commands
--config-file FILE Use this config file instead of default
--backtrace Show stack backtrace on errors
--debug Turn on Ruby debugging

Arguments:
GEMNAME name of gem to install

Summary:
Install a gem into the local repository

Description:
The install command installs local or remote gem into a gem repository.

For gems with executables ruby installs a wrapper file into the executable
directory by default.  This can be overridden with the --no-wrappers option.
The wrapper allows you to choose among alternate gem versions using
_version_.

For example `rake _0.7.3_ --version` will run rake version 0.7.3 if a newer
version is also installed.

If an extension fails to compile during gem installation the gem
specification is not written out, but the gem remains unpacked in the
repository.  You may need to specify the path to the library's headers and
libraries to continue.  You can do this by adding a -- between RubyGems'
options and the extension's build options:

  $ gem install some_extension_gem
  [build fails]
  Gem files will remain installed in \
  /path/to/gems/some_extension_gem-1.0 for inspection.
  Results logged to /path/to/gems/some_extension_gem-1.0/gem_make.out
  $ gem install some_extension_gem -- --with-extension-lib=/path/to/lib
  [build succeeds]
  $ gem list some_extension_gem

  *** LOCAL GEMS ***

  some_extension_gem (1.0)
  $

If you correct the compilation errors by editing the gem files you will need
to write the specification by hand.  For example:

  $ gem install some_extension_gem
  [build fails]
  Gem files will remain installed in \
  /path/to/gems/some_extension_gem-1.0 for inspection.
  Results logged to /path/to/gems/some_extension_gem-1.0/gem_make.out
  $ [cd /path/to/gems/some_extension_gem-1.0]
  $ [edit files or what-have-you and run make]
  $ gem spec ../../cache/some_extension_gem-1.0.gem --ruby > \
             ../../specifications/some_extension_gem-1.0.gemspec
  $ gem list some_extension_gem

  *** LOCAL GEMS ***

  some_extension_gem (1.0)
  $

Defaults:
--both --version '>= 0' --rdoc --ri --no-force
--install-dir /home/gv/.gem/ruby/1.9.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment