1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-25 23:21:54 +03:00

new man pages

(This used to be commit 8a7d6c8e91)
This commit is contained in:
Herb Lewis 2000-09-29 19:50:57 +00:00
parent 910e8a5c9c
commit 2c01353475
6 changed files with 557 additions and 0 deletions

View File

@ -0,0 +1,104 @@
<html><head><title>findsmb (1)</title>
<link rev="made" href="mailto:samba@samba.org">
</head>
<body>
<hr>
<h1>findsmb (1)</h1>
<h2>Samba</h2>
<h2>2 May 2000</h2>
<p><br><a name="NAME"></a>
<h2>NAME</h2>
findsmb - list info about machines that respond to SMB name queries on a subnet
<p><br><a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
<p><br><strong>findsmb</strong> [<a href="findsmb.1.html#subnetbroadcastaddress">subnet broadcast address</a>]
<p><br><a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
<p><br>This perl script is part of the <strong>Samba</strong> suite.
<p><br><strong>findsmb</strong> is a perl script that prints out several pieces
of information about machines on a subnet that respond to SMB
name query requests.
It uses <a href="nmblookup.1.html"><strong>nmblookup</strong></a> and
<a href="smbclient.1.html"><strong>smbclient</strong></a> to obtain this information.
<p><br><a name="OPTIONS"></a>
<h2>OPTIONS</h2>
<p><br><ul>
<p><br><a name="subnetbroadcastaddress"></a>
<li><strong><strong>subnet broadcast address</strong></strong> Without this option, <strong>findsmb</strong>
will probe the subnet of the machine where <strong>findsmb</strong> is run.
This value is passed to <strong>nmblookup</strong> as part of the <strong>-B</strong>
option
<p><br></ul>
<p><br><a name="EXAMPLES"></a>
<h2>EXAMPLES</h2>
<p><br>The output of <strong>findsmb</strong> lists the following information for all
machines that respond to the initial <strong>nmblookup</strong> for any name:
IP address, NetBIOS name, Workgroup name, operating system, and
SMB server version.
<p><br>There will be a "+" in front of the workgroup name for machines that are
local master browsers for that workgroup. There will be an "*" in front
of the workgroup name for machines that are the domain master browser for
that workgroup. Machines that are running Windows, Windows 95 or Windows 98
will not show any information about the operating system or server version.
<p><br>The command must be run on a system without
<strong>nmbd</strong> running. If <strong>nmbd</strong> is running on the system, you will only
get the IP address and the DNS name of the machine. To get proper responses
from Windows 95 and Windows 98 machines, the command must be run as root.
<p><br>For example running:
<p><br><code>findsmb</code>
<p><br>on a machine without <strong>nmbd</strong> running would yield output similar
to the following
<p><br><pre>
IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION
---------------------------------------------------------------------
192.168.35.10 MINESET-TEST1 [DMVENGR]
192.168.35.55 LINUXBOX *[MYGROUP] [Unix] [Samba 2.0.6]
192.168.35.56 HERBNT2 [HERB-NT]
192.168.35.63 GANDALF [MVENGR] [Unix] [Samba 2.0.5a for IRIX]
192.168.35.65 SAUNA [WORKGROUP] [Unix] [Samba 1.9.18p10]
192.168.35.71 FROGSTAR [ENGR] [Unix] [Samba 2.0.0 for IRIX]
192.168.35.78 HERBDHCP1 +[HERB]
192.168.35.88 SCNT2 +[MVENGR] [Windows NT 4.0] [NT LAN Manager 4.0]
192.168.35.93 FROGSTAR-PC [MVENGR] [Windows 5.0] [Windows 2000 LAN Manager]
192.168.35.97 HERBNT1 *[HERB-NT] [Windows NT 4.0] [NT LAN Manager 4.0]
</pre>
<p><br><a name="VERSION"></a>
<h2>VERSION</h2>
<p><br>This man page is correct for version 2.0 of the Samba suite.
<p><br><a name="SEEALSO"></a>
<h2>SEE ALSO</h2>
<p><br><a href="nmblookup.1.html"><strong>nmblookup (1)</strong></a>, <a href="smbclient.1.html"><strong>smbclient (1)</strong></a>
<p><br><a name="AUTHOR"></a>
<h2>AUTHOR</h2>
<p><br>This perl script was developed by Herb Lewis of SGI.
<p><br>The original Samba software and related utilities were created by
Andrew Tridgell <a href="mailto:samba@samba.org"><em>samba@samba.org</em></a>. Samba is now developed
by the Samba Team as an Open Source project similar to the way the
Linux kernel is developed.
<p><br>See <a href="samba.7.html"><strong>samba (7)</strong></a> to find out how to get a full
list of contributors and details on how to submit bug reports,
comments etc.
</body>
</html>

