It turns out that yodl strips all spaces from link() and url() commands.
authorJeremy Allison <jra@samba.org>
Wed, 4 Nov 1998 21:48:13 +0000 (21:48 +0000)
committerJeremy Allison <jra@samba.org>
Wed, 4 Nov 1998 21:48:13 +0000 (21:48 +0000)
This is a *massive* pain when doing cross referencing and will mean a
change to SWAT when generating the help URLs. Herb is looking at that.
Jeremy.
(This used to be commit 1f39207a8e16efe2199bef6a4851f3fe41d443ac)

docs/yodldocs/make_smbcodepage.1.yo
docs/yodldocs/smbclient.1.yo
docs/yodldocs/smbd.8.yo
docs/yodldocs/smbpasswd.8.yo
docs/yodldocs/smbrun.1.yo
docs/yodldocs/smbtar.1.yo
docs/yodldocs/testparm.1.yo

index 16d9cd9957c0fc11ae5c769f828b966b813819db..86d63d957cb23dfe3879d696a6e004ffee5f600b 100644 (file)
@@ -39,8 +39,8 @@ dit(outputfile) This is the output file to produce.
 
 endit()
 
-label(Samba Codepage files)
-manpagesection(Samba Codepage files)
+label(SambaCodepageFiles)
+manpagesection(Samba Codepage Files)
 
 A text Samba codepage definition file is a description that tells
 Samba how to map from upper to lower case for characters greater than
@@ -70,8 +70,9 @@ Samba em(source/codepages) directory are compiled and installed when a
 em('make install') command is issued there.
 
 The client codepage used by the url(bf(smbd))(smbd.8.html) server is
