Commits

Paul McLanahan  committed b3c46db

Added docs for the toggleglobalsitepackages command

  • Participants
  • Parent commits 5426faf

Comments (0)

Files changed (1)

File docs/en/command_ref.rst

 for the environment.
 
 *Based on a contribution from James Bennett and Jannis Leidel.*
+
+toggleglobalsitepackages
+------------------------
+
+Toggles the state of the currently active virtualenv's access to the packages
+in the global python ``site-packages`` directory.
+
+Syntax::
+
+    toggleglobalsitepackages [-q]
+
+Outputs the new state of the virtualenv. Use the ``-q`` switch to turn off all
+output.
+
+::
+
+    $ mkvirtualenv env1
+    New python executable in env1/bin/python
+    Installing distribute.............................................
+    ..................................................................
+    ..................................................................
+    done.
+    (env1)$ toggleglobalsitepackages
+    Disabled global site-packages
+    (env1)$ toggleglobalsitepackages
+    Enabled global site-packages
+    (env1)$ toggleglobalsitepackages -q
+    (env1)$