Skip to content

Commit 5507739

Browse files
committed
Added docs for the toggleglobalsitepackages command
1 parent 0359a7c commit 5507739

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/en/command_ref.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,3 +364,31 @@ The directory names are added to a path file named
364364
for the environment.
365365

366366
*Based on a contribution from James Bennett and Jannis Leidel.*
367+
368+
toggleglobalsitepackages
369+
------------------------
370+
371+
Toggles the state of the currently active virtualenv's access to the packages
372+
in the global python ``site-packages`` directory.
373+
374+
Syntax::
375+
376+
toggleglobalsitepackages [-q]
377+
378+
Outputs the new state of the virtualenv. Use the ``-q`` switch to turn off all
379+
output.
380+
381+
::
382+
383+
$ mkvirtualenv env1
384+
New python executable in env1/bin/python
385+
Installing distribute.............................................
386+
..................................................................
387+
..................................................................
388+
done.
389+
(env1)$ toggleglobalsitepackages
390+
Disabled global site-packages
391+
(env1)$ toggleglobalsitepackages
392+
Enabled global site-packages
393+
(env1)$ toggleglobalsitepackages -q
394+
(env1)$

0 commit comments

Comments
 (0)