summaryrefslogtreecommitdiff
path: root/docs/docbook/smbdotconf/misc/sourceenvironment.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docbook/smbdotconf/misc/sourceenvironment.xml')
-rw-r--r--docs/docbook/smbdotconf/misc/sourceenvironment.xml27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/docbook/smbdotconf/misc/sourceenvironment.xml b/docs/docbook/smbdotconf/misc/sourceenvironment.xml
new file mode 100644
index 0000000000..c6b4ce368f
--- /dev/null
+++ b/docs/docbook/smbdotconf/misc/sourceenvironment.xml
@@ -0,0 +1,27 @@
+<samba:parameter name="source environment"
+ context="G"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>This parameter causes Samba to set environment
+ variables as per the content of the file named.</para>
+
+ <para>If the value of this parameter starts with a &quot;|&quot; character
+ then Samba will treat that value as a pipe command to open and
+ will set the environment variables from the output of the pipe.</para>
+
+ <para>The contents of the file or the output of the pipe should
+ be formatted as the output of the standard Unix <command moreinfo="none">env(1)</command> command. This is of the form:</para>
+
+ <para>Example environment entry:</para>
+
+ <para><command moreinfo="none">SAMBA_NETBIOS_NAME = myhostname</command></para>
+
+ <para>Default: <emphasis>No default value</emphasis></para>
+
+ <para>Examples: <command moreinfo="none">source environment = |/etc/smb.conf.sh</command></para>
+
+ <para>Example: <command moreinfo="none">source environment =
+ /usr/local/smb_env_vars</command></para>
+</listitem>
+</samba:parameter>