diff options
author | Marcus Smith <qwcode@gmail.com> | 2014-04-09 16:53:52 -0700 |
---|---|---|
committer | Marcus Smith <qwcode@gmail.com> | 2014-07-21 20:51:44 -0700 |
commit | 6adbab3d9e7d82870ce2000da5bf401318aa0c7a (patch) | |
tree | ca848a6969e9ca19e4ea62aeaa45fa561aa789b0 | |
parent | 24952b32d3753dc6df4966c79ce734f8a3b1f3bc (diff) | |
download | pip-6adbab3d9e7d82870ce2000da5bf401318aa0c7a.tar.gz |
break out the examples so we can add a qualifying footnote for --user installs
Conflicts:
docs/installing.rst
-rw-r--r-- | docs/installing.rst | 33 |
1 files changed, 21 insertions, 12 deletions
diff --git a/docs/installing.rst b/docs/installing.rst index f6e8a8396..0bfd60afa 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -30,24 +30,27 @@ 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]_ + +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.) + Additionally, ``get-pip.py`` supports using the :ref:`pip install options <pip -install Options>` and the :ref:`General Options`. Below are some examples: +install Options>` and the :ref:`general options <General Options>`. Below are +some examples: -:: +Install from local copies of pip and setuptools:: - # 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 to the user site [4]_:: - # Install behind a proxy - python get-pip.py --proxy="[user:passwd@]proxy.server:port" + python get-pip.py --user -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.) +Install behind a proxy:: -To upgrade an existing `setuptools`_ (or `distribute`_), run ``pip install -U setuptools`` [3]_ + python get-pip.py --proxy="[user:passwd@]proxy.server:port" Upgrade pip @@ -60,7 +63,7 @@ On Linux or OS X: pip install -U pip -On Windows [4]_: +On Windows [5]_: :: @@ -99,7 +102,13 @@ On Fedora:: package that depends on setuptools or distribute. See :doc:`here for details <distribute_setuptools>`. -.. [4] https://github.com/pypa/pip/issues/1299 +.. [4] The pip developers are considering making ``--user`` the default for all + installs, including ``get-pip.py`` installs of pip, but at this time, + ``--user`` installs for pip itself, should not be considered to be fully + tested or endorsed. For discussion, see `Issue 1668 + <https://github.com/pypa/pip/issues/1668>`_. + +.. [5] https://github.com/pypa/pip/issues/1299 .. _setuptools: https://pypi.python.org/pypi/setuptools .. _distribute: https://pypi.python.org/pypi/distribute |