-configured using the url(bf(client code page))(smb.conf.5.html#client
-code page) parameter in the url(bf(smb.conf))(smb.conf.5.html) file.
+configured using the url(bf(client code
+page))(smb.conf.5.html#clientcodepage) parameter in the
+url(bf(smb.conf))(smb.conf.5.html) file.
 
 label(FILES)
 manpagefiles()
index 6892132cf8385572b7d2e2988e5299a7665cc17d..6273f3d4f3b76c96d02e5b7afe0af3c0fd3043cd 100644 (file)
@@ -40,10 +40,11 @@ host name of the server ! The name required is a NetBIOS server name,
 which may or may not be the same as the IP hostname of the machine
 running the server.
 
-The server name is looked up according to the url(bf(name resolve
-order))(smbclient.1.html#name resolve order) parameter in the smb.conf
-file, allowing an administrator to change the order and methods by
-which server names are looked up.
+The server name is looked up according to either the
+link(bf(-R))(nameresolveorder) parameter to bf(smbclient) or using the
+url(bf(name resolve order))(smb.conf.5.html#nameresolveorder)
+parameter in the smb.conf file, allowing an administrator to change
+the order and methods by which server names are looked up.
 
 dit(bf(password)) password is the password required to access the
 specified service on the specified server. If this parameter is
@@ -70,11 +71,11 @@ file.
 dit(bf(-B IP addr)) The IP address to use when sending a broadcast packet.
 
 dit(bf(-O socket_options)) TCP socket options to set on the client
-socket. See the url(socket options)(smb.conf.5.html#socket options)
+socket. See the url(socket options)(smb.conf.5.html#socketoptions)
 parameter in the url(bf(smb.conf (5)))(smb.conf.5.html) manpage for
 the list of valid options.
 
-label(name_resolve_order)
+label(nameresolveorder)
 dit(bf(-R name resolve order)) This option allows the user of
 smbclient to determine what name resolution services to use when
 looking up the NetBIOS name of the host being connected to.
@@ -92,7 +93,7 @@ resolution is operating system depended for instance on IRIX or
 Solaris this may be controlled by the em(/etc/nsswitch.conf) file).  
 
 it() bf(wins) : Query a name with the IP address listed in the url(bf(wins
-server))(smb.conf.5.html#wins server) parameter in the smb.conf file. If 
+server))(smb.conf.5.html#winsserver) parameter in the smb.conf file. If 
 no WINS server has been specified this method will be ignored.
 
 it() bf(bcast) : Do a broadcast on each of the known local interfaces
@@ -106,12 +107,12 @@ endit()
 
 If this parameter is not set then the name resolver order defined
 in the url(bf(smb.conf))(smb.conf.5.html) file parameter 
-url((bf(name resolve order)))(smb.conf.5.html#name resolve order)
+url((bf(name resolve order)))(smb.conf.5.html#nameresolveorder)
 will be used.
 
 The default order is lmhosts, host, wins, bcast and without this
 parameter or any entry in the url(bf("name resolve
-order"))(smb.conf.5.html#name resolve order) parameter of the
+order"))(smb.conf.5.html#nameresolveorder) parameter of the
 url(bf(smb.conf))(smb.conf.5.html) file the name resolution methods
 will be attempted in this order.
 
@@ -137,7 +138,7 @@ will send the message in the file em(mymessage.txt) to the machine FRED.
 You may also find the bf(-U) and bf(-I) options useful, as they allow
 you to control the FROM and TO parts of the message.
 
-See the url(bf(message command))(smb.conf.5.html#message command)
+See the url(bf(message command))(smb.conf.5.html#messagecommand)
 parameter in the bf(smb.conf (5)) for a description of how to handle
 incoming WinPopup messages in Samba.
 
@@ -213,7 +214,7 @@ connect to. It should be specified in standard "a.b.c.d" notation.
 
 Normally the client would attempt to locate a named SMB/CIFS server by
 looking it up via the NetBIOS name resolution mechanism described
-above in the url(bf(name resolve order))(smbclient.1.html#name_resolve_order) parameter
+above in the link(bf(name resolve order))(nameresolveorder) parameter
 above. Using this parameter will force the client to assume that the
 server is on the machine with the specified IP address and the NetBIOS
 name component of the resource being connected to will be ignored.
@@ -617,11 +618,11 @@ label(rmdir) dit(bf(rmdir <directory name>)) Remove the specified
 directory (user access privileges permitting) from the server.
 
 label(tar) dit(bf(tar <c|x>[IXbgNa])) Performs a tar operation - see
-the url(bf(-T))(smbclient.1.html#minusT) command line option
-above. Behaviour may be affected by the link(bf(tarmode))(tarmode)
-command (see below). Using g (incremental) and N (newer) will affect
-tarmode settings. Note that using the "-" option with tar x may not
-work - use the command line option instead.
+the link(bf(-T))(minusT) command line option above. Behaviour may be
+affected by the link(bf(tarmode))(tarmode) command (see below). Using
+g (incremental) and N (newer) will affect tarmode settings. Note that
+using the "-" option with tar x may not work - use the command line
+option instead.
 
 label(blocksize) dit(bf(blocksize <blocksize>)) Blocksize. Must be
 followed by a valid (greater than zero) blocksize. Causes tar file to
@@ -658,7 +659,7 @@ be known to the server.
 smbclient supports long file names where the server supports the
 LANMAN2 protocol or above.
 
-label(ENVIRONMENT VARIABLES)
+label(ENVIRONMENTVARIABLES)
 manpagesection(ENVIRONMENT VARIABLES)
 
 The variable bf(USER) may contain the username of the person using the
index 8cf88328297a94b3a3f4a36431f3ad861b80b720..9e22093cfa30c19e24bc9bd7c73da17517d0593a 100644 (file)
@@ -85,12 +85,12 @@ dit(bf(-l log file)) If specified, em(logfile) specifies a log
 filename into which informational and debug messages from the running
 server will be logged. The log file generated is never removed by the
 server although its size may be controlled by the url(bf(max log
-size))(smb.conf.5.html#max log size) option in the url(bf(smb.conf
+size))(smb.conf.5.html#maxlogsize) option in the url(bf(smb.conf
 (5)))(smb.conf.5.html) file.  The default log file name is specified
 at compile time.
 
 dit(bf(-O socket options)) See the url(bf(socket
-options))(smb.conf.5.html#socket options) parameter in the
+options))(smb.conf.5.html#socketoptions) parameter in the
 url(bf(smb.conf (5)))(smb.conf.5.html) file for details.
 
 dit(bf(-p port number)) port number is a positive integer value.  The
index 0526824bde8be3665676e7ecc175f6f719094455..d63309903568c07f4192ecde96159521c33eb348 100644 (file)
@@ -22,7 +22,10 @@ sessions on any machines that store SMB passwords.
 
 By default (when run with no arguments) it will attempt to change the
 current users SMB password on the local machine. This is similar to
-the way the bf(passwd (1)) program works. Note that in order for this
+the way the bf(passwd (1)) program works. bf(smbpasswd) differs from
+the bf(passwd) program works however in that it is not em(setuid root)
+but works in a client-server mode and communicates with a locally
+running url(bf(smbd))(smbd.8.html). As a consequence in order for this
 to succeed the url(bf(smbd))(smbd.8.html) daemon must be running on
 the local machine. On a UNIX machine the encrypted SMB passwords are
 usually stored in the url(bf(smbpasswd (5)))(smbpasswd.5.html) file.
@@ -37,8 +40,8 @@ press the <Enter> key when asked for your old password.
 
 bf(smbpasswd) also can be used by a normal user to change their SMB
 password on remote machines, such as Windows NT Primary Domain
-Controllers. See the link(bf(-r))(minusr) and link(bf(-U))(minusU)
-options below.
+Controllers. See the link((bf(-r)))(minusr) and
+link(bf(-U))(minusU) options below.
 
 When run by root, bf(smbpasswd) allows new users to be added and
 deleted in the url(bf(smbpasswd))(smbpasswd.5.html) file, as well as
@@ -121,23 +124,24 @@ url(bf(smbpasswd))(smbpasswd.5.html) file the administrator must set
 the following parameter in the [global] section of the
 url(bf(smb.conf))(smb.conf.5.html) file :
 
-url(null passwords = true)(smb.conf.5.html#null passwords)
+url(null passwords = true)(smb.conf.5.html#nullpasswords)
 
 This option is only available when running bf(smbpasswd) as root.
 
-dit(bf(-r remote machine name)) This option allows a user to specify
-what machine they wish to change their password on. Without this
-parameter bf(smbpasswd) defaults to the local host. The em("remote
-machine name") is the NetBIOS name of the SMB/CIFS server to contact
-to attempt the password change. This name is resolved into an IP
-address using the standard name resolution mechanism in all programs
-of the url(bf(Samba))(samba.7.html) suite. See the link(bf(-R name
-resolve order))(nameresolveorder) parameter for details on changing this
-resolving mechanism.
+label(minusr) dit(bf(-r remote machine name)) This option allows a
+user to specify what machine they wish to change their password
+on. Without this parameter bf(smbpasswd) defaults to the local
+host. The em("remote machine name") is the NetBIOS name of the
+SMB/CIFS server to contact to attempt the password change. This name
+is resolved into an IP address using the standard name resolution
+mechanism in all programs of the url(bf(Samba))(samba.7.html)
+suite. See the link(bf(-R name resolve order))(nameresolveorder) parameter for details on changing this resolving
+mechanism.
 
 The username whose password is changed is that of the current UNIX
-logged on user. See the link(bf(-U username))(minusU) parameter for
-details on changing the password for a different username.
+logged on user. See the link(bf(-U username))(minusU)
+parameter for details on changing the password for a different
+username.
  
 Note that if changing a Windows NT Domain password the remote machine
 specified must be the Primary Domain Controller for the domain (Backup
@@ -162,7 +166,7 @@ resolution is operating system depended for instance on IRIX or
 Solaris this may be controlled by the em(/etc/nsswitch.conf) file).
 
 it() bf(wins) : Query a name with the IP address listed in the url(bf(wins
-server))(smb.conf.5.html#wins server) parameter in the smb.conf file. If 
+server))(smb.conf.5.html#winsserver) parameter in the smb.conf file. If 
 no WINS server has been specified this method will be ignored.
 
 it() bf(bcast) : Do a broadcast on each of the known local interfaces
@@ -175,7 +179,7 @@ endit()
 
 If this parameter is not set then the name resolver order defined
 in the url(bf(smb.conf))(smb.conf.5.html) file parameter 
-url((bf(name resolve order))(smb.conf.5.html#name resolve order)
+url(bf(name resolve order))(smb.conf.5.html#nameresolveorder)
 will be used.
 
 The default order is lmhosts, host, wins, bcast and without this
@@ -200,14 +204,14 @@ option in the url(bf(smb.conf (5)))(smb.conf.5.html) man page.
 
 In order to be used in this way, the Administrator for the Windows
 NT Domain must have used the program em("Server Manager for Domains")
-to add the url(primary NetBIOS name)(smb.conf.5.html#netbios name) of 
+to add the url(primary NetBIOS name)(smb.conf.5.html#netbiosname) of 
 the Samba server as a member of the Domain.
 
 After this has been done, to join the Domain invoke bf(smbpasswd) with
 this parameter. bf(smbpasswd) will then look up the Primary Domain
 Controller for the Domain (found in the
 url(bf(smb.conf))(smb.conf.5.html) file in the parameter
-url(bf("password server"))(smb.conf.5.html#password server) and change
+url(bf(password server))(smb.conf.5.html#passwordserver) and change
 the machine account password used to create the secure Domain
 communication.  This password is then stored by bf(smbpasswd) in a
 file, read only by root, called tt(<Domain>.<Machine>.mac) where
@@ -227,96 +231,53 @@ on that machine.
 This option is only available when running bf(smbpasswd) as root.
 
 label(minusU)
-dit(bf(-U username))
-
-HERE !!!!
-
-.RE
-.I username
-
-.RS 3
-You may only specify a username to the smbpasswd command
-if you are running as root. Only root should have the
-permission to modify other users smb passwords.
-
-NOTES
-
-.B New for 1.9.18p4.
-smbpasswd will now allow a user to change their password
-on a Windows NT server. To use this add the 
-.I \-r
-.I \<remote_machine\>
-paramter to the smbpasswd command. The machine name is looked
-up using the "name resolve order" parameter defined in the
-smb.conf [global] section. Note that when changing a Windows
-NT password for a domain user,
-.I \<remote machine\>
-must be the name of the Primary domain controller.
-
-To allow users to change their passwords from "NO PASSWORD" in the
-smbpasswd file to a valid password the administrator must set the
-following parameter in the [global] section of the smb.conf :
-
-null passwords = true
-
-This is .B NOT recommended as a general policy, it is recommended that
-new users be assigned a default password instead.
-
-
-The 
-.I \-a
-and 
-.I username
-options can only be used by a user running as root.
-
-.RE
-.RE
-.SH INSTALLATION
-
-The location of the server and its support files is a matter for individual
-system administrators. The following are thus suggestions only.
-
-It is recommended that the
-.B smbpasswd
-program be installed in the /usr/local/samba/bin directory. This should be
-a directory readable by all, writeable only by root. The program should be
-executable by all. The program 
-.B must not 
-be setuid root.
-
-.SH VERSION
-
-This man page is correct for version 1.9.18p4 of the Samba suite.
-These notes will necessarily lag behind 
-development of the software, so it is possible that your version of 
-the program has extensions or parameter semantics that differ from or are not 
-covered by this man page. Please notify these to the address below for 
-rectification.
-.SH SEE ALSO
-.BR smbd (8), 
-.BR smb.conf (5) 
-.SH
-.B BUGS
-
-.RE
-The
-.B smbpasswd
-command is only useful if
-.I Samba
-has been set up to use encrypted passwords. See the file
-.I ENCRYPTION.txt
+dit(bf(-U username)) This option may only be used in
+conjunction with the link(bf(-r))(minusr)
+option. When changing a password on a remote machine it allows the
+user to specify the user name on that machine whose password will be
+changed. It is present to allow users who have different user names on
+different systems to change these passwords.
+
+dir(bf(username)) This specifies the username for all of the em(root
+only) options to operate on. Only root can specify this parameter as
+only root has the permission needed to modify attributes directly
+in the local url(bf(smbpasswd))(smbpasswd.5.html) file.
+
+label(NOTES)
+manpagesection(NOTES)
+
+As bf(smbpasswd) works in client-server mode communicating with a
+local url(bf(smbd))(smbd.8.html) for a non-root user then the bf(smbd)
+daemon must be running for this to work. A common problem is to add a
+restriction to the hosts that may access the bf(smbd) running on the
+local machine by specifying a url(bf("allow
+hosts"))(smb.conf.5.html#allowhosts) or url(bf("deny
+hosts"))(smb.conf.5.html#denyhosts) entry in the
+url(bf(smb.conf))(smb.conf.5.html) file and neglecting to allow
+em("localhost") access to the bf(smbd).
+
+In addition, the bf(smbpasswd) command is only useful if bf(Samba) has
+been set up to use encrypted passwords. See the file bf(ENCRYPTION.txt)
 in the docs directory for details on how to do this.
 
-.SH CREDITS
-.RE
-The original Samba software and related utilities were created by 
-Andrew Tridgell (samba-bugs@samba.anu.edu.au). Andrew is also the Keeper
-of the Source for this project. smbpasswd and the encrypted password
-file code was written by Jeremy Allison (samba-bugs@samba.anu.edu.au).
+label(VERSION)
+manpagesection(VERSION)
 
-This man page was written by Jeremy Allison. Bug reports to samba-bugs@samba.anu.edu.au.
+This man page is correct for version 2.0 of the Samba suite.
 
-See
-.BR smb.conf (5)
-for a full list of contributors and details of how to 
-submit bug reports, comments etc.
+label(AUTHOR)
+manpageauthor()
+
+The original Samba software and related utilities were created by
+Andrew Tridgell email(samba-bugs@samba.anu.edu.au). Samba is now developed
+by the Samba Team as an Open Source project similar to the way the
+Linux kernel is developed.
+
+The original Samba man pages were written by Karl Auer. The man page
+sources were converted to YODL format (another excellent piece of Open
+Source software) and updated for the Samba2.0 release by Jeremy
+Allison, email(samba-bugs@samba.anu.edu.au).
+
+See url(bf(samba (7)))(samba.7.html) to find out how to get a full
+list of contributors and details on how to submit bug reports,
+comments etc.
index 379d5a038bb5e766f42dd7913b4ac2c712162f9f..32f44821fae8d393f0bd0af8148ecfe4f8608f61 100644 (file)
@@ -34,7 +34,7 @@ should have a fully-qualified path.
 
 enddit()
 
-label(ENVIRONMENT_VARIABLES)
+label(ENVIRONMENTVARIABLES)
 manpagesection(ENVIRONMENT VARIABLES)
 
 The em(PATH) variable set for the environment in which bf(smbrun) is
index 8ef8ef00c1646ef79e2e9c0959a0702dcd2a2c91..27b4466777951ff6435e80fbd23c3f43a65d404f 100644 (file)
@@ -61,12 +61,12 @@ dit(bf(-r)) Restore. Files are restored to the share from the tar
 file.
 
 dit(bf(-l log level)) Log (debug) level. Corresponds to the
-url(bf(-d))(smbclient.1.html#minus_d) flag of url(bf(smbclient
+url(bf(-d))(smbclient.1.html#minusd) flag of url(bf(smbclient
 (1)))(smbclient.1.html).
 
 enddit()
 
-label(ENVIRONMENT_VARIABLES)
+label(ENVIRONMENTVARIABLES)
 manpagesection(ENVIRONMENT VARIABLES)
 
 The TAPE variable specifies the default tape device to write to. May
index 79ed611e4241a34454b8160e48f21f3de491325f..7ed84eee5e11d130996b4ced713046f82db6ce26 100644 (file)
@@ -39,8 +39,8 @@ url(bf(smb.conf))(smb.conf.5.html) file will be checked.
 
 dit(bf(hostname)) If this parameter and the following are specified,
 then testparm will examine the url(bf("hosts
-allow"))(smb.conf.5.html#hosts_allow) and url(bf("hosts
-deny"))(smb.conf.5.html#hosts_deny) parameters in the
+allow"))(smb.conf.5.html#hostsallow) and url(bf("hosts
+deny"))(smb.conf.5.html#hostsdeny) parameters in the
 url(bf(smb.conf))(smb.conf.5.html) file to determine if the hostname
 with this IP address would be allowed acces to the
 url(bf(smbd))(smbd.8.html) server. If this parameter is supplied, the