docs: Show current system path for smb.conf in &smb.conf entity

Signed-off-by: Andrew Bartlett <abartlet@samba.org>
Reviewed-by: Andreas Schneider <asn@samba.org>

diff --git a/docs-xml/build/DTD/samba.entities b/docs-xml/build/DTD/samba.entities
index 15a5ba83fb929d0eb56417bdb8156b1ccfc2bbd3..bba0c2c396b09b930429f73c2b9751893136080b 100644 (file)
--- a/docs-xml/build/DTD/samba.entities
+++ b/docs-xml/build/DTD/samba.entities
@@ -896,7 +896,7 @@
 <!ENTITY smbd '<application>smbd</application>'>
 <!ENTITY nmbd '<application>nmbd</application>'>
 <!ENTITY testparm '<application>testparm</application>'>
-<!ENTITY smb.conf '<filename>smb.conf</filename>'>
+<!ENTITY smb.conf '<filename>&pathconfig.CONFIGFILE;</filename>'>
 <!ENTITY smbclient '<application>smbclient</application>'>
 <!ENTITY winbindd '<application>winbindd</application>'>
 <!ENTITY net '<application>net</application>'>

diff --git a/docs-xml/generate-pathconf-entities.sh b/docs-xml/generate-pathconf-entities.sh
index cb3a346561af4bd5d76a83f0d47d8a99221bec1b..6c0c31a3522d182c0d7ef646deb57f2c38cce98b 100755 (executable)
--- a/docs-xml/generate-pathconf-entities.sh
+++ b/docs-xml/generate-pathconf-entities.sh
@@ -17,4 +17,5 @@ echo "
 <!ENTITY pathconfig.NTP_SIGND_SOCKET_DIR '\${prefix}/var/lib/ntp_signd'>
 <!ENTITY pathconfig.MITKDCPATH           '\${prefix}/sbin/krb5kdc'>
 <!ENTITY pathconfig.SAMBA_DATADIR        '\${prefix}/var/samba'>
+<!ENTITY pathconfig.CONFIGFILE           '\${prefix}/etc/smb.conf'>
 "

diff --git a/docs-xml/manpages/idmap_hash.8.xml b/docs-xml/manpages/idmap_hash.8.xml
index fd3a2d6824031bd44b0fa0aae442c900a7a52cad..03ff02a486b91e09654ced9700b349742d40cef5 100644 (file)
--- a/docs-xml/manpages/idmap_hash.8.xml
+++ b/docs-xml/manpages/idmap_hash.8.xml
@@ -25,7 +25,7 @@
          This plugin also implements the nss_info API and can be used
          to support a local name mapping files if enabled via the
          "winbind normalize names" and "winbind nss info"
-         parameters in smb.conf.
+         parameters in &smb.conf;.
          The module divides the range into subranges for each domain that is being
          handled by the idmap config.
 

diff --git a/docs-xml/manpages/idmap_ldap.8.xml b/docs-xml/manpages/idmap_ldap.8.xml
index 0601f6164cc262aadbfa7515cd1a79bf5b0d9ba2..80f272d3fa3fd90f127a3d86bc0874e974645d34 100644 (file)
--- a/docs-xml/manpages/idmap_ldap.8.xml
+++ b/docs-xml/manpages/idmap_ldap.8.xml
@@ -41,7 +41,7 @@
                <listitem><para>
                        Defines the directory base suffix to use for
                        SID/uid/gid mapping entries.  If not defined, idmap_ldap will default
-                       to using the &quot;ldap idmap suffix&quot; option from smb.conf.
+                       to using the &quot;ldap idmap suffix&quot; option from &smb.conf;.
                </para></listitem>
                </varlistentry>
 

diff --git a/docs-xml/manpages/idmap_script.8.xml b/docs-xml/manpages/idmap_script.8.xml
index 95afde18693b050ce318dbfe58501b3cd518c78f..2e7f2be59fd56ba83adb43d4fd29527e5348269e 100644 (file)
--- a/docs-xml/manpages/idmap_script.8.xml
+++ b/docs-xml/manpages/idmap_script.8.xml
@@ -60,7 +60,7 @@
 
        <para>
        The tdb2 idmap backend supports an external program for performing id mappings
-       through the smb.conf option <parameter>idmap config * : script</parameter> or
+       through the &smb.conf; option <parameter>idmap config * : script</parameter> or
        its deprecated legacy form <parameter>idmap : script</parameter>.
        </para>
 

diff --git a/docs-xml/manpages/libsmbclient.7.xml b/docs-xml/manpages/libsmbclient.7.xml
index 8dab4d06cba0d35a4492254daac00a5e550cb535..a08a4ae95ce9849b2fa821e29830ba653484fadf 100644 (file)
--- a/docs-xml/manpages/libsmbclient.7.xml
+++ b/docs-xml/manpages/libsmbclient.7.xml
@@ -93,7 +93,7 @@
        When libsmbclient is invoked by an application it searches for a directory called
        <filename>.smb</filename> in the $HOME directory that is specified in the users shell
        environment. It then searches for a file called <filename>smb.conf</filename> which,
