summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTim Potter <tpot@samba.org>2000-11-05 23:06:13 +0000
committerTim Potter <tpot@samba.org>2000-11-05 23:06:13 +0000
commitf68bbb4b665376b75a04af349a475928a3721d73 (patch)
tree0ec9d2ba0a1369402de607082a1d739695146282 /docs
parenta6ff0d29d6dc60942463adebd819b87da4775da5 (diff)
downloadsamba-f68bbb4b665376b75a04af349a475928a3721d73.tar.gz
samba-f68bbb4b665376b75a04af349a475928a3721d73.tar.xz
samba-f68bbb4b665376b75a04af349a475928a3721d73.zip
Added documentation for printer-notify smbcontrol command.
(This used to be commit fdf6a5c76abc38e16cb7ee3f31512bfc1f639651)
Diffstat (limited to 'docs')
-rw-r--r--docs/htmldocs/smbcontrol.1.html76
-rw-r--r--docs/manpages/smbcontrol.111
-rw-r--r--docs/yodldocs/smbcontrol.1.yo7
3 files changed, 54 insertions, 40 deletions
diff --git a/docs/htmldocs/smbcontrol.1.html b/docs/htmldocs/smbcontrol.1.html
index 4ce05714c65..bc8cdf82b84 100644
--- a/docs/htmldocs/smbcontrol.1.html
+++ b/docs/htmldocs/smbcontrol.1.html
@@ -3,6 +3,7 @@
+
<html><head><title>smbcontrol (1)</title>
<link rev="made" href="mailto:samba@samba.org">
@@ -15,84 +16,87 @@
<h2>Samba</h2>
<h2>29 Sep 2000</h2>
-
-<p><br><a name="NAME"></a>
+<p><a name="NAME"></a>
<h2>NAME</h2>
smbcontrol - send messages to smbd or nmbd processes
-<p><br><a name="SYNOPSIS"></a>
+<p><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>
+<p><strong>smbcontrol</strong> <a href="smbcontrol.1.html#minusi">-i</a>
+<p><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><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 an
+<p>This program is part of the <strong>Samba</strong> suite.
+<p><strong>smbcontrol</strong> is a very small program, which sends messages to an
<a href="smbd.8.html"><strong>smbd</strong></a> or an <a href="nmbd.8.html"><strong>nmbd</strong></a> daemon
running on the system.
-<p><br><a name="OPTIONS"></a>
+<p><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
+<p><dl>
+<p><a name="minusi"></a>
+<p></p><dt><strong><strong>-i</strong></strong><dd> 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 or a "q" 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
+<p><a name="destination"></a>
+<p></p><dt><strong><strong>destination</strong></strong><dd> is one of "nmbd", "smbd" or a process ID.
+<p>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
+<p>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
+<p>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, ping, profile,
-or debuglevel.
-<p><br>The <strong>debug</strong> message-type allows the debug level to be set to the value
+<p><a name="messagetype"></a>
+<p></p><dt><strong><strong>message-type</strong></strong><dd> is one of: debug, force-election, ping, profile,
+debuglevel, or printer-notify.
+<p>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>
+<p>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
+<p>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>The <strong>profile</strong> message-type sends a message to an smbd to change the profile
+<p>The <strong>profile</strong> message-type sends a message to an smbd to change the profile
settings based on the parameter. The parameter can be "on" to turn on
profile stats collection, "off" to turn off profile stats collection, "count"
to enable only collection of count stats (time stats are disabled), and
"flush" to zero the current profile stats.
This can be sent to any of the destinations.
-<p><br>The <strong>debuglevel</strong> message-type sends a "request debug level" message.
+<p>The <strong>debuglevel</strong> message-type sends a "request debug level" message.
The current debug level setting is returned by a
"debuglevel" message. 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>
+<p>The <strong>printer-notify</strong> message-type sends a message to smbd which in turn
+sends a printer notify message to any Windows NT clients connected to
+a printer. This message-type takes an argument of the printer name to
+send notify messages to. This message can only be sent to smbd.
+<p><a name="parameters"></a>
+<p></p><dt><strong><strong>parameters</strong></strong><dd> is any parameters required for the message-type
+<p></dl>
+<p><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>
+<p>This man page is correct for version 2.2.0 of the Samba suite.
+<p><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>
+<p><a href="smbd.8.html"><strong>smbd (8)</strong></a>, <a href="nmbd.8.html"><strong>nmbd (8)</strong></a>
+<p><a name="AUTHOR"></a>
<h2>AUTHOR</h2>
-<p><br>The original Samba software and related utilities were created by
+<p>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
+<p>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
+<p>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>
diff --git a/docs/manpages/smbcontrol.1 b/docs/manpages/smbcontrol.1
index 394e3051080..5791f3fc453 100644
--- a/docs/manpages/smbcontrol.1
+++ b/docs/manpages/smbcontrol.1
@@ -39,7 +39,7 @@ process\&.
.IP
.IP "\fBmessage-type\fP"
is one of: debug, force-election, ping, profile,
-or debuglevel\&.
+debuglevel, or printer-notify\&.
.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\&.
@@ -63,6 +63,11 @@ The \fBdebuglevel\fP message-type sends a "request debug level" message\&.
The current debug level setting is returned by a
"debuglevel" message\&. This can be sent to any of the destinations\&.
.IP
+The \fBprinter-notify\fP message-type sends a message to smbd which in turn
+sends a printer notify message to any Windows NT clients connected to
+a printer\&. This message-type takes an argument of the printer name to
+send notify messages to\&. This message can only be sent to smbd\&.
+.IP
.IP "\fBparameters\fP"
is any parameters required for the message-type
.IP
@@ -78,7 +83,7 @@ This man page is correct for version 2\&.2\&.0 of the Samba suite\&.
.SH "AUTHOR"
.PP
The original Samba software and related utilities were created by
-Andrew Tridgell \fIsamba@samba\&.org\fP\&. Samba is now developed
+Andrew Tridgell 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\&.
.PP
@@ -86,7 +91,7 @@ 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\&.
+samba@samba\&.org\&.
.PP
See \fBsamba (7)\fP to find out how to get a full
list of contributors and details on how to submit bug reports,
diff --git a/docs/yodldocs/smbcontrol.1.yo b/docs/yodldocs/smbcontrol.1.yo
index 4127a5d8818..a6e86e63259 100644
--- a/docs/yodldocs/smbcontrol.1.yo
+++ b/docs/yodldocs/smbcontrol.1.yo
@@ -45,7 +45,7 @@ process.
label(messagetype)
dit(bf(message-type)) is one of: debug, force-election, ping, profile,
-or debuglevel.
+debuglevel, or printer-notify.
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.
@@ -69,6 +69,11 @@ The bf(debuglevel) message-type sends a "request debug level" message.
The current debug level setting is returned by a
"debuglevel" message. This can be sent to any of the destinations.
+The bf(printer-notify) message-type sends a message to smbd which in turn
+sends a printer notify message to any Windows NT clients connected to
+a printer. This message-type takes an argument of the printer name to
+send notify messages to. This message can only be sent to smbd.
+
label(parameters)
dit(bf(parameters)) is any parameters required for the message-type