summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcus Smith <qwcode@gmail.com>2014-04-08 22:57:22 -0700
committerMarcus Smith <qwcode@gmail.com>2014-07-21 20:47:24 -0700
commit24952b32d3753dc6df4966c79ce734f8a3b1f3bc (patch)
treebaa1e501e703d380cf078f6b3286daebcbddcbc7
parentf78d128af8d189f7377da98d55e10e30f0dda42a (diff)
downloadpip-24952b32d3753dc6df4966c79ce734f8a3b1f3bc.tar.gz
get-pip.py option examples
Conflicts: docs/installing.rst
-rw-r--r--docs/installing.rst17
-rw-r--r--docs/reference/pip_install.rst1
2 files changed, 17 insertions, 1 deletions
diff --git a/docs/installing.rst b/docs/installing.rst
index caf4e7c83..f6e8a8396 100644
--- a/docs/installing.rst
+++ b/docs/installing.rst
@@ -30,11 +30,26 @@ Then run the following (which may require administrator access)::
If `setuptools`_ (or `distribute`_) is not already installed, ``get-pip.py`` will
install `setuptools`_ for you. [2]_
-To upgrade an existing `setuptools`_ (or `distribute`_), run ``pip install -U setuptools`` [3]_
+Additionally, ``get-pip.py`` supports using the :ref:`pip install options <pip
+install Options>` and the :ref:`General Options`. Below are some examples:
+
+::
+
+ # Install from local copies of pip and setuptools
+ python get-pip.py --no-index --find-links=/local/copies
+
+ # Install to the user site
+ python get-pip.py --user
+
+ # Install behind a proxy
+ python get-pip.py --proxy="[user:passwd@]proxy.server:port"
To enable the use of pip from the command line, ensure the ``Scripts`` subdirectory of
your Python installation is available on the system PATH. (This is not done automatically.)
+To upgrade an existing `setuptools`_ (or `distribute`_), run ``pip install -U setuptools`` [3]_
+
+
Upgrade pip
-----------
diff --git a/docs/reference/pip_install.rst b/docs/reference/pip_install.rst
index 11c596df6..06c003ae9 100644
--- a/docs/reference/pip_install.rst
+++ b/docs/reference/pip_install.rst
@@ -338,6 +338,7 @@ To have the dependency located from a local directory and not crawl PyPI, add th
find_links = file:///path/to/local/archives
+.. _`pip install Options`:
Options
*******