diff options
author | Jeremy Allison <jra@samba.org> | 1998-11-04 23:22:45 +0000 |
---|---|---|
committer | Jeremy Allison <jra@samba.org> | 1998-11-04 23:22:45 +0000 |
commit | 8080fb7ccce49f6401d1406ced647f5ceb333faf (patch) | |
tree | c545a21dff22b332c5688386099be12a98f84be9 | |
parent | 6bb6efe2b881f3ab67a73b2ef32faa2041ebedb5 (diff) | |
download | samba-8080fb7ccce49f6401d1406ced647f5ceb333faf.tar.gz samba-8080fb7ccce49f6401d1406ced647f5ceb333faf.tar.bz2 samba-8080fb7ccce49f6401d1406ced647f5ceb333faf.zip |
Added internal cross references for all man pages.
Jeremy.
(This used to be commit 9dd09fdb643b70e5b46aeb9f6580128b7a68fe4e)
-rw-r--r-- | docs/yodldocs/make_smbcodepage.1.yo | 6 | ||||
-rw-r--r-- | docs/yodldocs/nmbd.8.yo | 17 | ||||
-rw-r--r-- | docs/yodldocs/nmblookup.1.yo | 28 | ||||
-rw-r--r-- | docs/yodldocs/smbclient.1.yo | 4 | ||||
-rw-r--r-- | docs/yodldocs/smbd.8.yo | 28 | ||||
-rw-r--r-- | docs/yodldocs/smbpasswd.8.yo | 34 | ||||
-rw-r--r-- | docs/yodldocs/smbrun.1.yo | 3 | ||||
-rw-r--r-- | docs/yodldocs/smbstatus.1.yo | 9 | ||||
-rw-r--r-- | docs/yodldocs/smbtar.1.yo | 14 | ||||
-rw-r--r-- | docs/yodldocs/testparm.1.yo | 5 | ||||
-rw-r--r-- | docs/yodldocs/testprns.1.yo | 4 |
11 files changed, 129 insertions, 23 deletions
diff --git a/docs/yodldocs/make_smbcodepage.1.yo b/docs/yodldocs/make_smbcodepage.1.yo index 86d63d957c..6b59d5e01e 100644 --- a/docs/yodldocs/make_smbcodepage.1.yo +++ b/docs/yodldocs/make_smbcodepage.1.yo @@ -8,7 +8,7 @@ manpagename(make_codepage)(Construct a codepage file for Samba) label(SYNOPSIS) manpagesynopsis() -bf(make_smbcodepage) [c|d] codepage inputfile outputfile +bf(make_smbcodepage) [link(c|d)(cord)] link(codepage)(codepage) link(inputfile)(inputfile) link(outputfile)(outputfile) label(DESCRIPTION) manpagedescription() @@ -23,18 +23,22 @@ manpageoptions() startdit() +label(cord) dit(c|d) This tells make_smbcodepage if it is compiling (c) a text format code page file to binary, or (d) de-compiling a binary codepage file to text. +label(codepage) dit(codepage) This is the codepage we are processing (a number, eg. 850). +label(inputfile) dit(inputfile) This is the input file to process. In the 'c' case this will be a text codepage definition file such as the ones found in the Samba em(source/codepages) directory. In the 'd' case this will be the binary format codepage definition file normally found in the em(lib/codepages) directory in the Samba install directory path. +label(outputfile) dit(outputfile) This is the output file to produce. endit() diff --git a/docs/yodldocs/nmbd.8.yo b/docs/yodldocs/nmbd.8.yo index 42fb0b3876..f241af1d0e 100644 --- a/docs/yodldocs/nmbd.8.yo +++ b/docs/yodldocs/nmbd.8.yo @@ -9,7 +9,7 @@ naming services to clients) label(SYNOPSIS) manpagesynopsis() -bf(nmbd) [-D] [-o] [-a] [-H lmhosts file] [-d debuglevel] [-l log file basename] [-n primary NetBIOS name] [-p port number] [-s configuration file] [-i NetBIOS scope] [-h] +bf(nmbd) [link(-D)(minusD)] [link(-o)(minuso)] [link(-a)(minusa)] [link(-H lmhosts file)(minusH)] [link(-d debuglevel)(minusd)] [link(-l log file basename)(minusl)] [link(-n primary NetBIOS name)(minusn)] [link(-p port number)(minusp)] [link(-s configuration file)(minuss)] [link(-i NetBIOS scope)(minusi)] [link(-h)(minush)] label(DESCRIPTION) manpagedescription() @@ -49,19 +49,23 @@ manpageoptions() startdit() +label(minusD) dit(bf(-D)) If specified, this parameter causes the server to operate as a daemon. That is, it detaches itself and runs in the background, fielding requests on the appropriate port. By default, the server will NOT operate as a daemon. nmbd can also be operated from the inetd meta-daemon, although this is not recommended. +label(minusa) dit(bf(-a)) If this parameter is specified, each new connection will append log messages to the log file. This is the default. +label(minuso) dit(bf(-o)) If this parameter is specified, the log files will be overwritten when opened. By default, the log files will be appended to. +label(minusH) dit(bf(-H filename)) NetBIOS lmhosts file. The lmhosts file is a list of NetBIOS names to IP addresses that is @@ -77,6 +81,7 @@ build process. Common defaults are em(/usr/local/samba/lib/lmhosts), em(/usr/samba/lib/lmhosts) or em(/etc/lmhosts). See the bf(lmhosts (5)) man page for details on the contents of this file. +label(minusd) dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10. The default value if this parameter is not specified is zero. @@ -92,6 +97,11 @@ should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic. +Note that specifying this parameter here will override the url(bf(log +level))(smb.conf.5.html#loglevel) parameter in the url(bf(smb.conf +(5)))(smb.conf.5.html) file. + +label(minusl) dit(bf(-l logfile)) The bf(-l) parameter specifies a path and base filename into which operational data from the running nmbd server will be logged. The actual log file name is generated by appending the @@ -103,17 +113,20 @@ The default log file path is is compiled into Samba as part of the build process. Common defaults are em(/usr/local/samba/var/log.nmb), em(/usr/samba/var/log.nmb) or em(/var/log/log.nmb). +label(minusn) dit(bf(-n primary NetBIOS name)) This option allows you to override the NetBIOS name that Samba uses for itself. This is identical to setting the bf(NetBIOS name) parameter in the smb.conf file but will override the setting in the smb.conf file. +label(minusp) dit(bf(-p UDP port number)) UDP port number is a positive integer value. This option changes the default UDP port number (normally 137) that nmbd responds to name queries on. Don't use this option unless you are an expert, in which case you won't need help! +label(minuss) dit(bf(-s configuration file)) The default configuration file name is set at build time, typically as em(/usr/local/samba/lib/smb.conf), but this may be changed when Samba is autoconfigured. @@ -121,6 +134,7 @@ this may be changed when Samba is autoconfigured. The file specified contains the configuration details required by the server. See bf(smb.conf (5)) for more information. +label(minusi) dit(bf(-i scope)) This specifies a NetBIOS scope that the server 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 @@ -128,6 +142,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(minush) dit(bf(-h)) Prints the help information (usage) for nmbd. endit() diff --git a/docs/yodldocs/nmblookup.1.yo b/docs/yodldocs/nmblookup.1.yo index 20316ad3c6..af04e6b1e9 100644 --- a/docs/yodldocs/nmblookup.1.yo +++ b/docs/yodldocs/nmblookup.1.yo @@ -8,7 +8,7 @@ manpagename(nmblookup)(NetBIOS over TCP/IP client used to lookup NetBIOS names) label(SYNOPSIS) manpagesynopsis() -bf(nmblookup) [-M] [-R] [-S] [-r] [-A] [-h] [-B broadcast address] [-U unicast address] [-d debuglevel] [-s smb config file] [-i NetBIOS scope] name +bf(nmblookup) [link(-M)(minusM)] [link(-R)(minusR)] [link(-S)(minusS)] [link(-r)(minusr)] [link(-A)(minusA)] [link(-h)(minush)] [link(-B broadcast address)(minusB)] [link(-U unicast address)(minusU)] [link(-d debuglevel)(minusd)] [link(-s smb config file)(minuss)] [link(-i NetBIOS scope)(minusi)] link(name)(name) label(DESCRIPTION) manpagedescription() @@ -25,9 +25,11 @@ manpageoptions() startdit() +label(minusM) dit(bf(-M)) Searches for a master browser. This is done by doing a broadcast lookup on the special name tt(__MSBROWSE__). +label(minusR) dit(bf(-R)) Set the recursion desired bit in the packet to do a recursive lookup. This is used when sending a name query to a machine running a WINS server and the user wishes to query the names in the @@ -35,9 +37,11 @@ WINS server. If this bit is unset the normal (broadcast responding) NetBIOS processing code on a machine is used instead. See rfc1001, rfc1002 for details. +label(minusS) dit(bf(-S)) Once the name query has returned an IP address then do a node status query as well. +label(minusr) dit(bf(-r)) Try and bind to UDP port 137 to send and receive UDP datagrams. The reason for this option is a bug in Windows 95 where it ignores the source port of the requesting packet and only replies to @@ -46,11 +50,14 @@ needed to bind to this port, and in addition, if the url(bf(nmbd))(nmbd.8.html) daemon is running on this machine it also binds to this port. +label(minusA) dit(bf(-A)) Interpret <name> as an IP Address and do a node status query on this address. +label(minush) dit(bf(-h)) Print a help (usage) message. +label(minusB) dit(bf(-B broadcast address)) Send the query to the given broadcast address. Without this option the default behavior of nmblookup is to send the query to the broadcast address of the primary network @@ -58,10 +65,12 @@ interface as either auto-detected or defined in the url(bf(interfaces))(smb.conf.5.html#interfaces) parameter of the url(bf(smb.conf (5)))(smb.conf.5.html) file. +label(minusU) dit(bf(-U unicast address)) Do a unicast query to the specified address or host tt("unicast address"). This option (along with the -bf(-R) option) is needed to query a WINS server. +link(bf(-R))(minusR) option) is needed to query a WINS server. +label(minusd) dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10. The default value if this parameter is not specified is zero. @@ -75,6 +84,17 @@ should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of data, most of which is extremely cryptic. +Note that specifying this parameter here will override the url(bf(log +level))(smb.conf.5.html#loglevel) parameter in the url(bf(smb.conf +(5)))(smb.conf.5.html) file. + +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(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 @@ -82,6 +102,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(name) dit(bf(name)) This is the NetBIOS name being queried. Depending upon the previous options this may be a NetBIOS name or IP address. If a NetBIOS name then the different name types may be specified by @@ -113,7 +134,8 @@ This man page is correct for version 2.0 of the Samba suite. label(SEEALSO) manpageseealso() -url(bf(samba (7)))(samba.7.html), url(bf(nmbd (8)))(nmbd.8.html), url(bf(smb.conf (5)))(smb.conf.5.html) +url(bf(samba (7)))(samba.7.html), url(bf(nmbd (8)))(nmbd.8.html), +url(bf(smb.conf (5)))(smb.conf.5.html) label(AUTHOR) manpageauthor() diff --git a/docs/yodldocs/smbclient.1.yo b/docs/yodldocs/smbclient.1.yo index 1d2b2ed38b..3a7a4f0520 100644 --- a/docs/yodldocs/smbclient.1.yo +++ b/docs/yodldocs/smbclient.1.yo @@ -193,6 +193,10 @@ 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). +Note that specifying this parameter here will override the url(bf(log +level))(smb.conf.5.html#loglevel) parameter in the url(bf(smb.conf +(5)))(smb.conf.5.html) file. + 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 diff --git a/docs/yodldocs/smbd.8.yo b/docs/yodldocs/smbd.8.yo index 9e22093cfa..c5a3f9314d 100644 --- a/docs/yodldocs/smbd.8.yo +++ b/docs/yodldocs/smbd.8.yo @@ -8,8 +8,7 @@ manpagename(smbd)(server to provide SMB/CIFS services to clients) label(SYNOPSIS) manpagesynopsis() -bf(smbd) [-D] [-a] [-o] [-d debuglevel] [-l log file] [-p port number] -[-O socket options] [-s configuration file] [-i scope] [-P] [-h] +bf(smbd) [link(-D)(minusD)] [link(-a)(minusa)] [link(-o)(minuso)] [link(-d debuglevel)(minusd)] [link(-l log file)(minusl)] [link(-p port number)(minusp)] [link(-O socket options)(minusO)] [link(-s configuration file)(minuss)] [link(-i scope)(minusi)] [link(-P)(minusP)] [link(-h)(minush)] label(DESCRIPTION) manpagedescription() @@ -51,6 +50,7 @@ manpageoptions() startdit() +label(minusD) dit(bf(-D)) If specified, this parameter causes the server to operate as a daemon. That is, it detaches itself and runs in the background, fielding requests on the appropriate port. Operating the server as a @@ -59,13 +59,16 @@ more than casual use file and print services. By default, the server will NOT operate as a daemon. +label(minusa) dit(bf(-a)) If this parameter is specified, each new connection will append log messages to the log file. This is the default. +label(minuso) dit(bf(-o)) If this parameter is specified, the log files will be overwritten when opened. By default, the log files will be appended to. +label(minusd) dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10. The default value if this parameter is not specified is zero. @@ -81,18 +84,25 @@ should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic. -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#maxlogsize) option in the url(bf(smb.conf +Note that specifying this parameter here will override the url(bf(log +level))(smb.conf.5.html#loglevel) parameter in the url(bf(smb.conf +(5)))(smb.conf.5.html) file. + +label(minusl) +dit(bf(-l log file)) If specified, em(log file) 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#maxlogsize) option in the url(bf(smb.conf (5)))(smb.conf.5.html) file. The default log file name is specified at compile time. +label(minusO) dit(bf(-O socket options)) See the url(bf(socket options))(smb.conf.5.html#socketoptions) parameter in the url(bf(smb.conf (5)))(smb.conf.5.html) file for details. +label(minusp) dit(bf(-p port number)) port number is a positive integer value. The default value if this parameter is not specified is 139. @@ -112,6 +122,7 @@ rfc1002.txt section 4.3.5. This parameter is not normally specified except in the above situation. +label(minuss) dit(bf(-s configuration file)) The default configuration file name is determined at compile time. @@ -121,6 +132,7 @@ information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See bf(smb.conf (5)) for more information. +label(minusi) dit(bf(-i scope)) This specifies a NetBIOS scope that the server 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 @@ -128,8 +140,10 @@ 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(minush) dit(bf(-h)) Prints the help information (usage) for smbd. +label(minusP) dit(bf(-P)) Passive option. Causes smbd not to send any network traffic out. Used for debugging by the developers only. diff --git a/docs/yodldocs/smbpasswd.8.yo b/docs/yodldocs/smbpasswd.8.yo index d633099035..d84450ad87 100644 --- a/docs/yodldocs/smbpasswd.8.yo +++ b/docs/yodldocs/smbpasswd.8.yo @@ -8,7 +8,7 @@ manpagename(smbpasswd)(change a users SMB password) label(SYNOPSIS) manpagesynopsis() -bf(smbpasswd) [-a] [-d] [-e] [-D debug level] [-n] [-r remote_machine] [-R name resolve order] [-m] [-j DOMAIN] [-U username] [-h] [-s] username +bf(smbpasswd) [link(-a)(minusa)] [link(-d)(minusd)] [link(-e)(minuse)] [link(-D debug level)(minusD)] [link(-n)(minusn)] [link(-r remote_machine)(minusr)] [link(-R name resolve order)(minusR)] [link(-m)(minusm)] [link(-j DOMAIN)(minusj)] [link(-U username)(minusU)] [link(-h)(minush)] [link(-s)(minuss)] link(username)(username) label(DESCRIPTION) manpagedescription() @@ -55,6 +55,7 @@ manpageoptions() startdit() +label(minusa) dit(bf(-a)) This option specifies that the username following should be added to the local url(bf(smbpasswd))(smbpasswd.5.html) file, with the new password typed (type <Enter> for the old password). This @@ -84,6 +85,7 @@ formats. This option is only available when running bf(smbpasswd) as root. +label(minuse) dit(bf(-e)) This option specifies that the username following should be em(enabled) in the local url(bf(smbpasswd))(smbpasswd.5.html) file, if the account was previously disabled. If the account was not @@ -112,6 +114,7 @@ should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic. +label(minusn) dit(bf(-n)) This option specifies that the username following should have their password set to null (i.e. a blank password) in the local url(bf(smbpasswd))(smbpasswd.5.html) file. This is done by writing the @@ -128,14 +131,15 @@ url(null passwords = true)(smb.conf.5.html#nullpasswords) This option is only available when running bf(smbpasswd) as root. -label(minusr) dit(bf(-r remote machine name)) This option allows a +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 +suite. See the link(bf(-R name resolve order))(minusR) parameter for details on changing this resolving mechanism. The username whose password is changed is that of the current UNIX @@ -148,27 +152,32 @@ specified must be the Primary Domain Controller for the domain (Backup Domain Controllers only have a read-only copy of the user account database and will not allow the password change). -label(nameresolveorder) +label(minusR) 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. -The options are :"lmhosts", "host", "wins" and "bcast". They cause -names to be resolved as follows : +The options are :link("lmhosts")(lmhosts), link("host")(host), +link("wins")(wins) and link("bcast")(bcast). They cause names to be +resolved as follows : startit() +label(lmhosts) it() bf(lmhosts) : Lookup an IP address in the Samba lmhosts file. +label(host) it() bf(host) : Do a standard host name to IP address resolution, using the system /etc/hosts, NIS, or DNS lookups. This method of name resolution is operating system depended for instance on IRIX or Solaris this may be controlled by the em(/etc/nsswitch.conf) file). +label(wins) it() bf(wins) : Query a name with the IP address listed in the url(bf(wins server))(smb.conf.5.html#winsserver) parameter in the smb.conf file. If no WINS server has been specified this method will be ignored. +label(bcast) 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 @@ -186,6 +195,7 @@ The default order is lmhosts, host, wins, bcast and without this parameter or any entry in 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)) This option tells bf(smbpasswd) that the account being changed is a em(MACHINE) account. Currently this is used when Samba is being used as an NT Primary Domain Controller. PDC support is not a @@ -196,6 +206,7 @@ email(samba-ntdom@samba.anu.edu.au). This option is only available when running bf(smbpasswd) as root. +label(minusj) dit(bf(-j DOMAIN)) This option is used to add a Samba server into a Windows NT Domain, as a Domain member capable of authenticating user accounts to any Domain Controller in the same way as a Windows NT @@ -238,6 +249,17 @@ 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. +label(minush) +dit(bf(-h)) This option prints the help string for bf(smbpasswd), +selecting the correct one for running as root or as an ordinary user. + +label(minuss) +dit(bf(-s)) This option causes bf(smbpasswd) to be silent (ie. not +issue prompts) and to read it's old and new passwords from standard +input, rather than from tt(/dev/tty) (like the bf(passwd (1)) program +does). This option is to aid people writing scripts to drive bf(smbpasswd) + +label(username) 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 diff --git a/docs/yodldocs/smbrun.1.yo b/docs/yodldocs/smbrun.1.yo index 32f44821fa..7db843cd47 100644 --- a/docs/yodldocs/smbrun.1.yo +++ b/docs/yodldocs/smbrun.1.yo @@ -8,7 +8,7 @@ manpagename(smbrun)(interface program between smbd and external programs) label(SYNOPSIS) manpagesynopsis() -bf(smbrun) shell-command +bf(smbrun) link(shell-command)(shellcommand) label(DESCRIPTION) manpagedescription() @@ -29,6 +29,7 @@ manpageoptions() startdit() +label(shellcommand) dit(bf(shell-command)) The shell command to execute. The command should have a fully-qualified path. diff --git a/docs/yodldocs/smbstatus.1.yo b/docs/yodldocs/smbstatus.1.yo index c58e84cda0..9a76bdcd7f 100644 --- a/docs/yodldocs/smbstatus.1.yo +++ b/docs/yodldocs/smbstatus.1.yo @@ -8,7 +8,7 @@ manpagename(smbstatus)(report on current Samba connections) label(SYNOPSIS) manpagesynopsis() -bf(smbstatus) [-b] [-d] [-L] [-p] [-S] [-s configuration file] [-u username] +bf(smbstatus) [link(-b)(minusb)] [link(-d)(minusd)] [link(-L)(minusL)] [link(-p)(minusp)] [link(-S)(minusS)] [link(-s configuration file)(minuss)] [link(-u username)(minusu)] label(DESCRIPTION) manpagedescription() @@ -23,22 +23,29 @@ manpageoptions() startdit() +label(minusb) dit(bf(-b)) gives brief output. +label(minusd) dit(bf(-d)) gives verbose output. +label(minusL) dit(bf(-L)) causes smbstatus to only list locks. +label(minusp) dit(bf(-p)) print a list of url(bf(smbd))(smbd.8.html) processes and exit. Useful for scripting. +label(minusS) dit(bf(-S)) causes smbstatus to only list shares. +label(minuss) dit(bf(-s configuration file)) The default configuration file name is determined at compile time. The file specified contains the configuration details required by the server. See url(bf(smb.conf (5)))(smb.conf.5.html) for more information. +label(minusu) dit(bf(-u username)) selects information relevant to em(username) only. diff --git a/docs/yodldocs/smbtar.1.yo b/docs/yodldocs/smbtar.1.yo index 27b4466777..8f62c3a1f6 100644 --- a/docs/yodldocs/smbtar.1.yo +++ b/docs/yodldocs/smbtar.1.yo @@ -8,7 +8,7 @@ manpagename(smbtar)(shell script for backing up SMB/CIFS shares directly to UNIX label(SYNOPSIS) manpagesynopsis() -bf(smbtar) -s server [-p password] [-x service] [-X] [-d directory] [-u user] [-t tape] [-b blocksize] [-N filename] [-i] [-r] [-l log level] [-v] filenames +bf(smbtar) link(-s server)(minuss) [link(-p password)(minusp)] [link(-x service)(minusx)] [link(-X)(minusX)] [link(-d directory)(minusd)] [link(-u user)(minusu)] [link(-t tape)(minust)] [link(-b blocksize)(minusb)] [link(-N filename)(minusN)] [link(-i)(minusi)] [link(-r)(minusr)] [link(-l log level)(minusl)] [link(-v)(minusv)] filenames label(DESCRIPTION) manpagedescription() @@ -24,22 +24,29 @@ manpageoptions() startdit() +label(minuss) dit(bf(-s server)) The SMB/CIFS server that the share resides upon. +label(minusx) dit(bf(-x service)) The share name on the server to connect to. The default is tt(backup). +label(minusX) dit(bf(-X)) Exclude mode. Exclude filenames... from tar create or restore. +label(minusd) dit(bf(-d directory)) Change to initial em(directory) before restoring / backing up files. +label(minusv) dit(bf(-v)) Verbose mode. +label(minusp) dit(bf(-p password)) The password to use to access a share. Default: none +label(minusu) dit(bf(-u user)) The user id to connect as. Default: UNIX login name. label(minust) @@ -47,19 +54,24 @@ dit(bf(-t tape)) Tape device. May be regular file or tape device. Default: em(TAPE) environmental variable; if not set, a file called tt(tar.out). +label(minusb) dit(bf(-b blocksize)) Blocking factor. Defaults to 20. See bf(tar (1)) for a fuller explanation. +label(minusN) dit(bf(-N filename)) Backup only files newer than filename. Could be used (for example) on a log file to implement incremental backups. +label(minusi) dit(bf(-i)) Incremental mode; tar files are only backed up if they have the archive bit set. The archive bit is reset after each file is read. +label(minusr) dit(bf(-r)) Restore. Files are restored to the share from the tar file. +label(minusl) dit(bf(-l log level)) Log (debug) level. Corresponds to the url(bf(-d))(smbclient.1.html#minusd) flag of url(bf(smbclient (1)))(smbclient.1.html). diff --git a/docs/yodldocs/testparm.1.yo b/docs/yodldocs/testparm.1.yo index 7ed84eee5e..1ff31adcf8 100644 --- a/docs/yodldocs/testparm.1.yo +++ b/docs/yodldocs/testparm.1.yo @@ -8,7 +8,7 @@ manpagename(testparm)(check an smb.conf configuration file for internal correctn label(SYNOPSIS) manpagesynopsis() -bf(testparm) [configfilename [hostname hostIP] ] +bf(testparm) [link(configfilename)(configfilename) [link(hostname)(hostname) link(hostIP)(hostIP)] ] label(DESCRIPTION) manpagedescription() @@ -33,10 +33,12 @@ manpageoptions() startdit() +label(configfilename) dit(bf(configfilename)) This is the name of the configuration file to check. If this parameter is not present then the default url(bf(smb.conf))(smb.conf.5.html) file will be checked. +label(hostname) dit(bf(hostname)) If this parameter and the following are specified, then testparm will examine the url(bf("hosts allow"))(smb.conf.5.html#hostsallow) and url(bf("hosts @@ -46,6 +48,7 @@ with this IP address would be allowed acces to the url(bf(smbd))(smbd.8.html) server. If this parameter is supplied, the hostIP parameter must also be supplied. +label(hostIP) dit(bf(hostIP)) This is the IP address of the host specified in the previous parameter. This address must be supplied if the hostname parameter is supplied. diff --git a/docs/yodldocs/testprns.1.yo b/docs/yodldocs/testprns.1.yo index b76fc9f3c4..4ad996da3f 100644 --- a/docs/yodldocs/testprns.1.yo +++ b/docs/yodldocs/testprns.1.yo @@ -8,7 +8,7 @@ manpagename(testparm)(check printer name for validity with smbd ) label(SYNOPSIS) manpagesynopsis() -bf(testprns) printername [printcapname] +bf(testprns) link(printername)(printername) [link(printcapname)(printcapname)] label(DESCRIPTION) manpagedescription() @@ -28,6 +28,7 @@ manpageoptions() startdit() +label(printername) dit(bf(printername)) The printer name to validate. Printer names are taken from the first field in each record in the @@ -39,6 +40,7 @@ more forgiving or less forgiving than bf(testprns). However, if bf(testprns) finds the printer then url(bf(smbd))(smbd.8.html) should do so as well. +label(printcapname) dit(bf(printcapname)) This is the name of the printcap file within which to search for the given printer name. |