summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/htmldocs/smbcontrol.1.html21
-rw-r--r--docs/manpages/smbcontrol.123
-rw-r--r--docs/yodldocs/smbcontrol.1.yo23
3 files changed, 52 insertions, 15 deletions
diff --git a/docs/htmldocs/smbcontrol.1.html b/docs/htmldocs/smbcontrol.1.html
index 65eff8b6a4..4ce05714c6 100644
--- a/docs/htmldocs/smbcontrol.1.html
+++ b/docs/htmldocs/smbcontrol.1.html
@@ -30,8 +30,9 @@
<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><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>
<h2>OPTIONS</h2>
@@ -39,9 +40,9 @@ or a <a href="nmbd.8.html"><strong>nmbd</strong></a> daemon running on the syste
<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.
+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
+<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
@@ -49,7 +50,8 @@ 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.
+<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
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>
@@ -58,6 +60,15 @@ 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>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.
+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>
diff --git a/docs/manpages/smbcontrol.1 b/docs/manpages/smbcontrol.1
index 9a6dd16abf..394e305108 100644
--- a/docs/manpages/smbcontrol.1
+++ b/docs/manpages/smbcontrol.1
@@ -13,8 +13,9 @@ smbcontrol \- send messages to smbd or nmbd processes
.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\&.
+\fBsmbcontrol\fP is a very small program, which sends messages to an
+\fBsmbd\fP or an \fBnmbd\fP daemon
+running on the system\&.
.PP
.SH "OPTIONS"
.PP
@@ -22,10 +23,10 @@ or a \fBnmbd\fP daemon running on the system\&.
.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\&.
+can be entered on STDIN\&. An empty command line or a "q" will quit the program\&.
.IP
.IP "\fBdestination\fP"
-is one of "nmbd", "smbd" or a process ID
+is one of "nmbd", "smbd" or a process ID\&.
.IP
The \fBsmbd\fP destination causes the message to be "broadcast" to all
smbd daemons\&.
@@ -37,7 +38,8 @@ 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\&.
+is one of: debug, force-election, ping, profile,
+or debuglevel\&.
.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\&.
@@ -50,6 +52,17 @@ 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
+The \fBprofile\fP 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\&.
+.IP
+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
.IP "\fBparameters\fP"
is any parameters required for the message-type
.IP
diff --git a/docs/yodldocs/smbcontrol.1.yo b/docs/yodldocs/smbcontrol.1.yo
index 2960f38d28..4127a5d881 100644
--- a/docs/yodldocs/smbcontrol.1.yo
+++ b/docs/yodldocs/smbcontrol.1.yo
@@ -17,8 +17,9 @@ 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.
+bf(smbcontrol) is a very small program, which sends messages to an
+url(bf(smbd))(smbd.8.html) or an url(bf(nmbd))(nmbd.8.html) daemon
+running on the system.
label(OPTIONS)
manpageoptions()
@@ -28,10 +29,10 @@ 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.
+can be entered on STDIN. An empty command line or a "q" will quit the program.
label(destination)
-dit(bf(destination)) is one of "nmbd", "smbd" or a process ID
+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.
@@ -43,7 +44,8 @@ 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.
+dit(bf(message-type)) is one of: debug, force-election, ping, profile,
+or debuglevel.
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.
@@ -56,6 +58,17 @@ 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.
+The bf(profile) 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.
+
+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.
+
label(parameters)
dit(bf(parameters)) is any parameters required for the message-type