'make everything' in docs
[bbaumbach/samba-autobuild/.git] / docs / manpages / smbcontrol.1
index f3e6c843b598db0b6366cf4410edeedd914fbebe..b60841dc942d818c66aafd3edb388fdc6a4edcdb 100644 (file)
@@ -1,24 +1,26 @@
-.\" This manpage has been automatically generated by docbook2man-spec
-.\" from a DocBook document.  docbook2man-spec can be found at:
-.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> 
+.\" This manpage has been automatically generated by docbook2man 
+.\" from a DocBook document.  This tool can be found at:
+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 .\" Please send any bug reports, improvements, comments, patches, 
 .\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "SMBCONTROL" "1" "08 May 2002" "" ""
+.TH "SMBCONTROL" "1" "01 October 2002" "" ""
 .SH NAME
 smbcontrol \- send messages to smbd, nmbd or winbindd processes
 .SH SYNOPSIS
-.sp
-\fBsmbcontrol\fR [ \fB-i\fR ] 
-.sp
-\fBsmbcontrol\fR [ \fBdestination\fR ]  [ \fBmessage-type\fR ]  [ \fBparameter\fR ] 
+
+\fBsmbcontrol\fR [ \fB-i\fR ]
+
+
+\fBsmbcontrol\fR [ \fBdestination\fR ] [ \fBmessage-type\fR ] [ \fBparameter\fR ]
+
 .SH "DESCRIPTION"
 .PP
-This tool is part of the  Sambasuite.
+This tool is part of the  Samba suite.
 .PP
 \fBsmbcontrol\fR is a very small program, which 
-sends messages to an smbd(8), 
+sends messages to an smbd(8) 
 an nmbd(8)
-or a winbindd(8)
+or a winbindd(8) 
 daemon running on the system.
 .SH "OPTIONS"
 .TP
@@ -46,8 +48,8 @@ to only that process.
 One of: close-share,
 debug, 
 force-election, ping
-, profile,  debuglevel, profilelevel, 
-or printer-notify.
+, profile,   debuglevel, profilelevel, 
+or printnotify.
 
 The close-share message-type sends a 
 message to smbd which will then close the client connections to
@@ -69,7 +71,7 @@ master election.
 
 The 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 
+for the same number of  reply "pong" messages. This can be sent to 
 any of the destinations.
 
 The profile message-type sends a 
@@ -82,19 +84,47 @@ be sent to any smbd or nmbd destinations.
 
 The debuglevel message-type sends 
 a "request debug level" message. The current debug level setting 
-is returned by a "debuglevel" message. This can be 
+is returned by a  "debuglevel" message. This can be 
 sent to any of the destinations.
 
 The profilelevel message-type sends 
-a "request profile level" message. The current profile level 
-setting is returned by a "profilelevel" message. This can be sent 
+a "request profile level" message.  The current profile level 
+setting is returned by a  "profilelevel" message. This can be sent 
 to any smbd or nmbd destinations.
 
-The printer-notify message-type sends a 
+The printnotify 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.
+any Windows NT clients connected to a printer. This message-type
+takes the following arguments:
+.RS
+.TP
+\fBqueuepause printername\fR
+Send a queue pause change notify
+message to the printer specified.
+.TP
+\fBqueueresume printername\fR
+Send a queue resume change notify
+message for the printer specified.
+.TP
+\fBjobpause printername unixjobid\fR
+Send a job pause change notify
+message for the printer and unix jobid
+specified.
+.TP
+\fBjobresume printername unixjobid\fR
+Send a job resume change notify
+message for the printer and unix jobid
+specified.
+.TP
+\fBjobdelete printername unixjobid\fR
+Send a job delete change notify
+message for the printer and unix jobid
+specified.
+.RE
+Note that this message only sends notification that an
+event has occured.  It doesn't actually cause the
+event to happen.
+This message can only be sent to smbd. 
 .TP
 \fBparameters\fR
 any parameters required for the message-type
@@ -104,8 +134,8 @@ This man page is correct for version 2.2 of
 the Samba suite.
 .SH "SEE ALSO"
 .PP
-\fBnmbd(8)\fR, 
-and \fBsmbd(8)\fR.
+\fBnmbd(8)\fR 
+and \fBsmbd(8)\fR
 .SH "AUTHOR"
 .PP
 The original Samba software and related utilities 
@@ -117,5 +147,5 @@ 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, available at
 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 
-release by Jeremy Allison. The conversion to DocBook for 
+release by Jeremy Allison.  The conversion to DocBook for 
 Samba 2.2 was done by Gerald Carter