summaryrefslogtreecommitdiff
path: root/docs/reference/pip_freeze.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/pip_freeze.rst')
-rw-r--r--docs/reference/pip_freeze.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/reference/pip_freeze.rst b/docs/reference/pip_freeze.rst
new file mode 100644
index 000000000..360b69dfc
--- /dev/null
+++ b/docs/reference/pip_freeze.rst
@@ -0,0 +1,46 @@
+
+.. _`pip freeze`:
+
+pip freeze
+-----------
+
+.. contents::
+
+Usage
+*****
+
+.. pip-command-usage:: freeze
+
+
+Description
+***********
+
+.. pip-command-description:: freeze
+
+
+Options
+*******
+
+.. pip-command-options:: freeze
+
+
+Examples
+********
+
+1) Generate output suitable for a requirements file.
+
+ ::
+
+ $ pip freeze
+ Jinja2==2.6
+ Pygments==1.5
+ Sphinx==1.1.3
+ docutils==0.9.1
+
+
+2) Generate a requirements file and then install from it in another environment.
+
+ ::
+
+ $ env1/bin/pip freeze > requirements.txt
+ $ env2/bin/pip install -r requirements.txt