From ae13f4759fd47c0db36c8a3bd9759e01d709ee02 Mon Sep 17 00:00:00 2001
From: Peter Lemenkov <lemenkov@gmail.com>
Date: Sat, 8 Nov 2014 15:11:04 +0300
Subject: Introduce os:getenv/2

Signed-off-by: Peter Lemenkov <lemenkov@gmail.com>
---
 lib/kernel/doc/src/os.xml | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'lib/kernel/doc/src/os.xml')

diff --git a/lib/kernel/doc/src/os.xml b/lib/kernel/doc/src/os.xml
index 2b57e75023..8b85f24455 100644
--- a/lib/kernel/doc/src/os.xml
+++ b/lib/kernel/doc/src/os.xml
@@ -99,6 +99,19 @@ DirOut = os:cmd("dir"), % on Win32 platform</code>
 	<c><anno>Value</anno></c>) may contain characters with codepoints > 255.</p>
       </desc>
     </func>
+    <func>
+      <name name="getenv" arity="2"/>
+      <fsummary>Get the value of an environment variable</fsummary>
+      <desc>
+        <p>Returns the <c><anno>Value</anno></c> of the environment variable
+          <c><anno>VarName</anno></c>, or <c>DefaultValue</c> if the environment variable
+          is undefined.</p>
+	<p>If Unicode file name encoding is in effect (see the <seealso
+	marker="erts:erl#file_name_encoding">erl manual
+	page</seealso>), the strings (both <c><anno>VarName</anno></c> and
+	<c><anno>Value</anno></c>) may contain characters with codepoints > 255.</p>
+      </desc>
+    </func>
     <func>
       <name name="getpid" arity="0"/>
       <fsummary>Return the process identifier of the emulator process</fsummary>
-- 
cgit v1.2.3