From 6f96bb40e79574af2cd5579557c196be07b5c9f2 Mon Sep 17 00:00:00 2001 From: Andrew Bartlett Date: Tue, 21 Jun 2022 11:44:04 +1200 Subject: [PATCH] docs: Show current system path for smb.conf in &smb.conf entity Signed-off-by: Andrew Bartlett Reviewed-by: Andreas Schneider --- docs-xml/build/DTD/samba.entities | 2 +- docs-xml/generate-pathconf-entities.sh | 1 + docs-xml/manpages/idmap_hash.8.xml | 2 +- docs-xml/manpages/idmap_ldap.8.xml | 2 +- docs-xml/manpages/idmap_script.8.xml | 2 +- docs-xml/manpages/libsmbclient.7.xml | 2 +- docs-xml/manpages/net.8.xml | 20 ++++++++++---------- 7 files changed, 16 insertions(+), 15 deletions(-) diff --git a/docs-xml/build/DTD/samba.entities b/docs-xml/build/DTD/samba.entities index 15a5ba83fb9..bba0c2c396b 100644 --- a/docs-xml/build/DTD/samba.entities +++ b/docs-xml/build/DTD/samba.entities @@ -896,7 +896,7 @@ smbd'> nmbd'> testparm'> -smb.conf'> +&pathconfig.CONFIGFILE;'> smbclient'> winbindd'> net'> diff --git a/docs-xml/generate-pathconf-entities.sh b/docs-xml/generate-pathconf-entities.sh index cb3a346561a..6c0c31a3522 100755 --- a/docs-xml/generate-pathconf-entities.sh +++ b/docs-xml/generate-pathconf-entities.sh @@ -17,4 +17,5 @@ echo " + " diff --git a/docs-xml/manpages/idmap_hash.8.xml b/docs-xml/manpages/idmap_hash.8.xml index fd3a2d68240..03ff02a486b 100644 --- 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 0601f6164cc..80f272d3fa3 100644 --- a/docs-xml/manpages/idmap_ldap.8.xml +++ b/docs-xml/manpages/idmap_ldap.8.xml @@ -41,7 +41,7 @@ Defines the directory base suffix to use for SID/uid/gid mapping entries. If not defined, idmap_ldap will default - to using the "ldap idmap suffix" option from smb.conf. + to using the "ldap idmap suffix" option from &smb.conf;. diff --git a/docs-xml/manpages/idmap_script.8.xml b/docs-xml/manpages/idmap_script.8.xml index 95afde18693..2e7f2be59fd 100644 --- a/docs-xml/manpages/idmap_script.8.xml +++ b/docs-xml/manpages/idmap_script.8.xml @@ -60,7 +60,7 @@ The tdb2 idmap backend supports an external program for performing id mappings - through the smb.conf option idmap config * : script or + through the &smb.conf; option idmap config * : script or its deprecated legacy form idmap : script. diff --git a/docs-xml/manpages/libsmbclient.7.xml b/docs-xml/manpages/libsmbclient.7.xml index 8dab4d06cba..a08a4ae95ce 100644 --- 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 .smb in the $HOME directory that is specified in the users shell environment. It then searches for a file called smb.conf which, - if present, will fully over-ride the system /etc/samba/smb.conf file. If + if present, will fully over-ride the system &smb.conf; file. If instead libsmbclient finds a file called ~/.smb/smb.conf.append, it will read the system /etc/samba/smb.conf and then append the contents of the ~/.smb/smb.conf.append to it. diff --git a/docs-xml/manpages/net.8.xml b/docs-xml/manpages/net.8.xml index 5a37119aa20..557cf0d0883 100644 --- a/docs-xml/manpages/net.8.xml +++ b/docs-xml/manpages/net.8.xml @@ -2111,7 +2111,7 @@ commands. -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". "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". @@ -2166,7 +2166,7 @@ on the share when browsed to by a client. 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. 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;. 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. The deployment of this configuration data can be activated in two levels from the -smb.conf file: Share definitions from registry are +&smb.conf; file: Share definitions from registry are activated by setting registry shares to yes in the [global] section and global configuration options are activated by setting registry in @@ -2721,7 +2721,7 @@ win32 eventlog files (usually *.evt). evt files are used by the native Windows e The import and export of evt files can only succeed when eventlog list is used in -smb.conf file. +&smb.conf; file. See the smb.conf 5 manpage for details. @@ -2750,7 +2750,7 @@ Prints a eventlog *.evt file to standard output. Imports a eventlog *.evt file defined by filename into the samba internal tdb representation of eventlog defined by eventlog. eventlog needs to part of the eventlog list -defined in smb.conf. +defined in &smb.conf;. See the smb.conf 5 manpage for details. @@ -2763,7 +2763,7 @@ See the smb.conf 5eventlog to a eventlog *.evt file defined by filename. eventlog needs to part of the eventlog list -defined in smb.conf. +defined in &smb.conf;. See the smb.conf 5 manpage for details.