Cross linked all the command line options.

Jeremy.

1 files changed, 35 insertions, 13 deletions

diff --git a/docs/yodldocs/smbclient.1.yo b/docs/yodldocs/smbclient.1.yo
index 6273f3d4f3b..1d2b2ed38be 100644
--- a/docs/yodldocs/smbclient.1.yo
+++ b/docs/yodldocs/smbclient.1.yo
@@ -8,7 +8,7 @@ manpagename(smbclient)(ftp-like client to access SMB/CIFS resources on servers)
 label(SYNOPSIS)
 manpagesynopsis()
 
-bf(smbclient) service [password] [-s smb.conf] [-B IP addr] [-O socket_options][-R name resolve order] [-M NetBIOS name] [-i scope] [-N] [-n NetBIOS name] [-d debuglevel] [-P] [-p port] [-l log basename] [-h] [-I dest IP] [-E] [-U username] [-L NetBIOS name] [-t terminal code] [-m max protocol] [-W workgroup] [-T<c|x>IXFqgbNan] [-D directory] [-c command string]
+bf(smbclient) link(servicename)(servicename) [link(password)(password)] [link(-s smb.conf)(minuss)] [link(-B IP addr)(minusB)] [link(-O socket options)(minusO)][link(-R name resolve order)(nameresolveorder)] [link(-M NetBIOS name)(minusM)] [link(-i scope)(minusi)] [link(-N)(minusN)] [link(-n NetBIOS name)(minusn)] [link(-d debuglevel)(minusd)] [link(-P)(minusP)] [link(-p port)(minusp)] [link(-l log basename)(minusl)] [link(-h)(minush)] [link(-I dest IP)(minusI)] [link(-E)(minusE)] [link(-U username)(minusU)] [link(-L NetBIOS name)(minusL)] [link(-t terminal code)(minust)] [link(-m max protocol)(minusm)] [link(-W workgroup)(minusW)] [link(-T<c|x>IXFqgbNan)(minusT)] [link(-D directory)(minusD)] [link(-c command string)(minusc)]
 
 label(DESCRIPTION)
 manpagedescription()
@@ -26,6 +26,7 @@ manpageoptions()
 
 startdit()
 
+label(servicename)
 dit(bf(servicename)) servicename is the name of the service you want
 to use on the server. A service name takes the form
 tt(//server/service) where em(server) is the NetBIOS name of the SMB/CIFS
@@ -46,13 +47,14 @@ 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.
 
+label(password)
 dit(bf(password)) password is the password required to access the
 specified service on the specified server. If this parameter is
-supplied, the bf(-N) option (suppress password prompt) is assumed.
+supplied, the link(bf(-N))(minusN) option (suppress password prompt) is assumed.
 
 There is no default password. If no password is supplied on the
 command line (either by using this parameter or adding a password to
-the bf(-U) option (see below)) and the bf(-N) option is not specified,
+the link(bf(-U))(minusU) option (see below)) and the link(bf(-N))(minusN) option is not specified,
 the client will prompt for a password, even if the desired service
 does not require one. (If no password is required, simply press ENTER
 to provide a null password.)
@@ -63,14 +65,17 @@ rejected by these servers.
 
 Be cautious about including passwords in scripts.
 
+label(minuss)
 dit(bf(-s smb.conf)) This parameter specifies the pathname to the
 Samba configuration file, smb.conf. This file controls all aspects of
 the Samba setup on the machine and smbclient also needs to read this
 file.
 
+label(minusB)
 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
+label(minusO)
+dit(bf(-O socket options)) TCP socket options to set on the client
 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.
