Debian Codegraph @

upstream/debian-unstable/man7/samba.7

raw
1 '\" t
2 .\" Title: samba
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: Miscellanea
7 .\" Source: Samba 4.24.3-Debian-4.24.3+dfsg-1
8 .\" Language: English
9 .\"
10 .TH "SAMBA" "7" "05/26/2026" "Samba 4\&.24\&.3\-Debian\-4\&.24\&.3+dfs" "Miscellanea"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 samba \- A Windows AD and SMB/CIFS fileserver for UNIX
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 samba
35 .SH "DESCRIPTION"
36 .PP
37 The Samba software suite is a collection of programs that implements the Server Message Block (commonly abbreviated as SMB) protocol for UNIX systems and provides Active Directory services\&. The first version of the SMB protocol is sometimes also referred to as the Common Internet File System (CIFS)\&. For a more thorough description, see
38 http://www\&.ubiqx\&.org/cifs/\&. Samba also implements the NetBIOS protocol in nmbd\&.
39 .PP
40 \fBsamba\fR(8)
41 .RS 4
42 The
43 samba
44 daemon provides the Active Directory services and file and print services to SMB clients\&. The configuration file for this daemon is described in
45 \fBsmb.conf\fR(5)\&.
46 .RE
47 .PP
48 \fBsmbd\fR(8)
49 .RS 4
50 The
51 smbd
52 daemon provides the file and print services to SMB clients\&. The configuration file for this daemon is described in
53 \fBsmb.conf\fR(5)\&.
54 .RE
55 .PP
56 \fBnmbd\fR(8)
57 .RS 4
58 The
59 nmbd
60 daemon provides NetBIOS nameservice and browsing support\&. The configuration file for this daemon is described in
61 \fBsmb.conf\fR(5)\&.
62 .RE
63 .PP
64 \fBwinbindd\fR(8)
65 .RS 4
66 winbindd
67 is a daemon that is used for integrating authentication and the user database into unix\&.
68 .RE
69 .PP
70 \fBsmbclient\fR(1)
71 .RS 4
72 The
73 smbclient
74 program implements a simple ftp\-like client\&. This is useful for accessing SMB shares on other compatible SMB servers, and can also be used to allow a UNIX box to print to a printer attached to any SMB server\&.
75 .RE
76 .PP
77 \fBsamba-tool\fR(8)
78 .RS 4
79 The
80 samba\-tool
81 is the main Samba Administration tool regarding Active Directory services\&.
82 .RE
83 .PP
84 \fBtestparm\fR(1)
85 .RS 4
86 The
87 testparm
88 utility is a simple syntax checker for Samba\*(Aqs
89 \fBsmb.conf\fR(5)
90 configuration file\&. In AD server mode
91 samba\-tool testparm
92 should be used though\&.
93 .RE
94 .PP
95 \fBsmbstatus\fR(1)
96 .RS 4
97 The
98 smbstatus
99 tool provides access to information about the current connections to
100 smbd\&.
101 .RE
102 .PP
103 \fBnmblookup\fR(1)
104 .RS 4
105 The
106 nmblookup
107 tool allows NetBIOS name queries to be made\&.
108 .RE
109 .PP
110 \fBsmbpasswd\fR(8)
111 .RS 4
112 The
113 smbpasswd
114 command is a tool for setting passwords on local Samba but also on remote SMB servers\&.
115 .RE
116 .PP
117 \fBsmbcacls\fR(1)
118 .RS 4
119 The
120 smbcacls
121 command is a tool to set ACL\*(Aqs on remote SMB servers\&.
122 .RE
123 .PP
124 \fBsmbtree\fR(1)
125 .RS 4
126 The
127 smbtree
128 command is a text\-based network neighborhood tool\&.
129 .RE
130 .PP
131 \fBsmbtar\fR(1)
132 .RS 4
133 The
134 smbtar
135 can make backups of data directly from SMB servers\&.
136 .RE
137 .PP
138 \fBsmbspool\fR(8)
139 .RS 4
140 smbspool
141 is a helper utility for printing on printers connected to SMB servers\&.
142 .RE
143 .PP
144 \fBsmbcontrol\fR(1)
145 .RS 4
146 smbcontrol
147 is a utility that can change the behaviour of running
148 samba,
149 smbd,
150 nmbd
151 and
152 winbindd
153 daemons\&.
154 .RE
155 .PP
156 \fBrpcclient\fR(1)
157 .RS 4
158 rpcclient
159 is a utility that can be used to execute RPC commands on remote SMB servers\&.
160 .RE
161 .PP
162 \fBpdbedit\fR(8)
163 .RS 4
164 The
165 pdbedit
166 command can be used to maintain the local user database on a Samba server\&.
167 .RE
168 .PP
169 \fBnet\fR(8)
170 .RS 4
171 The
172 net
173 command is the main administration tool for Samba member and standalone servers\&.
174 .RE
175 .PP
176 \fBwbinfo\fR(1)
177 .RS 4
178 wbinfo
179 is a utility that retrieves and stores information related to winbind\&.
180 .RE
181 .PP
182 \fBprofiles\fR(1)
183 .RS 4
184 profiles
185 is a command\-line utility that can be used to replace all occurrences of a certain SID with another SID\&.
186 .RE
187 .PP
188 \fBlog2pcap\fR(1)
189 .RS 4
190 log2pcap
191 is a utility for generating pcap trace files from Samba log files\&.
192 .RE
193 .PP
194 \fBvfstest\fR(1)
195 .RS 4
196 vfstest
197 is a utility that can be used to test vfs modules\&.
198 .RE
199 .PP
200 \fBntlm_auth\fR(1)
201 .RS 4
202 ntlm_auth
203 is a helper\-utility for external programs wanting to do NTLM\-authentication\&.
204 .RE
205 .PP
206 \fBsmbcquotas\fR(1)
207 .RS 4
208 smbcquotas
209 is a tool to manage quotas on remote SMB servers\&.
210 .RE
211 .SH "COMPONENTS"
212 .PP
213 The Samba suite is made up of several components\&. Each component is described in a separate manual page\&. It is strongly recommended that you read the documentation that comes with Samba and the manual pages of those components that you use\&. If the manual pages and documents aren\*(Aqt clear enough then please visit
214 https://devel\&.samba\&.org
215 for information on how to file a bug report or submit a patch\&.
216 .PP
217 If you require help, visit the Samba webpage at
218 https://www\&.samba\&.org/
219 and explore the many option available to you\&.
220 .SH "AVAILABILITY"
221 .PP
222 The Samba software suite is licensed under the GNU Public License(GPL)\&. A copy of that license should have come with the package in the file COPYING\&. You are encouraged to distribute copies of the Samba suite, but please obey the terms of this license\&.
223 .PP
224 The latest version of the Samba suite can be obtained from
225 https://download\&.samba\&.org/pub/samba/\&.
226 .PP
227 The Samba Wiki at
228 https://wiki\&.samba\&.org
229 has also a lot of useful information\&. On the Samba mailing list at
230 https://lists\&.samba\&.org
231 you can find a lot of information in the archives and you can subscribe to the samba list and ask for help or discuss things\&.
232 .SH "VERSION"
233 .PP
234 This man page is part of version 4\&.24\&.3\-Debian\-4\&.24\&.3+dfsg\-1 of the Samba suite\&.
235 .SH "CONTRIBUTIONS"
236 .PP
237 If you wish to contribute to the Samba project, then I suggest you join the Samba mailing list at
238 https://lists\&.samba\&.org\&.
239 .PP
240 If you have patches to submit, visit
241 https://devel\&.samba\&.org/
242 for information on how to do it properly\&. We prefer patches in
243 git format\-patch
244 format\&.
245 .SH "CONTRIBUTORS"
246 .PP
247 Contributors to the project are now too numerous to mention here but all deserve the thanks of all Samba users\&. To see a full list, look at the
248 change\-log
249 in the source package for the pre\-CVS changes and at
250 https://git\&.samba\&.org/
251 for the contributors to Samba post\-GIT\&. GIT is the Open Source source code control system used by the Samba Team to develop Samba\&. The project would have been unmanageable without it\&.
252 .SH "AUTHOR"
253 .PP
254 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\&.