@@ -43,6 +43,8 @@ when creating a virtual environment) or after explicitly uninstalling
43
43
Command line interface
44
44
----------------------
45
45
46
+ .. program :: ensurepip
47
+
46
48
The command line interface is invoked using the interpreter's ``-m `` switch.
47
49
48
50
The simplest possible invocation is::
@@ -61,26 +63,34 @@ By default, ``pip`` is installed into the current virtual environment
61
63
active virtual environment). The installation location can be controlled
62
64
through two additional command line options:
63
65
64
- * :samp: `--root { dir } `: Installs ``pip `` relative to the given root directory
65
- rather than the root of the currently active virtual environment (if any)
66
- or the default root for the current Python installation.
67
- * ``--user ``: Installs ``pip `` into the user site packages directory rather
68
- than globally for the current Python installation (this option is not
69
- permitted inside an active virtual environment).
66
+ .. option :: --root <dir >
67
+
68
+ Installs ``pip `` relative to the given root directory rather than the root
69
+ of the currently active virtual environment (if any) or the default root
70
+ for the current Python installation.
71
+
72
+ .. option :: --user
73
+
74
+ Installs ``pip `` into the user site packages directory rather than globally
75
+ for the current Python installation (this option is not permitted inside an
76
+ active virtual environment).
70
77
71
78
By default, the scripts ``pipX `` and ``pipX.Y `` will be installed (where
72
79
X.Y stands for the version of Python used to invoke ``ensurepip ``). The
73
80
scripts installed can be controlled through two additional command line
74
81
options:
75
82
76
- * ``--altinstall ``: if an alternate installation is requested, the ``pipX ``
77
- script will *not * be installed.
83
+ .. option :: --altinstall
78
84
79
- * `` --default-pip ``: if a "default pip" installation is requested, the
80
- `` pip `` script will be installed in addition to the two regular scripts .
85
+ If an alternate installation is requested, the `` pipX `` script will * not * be
86
+ installed.
81
87
82
- Providing both of the script selection options will trigger an exception.
88
+ .. option :: --default-pip
89
+
90
+ If a "default pip" installation is requested, the ``pip `` script will be
91
+ installed in addition to the two regular scripts.
83
92
93
+ Providing both of the script selection options will trigger an exception.
84
94
85
95
Module API
86
96
----------
@@ -136,3 +146,4 @@ Module API
136
146
``pip ``, but other software should not assume those dependencies will
137
147
always be present by default (as the dependencies may be removed in a
138
148
future version of ``pip ``).
149
+
0 commit comments