View File

@ -0,0 +1,88 @@
<html><head><title>smbcontrol (1)</title>
<link rev="made" href="mailto:samba@samba.org">
</head>
<body>
<hr>
<h1>smbcontrol (1)</h1>
<h2>Samba</h2>
<h2>29 Sep 2000</h2>
<p><br><a name="NAME"></a>
<h2>NAME</h2>
smbcontrol - send messages to smbd or nmbd processes
<p><br><a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
<p><br><strong>smbcontrol</strong> <a href="smbcontrol.1.html#minusi">-i</a>
<p><br><strong>smbcontrol</strong> <a href="smbcontrol.1.html#destination">destination</a> <a href="smbcontrol.1.html#messagetype">message-type</a> <a href="smbcontrol.1.html#parameters">parameters</a>
<p><br><a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
<p><br>This program is part of the <strong>Samba</strong> suite.
<p><br><strong>smbcontrol</strong> is a very small program, which sends messages to a <a href="smbd.8.html"><strong>smbd</strong></a>
or a <a href="nmbd.8.html"><strong>nmbd</strong></a> daemon running on the system.
<p><br><a name="OPTIONS"></a>
<h2>OPTIONS</h2>
<p><br><ul>
<p><br><a name="minusi"></a>
<li><strong><strong>-i</strong></strong> Run interactively. Individual commands of the form
<a href="smbcontrol.1.html#destination">destination</a> <a href="smbcontrol.1.html#messagetype">message-type</a> <a href="smbcontrol.1.html#parameters">parameters</a>
can be entered on STDIN. An empty command line will quit the program.
<p><br><a name="destination"></a>
<li><strong><strong>destination</strong></strong> is one of "nmbd", "smbd" or a process ID
<p><br>The <strong>smbd</strong> destination causes the message to be "broadcast" to all
smbd daemons.
<p><br>The <strong>nmbd</strong> destination causes the message to be sent to the nmbd
daemon specified in the <strong>nmbd.pid</strong> file.
<p><br>If a single process ID is given, the message is sent to only that
process.
<p><br><a name="messagetype"></a>
<li><strong><strong>message-type</strong></strong> is one of: debug, force-election, or ping.
<p><br>The <strong>debug</strong> message-type allows the debug level to be set to the value
specified by the parameter. This can be sent to any of the destinations.
<p><br>The <strong>force-election</strong> message-type can only be sent to the <strong>nmbd</strong>
destination. This message causes the <strong>nmbd</strong> daemon to force a
new browse master election.
<p><br>The <strong>ping</strong> message-type sends the number of "ping" messages specified
by the parameter and waits for the same number of
reply "pong" messages. This can be sent to any of the destinations.
<p><br><a name="parameters"></a>
<li><strong><strong>parameters</strong></strong> is any parameters required for the message-type
<p><br></ul>
<p><br><a name="VERSION"></a>
<h2>VERSION</h2>
<p><br>This man page is correct for version 2.2.0 of the Samba suite.
<p><br><a name="SEEALSO"></a>
<h2>SEE ALSO</h2>
<p><br><a href="smbd.8.html"><strong>smbd (8)</strong></a>, <a href="nmbd.8.html"><strong>nmbd (8)</strong></a>
<p><br><a name="AUTHOR"></a>
<h2>AUTHOR</h2>
<p><br>The original Samba software and related utilities were created by
Andrew Tridgell <a href="mailto:samba@samba.org"><em>samba@samba.org</em></a>. Samba is now developed
by the Samba Team as an Open Source project similar to the way the
Linux kernel is developed.
<p><br>This man page source was written in YODL format (another excellent piece of Open
Source software, available at
<a href="ftp://ftp.icce.rug.nl/pub/unix/"><strong>ftp://ftp.icce.rug.nl/pub/unix/</strong></a>)
for the Samba 2.2.0 release by Herb Lewis.
<a href="mailto:samba@samba.org"><em>samba@samba.org</em></a>.
<p><br>See <a href="samba.7.html"><strong>samba (7)</strong></a> to find out how to get a full
list of contributors and details on how to submit bug reports,
comments etc.
</body>
</html>

95
docs/manpages/findsmb.1 Normal file
View File

@ -0,0 +1,95 @@
.TH "findsmb " "1" "2 May 2000" "Samba" "SAMBA"
.PP
.SH "NAME"
findsmb \- list info about machines that respond to SMB name queries on a subnet
.PP
.SH "SYNOPSIS"
.PP
\fBfindsmb\fP [subnet broadcast address]
.PP
.SH "DESCRIPTION"
.PP
This perl script is part of the \fBSamba\fP suite\&.
.PP
\fBfindsmb\fP is a perl script that prints out several pieces
of information about machines on a subnet that respond to SMB
name query requests\&.
It uses \fBnmblookup\fP and
\fBsmbclient\fP to obtain this information\&.
.PP
.SH "OPTIONS"
.PP
.IP
.IP "\fBsubnet broadcast address\fP"
Without this option, \fBfindsmb\fP
will probe the subnet of the machine where \fBfindsmb\fP is run\&.
This value is passed to \fBnmblookup\fP as part of the \fB-B\fP
option
.IP
.PP
.SH "EXAMPLES"
.PP
The output of \fBfindsmb\fP lists the following information for all
machines that respond to the initial \fBnmblookup\fP for any name:
IP address, NetBIOS name, Workgroup name, operating system, and
SMB server version\&.
.PP
There will be a "+" in front of the workgroup name for machines that are
local master browsers for that workgroup\&. There will be an "*" in front
of the workgroup name for machines that are the domain master browser for
that workgroup\&. Machines that are running Windows, Windows 95 or Windows 98
will not show any information about the operating system or server version\&.
.PP
The command must be run on a system without
\fBnmbd\fP running\&. If \fBnmbd\fP is running on the system, you will only
get the IP address and the DNS name of the machine\&. To get proper responses
from Windows 95 and Windows 98 machines, the command must be run as root\&.
.PP
For example running:
.PP
\f(CWfindsmb\fP
.PP
on a machine without \fBnmbd\fP running would yield output similar
to the following
.PP
.DS
IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION
---------------------------------------------------------------------
192\&.168\&.35\&.10 MINESET-TEST1 [DMVENGR]
192\&.168\&.35\&.55 LINUXBOX *[MYGROUP] [Unix] [Samba 2\&.0\&.6]
192\&.168\&.35\&.56 HERBNT2 [HERB-NT]
192\&.168\&.35\&.63 GANDALF [MVENGR] [Unix] [Samba 2\&.0\&.5a for IRIX]
192\&.168\&.35\&.65 SAUNA [WORKGROUP] [Unix] [Samba 1\&.9\&.18p10]
192\&.168\&.35\&.71 FROGSTAR [ENGR] [Unix] [Samba 2\&.0\&.0 for IRIX]
192\&.168\&.35\&.78 HERBDHCP1 +[HERB]
192\&.168\&.35\&.88 SCNT2 +[MVENGR] [Windows NT 4\&.0] [NT LAN Manager 4\&.0]
192\&.168\&.35\&.93 FROGSTAR-PC [MVENGR] [Windows 5\&.0] [Windows 2000 LAN Manager]
192\&.168\&.35\&.97 HERBNT1 *[HERB-NT] [Windows NT 4\&.0] [NT LAN Manager 4\&.0]
.DE
.PP
.SH "VERSION"
.PP
This man page is correct for version 2\&.0 of the Samba suite\&.
.PP
.SH "SEE ALSO"
.PP
\fBnmblookup (1)\fP, \fBsmbclient (1)\fP
.PP
.SH "AUTHOR"
.PP
This perl script was developed by Herb Lewis of SGI\&.
.PP
The original Samba software and related utilities were created by
Andrew Tridgell \fIsamba@samba\&.org\fP\&. Samba is now developed
by the Samba Team as an Open Source project similar to the way the
Linux kernel is developed\&.
.PP
See \fBsamba (7)\fP to find out how to get a full
list of contributors and details on how to submit bug reports,
comments etc\&.

View File

@ -0,0 +1,80 @@
.TH "smbcontrol " "1" "29 Sep 2000" "Samba" "SAMBA"
.PP
.SH "NAME"
smbcontrol \- send messages to smbd or nmbd processes
.PP
.SH "SYNOPSIS"
.PP
\fBsmbcontrol\fP -i
.PP
\fBsmbcontrol\fP destination message-type parameters
.PP
.SH "DESCRIPTION"
.PP
This program is part of the \fBSamba\fP suite\&.
.PP
\fBsmbcontrol\fP is a very small program, which sends messages to a \fBsmbd\fP
or a \fBnmbd\fP daemon running on the system\&.
.PP
.SH "OPTIONS"
.PP
.IP
.IP "\fB-i\fP"
Run interactively\&. Individual commands of the form
destination message-type parameters
can be entered on STDIN\&. An empty command line will quit the program\&.
.IP
.IP "\fBdestination\fP"
is one of "nmbd", "smbd" or a process ID
.IP
The \fBsmbd\fP destination causes the message to be "broadcast" to all
smbd daemons\&.
.IP
The \fBnmbd\fP destination causes the message to be sent to the nmbd
daemon specified in the \fBnmbd\&.pid\fP file\&.
.IP
If a single process ID is given, the message is sent to only that
process\&.
.IP
.IP "\fBmessage-type\fP"
is one of: debug, force-election, or ping\&.
.IP
The \fBdebug\fP message-type allows the debug level to be set to the value
specified by the parameter\&. This can be sent to any of the destinations\&.
.IP
The \fBforce-election\fP message-type can only be sent to the \fBnmbd\fP
destination\&. This message causes the \fBnmbd\fP daemon to force a
new browse master election\&.
.IP
The \fBping\fP message-type sends the number of "ping" messages specified
by the parameter and waits for the same number of
reply "pong" messages\&. This can be sent to any of the destinations\&.
.IP
.IP "\fBparameters\fP"
is any parameters required for the message-type
.IP
.PP
.SH "VERSION"
.PP
This man page is correct for version 2\&.2\&.0 of the Samba suite\&.
.PP
.SH "SEE ALSO"
.PP
\fBsmbd (8)\fP, \fBnmbd (8)\fP
.PP
.SH "AUTHOR"
.PP
The original Samba software and related utilities were created by
Andrew Tridgell \fIsamba@samba\&.org\fP\&. Samba is now developed
by the Samba Team as an Open Source project similar to the way the
Linux kernel is developed\&.
.PP
This man page source was written in YODL format (another excellent piece of Open
Source software, available at
\fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
for the Samba 2\&.2\&.0 release by Herb Lewis\&.
\fIsamba@samba\&.org\fP\&.
.PP
See \fBsamba (7)\fP to find out how to get a full
list of contributors and details on how to submit bug reports,
comments etc\&.

100
docs/yodldocs/findsmb.1.yo Normal file
View File

@ -0,0 +1,100 @@
mailto(samba@samba.org)
manpage(findsmb htmlcommand((1)))(1)(2 May 2000)(Samba)(SAMBA)
label(NAME)
manpagename(findsmb)(list info about machines that respond to SMB name queries on a subnet)
label(SYNOPSIS)
manpagesynopsis()
bf(findsmb) [link(subnet broadcast address)(subnetbroadcastaddress)]
label(DESCRIPTION)
manpagedescription()
This perl script is part of the bf(Samba) suite.
bf(findsmb) is a perl script that prints out several pieces
of information about machines on a subnet that respond to SMB
name query requests.
It uses url(bf(nmblookup))(nmblookup.1.html) and
url(bf(smbclient))(smbclient.1.html) to obtain this information.
label(OPTIONS)
manpageoptions()
startdit()
label(subnetbroadcastaddress)
dit(bf(subnet broadcast address)) Without this option, bf(findsmb)
will probe the subnet of the machine where bf(findsmb) is run.
This value is passed to bf(nmblookup) as part of the bf(-B)
option
enddit()
label(EXAMPLES)
manpagesection(EXAMPLES)
The output of bf(findsmb) lists the following information for all
machines that respond to the initial bf(nmblookup) for any name:
IP address, NetBIOS name, Workgroup name, operating system, and
SMB server version.
There will be a "+" in front of the workgroup name for machines that are
local master browsers for that workgroup. There will be an "*" in front
of the workgroup name for machines that are the domain master browser for
that workgroup. Machines that are running Windows, Windows 95 or Windows 98
will not show any information about the operating system or server version.
The command must be run on a system without
bf(nmbd) running. If bf(nmbd) is running on the system, you will only
get the IP address and the DNS name of the machine. To get proper responses
from Windows 95 and Windows 98 machines, the command must be run as root.
For example running:
tt(findsmb)
on a machine without bf(nmbd) running would yield output similar
to the following
verb(
IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION
---------------------------------------------------------------------
192.168.35.10 MINESET-TEST1 [DMVENGR]
192.168.35.55 LINUXBOX *[MYGROUP] [Unix] [Samba 2.0.6]
192.168.35.56 HERBNT2 [HERB-NT]
192.168.35.63 GANDALF [MVENGR] [Unix] [Samba 2.0.5a for IRIX]
192.168.35.65 SAUNA [WORKGROUP] [Unix] [Samba 1.9.18p10]
192.168.35.71 FROGSTAR [ENGR] [Unix] [Samba 2.0.0 for IRIX]
192.168.35.78 HERBDHCP1 +[HERB]
192.168.35.88 SCNT2 +[MVENGR] [Windows NT 4.0] [NT LAN Manager 4.0]
192.168.35.93 FROGSTAR-PC [MVENGR] [Windows 5.0] [Windows 2000 LAN Manager]
192.168.35.97 HERBNT1 *[HERB-NT] [Windows NT 4.0] [NT LAN Manager 4.0]
)
label(VERSION)
manpagesection(VERSION)
This man page is correct for version 2.0 of the Samba suite.
label(SEEALSO)
manpageseealso()
url(bf(nmblookup (1)))(nmblookup.1.html), url(bf(smbclient (1)))(smbclient.1.html)
label(AUTHOR)
manpageauthor()
This perl script was developed by Herb Lewis of SGI.
The original Samba software and related utilities were created by
Andrew Tridgell email(samba@samba.org). Samba is now developed
by the Samba Team as an Open Source project similar to the way the
Linux kernel is developed.
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.

View File

@ -0,0 +1,90 @@
mailto(samba@samba.org)
manpage(smbcontrol htmlcommand((1)))(1)(29 Sep 2000)(Samba)(SAMBA)
label(NAME)
manpagename(smbcontrol)(send messages to smbd or nmbd processes)
label(SYNOPSIS)
manpagesynopsis()
bf(smbcontrol) link(-i)(minusi)
bf(smbcontrol) link(destination)(destination) link(message-type)(messagetype) link(parameters)(parameters)
label(DESCRIPTION)
manpagedescription()
This program is part of the bf(Samba) suite.
bf(smbcontrol) is a very small program, which sends messages to a url(bf(smbd))(smbd.8.html)
or a url(bf(nmbd))(nmbd.8.html) daemon running on the system.
label(OPTIONS)
manpageoptions()
startdit()
label(minusi)
dit(bf(-i)) Run interactively. Individual commands of the form
link(destination)(destination) link(message-type)(messagetype) link(parameters)(parameters)
can be entered on STDIN. An empty command line will quit the program.
label(destination)
dit(bf(destination)) is one of "nmbd", "smbd" or a process ID
The bf(smbd) destination causes the message to be "broadcast" to all
smbd daemons.
The bf(nmbd) destination causes the message to be sent to the nmbd
daemon specified in the bf(nmbd.pid) file.
If a single process ID is given, the message is sent to only that
process.
label(messagetype)
dit(bf(message-type)) is one of: debug, force-election, or ping.
The bf(debug) message-type allows the debug level to be set to the value
specified by the parameter. This can be sent to any of the destinations.
The bf(force-election) message-type can only be sent to the bf(nmbd)
destination. This message causes the bf(nmbd) daemon to force a
new browse master election.
The bf(ping) message-type sends the number of "ping" messages specified
by the parameter and waits for the same number of
reply "pong" messages. This can be sent to any of the destinations.
label(parameters)
dit(bf(parameters)) is any parameters required for the message-type
enddit()
label(VERSION)
manpagesection(VERSION)
This man page is correct for version 2.2.0 of the Samba suite.
label(SEEALSO)
manpageseealso()
url(bf(smbd (8)))(smbd.8.html), url(bf(nmbd (8)))(nmbd.8.html)
label(AUTHOR)
manpageauthor()
The original Samba software and related utilities were created by
Andrew Tridgell email(samba@samba.org). Samba is now developed
by the Samba Team as an Open Source project similar to the way the
Linux kernel is developed.
This man page source was written in YODL format (another excellent piece of Open
Source software, available at
url(bf(ftp://ftp.icce.rug.nl/pub/unix/))(ftp://ftp.icce.rug.nl/pub/unix/))
for the Samba 2.2.0 release by Herb Lewis.
email(samba@samba.org).
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.