-       if present, will fully over-ride the system <filename>/etc/samba/smb.conf</filename> file. If
+       if present, will fully over-ride the system &smb.conf; file. If
        instead libsmbclient finds a file called <filename>~/.smb/smb.conf.append</filename>,
        it will read the system <filename>/etc/samba/smb.conf</filename> and then append the
        contents of the <filename>~/.smb/smb.conf.append</filename> to it.

diff --git a/docs-xml/manpages/net.8.xml b/docs-xml/manpages/net.8.xml
index 5a37119aa20aed7713415974eaede03bc3343642..557cf0d0883bbef105cb57f71e2c13aa8cb8aca6 100644 (file)
--- a/docs-xml/manpages/net.8.xml
+++ b/docs-xml/manpages/net.8.xml
@@ -2111,7 +2111,7 @@ commands.
 </para>
 
 <para>
-To set this up, first set up your smb.conf by adding to the [global] section:
+To set this up, first set up your &smb.conf; by adding to the [global] section:
 
 usershare path = /usr/local/samba/lib/usershares
 
@@ -2126,7 +2126,7 @@ which means that a file in that directory can be renamed or deleted only
 by the owner of the file).
 
 Finally, tell smbd how many usershares you will allow by adding to the [global]
-section of smb.conf a line such as :
+section of &smb.conf; a line such as :
 
 usershare max shares = 100.
 
@@ -2154,7 +2154,7 @@ Add or replace a new user defined share, with name "sharename".
 
 <para>
 "path" specifies the absolute pathname on the system to be exported.
-Restrictions may be put on this, see the global smb.conf parameters:
+Restrictions may be put on this, see the global &smb.conf; parameters:
 "usershare owner only", "usershare prefix allow list", and
 "usershare prefix deny list".
 </para>
@@ -2166,7 +2166,7 @@ on the share when browsed to by a client.
 
 <para>The optional "acl" field
 specifies which users have read and write access to the entire share.
-Note that guest connections are not allowed unless the smb.conf parameter
+Note that guest connections are not allowed unless the &smb.conf; parameter
 "usershare allow guests" has been set. The definition of a user
 defined share acl is: "user:permission", where user is a valid
 username on the system and permission can be "F", "R", or "D".
@@ -2184,9 +2184,9 @@ authenticated user has read-only access.
 
 <para>
 The optional "guest_ok" has the same effect as the parameter of the
-same name in smb.conf, in that it allows guest access to this user
+same name in &smb.conf;, in that it allows guest access to this user
 defined share. This parameter is only allowed if the global parameter
-"usershare allow guests" has been set to true in the smb.conf.
+"usershare allow guests" has been set to true in the &smb.conf;.
 </para>
 
 There is no separate command to modify an existing user defined share,
@@ -2268,7 +2268,7 @@ by enabling the RPC conf mode and specifying the address of the remote server.
 
 <para>
 The deployment of this configuration data can be activated in two levels from the
-<emphasis>smb.conf</emphasis> file: Share definitions from registry are
+<emphasis>&smb.conf;</emphasis> file: Share definitions from registry are
 activated by setting <parameter>registry shares</parameter> to
 <quote>yes</quote> in the [global] section and global configuration options are
 activated by setting <smbconfoption name="include">registry</smbconfoption> in
@@ -2721,7 +2721,7 @@ win32 eventlog files (usually *.evt). evt files are used by the native Windows e
 
 <para>
 The import and export of evt files can only succeed when <parameter>eventlog list</parameter> is used in
-<emphasis>smb.conf</emphasis> file.
+<emphasis>&smb.conf;</emphasis> file.
 See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
 </para>
 
@@ -2750,7 +2750,7 @@ Prints a eventlog *.evt file to standard output.
 Imports a eventlog *.evt file defined by <replaceable>filename</replaceable> into the
 samba internal tdb representation of eventlog defined by <replaceable>eventlog</replaceable>.
 <replaceable>eventlog</replaceable> needs to part of the <parameter>eventlog list</parameter>
-defined in smb.conf.
+defined in &smb.conf;.
 See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
 </para>
 
@@ -2763,7 +2763,7 @@ See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manv
 Exports the samba internal tdb representation of eventlog defined by <replaceable>eventlog</replaceable>
 to a eventlog *.evt file defined by <replaceable>filename</replaceable>.
 <replaceable>eventlog</replaceable> needs to part of the <parameter>eventlog list</parameter>
-defined in smb.conf.
+defined in &smb.conf;.
 See the <citerefentry><refentrytitle>smb.conf</refentrytitle> <manvolnum>5</manvolnum></citerefentry> manpage for details.
 </para>