Ignore:
Timestamp:
May 23, 2008, 6:56:41 AM (17 years ago)
Author:
Paul Smedley
Message:

Update source to 3.0.29

File:
1 edited

Legend:

Unmodified
Added
Removed

  • branches/samba-3.0/docs/manpages/smbcontrol.1

    r44 r134  
    1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
    2 .de Sh \" Subsection
    3 .br
    4 .if t .Sp
    5 .ne 5
    6 .PP
    7 \fB\\$1\fR
    8 .PP
    9 ..
    10 .de Sp \" Vertical space (when we can't use .PP)
    11 .if t .sp .5v
    12 .if n .sp
    13 ..
    14 .de Ip \" List item
    15 .br
    16 .ie \\n(.$>=3 .ne \\$3
    17 .el .ne 3
    18 .IP "\\$1" \\$2
    19 ..
    20 .TH "SMBCONTROL" 1 "" "" ""
     1.\"     Title: smbcontrol
     2.\"    Author:
     3.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
     4.\"      Date: 05/21/2008
     5.\"    Manual: User Commands
     6.\"    Source: Samba 3.0
     7.\"
     8.TH "SMBCONTROL" "1" "05/21/2008" "Samba 3\.0" "User Commands"
     9.\" disable hyphenation
     10.nh
     11.\" disable justification (adjust text to left margin only)
     12.ad l
    2113.SH "NAME"
    2214smbcontrol - send messages to smbd, nmbd or winbindd processes
    2315.SH "SYNOPSIS"
    2416.HP 1
    25 smbcontrol [-i] [-s]
     17smbcontrol [\-i] [\-s]
    2618.HP 1
    27 smbcontrol [destination] [message-type] [parameter]
     19smbcontrol [destination] [message\-type] [parameter]
    2820.SH "DESCRIPTION"
    2921.PP
    3022This tool is part of the
    3123\fBsamba\fR(7)
    32 suite.
     24suite\.
    3325.PP
    3426smbcontrol
    … …  
    3729\fBnmbd\fR(8), or a
    3830\fBwinbindd\fR(8)
    39 daemon running on the system.
     31daemon running on the system\.
    4032.SH "OPTIONS"
    4133.PP
    42 -h|--help
    43 .RS 3n
    44 Print a summary of command line options.
    45 .RE
    46 .PP
    47 -s <configuration file>
    48 .RS 3n
    49 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See
    50 \fIsmb.conf\fR
    51 for more information. The default configuration file name is determined at compile time.
    52 .RE
    53 .PP
    54 -i
    55 .RS 3n
    56 Run interactively. Individual commands of the form destination message-type parameters can be entered on STDIN. An empty command line or a "q" will quit the program.
     34\-h|\-\-help
     35.RS 4
     36Print a summary of command line options\.
     37.RE
     38.PP
     39\-s <configuration file>
     40.RS 4
     41The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See
     42\fIsmb\.conf\fR
     43for more information\. The default configuration file name is determined at compile time\.
     44.RE
     45.PP
     46\-i
     47.RS 4
     48Run interactively\. Individual commands of the form destination message\-type parameters can be entered on STDIN\. An empty command line or a "q" will quit the program\.
    5749.RE
    5850.PP
    5951destination
    60 .RS 3n
     52.RS 4
    6153One of
    6254\fInmbd\fR,
    6355\fIsmbd\fR
    64 or a process ID.
     56or a process ID\.
    6557.sp
    6658The
    6759\fIsmbd\fR
    68 destination causes the message to "broadcast" to all smbd daemons.
     60destination causes the message to "broadcast" to all smbd daemons\.
    6961.sp
    7062The
    7163\fInmbd\fR
    7264destination causes the message to be sent to the nmbd daemon specified in the
    73 \fInmbd.pid\fR
    74 file.
    75 .sp
    76 If a single process ID is given, the message is sent to only that process.
    77 .RE
    78 .PP
    79 message-type
    80 .RS 3n
    81 Type of message to send. See the section
    82 \fBMESSAGE-TYPES\fR
    83 for details.
     65\fInmbd\.pid\fR
     66file\.
     67.sp
     68If a single process ID is given, the message is sent to only that process\.
     69.RE
     70.PP
     71message\-type
     72.RS 4
     73Type of message to send\. See the section
     74\fBMESSAGE\-TYPES\fR
     75for details\.
    8476.RE
    8577.PP
    8678parameters
    87 .RS 3n
    88 any parameters required for the message-type
     79.RS 4
     80any parameters required for the message\-type
    8981.RE
    9082.SH "MESSAGE-TYPES"
    … …  
    9284Available message types are:
    9385.PP
    94 close-share
    95 .RS 3n
    96 Order smbd to close the client connections to the named share. Note that this doesn't affect client connections to any other shares. This message-type takes an argument of the share name for which client connections will be closed, or the "*" character which will close all currently open shares. This may be useful if you made changes to the access controls on the share. This message can only be sent to
    97 \fBsmbd\fR.
     86close\-share
     87.RS 4
     88Order smbd to close the client connections to the named share\. Note that this doesn\'t affect client connections to any other shares\. This message\-type takes an argument of the share name for which client connections will be closed, or the "*" character which will close all currently open shares\. This may be useful if you made changes to the access controls on the share\. This message can only be sent to
     89\fBsmbd\fR\.
    9890.RE
    9991.PP
    10092debug
    101 .RS 3n
    102 Set debug level to the value specified by the parameter. This can be sent to any of the destinations.
    103 .RE
    104 .PP
    105 force-election
    106 .RS 3n
     93.RS 4
     94Set debug level to the value specified by the parameter\. This can be sent to any of the destinations\.
     95.RE
     96.PP
     97force\-election
     98.RS 4
    10799This message causes the
    108100nmbd
    109 daemon to force a new browse master election.
     101daemon to force a new browse master election\.
    110102.RE
    111103.PP
    112104ping
    113 .RS 3n
    114 Send specified number of "ping" messages and wait for the same number of reply "pong" messages. This can be sent to any of the destinations.
     105.RS 4
     106Send specified number of "ping" messages and wait for the same number of reply "pong" messages\. This can be sent to any of the destinations\.
    115107.RE
    116108.PP
    117109profile
    118 .RS 3n
    119 Change profile settings of a daemon, 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 smbd or nmbd destinations.
     110.RS 4
     111Change profile settings of a daemon, 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 smbd or nmbd destinations\.
    120112.RE
    121113.PP
    122114debuglevel
    123 .RS 3n
    124 Request debuglevel of a certain daemon and write it to stdout. This can be sent to any of the destinations.
     115.RS 4
     116Request debuglevel of a certain daemon and write it to stdout\. This can be sent to any of the destinations\.
    125117.RE
    126118.PP
    127119profilelevel
    128 .RS 3n
    129 Request profilelevel of a certain daemon and write it to stdout. This can be sent to any smbd or nmbd destinations.
     120.RS 4
     121Request profilelevel of a certain daemon and write it to stdout\. This can be sent to any smbd or nmbd destinations\.
    130122.RE
    131123.PP
    132124printnotify
    133 .RS 3n
    134 Order smbd to send a printer notify message to any Windows NT clients connected to a printer. This message-type takes the following arguments:
    135 
    136 .RS 3n
     125.RS 4
     126Order smbd to send a printer notify message to any Windows NT clients connected to a printer\. This message\-type takes the following arguments:
    137127.PP
    138128queuepause printername
    139 .RS 3n
    140 Send a queue pause change notify message to the printer specified.
     129.RS 4
     130Send a queue pause change notify message to the printer specified\.
    141131.RE
    142132.PP
    143133queueresume printername
    144 .RS 3n
    145 Send a queue resume change notify message for the printer specified.
     134.RS 4
     135Send a queue resume change notify message for the printer specified\.
    146136.RE
    147137.PP
    148138jobpause printername unixjobid
    149 .RS 3n
    150 Send a job pause change notify message for the printer and unix jobid specified.
     139.RS 4
     140Send a job pause change notify message for the printer and unix jobid specified\.
    151141.RE
    152142.PP
    153143jobresume printername unixjobid
    154 .RS 3n
    155 Send a job resume change notify message for the printer and unix jobid specified.
     144.RS 4
     145Send a job resume change notify message for the printer and unix jobid specified\.
    156146.RE
    157147.PP
    158148jobdelete printername unixjobid
    159 .RS 3n
    160 Send a job delete change notify message for the printer and unix jobid specified.
    161 .RE
    162 .RE
    163 .IP "" 3n
    164 Note that this message only sends notification that an event has occured. It doesn't actually cause the event to happen.
     149.RS 4
     150Send a job delete change notify message for the printer and unix jobid specified\.
     151.RE
     152.sp
     153Note that this message only sends notification that an event has occured\. It doesn\'t actually cause the event to happen\.
    165154.sp
    166155This message can only be sent to
    167 \fBsmbd\fR.
     156\fBsmbd\fR\.
    168157.RE
    169158.PP
    170159samsync
    171 .RS 3n
    172 Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to
    173 \fBsmbd\fR.
     160.RS 4
     161Order smbd to synchronise sam database from PDC (being BDC)\. Can only be sent to
     162\fBsmbd\fR\.
    174163.sp
    175164.it 1 an-trap
    … …  
    177166.nr an-break-flag 1
    178167.br
    179 \fBNote\fR
     168Note
    180169Not working at the moment
    181170.RE
    182171.PP
    183172samrepl
    184 .RS 3n
    185 Send sam replication message, with specified serial. Can only be sent to
    186 \fBsmbd\fR. Should not be used manually.
    187 .RE
    188 .PP
    189 dmalloc-mark
    190 .RS 3n
    191 Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support.
    192 .RE
    193 .PP
    194 dmalloc-log-changed
    195 .RS 3n
    196 Dump the pointers that have changed since the mark set by dmalloc-mark. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support.
     173.RS 4
     174Send sam replication message, with specified serial\. Can only be sent to
     175\fBsmbd\fR\. Should not be used manually\.
     176.RE
     177.PP
     178dmalloc\-mark
     179.RS 4
     180Set a mark for dmalloc\. Can be sent to both smbd and nmbd\. Only available if samba is built with dmalloc support\.
     181.RE
     182.PP
     183dmalloc\-log\-changed
     184.RS 4
     185Dump the pointers that have changed since the mark set by dmalloc\-mark\. Can be sent to both smbd and nmbd\. Only available if samba is built with dmalloc support\.
    197186.RE
    198187.PP
    199188shutdown
    200 .RS 3n
    201 Shut down specified daemon. Can be sent to both smbd and nmbd.
    202 .RE
    203 .PP
    204 pool-usage
    205 .RS 3n
    206 Print a human-readable description of all talloc(pool) memory usage by the specified daemon/process. Available for both smbd and nmbd.
     189.RS 4
     190Shut down specified daemon\. Can be sent to both smbd and nmbd\.
     191.RE
     192.PP
     193pool\-usage
     194.RS 4
     195Print a human\-readable description of all talloc(pool) memory usage by the specified daemon/process\. Available for both smbd and nmbd\.
    207196.RE
    208197.PP
    209198drvupgrade
    210 .RS 3n
    211 Force clients of printers using specified driver to update their local version of the driver. Can only be sent to smbd.
    212 .RE
    213 .PP
    214 reload-config
    215 .RS 3n
    216 Force daemon to reload smb.conf configuration file. Can be sent to
     199.RS 4
     200Force clients of printers using specified driver to update their local version of the driver\. Can only be sent to smbd\.
     201.RE
     202.PP
     203reload\-config
     204.RS 4
     205Force daemon to reload smb\.conf configuration file\. Can be sent to
    217206\fBsmbd\fR,
    218207\fBnmbd\fR, or
    219 \fBwinbindd\fR.
     208\fBwinbindd\fR\.
    220209.RE
    221210.SH "VERSION"
    222211.PP
    223 This man page is correct for version 3.0 of the Samba suite.
     212This man page is correct for version 3\.0 of the Samba suite\.
    224213.SH "SEE ALSO"
    225214.PP
    226215\fBnmbd\fR(8)
    227216and
    228 \fBsmbd\fR(8).
     217\fBsmbd\fR(8)\.
    229218.SH "AUTHOR"
    230219.PP
    231 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.
    232 .PP
    233 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
    234 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.
    235 
     220The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\.
     221.PP
     222The 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
     223ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\.
Note: See TracChangeset for help on using the changeset viewer.