summaryrefslogtreecommitdiff
path: root/docs-xml
diff options
context:
space:
mode:
authorStefan Metzmacher <metze@samba.org>2020-05-07 12:04:00 +0200
committerStefan Metzmacher <metze@samba.org>2020-05-07 16:23:39 +0000
commitafd3bd01eb463081cb85724260a0840cd98b38c2 (patch)
treec097f912bc2c3d9fa7d67abaf54c6dc4ad44a4dc /docs-xml
parentfe3380d369c2a528f89da5a047235420cec63b4d (diff)
downloadsamba-afd3bd01eb463081cb85724260a0840cd98b38c2.tar.gz
docs-xml/smbdotconf: clarify the quoting for advanced "interfaces" options
Signed-off-by: Stefan Metzmacher <metze@samba.org> Reviewed-by: Ralph Boehme <slow@samba.org> Autobuild-User(master): Stefan Metzmacher <metze@samba.org> Autobuild-Date(master): Thu May 7 16:23:40 UTC 2020 on sn-devel-184
Diffstat (limited to 'docs-xml')
-rw-r--r--docs-xml/smbdotconf/base/interfaces.xml20
1 files changed, 16 insertions, 4 deletions
diff --git a/docs-xml/smbdotconf/base/interfaces.xml b/docs-xml/smbdotconf/base/interfaces.xml
index b804e64be9e..cbc29712385 100644
--- a/docs-xml/smbdotconf/base/interfaces.xml
+++ b/docs-xml/smbdotconf/base/interfaces.xml
@@ -41,12 +41,13 @@
<para>
In order to support SMB3 multi-channel configurations, smbd understands
- some extra data that can be appended after the actual interface with
- this extended syntax:
+ some extra parameters which can be appended after the actual interface with
+ this extended syntax (note that the quoting is important in order to handle the ; and ,
+ characters):
</para>
<para>
- interface[;key1=value1[,key2=value2[...]]]
+ &quot;interface[;key1=value1[,key2=value2[...]]]&quot;
</para>
<para>
@@ -58,18 +59,29 @@
development rather than for production use. At least on Linux systems,
these values should be auto-detected, but the settings can serve
as last a resort when autodetection is not working or is not available.
+ The specified values overwrite the auto-detected values.
</para>
<para>
- The example below configures three network interfaces corresponding
+ The first two example below configures three network interfaces corresponding
to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
The netmasks of the latter two interfaces would be set to 255.255.255.0.
</para>
+ <para>
+ The other examples show how per interface extra parameters can be specified.
+ Notice the possible usage of &quot;,&quot; and &quot;;&quot;, which makes
+ the double quoting necessary.
+ </para>
</description>
<related>bind interfaces only</related>
<value type="example">eth0 192.168.2.10/24 192.168.3.10/255.255.255.0</value>
+<value type="example">eth0, 192.168.2.10/24; 192.168.3.10/255.255.255.0</value>
+<value type="example">&quot;eth0;if_index=65,speed=1000000000,capability=RSS&quot;</value>
+<value type="example">&quot;lo;speed=1000000000&quot; &quot;eth0;capability=RSS&quot;</value>
+<value type="example">&quot;lo;speed=1000000000&quot; , &quot;eth0;capability=RSS&quot;</value>
+<value type="example">&quot;eth0;capability=RSS&quot; , &quot;rdma1;capability=RDMA&quot; ; &quot;rdma2;capability=RSS,capability=RDMA&quot;</value>
<value type="default"/>
</samba:parameter>