source: networking/netprogs/samba.xml@ 2f81d97a

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 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 2f81d97a was 2f81d97a, checked in by DJ Lucas <dj@…>, 8 years ago

Add Parse-Yapp-1.05 to fix samba reinstall issue.

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