summaryrefslogtreecommitdiff
path: root/docs/yodldocs
diff options
context:
space:
mode:
authorJeremy Allison <jra@samba.org>1998-11-02 21:25:00 +0000
committerJeremy Allison <jra@samba.org>1998-11-02 21:25:00 +0000
commit47f2e19adf2917e994b7eeddf1c24f96c5e6fe19 (patch)
treed2c0da8185bc941f0e5c2395a9a7023cb159407b /docs/yodldocs
parentc082539152eefb90a752277b3917403f613c3a3a (diff)
downloadsamba-47f2e19adf2917e994b7eeddf1c24f96c5e6fe19.tar.gz
samba-47f2e19adf2917e994b7eeddf1c24f96c5e6fe19.tar.bz2
samba-47f2e19adf2917e994b7eeddf1c24f96c5e6fe19.zip
Fixed up html links - docs look better now (getting the hang of this).
Added nmblookup.1.yo. Jeremy. (This used to be commit 8eb78a1fe5ff65f575cc1773b301e18be714d652)
Diffstat (limited to 'docs/yodldocs')
-rw-r--r--docs/yodldocs/make_smbcodepage.1.yo9
-rw-r--r--docs/yodldocs/nmbd.8.yo2
-rw-r--r--docs/yodldocs/nmblookup.1.yo138
-rw-r--r--docs/yodldocs/samba.7.yo25
-rw-r--r--docs/yodldocs/smbclient.1.yo38
-rw-r--r--docs/yodldocs/smbd.8.yo5
6 files changed, 185 insertions, 32 deletions
diff --git a/docs/yodldocs/make_smbcodepage.1.yo b/docs/yodldocs/make_smbcodepage.1.yo
index a4f30e4a47..285079d336 100644
--- a/docs/yodldocs/make_smbcodepage.1.yo
+++ b/docs/yodldocs/make_smbcodepage.1.yo
@@ -135,14 +135,15 @@ label(AUTHOR)
manpageauthor()
The original Samba software and related utilities were created by
-Andrew Tridgell (samba-bugs@samba.anu.edu.au). Samba is now developed
+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.
+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.
+See url(bf(samba (8)))(samba.7.html) to find out how to get a full
+list of contributors and details on how to submit bug reports,
+comments etc.
diff --git a/docs/yodldocs/nmbd.8.yo b/docs/yodldocs/nmbd.8.yo
index af62505dc4..6cd9a12522 100644
--- a/docs/yodldocs/nmbd.8.yo
+++ b/docs/yodldocs/nmbd.8.yo
@@ -200,7 +200,7 @@ 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.
+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.
diff --git a/docs/yodldocs/nmblookup.1.yo b/docs/yodldocs/nmblookup.1.yo
new file mode 100644
index 0000000000..9de3372e4f
--- /dev/null
+++ b/docs/yodldocs/nmblookup.1.yo
@@ -0,0 +1,138 @@
+mailto(samba-bugs@samba.anu.edu.au)
+
+manpage(nmblookup)(1)(23 Oct 1998)(Samba)(SAMBA)
+
+label(NAME)
+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
+
+label(DESCRIPTION)
+manpagedescription()
+
+This program is part of the bf(Samba) suite.
+
+bf(nmblookup) is used to query NetBIOS names and map them to IP
+addresses in a network using NetBIOS over TCP/IP queries. The options
+allow the name queries to be directed at a particlar IP broadcast area
+or to a particular machine. All queries are done over UDP.
+
+label(OPTIONS)
+manpageoptions()
+
+startdit()
+
+dit(bf(-M)) Searches for a master browser. This is done by doing a
+broadcast lookup on the special name tt(__MSBROWSE__).
+
+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
+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.
+
+dit(bf(-S)) Once the name query has returned an IP address then do a
+node status query as well.
+
+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
+UDP port 137. Unfortunately, on most UNIX systems root privillage is
+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.
+
+dit(bf(-A)) Interpret <name> as an IP Address and do a node status
+query on this address.
+
+dit(bf(-h)) Print a help (usage) message.
+
+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
+interface as either auto-detected or defined in the url(bf(smb.conf
+(5)))(smb.conf.5.html) file.
+
+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.
+
+dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10.
+
+The default value if this parameter is not specified is zero.
+
+The higher this value, the more detail will be logged about the
+activities of bf(nmblookup). At level 0, only critical errors and
+serious warnings will be logged.
+
+Levels above 1 will generate considerable amounts of log data, and
+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.
+
+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
+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.
+
+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
+appending tt(#<type>) to the name.
+
+enddit()
+
+label(EXAMPLES)
+manpagesection(EXAMPLES)
+
+bf(nmblookup) can be used to query a WINS server (in the same way .B
+nslookup is used to query DNS servers). To query a WINS server,
+nmblookup must be called like this:
+
+tt(nmblookup -U server -R 'name')
+
+For example, running :
+
+tt(nmblookup -U samba.anu.edu.au -R IRIX#1B')
+
+would query the WINS server samba.anu.edu.au for the domain master
+browser (1B name type) for the IRIX workgroup.
+
+label(VERSION)
+manpagesection(VERSION)
+
+This man page is (mostly) correct for version 2.0 of the Samba suite,
+plus some of the recent patches to it. These notes will necessarily
+lag behind development of the software, so it is possible that your
+version of the server 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.
+
+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)
+
+label(AUTHOR)
+manpageauthor()
+
+The original Samba software and related utilities were created by
+Andrew Tridgell (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.
+
diff --git a/docs/yodldocs/samba.7.yo b/docs/yodldocs/samba.7.yo
index b9034edd44..da9eb224d2 100644
--- a/docs/yodldocs/samba.7.yo
+++ b/docs/yodldocs/samba.7.yo
@@ -1,5 +1,5 @@
mailto(samba-bugs@samba.anu.edu.au)
-manpage(samba)(7)(23 Oct 1998)(Samba)()
+manpage(Samba)(7)(23 Oct 1998)(Samba)()
label(NAME)
manpagename(Samba)(A Windows fileserver for UNIX)
@@ -28,28 +28,28 @@ enough then please send a patch to email(samba-bugs@samba.anu.edu.au).
startdit()
-dit(bf(smbd)) nl() The bf(smbd) (8) daemon provides the file and print
+dit(url(bf(smbd))(smbd.8.html)) nl() The bf(smbd) (8) daemon provides the file and print
services to SMB clients, such as Windows 95/98, Windows NT, Windows
for Workgroups or LanManager. The configuration file for this daemon
is described in bf(smb.conf (5)).
-dit(bf(nmbd)) nl() The bf(nmbd) (8) daemon provides NetBIOS
+dit(url(bf(nmbd))(nmbd.8.html)) nl() The bf(nmbd) (8) daemon provides NetBIOS
nameserving and browsing support. The configuration file for this
daemon is described in bf(smb.conf (5)).
-dit(bf(smbclient)) nl() The bf(smbclient) (1) program implements a simple
+dit(url(bf(smbclient))(smbclient.1.html)) nl() The bf(smbclient) (1) program implements a simple
ftp-like client. This is useful for accessing SMB shares on other
compatible servers (such as Windows NT), and can also be used to allow
a UNIX box to print to a printer attached to any SMB server (such as a
PC running Windows NT).
-dit(bf(testparm)) nl() The bf(testparm) (1) utility allows you to test your
+dit(url(bf(testparm))(testparm.1.html)) nl() The bf(testparm) (1) utility allows you to test your
bf(smb.conf (5)) configuration file.
-dit(bf(smbstatus)) nl() The bf(smbstatus) (1) utility allows you to tell
+dit(url(bf(smbstatus))(smbstatus.1.html)) nl() The bf(smbstatus) (1) utility allows you to tell
who is currently using the bf(smbd) (8) server.
-dit(bf(nmblookup)) nl() the bf(nmblookup) (1) utility allows NetBIOS
+dit(url(bf(nmblookup))(nmblookup.1.html)) nl() the bf(nmblookup) (1) utility allows NetBIOS
name queries to be made from the UNIX machine.
enddit()
@@ -113,13 +113,12 @@ url(http://samba.anu.edu.au/samba/samba-thanks.html)(http://samba.anu.edu.au/sam
label(AUTHOR)
manpageauthor()
-The main author of the Samba suite is Andrew Tridgell. He may be
-contacted via e-mail at email(samba-bugs@samba.anu.edu.au). Samba is
-now maintained by a distributed group of people around the world
-collectively known as the Samba Team.
+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.
-
+Allison, email(samba-bugs@samba.anu.edu.au).
diff --git a/docs/yodldocs/smbclient.1.yo b/docs/yodldocs/smbclient.1.yo
index 8634bee742..92b0f162de 100644
--- a/docs/yodldocs/smbclient.1.yo
+++ b/docs/yodldocs/smbclient.1.yo
@@ -40,10 +40,10 @@ 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 link(bf(name resolve
-order))(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 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.
dit(bf(password)) password is the password required to access the
specified service on the specified server. If this parameter is
@@ -74,7 +74,7 @@ socket. See the url(socket options)(smb.conf.5.html#socket options)
parameter in the url(bf(smb.conf (5)))(smb.conf.5.html) manpage for
the list of valid options.
-label(name resolve order)
+label(name_resolve_order)
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.
@@ -202,7 +202,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 link(name resolve order)(name resolve order) parameter
+above in the url(bf(name resolve order))(smbclient.1.html#name_resolve_order) 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.
@@ -321,7 +321,7 @@ share. The secondary tar flags that can be given to this option are :
dit(bf(c)) Create a tar file on UNIX. Must be followed by the
name of a tar file, tape device or tt("-") for standard output. If
using standard output you must turn the log level to its lowest value
- tt(-d0) to avoid corrupting your tar file. This flag is
+ tt(-d0) to avoid corrupting your tar file. This flag is
mutually exclusive with the bf(x) flag.
dit(bf(x)) Extract (restore) a local tar file back to a
@@ -605,11 +605,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 link(bf(-T))(minus_T) 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 url(bf(-T))(smbclient.1.html#minus_T) 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
@@ -689,18 +689,28 @@ The number and nature of diagnostics available depends on the debug
level used by the client. If you have problems, set the debug level to
3 and peruse the log files.
+label(VERSION)
+manpagesection(VERSION)
+
+This man page is (mostly) correct for version 2.0 of the Samba suite,
+plus some of the recent patches to it. These notes will necessarily
+lag behind development of the software, so it is possible that your
+version of the server 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.
+
label(AUTHOR)
manpageauthor()
The original Samba software and related utilities were created by
-Andrew Tridgell (samba-bugs@samba.anu.edu.au). Samba is now developed
+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.
+Allison, email(samba-bugs@samba.anu.edu.au).
See url(bf(samba (8)))(samba.7.html) to find out how to get a full
list of contributors and details on how to submit bug reports,
diff --git a/docs/yodldocs/smbd.8.yo b/docs/yodldocs/smbd.8.yo
index e94bc69845..c537ccc83b 100644
--- a/docs/yodldocs/smbd.8.yo
+++ b/docs/yodldocs/smbd.8.yo
@@ -419,5 +419,10 @@ Andrew Tridgell (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.