SF.net SVN: matplotlib: [5440] trunk/matplotlib/doc/faq/ environment_variables_faq.rst

[<ds...@us...>]

Revision: 5440
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5440&view=rev
Author:   dsdale
Date:     2008-06-09 12:52:11 -0700 (Mon, 09 Jun 2008)

Log Message:
-----------
updated the environment variables FAQ

Modified Paths:
--------------
    trunk/matplotlib/doc/faq/environment_variables_faq.rst

Modified: trunk/matplotlib/doc/faq/environment_variables_faq.rst
===================================================================
--- trunk/matplotlib/doc/faq/environment_variables_faq.rst	2008-06-09 18:15:08 UTC (rev 5439)
+++ trunk/matplotlib/doc/faq/environment_variables_faq.rst	2008-06-09 19:52:11 UTC (rev 5440)
@@ -4,22 +4,77 @@
 Environment Variables
 *********************
 
+.. envvar:: HOME
+
+  The user's home directory. On linux, :envvar:`~ <HOME>` is shorthand for :envvar:`HOME`.
+
 .. envvar:: PATH
 
   The list of directories searched to find executable programs
 
 .. envvar:: PYTHONPATH
 
-  The list of directories that is searched to find Python packages and modules
+  The list of directories that is added to Python's standard search list when
+  importing packages and modules
 
 
-Setting Environment Variables
-=============================
+Setting Environment Variables in Linux
+======================================
 
-Linux/OS-X
-----------
+To list the current value of :envvar:`PYTHONPATH`, which may be empty, try::
 
+  echo $PYTHONPATH
 
+The procedure for setting environment variables in depends on what your default
+shell is. BASH seems to be the most common, but CSH is also common. You
+should be able to determine which by running at the command prompt::
 
-Windows
--------
+  echo $SHELL
+  
+
+BASH/KSH
+--------
+
+To create a new environment variable::
+
+  export PYTHONPATH=~/Python
+
+To prepend to an existing environment variable::
+
+  export PATH=~/bin:${PATH}
+
+The search order may be important to you, do you want `~/bin` to be searched
+first or last? To append to an existing environment variable::
+
+  export PATH=${PATH}:~/bin
+
+To make your changes available in the future, add the commands to your
+`~/.bashrc` file.
+
+
+CSH/TCSH
+--------
+
+To create a new environment variable::
+
+  setenv PYTHONPATH ~/Python
+
+To prepend to an existing environment variable::
+
+  setenv PATH ~/bin:${PATH}
+
+The search order may be important to you, do you want `~/bin` to be searched
+first or last? To append to an existing environment variable::
+
+  setenv PATH ${PATH}:~/bin
+
+To make your changes available in the future, add the commands to your
+`~/.cshrc` file.
+
+
+Setting Environment Variables in Windows
+========================================
+
+Go to the Windows start menu, select `Control Panel`, then select the `System`
+icon, click the `Advanced` tab, and select the `Environment Variables`
+button. You can edit or add to the `user variables`.
\ No newline at end of file


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.