File: pip.1

package info (click to toggle)
python-pip 18.1-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 5,564 kB
  • sloc: python: 67,021; sh: 77; makefile: 68
file content (137 lines) | stat: -rw-r--r-- 3,997 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
'\" t
.\"     Title: pip
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 05/27/2012
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "PIP" "1" "05/27/2012" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
pip \- install Python packages
.SH "SYNOPSIS"
.sp
\fBpip\fR [\fIcommand\fR] [\fIoptions\fR]
.sp
\fBpip\fIX\fR [\fIcommand\fR] [\fIoptions\fR]
.SH "DESCRIPTION"
.sp
pip is an alternative Python package installer\&. It performs the same basic job as easy_install, but with some extra features\&. It can work with version control repositories (currently only Git, Mercurial, and Bazaar repositories), logs output extensively, and prevents partial installs by downloading all requirements before starting installation\&.
.sp
It has some disadvantages when compared to easy_install\&. It does not use egg files, although it does preserve egg metadata\&. Some setuptools features are not yet supported, and some custom setup\&.py features won\(aat work\&.
.SH "COMMANDS"
.sp
The command comes before any options\&. The following commands are recognized:
.PP
\fBhelp\fR
.RS 4
Show the help text\&.
.RE
.PP
\fBbundle\fR
.RS 4
Create "bundles" which can be used by pip to install the group of Python packages in multiple places\&.
.RE
.PP
\fBfreeze\fR
.RS 4
Write the current list of installed packages to a requirements file, which can be used by pip to reinstall the same set of packages\&.
.RE
.PP
\fBinstall\fR
.RS 4
Install packages\&.
.RE
.PP
\fBunzip\fR
.RS 4
Unzip an individual package\&.
.RE
.PP
\fBzip\fR
.RS 4
Zip an individual package\&.
.RE
.SH "OPTIONS"
.PP
\fB\-h, \-\-help\fR
.RS 4
Show summary of options\&.
.RE
.PP
\fB\-\-version\fR
.RS 4
Show the version of the program\&.
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Be more verbose\&.
.RE
.PP
\fB\-q, \-\-quiet\fR
.RS 4
Be less verbose; suppress unimportant output\&.
.RE
.PP
\fB\-\-log\fR=\fIFILENAME\fR
.RS 4
Log file where a complete (maximum verbosity) record will be kept\&.
.RE
.PP
\fB\-\-proxy\fR=\fIPROXY\fR
.RS 4
Have pip use a proxy server to access sites\&. This can be specified using "user:password@proxy\&.server:port" notation\&. If the password is left out, pip will ask for it\&.
.RE
.PP
\fB\-\-exists\-action\fR=\fIEXISTS_ACTION\fR
.RS 4
Default action when a path already exists\&.Use this option more then one time to specify another action if a certain option is not available, choices: (s)witch, (i)gnore, (w)ipe, (b)ackup
.RE
.PP
\fB\-\-timeout\fR=\fITIMEOUT\fR
.RS 4
Set the timeout for connecting to download sites, in seconds\&. This defaults to 15 seconds if not given\&.
.RE
.SH "AUTHORS"
.sp
.if n \{\
.RS 4
.\}
.nf
This manual page was originally written by Jeff Licquia <licquia@debian\&.org>, later rewritten by Carl Chenet <chaica@debian\&.org>\&.
.fi
.if n \{\
.RE
.\}
.SH "LICENSE"
.sp
.if n \{\
.RS 4
.\}
.nf
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, version 3 or any later version published by the Free Software Foundation\&.
.fi
.if n \{\
.RE
.\}