Skip to content

Commit 415ea28

Browse files
committed
add link to powershell port
1 parent 26a864c commit 415ea28

File tree

1 file changed

+48
-29
lines changed

1 file changed

+48
-29
lines changed

docs/en/install.rst

Lines changed: 48 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,59 @@ Supported Shells
88
================
99

1010
virtualenvwrapper is a set of shell *functions* defined in Bourne
11-
shell compatible syntax. It is tested under `bash`, `ksh`, and `zsh`.
11+
shell compatible syntax. Its automated tests run under these
12+
shells on OS X and Linux:
13+
14+
* ``bash``
15+
* ``ksh``
16+
* ``zsh``
17+
1218
It may work with other shells, so if you find that it does work with a
1319
shell not listed here please let me know. If you can modify it to
14-
work with another shell, without completely rewriting it, send a pull
15-
request through the bitbucket project page. If you write a clone to
20+
work with another shell without completely rewriting it, then send a pull
21+
request through the `bitbucket project page`_. If you write a clone to
1622
work with an incompatible shell, let me know and I will link to it
1723
from this page.
1824

25+
.. _bitbucket project page: https://bitbucket.org/dhellmann/virtualenvwrapper/
26+
27+
MSYS
28+
----
29+
30+
It is possible to use virtualenv wrapper under `MSYS
31+
<http://www.mingw.org/wiki/MSYS>`_ with a native Windows Python
32+
installation. In order to make it work, you need to define an extra
33+
environment variable named ``MSYS_HOME`` containing the root path to
34+
the MSYS installation.
35+
36+
::
37+
38+
export WORKON_HOME=$HOME/.virtualenvs
39+
export MSYS_HOME=/c/msys/1.0
40+
source /usr/local/bin/virtualenvwrapper.sh
41+
42+
or::
43+
44+
export WORKON_HOME=$HOME/.virtualenvs
45+
export MSYS_HOME=C:\msys\1.0
46+
source /usr/local/bin/virtualenvwrapper.sh
47+
48+
Depending on your MSYS setup, you may need to install the `MSYS mktemp
49+
binary`_ in the ``MSYS_HOME/bin`` folder.
50+
51+
.. _MSYS mktemp binary: http://sourceforge.net/projects/mingw/files/MSYS/mktemp/
52+
53+
PowerShell
54+
----------
55+
56+
Guillermo López-Anglada has ported virtualenvwrapper to run under
57+
Microsoft's PowerShell. We have agreed that since it is not compatible
58+
with the rest of the extensions, and is largely a re-implementation
59+
(rather than an adaptation), it should be distributed separately. You
60+
can download virtualenvwrapper-powershell_ from PyPI.
61+
62+
.. _virtualenvwrapper-powershell: http://pypi.python.org/pypi/virtualenvwrapper-powershell/2.7.1
63+
1964
.. _supported-versions:
2065

2166
Python Versions
@@ -196,29 +241,3 @@ supported. In your startup file, change ``source
196241
/usr/local/bin/virtualenvwrapper.sh``.
197242

198243
.. _pip: http://pypi.python.org/pypi/pip
199-
200-
Using virtualenvwrapper Under MSys
201-
==================================
202-
203-
It is possible to use virtualenv wrapper under `MSYS
204-
<http://www.mingw.org/wiki/MSYS>`_ with a native Windows Python
205-
installation. In order to make it work, you need to define an extra
206-
environment variable named ``MSYS_HOME`` containing the root path to
207-
the MSYS installation.
208-
209-
::
210-
211-
export WORKON_HOME=$HOME/.virtualenvs
212-
export MSYS_HOME=/c/msys/1.0
213-
source /usr/local/bin/virtualenvwrapper.sh
214-
215-
or::
216-
217-
export WORKON_HOME=$HOME/.virtualenvs
218-
export MSYS_HOME=C:\msys\1.0
219-
source /usr/local/bin/virtualenvwrapper.sh
220-
221-
Depending on your MSYS setup, you may need to install the `MSYS mktemp
222-
binary`_ in the ``MSYS_HOME/bin`` folder.
223-
224-
.. _MSYS mktemp binary: http://sourceforge.net/projects/mingw/files/MSYS/mktemp/

0 commit comments

Comments
 (0)