@@ -100,7 +105,7 @@ it() bf(bcast) : Do a broadcast on each of the known local interfaces
 listed in the url(bf(interfaces))(smb.conf.5.html#interfaces) parameter
 in the smb.conf file. This is the least reliable of the name resolution
 methods as it depends on the target host being on a locally connected
-subnet. To specify a particular broadcast address the bf(-B) option 
+subnet. To specify a particular broadcast address the link(bf(-B))(minusB) option 
 may be used.
 
 endit()
@@ -116,6 +121,7 @@ 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.
 
+label(minusM)
 dit(bf(-M NetBIOS name)) This options allows you to send messages,
 using the "WinPopup" protocol, to another computer. Once a connection
 is established you then type your message, pressing ^D (control-D) to
@@ -135,7 +141,7 @@ tt(cat mymessage.txt | smbclient -M FRED)
 
 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 may also find the link(bf(-U))(minusU) and link(bf(-I))(minusI) 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#messagecommand)
@@ -145,6 +151,7 @@ incoming WinPopup messages in Samba.
 Note: Copy WinPopup into the startup group on your WfWg PCs if you
 want them to always be able to receive messages.
 
+label(minusi)
 dit(bf(-i scope)) This specifies a NetBIOS scope that smbclient will use
 to communicate with when generating NetBIOS names. For details on the
 use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes
@@ -152,6 +159,7 @@ are em(very) rarely used, only set this parameter if you are the
 system administrator in charge of all the NetBIOS systems you
 communicate with.
 
+label(minusN)
 dit(bf(-N)) If specified, this parameter suppresses the normal
 password prompt from the client to the user. This is useful when
 accessing a service that does not require a password.
@@ -159,6 +167,7 @@ accessing a service that does not require a password.
 Unless a password is specified on the command line or this parameter
 is specified, the client will request a password.
 
+label(minusn)
 dit(bf(-n NetBIOS name)) By default, the client will use the local
 machine's hostname (in uppercase) as its NetBIOS name. This parameter
 allows you to override the host name and use whatever NetBIOS name you
@@ -184,6 +193,7 @@ letter 'A', then em(all) debug messages will be printed. This setting
 is for developers only (and people who em(really) want to know how the
 code works internally).
 
+label(minusP)
 dit(bf(-P)) If this option is specified, the service requested will be
 connected to as a printer service rather than as a normal filespace
 service. Operations such as put and get will not be applicable for
@@ -191,10 +201,12 @@ such a connection.
 
 By default, services will be connected to as NON-printer services.
 
+label(minusp)
 dit(bf(-p port)) This number is the TCP port number that will be used
 when making connections to the server. The standard (well-known) TCP
 port number for an SMB/CIFS server is 139, which is the default.
 
+label(minusl)
 dit(bf(-l logfilename)) If specified, logfilename specifies a base
 filename into which operational data from the running client will be
 logged.
@@ -207,8 +219,10 @@ tt(log.client).
 
 The log file generated is never removed by the client.
 
+label(minush)
 dit(bf(-h)) Print the usage message for the client.
 
+label(minusI)
 dit(bf(-I IP address)) IP address is the address of the server to
 connect to. It should be specified in standard "a.b.c.d" notation.
 
@@ -222,6 +236,7 @@ name component of the resource being connected to will be ignored.
 There is no default for this parameter. If not supplied, it will be
 determined automatically by the client as described above.
 
+label(minusE)
 dit(bf(-E)) This parameter causes the client to write messages to the
 standard error stream (stderr) rather than to the standard output
 stream.
@@ -229,6 +244,7 @@ stream.
 By default, the client writes messages to standard output - typically
 the user's tty.
 
+label(minusU)
 dit(bf(-U username)) This specifies the user name that will be used by
 the client to make a connection, assuming your server is not a downlevel
 server that is running a protocol level that uses passwords on shares,
@@ -249,7 +265,7 @@ that a password is not passed on the command line (where it may be
 seen by the ps command).
 
 If the service you are connecting to requires a password, it can be
-supplied using the bf(-U) option, by appending a percent symbol ("%")
+supplied using the link(bf(-U))(minusU) option, by appending a percent symbol ("%")
 then the password to username.  For example, to attach to a service as
 user tt("fred") with password tt("secret"), you would specify. nl()
 
@@ -258,7 +274,7 @@ tt(-U fred%secret) nl()
 on the command line. Note that there are no spaces around the percent
 symbol.
 
-If you specify the password as part of username then the bf(-N) option
+If you specify the password as part of username then the link(bf(-N))(minusN) option
 (suppress password prompt) is assumed.
 
 If you specify the password as a parameter em(AND) as part of username
@@ -282,12 +298,14 @@ line of a running process may be seen via the tt(ps) command to be
 safe always allow smbclient to prompt for a password and type it in
 directly.
 
+label(minusL)
 dit(bf(-L)) This option allows you to look at what services are
 available on a server. You use it as tt("smbclient -L host") and a
-list should appear.  The bf(-I) option may be useful if your NetBIOS
+list should appear.  The link(bf(-I))(minusI) option may be useful if your NetBIOS
 names don't match your tcp/ip dns host names or if you are trying to
 reach a host on another network.
 
+label(minust)
 dit(bf(-t terminal code)) This option tells smbclient how to interpret
 filenames coming from the remote server. Usually Asian language
 multibyte UNIX implementations use different character sets than
@@ -300,6 +318,7 @@ The terminal codes include tt(sjis), tt(euc), tt(jis7), tt(jis8),
 tt(junet), tt(hex), tt(cap). This is not a complete list, check the
 Samba source code for the complete list.
 
+label(minusm)
 dit(bf(-m max protocol level)) Normally, smbclient will negotiate with
 the server to use the most advanced version of the SMB/CIFS protocol
 that the server supports. Occasionaly it may be desirable to tell
@@ -320,6 +339,7 @@ it() NT1
 
 endit()
 
+label(minusW)
 dit(bf(-W WORKGROUP)) Override the default workgroup specified in the
 url(bf(workgroup))(smb.conf.5.html#workgroup) parameter of the
 url(bf(smb.conf))(smb.conf.5.html) file for this connection. This may
@@ -338,7 +358,7 @@ share. The secondary tar flags that can be given to this option are :
 	mutually exclusive with the bf(x) flag.
 
 	dit(bf(x)) Extract (restore) a local tar file back to a
-	share. Unless the bf(-D) option is given, the tar files will be
+	share. Unless the link(bf(-D))(minusD) option is given, the tar files will be
 	restored from the top level of the share. Must be followed by the name
 	of the tar file, device or tt("-") for standard input. Mutually exclusive
 	with the bf(c) flag. Restored files have theuir creation times (mtime)
@@ -415,12 +435,14 @@ it() Create a tar file of all the files and directories in the share.
 
 endit()
 
+label(minusD)
 dit(bf(-D initial directory)) Change to initial directory before
-starting. Probably only of any use with the tar bf(-T) option.
+starting. Probably only of any use with the tar link(bf(-T))(minusT) option.
 
+label(minusc)
 dit(bf(-c command string)) command string is a semicolon separated
 list of commands to be executed instead of prompting from stdin.
-bf(-N) is implied by bf(-c).
+link(bf(-N))(minusN) is implied by bf(-c).
 
 This is particularly useful in scripts and for printing stdin to the
 server, e.g. tt(-c 'print -').
@@ -651,7 +673,7 @@ Some servers are fussy about the case of supplied usernames,
 passwords, share names (aka service names) and machine names. If you
 fail to connect try giving all parameters in uppercase.
 
-It is often necessary to use the -n option when connecting to some
+It is often necessary to use the link(bf(-n))(minusn) option when connecting to some
 types of servers. For example OS/2 LanManager insists on a valid
 NetBIOS name being used, so you need to supply a valid name that would
 be known to the server.