source: networking/netprogs/samba.xml@ 7b478500

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 7b478500 was 7b478500, checked in by DJ Lucas <dj@…>, 8 years ago

[Systemd merge] - Chapter 16

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@17478 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 46.7 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY samba-download-http "https://download.samba.org/pub/samba/stable/samba-&samba-version;.tar.gz">
8 <!ENTITY samba-download-ftp " ">
9 <!ENTITY samba-md5sum "83b1af8a9899ab4de99f155fc42c83dd">
10 <!ENTITY samba-size "20 MB">
11 <!ENTITY samba-buildsize "464 MB (add 15 MB for quicktest, reputedly up to 500 MB additional for all tests)">
12 <!ENTITY samba-time "2.1 SBU, using parallelism=4 (add 0.4 SBU for quicktest, reputedly up to 110 SBU to run all tests)">
13]>
14
15<sect1 id="samba" xreflabel="Samba-&samba-version;">
16 <?dbhtml filename="samba.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Samba-&samba-version;</title>
24
25 <indexterm zone="samba">
26 <primary sortas="a-Samba">Samba</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Samba</title>
31
32 <para>The <application>Samba</application> package provides file and print
33 services to SMB/CIFS clients and Windows networking to Linux clients.
34 <application>Samba</application> can also be configured as a Windows Domain
35 Controller replacement, a file/print server acting as a member of a Windows
36 Active Directory domain and a NetBIOS (rfc1001/1002) nameserver (which
37 among other things provides LAN browsing support).</para>
38
39 &lfs79_checked;
40 &gcc6_checked;
41
42 <bridgehead renderas="sect3">Package Information</bridgehead>
43 <itemizedlist spacing="compact">
44 <listitem>
45 <para>Download (HTTP): <ulink url="&samba-download-http;"/></para>
46 </listitem>
47 <listitem>
48 <para>Download (FTP): <ulink url="&samba-download-ftp;"/></para>
49 </listitem>
50 <listitem>
51 <para>Download MD5 sum: &samba-md5sum;</para>
52 </listitem>
53 <listitem>
54 <para>Download size: &samba-size;</para>
55 </listitem>
56 <listitem>
57 <para>Estimated disk space required: &samba-buildsize;</para>
58 </listitem>
59 <listitem>
60 <para>Estimated build time: &samba-time;</para>
61 </listitem>
62 </itemizedlist>
63
64 <bridgehead renderas="sect3">Samba Dependencies</bridgehead>
65
66 <bridgehead renderas="sect4">Required</bridgehead>
67 <para role="required">
68 <xref linkend="python2"/>
69 </para>
70
71 <bridgehead renderas="sect4">Recommended</bridgehead>
72 <para role="recommended">
73 <xref linkend="libxslt"/> (for documentation) and
74 <xref linkend="openldap"/>
75 </para>
76
77 <bridgehead renderas="sect4">Optional</bridgehead>
78 <para role="optional">
79 <xref linkend="avahi"/>,
80 <xref linkend="cups"/>,
81 <xref linkend="gnutls"/>,
82 <xref linkend="libarchive"/>,
83 <xref linkend="libcap-pam"/>,
84 <xref linkend="libgpg-error"/>,
85 <xref linkend="linux-pam"/>,
86 <xref linkend="mitkrb"/>,
87 <xref linkend="popt"/>,
88 <xref linkend="python3"/>,
89 <xref linkend="talloc"/>,
90 <xref linkend="valgrind"/> (optionally used by the test suite),
91 <xref linkend="xfsprogs"/>,
92 <ulink url="https://ctdb.samba.org/">ctdb</ulink>,
93 <ulink url="https://people.gnome.org/~veillard/gamin/">Gamin</ulink>,
94 <ulink url="http://www.h5l.org/">Heimdal</ulink>,
95 <ulink url="http://ftp.de.debian.org/debian/pool/main/liba/libaio/">libaio</ulink>,
96 <ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink>,
97 <ulink url="https://www.samba.org/ftp/ldb/">ldb</ulink>,
98 <ulink url="http://www.openafs.org/">OpenAFS</ulink>,
99 <ulink url="https://tevent.samba.org/">tevent</ulink>, and
100 <ulink url="https://tdb.samba.org/">tdb</ulink>
101 </para>
102
103 <para condition="html" role="usernotes">User Notes:
104 <ulink url="&blfs-wiki;/samba4"/></para>
105
106 </sect2>
107
108 <sect2 role="installation">
109 <title>Installation of Samba</title>
110
111 <note>
112 <para>If you wish to run the test suite after the binaries are built, you
113 must add the <option>--enable-selftest</option> parameter to the
114 <command>configure</command> script below. You may want to run
115 <command>configure</command> with the <option>--help</option> parameter
116 first. There may be other parameters needed to take advantage of optional
117 dependencies.</para>
118 </note>
119
120 <para>Install <application>Samba</application> by running the following
121 commands:</para>
122
123<screen revision="sysv"><userinput>./configure \
124 --prefix=/usr \
125 --sysconfdir=/etc \
126 --localstatedir=/var \
127 --with-piddir=/run/samba \
128 --with-pammodulesdir=/lib/security \
129 --enable-fhs \
130 --without-ad-dc \
131 --without-systemd &amp;&amp;
132make</userinput></screen>
133
134<screen revision="systemd"><userinput>./configure \
135 --prefix=/usr \
136 --sysconfdir=/etc \
137 --localstatedir=/var \
138 --with-piddir=/run/samba \
139 --with-pammodulesdir=/lib/security \
140 --enable-fhs &amp;&amp;
141make</userinput></screen>
142
143<!--
144 <para>According to <application>Samba</application> developers, the
145 limitation to 108 characters of the path length of a unix named pipe socket
146 may be the cause of errors, so that over 1/3 of the tests might fail. For
147 this reason, the switch <option>- -with-selftest-prefix=/tmp/quick</option>
148 (or another path with small number of characters) can be used with
149 configure. Even so, the
150 <quote><replaceable>samba3.raw.eas</replaceable></quote> test may fail,
151 apparently for the same reason. If one quicktest fails, it can be disabled.
152 For example, <quote><replaceable>samba3.raw.eas</replaceable></quote> may
153 be disabled with the following command:</para>
154
155<screen><userinput>sed -i "/samba3.blackbox.failure.failure/i \^samba3.raw.eas" selftest/knownfail</userinput></screen>
156-->
157 <para>To test the results, as the
158 <systemitem class="username">root</systemitem> user, issue:
159 <command>make quicktest 2>&amp;1 | tee quicktest.log</command>. Summary of
160 the test results and some other information may be obtained with
161 <command>grep -A5 testsuites quicktest.log</command>. There are other
162 targets (test, subunit-test) available, but take a very long time
163 (over 100 SBU).</para>
164
165 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
166
167<screen role="root"><userinput>make install &amp;&amp;
168
169mv -v /usr/lib/libnss_win{s,bind}.so* /lib &amp;&amp;
170ln -v -sf ../../lib/libnss_winbind.so.2 /usr/lib/libnss_winbind.so &amp;&amp;
171ln -v -sf ../../lib/libnss_wins.so.2 /usr/lib/libnss_wins.so &amp;&amp;
172
173install -v -m644 examples/smb.conf.default /etc/samba &amp;&amp;
174
175mkdir -pv /etc/openldap/schema &amp;&amp;
176
177install -v -m644 examples/LDAP/README \
178 /etc/openldap/schema/README.LDAP &amp;&amp;
179
180install -v -m644 examples/LDAP/samba* \
181 /etc/openldap/schema &amp;&amp;
182
183install -v -m755 examples/LDAP/{get*,ol*} \
184 /etc/openldap/schema</userinput></screen>
185
186 </sect2>
187
188 <sect2 role="commands">
189 <title>Command Explanations</title>
190
191 <para><parameter>--enable-fhs</parameter>: Assigns all other file paths in
192 a manner compliant with the Filesystem Hierarchy Standard (FHS).</para>
193
194 <para revision="sysv"><parameter>--without-systemd</parameter>: Disable
195 <application>systemd</application> integration, which is not part of
196 LFS/BLFS. If you use <application>systemd</application>, replace by
197 <parameter>--with-systemd</parameter>.</para>
198
199 <para revision="sysv"><option>--without-ad-dc</option>: Disable Active
200 Directory Domain Controller functionality. See <ulink
201 url="https://wiki.samba.org/index.php/Setup_a_Samba_Active_Directory_Domain_Controller">
202 Setup a Samba Active Directory Domain Controller</ulink> for detailed
203 information.</para>
204
205 <para><option>--with-selftest-prefix=SELFTEST_PREFIX</option>: This option
206 specify the test suite work directory (default=./st).</para>
207
208 <para><command>mv -v /usr/lib/libnss_win{s,bind}.so* /lib</command>:
209 The nss libraries are installed in /usr/lib by default. Move them to
210 /lib.</para>
211
212 <para><command>ln -v -sf ../../lib/libnss_winbind.so.2 /usr/lib/libnss_winbind.so</command>
213 and <command>ln -v -sf ../../lib/libnss_wins.so.2 /usr/lib/libnss_wins.so</command>:
214 These symlinks are required when applicationss build against these
215 libraries.</para>
216
217 <para><command>install -v -m644 examples/LDAP/* /etc/openldap/schema</command>:
218 These commands are used to copy sample Samba schemas to the OpenLDAP
219 <filename class='directory'>schema</filename> directory.</para>
220
221 <para><command>install -v -m644 ../examples/smb.conf.default
222 /etc/samba</command>: This copies a default <filename>smb.conf</filename>
223 file into <filename>/etc/samba</filename>. This sample configuration will
224 not work until you copy it to <filename>/etc/samba/smb.conf</filename> and
225 make the appropriate changes for your installation. See the configuration
226 section for minimum values which must be set.</para>
227
228 </sect2>
229
230 <sect2 role="configuration">
231 <title>Configuring Samba</title>
232
233 <sect3 id="samba-config">
234 <title>Config Files</title>
235
236 <para>/etc/samba/smb.conf</para>
237
238 <indexterm zone="samba samba-config">
239 <primary sortas="e-etc-samba-smb.conf">/etc/samba/smb.conf</primary>
240 </indexterm>
241
242 </sect3>
243
244 <sect3>
245 <title>Printing to SMB Clients</title>
246
247 <para>If you use <application>CUPS</application> for print services,
248 and you wish to print to a printer attached to an SMB client, you
249 need to create an SMB backend device. To create the device, issue the
250 following command as the <systemitem class="username">root</systemitem>
251 user:</para>
252
253<screen role="root"><userinput>ln -v -sf /usr/bin/smbspool /usr/lib/cups/backend/smb</userinput></screen>
254
255 </sect3>
256
257 <sect3>
258 <title>Configuration Information</title>
259
260 <para>Due to the complexity and the many various uses for
261 <application>Samba</application>, complete configuration for all the
262 package's capabilities is well beyond the scope of the BLFS book. This
263 section provides instructions to configure the
264 <filename>/etc/samba/smb.conf</filename> file for two common scenarios.
265 The complete contents of <filename>/etc/samba/smb.conf</filename> will
266 depend on the purpose of <application>Samba</application>
267 installation.</para>
268
269 <note>
270 <para>You may find it easier to copy the configuration parameters shown
271 below into an empty <filename>/etc/samba/smb.conf</filename> file
272 instead of copying and editing the default file as mentioned in the
273 <quote>Command Explanations</quote> section. How you create/edit the
274 <filename>/etc/samba/smb.conf</filename> file will be left up to
275 you. Do ensure the file is only writeable by the
276 <systemitem class="username">root</systemitem> user (mode 644).</para>
277 </note>
278
279 <sect4>
280 <title>Scenario 1: Minimal Standalone Client-Only Installation</title>
281
282 <para>Choose this variant if you only want to transfer files using
283 <command>smbclient</command>, mount Windows shares and print to Windows
284 printers, and don't want to share your files and printers to Windows
285 machines.</para>
286
287 <para>A <filename>/etc/samba/smb.conf</filename> file with the following
288 three parameters is sufficient:</para>
289
290<screen role='root'><literal>[global]
291 workgroup = <replaceable>MYGROUP</replaceable>
292 dos charset = <replaceable>cp850</replaceable>
293 unix charset = <replaceable>ISO-8859-1</replaceable></literal></screen>
294
295 <para>The values in this example specify that the computer belongs to a
296 Windows workgroup named
297 <quote><replaceable>MYGROUP</replaceable></quote>, uses the
298 <quote><replaceable>cp850</replaceable></quote> character set on the
299 wire when talking to MS-DOS and MS Windows 9x, and that the filenames
300 are stored in the <quote><replaceable>ISO-8859-1</replaceable></quote>
301 encoding on the disk. Adjust these values appropriately for your
302 installation. The <quote>unix charset</quote> value must be the same as
303 the output of <command>locale charmap</command> when executed with the
304 <envar>LANG</envar> variable set to your preferred locale, otherwise the
305 <command>ls</command> command may not display correct filenames of
306 downloaded files.</para>
307
308 <para>There is no need to run any <application>Samba</application>
309 servers in this scenario, thus you don't need to install the provided
310 bootscripts.</para>
311
312 </sect4>
313
314 <sect4>
315 <title>Scenario 2: Standalone File/Print Server</title>
316
317 <para>Choose this variant if you want to share your files and printers
318 to Windows machines in your workgroup in addition to the capabilities
319 described in Scenario 1.</para>
320
321 <para>In this case, the <filename>/etc/samba/smb.conf.default</filename>
322 file may be a good template to start from. Also add
323 <quote>dos charset</quote> and <quote>unix charset</quote> parameters
324 to the <quote>[global]</quote> section as described in Scenario 1 in
325 order to prevent filename corruption. For security reasons, you may
326 wish to define
327 <replaceable>path = /home/alice/shared-files</replaceable>,
328 assuming your user name is <replaceable>alice</replaceable> and you
329 only want to share the files in that directory, instead of your entire
330 home. Then, replace <replaceable>homes</replaceable> by
331 <replaceable>shared-files</replaceable> and change also the
332 <quote><literal>comment</literal></quote> if used the configuration
333 file below or the <filename>/etc/samba/smb.conf.default</filename>
334 to create yours.</para>
335
336 <para>The following configuration file creates a separate share for each
337 user's home directory and also makes all printers available to Windows
338 machines:</para>
339
340<screen role='root'><literal>[global]
341 workgroup = <replaceable>MYGROUP</replaceable>
342 dos charset = <replaceable>cp850</replaceable>
343 unix charset = <replaceable>ISO-8859-1</replaceable>
344
345[homes]
346 comment = Home Directories
347 browseable = no
348 writable = yes
349
350[printers]
351 comment = All Printers
352 path = /var/spool/samba
353 browseable = no
354 guest ok = no
355 printable = yes</literal></screen>
356
357 <para>Other parameters you may wish to customize in the
358 <quote>[global]</quote> section include:</para>
359
360<screen role='root'><literal> server string =
361 security =
362 hosts allow =
363 load printers =
364 log file =
365 max log size =
366 socket options =
367 local master =</literal></screen>
368
369 <para>Reference the comments in the
370 <filename>/etc/samba/smb.conf.default</filename> file for information
371 regarding these parameters.</para>
372
373 <para>Since the <command>smbd</command> and <command>nmbd</command>
374 daemons are needed in this case, install the <filename>samba</filename>
375 bootscript. Be sure to run <command>smbpasswd</command> (with the
376 <option>-a</option> option to add users) to enable and
377 set passwords for all accounts that need
378 <application>Samba</application> access. Using the default
379 <application>Samba</application> passdb backend, any user you attempt
380 to add will also be required to exist in the
381 <filename>/etc/passwd</filename> file.</para>
382
383 </sect4>
384
385 <sect4>
386 <title>Advanced Requirements</title>
387
388 <para>More complex scenarios involving domain control or membership are
389 possible. Such setups are advanced topics and cannot be adequately
390 covered in BLFS. Many complete books have been written on these topics
391 alone. Note that in some domain membership scenarios, the
392 <command>winbindd</command> daemon and the corresponding bootscript are
393 needed.</para>
394
395 <para>There is quite a bit of documentation available which covers many
396 of these advanced configurations. Point your web browser to the links
397 below to view some of the documentation included with the
398 <application>Samba</application> package:</para>
399
400 <itemizedlist spacing='compact'>
401 <listitem>
402 <para>Using Samba, 2nd Edition; a popular book published by O'Reilly
403 <ulink url="http://www.samba.org/samba/docs/using_samba/toc.html"/></para>
404 </listitem>
405 <listitem>
406 <para>The Official Samba HOWTO and Reference Guide <ulink
407 url="http://www.samba.org/samba/docs/man/Samba-HOWTO-Collection/"/>
408 </para>
409 </listitem>
410 <listitem>
411 <para>Samba-3 by Example
412 <ulink url="http://www.samba.org/samba/docs/man/Samba-Guide/"/>
413 </para>
414 </listitem>
415 </itemizedlist>
416
417 </sect4>
418
419 <sect4 id="samba-init" revision="sysv">
420 <title>Boot Script</title>
421
422 <para>For your convenience, boot scripts have been provided for
423 <application>Samba</application>. There are two included in the
424 <xref linkend="bootscripts"/> package. The first,
425 <filename>samba</filename>, will start the <command>smbd</command>
426 and <command>nmbd</command> daemons needed to provide SMB/CIFS
427 services. The second script, <filename>winbind</filename>, starts
428 the <command>winbindd</command> daemon, used for providing Windows
429 domain services to Linux clients.</para>
430
431 <indexterm zone="samba samba-init">
432 <primary sortas="f-samba">samba</primary>
433 </indexterm>
434
435 <indexterm zone="samba samba-init">
436 <primary sortas="f-winbind">winbind</primary>
437 </indexterm>
438
439 <para>The default <application>Samba</application> installation uses the
440 <systemitem class='username'>nobody</systemitem> user for guest access
441 to the server. This can be overridden by setting the
442 <option>guest account =</option> parameter in the
443 <filename>/etc/samba/smb.conf</filename> file. If you utilize the
444 <option>guest account =</option> parameter, ensure this user exists in
445 the <filename>/etc/passwd</filename> file. To use the default user,
446 issue the following commands as the
447 <systemitem class='username'>root</systemitem> user:</para>
448
449<screen role="root"><userinput>groupadd -g 99 nogroup &amp;&amp;
450useradd -c "Unprivileged Nobody" -d /dev/null -g nogroup \
451 -s /bin/false -u 99 nobody</userinput></screen>
452
453 <para>Install the <filename>samba</filename> script with the following
454 command issued as the <systemitem class="username">root</systemitem>
455 user:</para>
456
457<screen role="root"><userinput>make install-samba</userinput></screen>
458
459 <para>If you also need the <filename>winbindd</filename>
460 script to resolve names from Windows clients, run:</para>
461
462<screen role="root"><userinput>make install-winbindd</userinput></screen>
463
464 </sect4>
465
466 <sect4 id="samba-init-sysd" revision="systemd">
467 <title>Systemd Units</title>
468
469 <para>The default <application>Samba</application> installation uses the
470 <systemitem class='username'>nobody</systemitem> user for guest access
471 to the server. This can be overridden by setting the
472 <option>guest account =</option> parameter in the
473 <filename>/etc/samba/smb.conf</filename> file. If you utilize the
474 <option>guest account =</option> parameter, ensure this user exists in
475 the <filename>/etc/passwd</filename> file.</para>
476
477 <para>
478 To start the <application>Samba</application> daemons at boot,
479 install the systemd units from the <xref linkend="systemd-units"/>
480 package by running the following command as the
481 <systemitem class="username">root</systemitem> user:
482 </para>
483
484 <indexterm zone="samba samba-init-sysd">
485 <primary sortas="f-samba">samba</primary>
486 </indexterm>
487
488<screen role="root"><userinput>make install-samba</userinput></screen>
489
490 <para>
491 To start the <command>winbindd</command> daemon at boot,
492 install the systemd unit from the <xref linkend="systemd-units"/>
493 package by running the following command as the
494 <systemitem class="username">root</systemitem> user:
495 </para>
496
497 <indexterm zone="samba samba-init-sysd">
498 <primary sortas="f-winbindd">winbindd</primary>
499 </indexterm>
500
501<screen role="root"><userinput>make install-winbindd</userinput></screen>
502
503 <note>
504 <para>This package comes with two types of units: A service file and a
505 socket file. The service file will start the smbd daemon once at boot
506 and it will keep running until the system shuts down. The socket file
507 will make systemd listen on the smbd port (Default 445, needs to be
508 edited for anything else) and will start the smbd daemon when something
509 tries to connect to that port and stop the daemon when the connection
510 is terminated. This is called socket activation and is analogous to
511 using <application>{,x}inetd</application> on a SysVinit based
512 system.</para>
513
514 <para>By default, the first method is used - the smbd daemon is started
515 at boot and stopped at shutdown. If the socket method is desired, you
516 need to run the following commands as the
517 <systemitem class="username">root</systemitem> user:</para>
518
519<screen role="root"><userinput>systemctl stop smbd &amp;&amp;
520systemctl disable smbd &amp;&amp;
521systemctl enable smbd.socket &amp;&amp;
522systemctl start smbd.socket</userinput></screen>
523
524 <para>Note that only the smbd daemon can be socket activated.</para>
525 </note>
526 </sect4>
527
528 </sect3>
529
530 </sect2>
531
532 <sect2 role="content">
533 <title>Contents</title>
534
535 <segmentedlist>
536 <segtitle>Installed Programs</segtitle>
537 <segtitle>Installed Libraries</segtitle>
538 <segtitle>Installed Directories</segtitle>
539
540 <seglistitem>
541
542 <seg>
543 cifsdd, dbwrap_tool, eventlogadm, gentest, ldbadd, ldbdel,
544 ldbedit, ldbmodify, ldbrename, ldbsearch, locktest, masktest,
545 ndrdump, net, nmbd, nmblookup, ntlm_auth, oLschema2ldif,
546 pdbedit, pidl, profiles, regdiff, regpatch, regshell, regtree,
547 rpcclient, samba, samba_dnsupdate, samba_kcc, samba-regedit,
548 samba_spnupdate, samba-tool, samba_upgradedns, sharesec,
549 smbcacls, smbclient, smbcontrol, smbcquotas, smbd, smbget,
550 smbpasswd, smbspool, smbstatus, smbtar, smbta-util,
551 smbtorture, smbtree, tdbbackup, tdbdump, tdbrestore, tdbtool,
552 testparm, wbinfo, and winbindd
553 </seg>
554
555 <seg>
556 libdcerpc-atsvc.so, libdcerpc-binding.so, libdcerpc-samr.so,
557 libdcerpc-server.so, libdcerpc.so, libgensec.so, libndr-krb5pac.so,
558 libndr-nbt.so, libndr.so, libndr-standard.so, libnetapi.so,
559 libnss_winbind.so, libnss_wins.so, libregistry.so,
560 libsamba-credentials.so, libsamba-hostconfig.so, libsamba-passdb.so,
561 libsamba-policy.so, libsamba-util.so, libsamdb.so,
562 libsmbclient-raw.so, libsmbclient.so, libsmbconf.so, libsmbldap.so,
563 libtevent-util.so, libtorture.so, libwbclient.so, <!--mit_samba.so,
564 --> and winbind_krb5_locator.so; the pam_winbind.so and pam_smbpass.so
565 PAM libraries; and assorted character set, filesystem and support
566 modules under /usr/lib/{python&python2-majorver;,samba}
567 </seg>
568
569 <seg>
570 /etc/samba, /run/samba, /usr/include/samba-4.0,
571 /usr/lib/perl5/vendor_perl/5.x.y/Parse/Pidl/{Samba{3,4},Wireshark},
572 /usr/lib/python&python2-majorver;/site-packages/samba,
573 /usr/{lib,share}/samba, and /var/{cache,lib,lock,log,run}/samba
574 </seg>
575
576 </seglistitem>
577 </segmentedlist>
578
579 <variablelist>
580 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
581 <?dbfo list-presentation="list"?>
582 <?dbhtml list-presentation="table"?>
583
584 <varlistentry id="cifsdd">
585 <term><command>cifsdd</command></term>
586 <listitem>
587 <para>is the dd command for SMB.</para>
588 <indexterm zone="samba cifsdd">
589 <primary sortas="b-cifsdd">cifsdd</primary>
590 </indexterm>
591 </listitem>
592 </varlistentry>
593
594 <varlistentry id="dbwrap_tool">
595 <term><command>dbwrap_tool</command></term>
596 <listitem>
597 <para>is used to read and manipulate TDB/CTDB databases using
598 the dbwrap interface.</para>
599 <indexterm zone="samba dbwrap_tool">
600 <primary sortas="b-dbwrap_tool">dbwrap_tool</primary>
601 </indexterm>
602 </listitem>
603 </varlistentry>
604
605 <varlistentry id="eventlogadm">
606 <term><command>eventlogadm</command></term>
607 <listitem>
608 <para>is used to write records to eventlogs from STDIN, add the
609 specified source and DLL eventlog registry entries and display the
610 active eventlog names (from <filename>smb.conf</filename>).</para>
611 <indexterm zone="samba eventlogadm">
612 <primary sortas="b-eventlogadm">eventlogadm</primary>
613 </indexterm>
614 </listitem>
615 </varlistentry>
616
617 <varlistentry id="gentest">
618 <term><command>gentest</command></term>
619 <listitem>
620 <para>is used to run random generic SMB operations against two
621 SMB servers and show the differences in behavior.</para>
622 <indexterm zone="samba gentest">
623 <primary sortas="b-gentest">gentest</primary>
624 </indexterm>
625 </listitem>
626 </varlistentry>
627
628 <varlistentry id="ldbadd">
629 <term><command>ldbadd</command></term>
630 <listitem>
631 <para>is a command-line utility for adding records to an LDB
632 database.</para>
633 <indexterm zone="samba ldbadd">
634 <primary sortas="b-ldbadd">ldbadd</primary>
635 </indexterm>
636 </listitem>
637 </varlistentry>
638
639 <varlistentry id="ldbdel">
640 <term><command>ldbdel</command></term>
641 <listitem>
642 <para>is a command-line program for deleting LDB database
643 records.</para>
644 <indexterm zone="samba ldbdel">
645 <primary sortas="b-ldbdel">ldbdel</primary>
646 </indexterm>
647 </listitem>
648 </varlistentry>
649
650 <varlistentry id="ldbedit">
651 <term><command>ldbedit</command></term>
652 <listitem>
653 <para>allows you to edit LDB databases using your preferred
654 editor.</para>
655 <indexterm zone="samba ldbedit">
656 <primary sortas="b-ldbedit">ldbedit</primary>
657 </indexterm>
658 </listitem>
659 </varlistentry>
660
661 <varlistentry id="ldbmodify">
662 <term><command>ldbmodify</command></term>
663 <listitem>
664 <para>allows you to modify records in an LDB database.</para>
665 <indexterm zone="samba ldbmodify">
666 <primary sortas="b-ldbmodify">ldbmodify</primary>
667 </indexterm>
668 </listitem>
669 </varlistentry>
670
671 <varlistentry id="ldbrename">
672 <term><command>ldbrename</command></term>
673 <listitem>
674 <para>allows you to edit LDB databases using your preferred
675 editor.</para>
676 <indexterm zone="samba ldbrename">
677 <primary sortas="b-ldbrename">ldbrename</primary>
678 </indexterm>
679 </listitem>
680 </varlistentry>
681
682 <varlistentry id="ldbsearch">
683 <term><command>ldbsearch</command></term>
684 <listitem>
685 <para>searches an LDB database for records matching a specified
686 expression.</para>
687 <indexterm zone="samba ldbsearch">
688 <primary sortas="b-ldbsearch">ldbsearch</primary>
689 </indexterm>
690 </listitem>
691 </varlistentry>
692
693 <varlistentry id="locktest">
694 <term><command>locktest</command></term>
695 <listitem>
696 <para>is used to find differences in locking between two SMB
697 servers.</para>
698 <indexterm zone="samba locktest">
699 <primary sortas="b-locktest">locktest</primary>
700 </indexterm>
701 </listitem>
702 </varlistentry>
703
704 <varlistentry id="masktest">
705 <term><command>masktest</command></term>
706 <listitem>
707 <para>is used to find differences in wildcard matching between
708 Samba's implementation and that of a remote server.</para>
709 <indexterm zone="samba masktest">
710 <primary sortas="b-masktest">masktest</primary>
711 </indexterm>
712 </listitem>
713 </varlistentry>
714
715 <varlistentry id="ndrdump">
716 <term><command>ndrdump</command></term>
717 <listitem>
718 <para>is a DCE/RPC Packet Parser and Dumper.</para>
719 <indexterm zone="samba ndrdump">
720 <primary sortas="b-ndrdump">ndrdump</primary>
721 </indexterm>
722 </listitem>
723 </varlistentry>
724
725 <varlistentry id="net">
726 <term><command>net</command></term>
727 <listitem>
728 <para>is a tool for administration of
729 <application>Samba</application> and remote CIFS servers, similar
730 to the <command>net</command> utility for DOS/Windows.</para>
731 <indexterm zone="samba net">
732 <primary sortas="b-net">net</primary>
733 </indexterm>
734 </listitem>
735 </varlistentry>
736
737 <varlistentry id="nmbd">
738 <term><command>nmbd</command></term>
739 <listitem>
740 <para>is the <application>Samba</application>
741 NetBIOS name server.</para>
742 <indexterm zone="samba nmbd">
743 <primary sortas="b-nmbd">nmbd</primary>
744 </indexterm>
745 </listitem>
746 </varlistentry>
747
748 <varlistentry id="nmblookup">
749 <term><command>nmblookup</command></term>
750 <listitem>
751 <para>is used to query NetBIOS names and map
752 them to IP addresses.</para>
753 <indexterm zone="samba nmblookup">
754 <primary sortas="b-nmblookup">nmblookup</primary>
755 </indexterm>
756 </listitem>
757 </varlistentry>
758
759 <varlistentry id="ntlm_auth">
760 <term><command>ntlm_auth</command></term>
761 <listitem>
762 <para>is a tool to allow external access to Winbind's
763 NTLM authentication function.</para>
764 <indexterm zone="samba ntlm_auth">
765 <primary sortas="b-ntlm_auth">ntlm_auth</primary>
766 </indexterm>
767 </listitem>
768 </varlistentry>
769
770 <varlistentry id="oLschema2ldif">
771 <term><command>oLschema2ldif</command></term>
772 <listitem>
773 <para>converts LDAP schema's to LDB-compatible LDIF.</para>
774 <indexterm zone="samba oLschema2ldif">
775 <primary sortas="b-oLschema2ldif">oLschema2ldif</primary>
776 </indexterm>
777 </listitem>
778 </varlistentry>
779
780 <varlistentry id="pdbedit">
781 <term><command>pdbedit</command></term>
782 <listitem>
783 <para>is a tool used to manage the SAM database.</para>
784 <indexterm zone="samba pdbedit">
785 <primary sortas="b-pdbedit">pdbedit</primary>
786 </indexterm>
787 </listitem>
788 </varlistentry>
789
790 <varlistentry id="pidl">
791 <term><command>pidl</command></term>
792 <listitem>
793 <para>is an IDL (Interface Definition Language) compiler
794 written in Perl.</para>
795 <indexterm zone="samba pidl">
796 <primary sortas="b-pidl">pidl</primary>
797 </indexterm>
798 </listitem>
799 </varlistentry>
800
801 <varlistentry id="profiles">
802 <term><command>profiles</command></term>
803 <listitem>
804 <para>is a utility that reports and changes SIDs in Windows
805 registry files. It currently only supports Windows NT.</para>
806 <indexterm zone="samba profiles">
807 <primary sortas="b-profiles">profiles</primary>
808 </indexterm>
809 </listitem>
810 </varlistentry>
811
812 <varlistentry id="regdiff">
813 <term><command>regdiff</command></term>
814 <listitem>
815 <para>is a Diff program for Windows registry files.</para>
816 <indexterm zone="samba regdiff">
817 <primary sortas="b-regdiff">regdiff</primary>
818 </indexterm>
819 </listitem>
820 </varlistentry>
821
822 <varlistentry id="regpatch">
823 <term><command>regpatch</command></term>
824 <listitem>
825 <para>applies registry patches to registry files.</para>
826 <indexterm zone="samba regpatch">
827 <primary sortas="b-regpatch">regpatch</primary>
828 </indexterm>
829 </listitem>
830 </varlistentry>
831
832 <varlistentry id="regshell">
833 <term><command>regshell</command></term>
834 <listitem>
835 <para>is a Windows registry file browser using readline.</para>
836 <indexterm zone="samba regshell">
837 <primary sortas="b-regshell">regshell</primary>
838 </indexterm>
839 </listitem>
840 </varlistentry>
841
842 <varlistentry id="regtree">
843 <term><command>regtree</command></term>
844 <listitem>
845 <para>is a text-mode registry viewer.</para>
846 <indexterm zone="samba regtree">
847 <primary sortas="b-regtree">regtree</primary>
848 </indexterm>
849 </listitem>
850 </varlistentry>
851
852 <varlistentry id="rpcclient">
853 <term><command>rpcclient</command></term>
854 <listitem>
855 <para>is used to execute MS-RPC client side functions.</para>
856 <indexterm zone="samba rpcclient">
857 <primary sortas="b-rpcclient">rpcclient</primary>
858 </indexterm>
859 </listitem>
860 </varlistentry>
861
862 <varlistentry id="samba-prog">
863 <term><command>samba</command></term>
864 <listitem>
865 <para>is a server to provide AD and SMB/CIFS services
866 to clients.</para>
867 <indexterm zone="samba samba-prog">
868 <primary sortas="b-samba-prog">samba</primary>
869 </indexterm>
870 </listitem>
871 </varlistentry>
872
873 <varlistentry id="samba_dnsupdate">
874 <term><command>samba_dnsupdate</command></term>
875 <listitem>
876 <para>is used to update our DNS names using TSIG-GSS.</para>
877 <indexterm zone="samba samba_dnsupdate">
878 <primary sortas="b-samba_dnsupdate">samba_dnsupdate</primary>
879 </indexterm>
880 </listitem>
881 </varlistentry>
882
883 <varlistentry id="samba_kcc">
884 <term><command>samba_kcc</command></term>
885 <listitem>
886 <para>is a script used to compute your KCC (Knowledge
887 Consistency Checker) topology.</para>
888 <indexterm zone="samba samba_kcc">
889 <primary sortas="b-samba_kcc">samba_kcc</primary>
890 </indexterm>
891 </listitem>
892 </varlistentry>
893
894 <varlistentry id="samba-regedit">
895 <term><command>samba-regedit</command></term>
896 <listitem>
897 <para>is a ncurses based tool to manage the Samba registry.</para>
898 <indexterm zone="samba samba-regedit">
899 <primary sortas="b-samba-regedit">samba-regedit</primary>
900 </indexterm>
901 </listitem>
902 </varlistentry>
903
904 <varlistentry id="samba_spnupdate">
905 <term><command>samba_spnupdate</command></term>
906 <listitem>
907 <para>is a script to update the servicePrincipalName
908 names from spn_update_list.</para>
909 <indexterm zone="samba samba_spnupdate">
910 <primary sortas="b-samba_spnupdate">samba_spnupdate</primary>
911 </indexterm>
912 </listitem>
913 </varlistentry>
914
915 <varlistentry id="samba-tool">
916 <term><command>samba-tool</command></term>
917 <listitem>
918 <para>is the main Samba administration tool.</para>
919 <indexterm zone="samba samba-tool">
920 <primary sortas="b-samba-tool">samba-tool</primary>
921 </indexterm>
922 </listitem>
923 </varlistentry>
924
925 <varlistentry id="samba_upgradedns">
926 <term><command>samba_upgradedns</command></term>
927 <listitem>
928 <para>is a Unix SMB/CIFS implementation.</para>
929 <indexterm zone="samba samba_upgradedns">
930 <primary sortas="b-samba_upgradedns">samba_upgradedns</primary>
931 </indexterm>
932 </listitem>
933 </varlistentry>
934
935 <varlistentry id="sharesec">
936 <term><command>sharesec</command></term>
937 <listitem>
938 <para>manipulates share ACL permissions on SMB file shares.</para>
939 <indexterm zone="samba sharesec">
940 <primary sortas="b-sharesec">sharesec</primary>
941 </indexterm>
942 </listitem>
943 </varlistentry>
944
945 <varlistentry id="smbcacls">
946 <term><command>smbcacls</command></term>
947 <listitem>
948 <para>is used to manipulate Windows NT access control lists.</para>
949 <indexterm zone="samba smbcacls">
950 <primary sortas="b-smbcacls">smbcacls</primary>
951 </indexterm>
952 </listitem>
953 </varlistentry>
954
955 <varlistentry id="smbclient">
956 <term><command>smbclient</command></term>
957 <listitem>
958 <para>is a SMB/CIFS access utility, similar to FTP.</para>
959 <indexterm zone="samba smbclient">
960 <primary sortas="b-smbclient">smbclient</primary>
961 </indexterm>
962 </listitem>
963 </varlistentry>
964
965 <varlistentry id="smbcontrol">
966 <term><command>smbcontrol</command></term>
967 <listitem>
968 <para>is used to control running <command>smbd</command>,
969 <command>nmbd</command> and <command>winbindd</command>
970 daemons.</para>
971 <indexterm zone="samba smbcontrol">
972 <primary sortas="b-smbcontrol">smbcontrol</primary>
973 </indexterm>
974 </listitem>
975 </varlistentry>
976
977 <varlistentry id="smbcquotas">
978 <term><command>smbcquotas</command></term>
979 <listitem>
980 <para>is used to manipulate Windows NT quotas on
981 SMB file shares.</para>
982 <indexterm zone="samba smbcquotas">
983 <primary sortas="b-smbcquotas">smbcquotas</primary>
984 </indexterm>
985 </listitem>
986 </varlistentry>
987
988 <varlistentry id="smbd">
989 <term><command>smbd</command></term>
990 <listitem>
991 <para>is the main <application>Samba</application> daemon which
992 provides SMB/CIFS services to clients.</para>
993 <indexterm zone="samba smbd">
994 <primary sortas="b-smbd">smbd</primary>
995 </indexterm>
996 </listitem>
997 </varlistentry>
998
999 <varlistentry id="smbget">
1000 <term><command>smbget</command></term>
1001 <listitem>
1002 <para>is a simple utility with <command>wget</command>-like
1003 semantics, that can download files from SMB servers. You can specify
1004 the files you would like to download on the command-line.</para>
1005 <indexterm zone="samba smbget">
1006 <primary sortas="b-smbget">smbget</primary>
1007 </indexterm>
1008 </listitem>
1009 </varlistentry>
1010
1011 <varlistentry id="smbpasswd">
1012 <term><command>smbpasswd</command></term>
1013 <listitem>
1014 <para>changes a user's <application>Samba</application>
1015 password.</para>
1016 <indexterm zone="samba smbpasswd">
1017 <primary sortas="b-smbpasswd">smbpasswd</primary>
1018 </indexterm>
1019 </listitem>
1020 </varlistentry>
1021
1022 <varlistentry id="smbspool">
1023 <term><command>smbspool</command></term>
1024 <listitem>
1025 <para>sends a print job to an SMB printer.</para>
1026 <indexterm zone="samba smbspool">
1027 <primary sortas="b-smbspool">smbspool</primary>
1028 </indexterm>
1029 </listitem>
1030 </varlistentry>
1031
1032 <varlistentry id="smbstatus">
1033 <term><command>smbstatus</command></term>
1034 <listitem>
1035 <para>reports current <application>Samba</application>
1036 connections.</para>
1037 <indexterm zone="samba smbstatus">
1038 <primary sortas="b-smbstatus">smbstatus</primary>
1039 </indexterm>
1040 </listitem>
1041 </varlistentry>
1042
1043 <varlistentry id="smbtar">
1044 <term><command>smbtar</command></term>
1045 <listitem>
1046 <para>is a shell script used for backing up SMB/CIFS shares
1047 directly to Linux tape drives or a file.</para>
1048 <indexterm zone="samba smbtar">
1049 <primary sortas="b-smbtar">smbtar</primary>
1050 </indexterm>
1051 </listitem>
1052 </varlistentry>
1053
1054 <varlistentry id="smbta-util">
1055 <term><command>smbta-util</command></term>
1056 <listitem>
1057 <para>is a tool to ease the configuration of the
1058 vfs_smb_traffic_analyzer module regarding data encryption.</para>
1059 <indexterm zone="samba smbta-util">
1060 <primary sortas="b-smbta-util">smbta-util</primary>
1061 </indexterm>
1062 </listitem>
1063 </varlistentry>
1064
1065 <varlistentry id="smbtorture">
1066 <term><command>smbtorture</command></term>
1067 <listitem>
1068 <para>is a testsuite that runs several tests against a SMB
1069 server.</para>
1070 <indexterm zone="samba smbtorture">
1071 <primary sortas="b-smbtorture">smbtorture</primary>
1072 </indexterm>
1073 </listitem>
1074 </varlistentry>
1075
1076 <varlistentry id="smbtree">
1077 <term><command>smbtree</command></term>
1078 <listitem>
1079 <para>is a text-based SMB network browser.</para>
1080 <indexterm zone="samba smbtree">
1081 <primary sortas="b-smbtree">smbtree</primary>
1082 </indexterm>
1083 </listitem>
1084 </varlistentry>
1085
1086 <varlistentry id="tdbbackup">
1087 <term><command>tdbbackup</command></term>
1088 <listitem>
1089 <para>is a tool for backing up or validating the integrity of
1090 <application>Samba</application> <filename>.tdb</filename>
1091 files.</para>
1092 <indexterm zone="samba tdbbackup">
1093 <primary sortas="b-tdbbackup">tdbbackup</primary>
1094 </indexterm>
1095 </listitem>
1096 </varlistentry>
1097
1098 <varlistentry id="tdbdump">
1099 <term><command>tdbdump</command></term>
1100 <listitem>
1101 <para> is a tool used to print the contents of a
1102 <application>Samba</application> <filename>.tdb</filename>
1103 file.</para>
1104 <indexterm zone="samba tdbdump">
1105 <primary sortas="b-tdbdump">tdbdump</primary>
1106 </indexterm>
1107 </listitem>
1108 </varlistentry>
1109
1110 <varlistentry id="tdbrestore">
1111 <term><command>tdbrestore</command></term>
1112 <listitem>
1113 <para> is a tool for creating a <application>Samba</application>
1114 <filename>.tdb</filename> file out of a ntdbdump.</para>
1115 <indexterm zone="samba tdbrestore">
1116 <primary sortas="b-tdbrestore">tdbrestore</primary>
1117 </indexterm>
1118 </listitem>
1119 </varlistentry>
1120
1121 <varlistentry id="tdbtool">
1122 <term><command>tdbtool</command></term>
1123 <listitem>
1124 <para>is a tool which allows simple database manipulation from the
1125 command line.</para>
1126 <indexterm zone="samba tdbtool">
1127 <primary sortas="b-tdbtool">tdbtool</primary>
1128 </indexterm>
1129 </listitem>
1130 </varlistentry>
1131
1132 <varlistentry id="testparm">
1133 <term><command>testparm</command></term>
1134 <listitem>
1135 <para>checks an <filename>smb.conf</filename> file for proper
1136 syntax.</para>
1137 <indexterm zone="samba testparm">
1138 <primary sortas="b-testparm">testparm</primary>
1139 </indexterm>
1140 </listitem>
1141 </varlistentry>
1142
1143 <varlistentry id="wbinfo">
1144 <term><command>wbinfo</command></term>
1145 <listitem>
1146 <para>queries a running <command>winbindd</command> daemon.</para>
1147 <indexterm zone="samba wbinfo">
1148 <primary sortas="b-wbinfo">wbinfo</primary>
1149 </indexterm>
1150 </listitem>
1151 </varlistentry>
1152
1153 <varlistentry id="winbindd">
1154 <term><command>winbindd</command></term>
1155 <listitem>
1156 <para>resolves names from Windows NT servers.</para>
1157 <indexterm zone="samba winbindd">
1158 <primary sortas="b-winbindd">winbindd</primary>
1159 </indexterm>
1160 </listitem>
1161 </varlistentry>
1162
1163 <varlistentry id="libnss_winbind">
1164 <term><filename class='libraryfile'>libnss_winbind.so</filename></term>
1165 <listitem>
1166 <para>provides Name Service Switch API functions for resolving names
1167 from NT servers.</para>
1168 <indexterm zone="samba libnss_winbind">
1169 <primary sortas="c-libnss_winbind">libnss_winbind.so</primary>
1170 </indexterm>
1171 </listitem>
1172 </varlistentry>
1173
1174 <varlistentry id="libnss_wins">
1175 <term><filename class='libraryfile'>libnss_wins.so</filename></term>
1176 <listitem>
1177 <para>provides API functions for Samba's implementation of the
1178 Windows Internet Naming Service.</para>
1179 <indexterm zone="samba libnss_wins">
1180 <primary sortas="c-libnss_wins">libnss_wins.so</primary>
1181 </indexterm>
1182 </listitem>
1183 </varlistentry>
1184
1185 <varlistentry id="libnetapi">
1186 <term><filename class='libraryfile'>libnetapi.so</filename></term>
1187 <listitem>
1188 <para>provides the API functions for the administration tools used
1189 for Samba and remote CIFS servers.</para>
1190 <indexterm zone="samba libnetapi">
1191 <primary sortas="c-libnetapi">libnetapi.so</primary>
1192 </indexterm>
1193 </listitem>
1194 </varlistentry>
1195
1196 <varlistentry id="libsmbclient">
1197 <term><filename class='libraryfile'>libsmbclient.so</filename></term>
1198 <listitem>
1199 <para>provides the API functions for the Samba SMB client tools.</para>
1200 <indexterm zone="samba libsmbclient">
1201 <primary sortas="c-libsmbclient">libsmbclient.so</primary>
1202 </indexterm>
1203 </listitem>
1204 </varlistentry>
1205<!--
1206 <varlistentry id="libsmbsharemodes">
1207 <term><filename class='libraryfile'>libsmbsharemodes.so</filename></term>
1208 <listitem>
1209 <para>provides API functions for accessing SMB share modes
1210 (locks etc.)</para>
1211 <indexterm zone="samba libsmbsharemodes">
1212 <primary sortas="c-libsmbsharemodes">libsmbsharemodes.so</primary>
1213 </indexterm>
1214 </listitem>
1215 </varlistentry>-->
1216
1217 <varlistentry id="libwbclient">
1218 <term><filename class='libraryfile'>libwbclient.so</filename></term>
1219 <listitem>
1220 <para>provides API functions for Windows domain client services.</para>
1221 <indexterm zone="samba libwbclient">
1222 <primary sortas="c-libwbclient">libwbclient.so</primary>
1223 </indexterm>
1224 </listitem>
1225 </varlistentry>
1226
1227 </variablelist>
1228
1229 </sect2>
1230
1231</sect1>
Note: See TracBrowser for help on using the repository browser.