]> granicus.if.org Git - python/commitdiff
#5015: document PythonHome API functions.
authorGeorg Brandl <georg@python.org>
Thu, 5 Feb 2009 11:32:18 +0000 (11:32 +0000)
committerGeorg Brandl <georg@python.org>
Thu, 5 Feb 2009 11:32:18 +0000 (11:32 +0000)
Doc/c-api/init.rst

index 327aed72ea4bb35dcfb03da0df522fe76e392892..ec6207baf4d1604deba5b3dc1f4b497a92292374 100644 (file)
@@ -369,6 +369,20 @@ Initialization, Finalization, and Threads
       check w/ Guido.
 
 
+.. cfunction:: void Py_SetPythonHome(char *home)
+
+   Set the default "home" directory, that is, the location of the standard
+   Python libraries.  The libraries are searched in
+   :file:`{home}/lib/python{version}` and :file:`{home}/lib/python{version}`.
+
+
+.. cfunction:: char* Py_GetPythonHome()
+
+   Return the default "home", that is, the value set by a previous call to
+   :cfunc:`Py_SetPythonHome`, or the value of the :envvar:`PYTHONHOME`
+   environment variable if it is set.
+
+
 .. _threads:
 
 Thread State and the Global Interpreter Lock