source: networking/netprogs/samba.xml@ 418edc0

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 418edc0 was 418edc0, checked in by Tim Tassonis <stuff@…>, 7 months ago

samba-4.19.1.
  • Property mode set to 100644
File size: 48.5 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 "bd97ede7457b4cee98dc4aa40cea7da5">
10 <!ENTITY samba-size "40 MB">
11 <!ENTITY samba-buildsize "696 MB (add 73 MB for quicktest)">
12 <!ENTITY samba-time "2.1 SBU (using parallelism=4; add 0.4 SBU for quicktest)">
13]>
14
15<sect1 id="samba" xreflabel="Samba-&samba-version;">
16 <?dbhtml filename="samba.html"?>
17
18
19 <title>Samba-&samba-version;</title>
20
21 <indexterm zone="samba">
22 <primary sortas="a-Samba">Samba</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Samba</title>
27
28 <para>
29 The <application>Samba</application> package provides file and print
30 services to SMB/CIFS clients and Windows networking to Linux clients.
31 <application>Samba</application> can also be configured as a Windows
32 Domain Controller replacement, a file/print server acting as a member
33 of a Windows Active Directory domain and a NetBIOS (RFC1001/1002)
34 nameserver (which among other things provides LAN browsing support).
35 </para>
36
37 &lfs120_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>
43 Download (HTTP): <ulink url="&samba-download-http;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download (FTP): <ulink url="&samba-download-ftp;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download MD5 sum: &samba-md5sum;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download size: &samba-size;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated disk space required: &samba-buildsize;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated build time: &samba-time;
69 </para>
70 </listitem>
71 </itemizedlist>
72
73 <bridgehead renderas="sect3">Samba Dependencies</bridgehead>
74
75 <bridgehead renderas="sect4">Required</bridgehead>
76 <para role="required">
77 <xref linkend="gnutls"/>,
78 <xref linkend="jansson"/>,
79 <xref linkend="perl-json"/>,
80 <xref linkend="libtirpc"/>,
81 <xref linkend="perl-parse-yapp"/>, and
82 <xref linkend="rpcsvc-proto"/>
83 </para>
84
85 <bridgehead renderas="sect4">Recommended</bridgehead>
86 <para role="recommended">
87 <phrase revision="sysv"><xref linkend="dbus"/> (for vfs_snapper, which is
88 useful on systems that support Volume Shadow Copies on Windows),</phrase>
89 <xref linkend="fuse3"/>,
90 <xref linkend="gpgme"/>,
91 <xref linkend="icu"/>,
92 <xref linkend="libtasn1"/>,
93 <xref linkend="libxslt"/> (for documentation),
94 <xref linkend="linux-pam"/>, and
95 <xref linkend="openldap"/>
96 </para>
97
98 <bridgehead renderas="sect4">Optional</bridgehead>
99 <para role="optional">
100 <xref linkend="avahi"/>,
101 <xref linkend="bind"/>,
102 <xref linkend="cups"/>,
103 <xref linkend="cyrus-sasl"/>,
104 <xref linkend="gdb"/>,
105 <xref linkend="git"/>,
106 <xref linkend="gnupg2"/> (required for ADS and the test suite),
107 <xref linkend="libaio"/>,
108 <xref linkend="libarchive"/> (for tar in smbclient),
109 <xref linkend="libcap-pam"/>,
110 <xref linkend="libgcrypt"/>,
111 <xref linkend="libnsl"/>,
112 <xref linkend="libunwind"/>,
113 <xref linkend="lmdb"/>,
114 <xref linkend="markdown"/>,
115 <xref linkend="mitkrb"/>,
116 <xref linkend="nss"/>,
117 <xref linkend="popt"/>,
118 <xref linkend="talloc"/> (included),
119 <xref linkend="vala"/>,
120 <xref linkend="valgrind"/> (optionally used by the test suite),
121 <xref linkend="xfsprogs"/>,
122 <ulink url="https://cmocka.org/">cmocka</ulink>,
123 <ulink url="https://cryptography.io/en/latest/">cryptography</ulink>,
124 <ulink url="https://ctdb.samba.org/">ctdb</ulink> (included),
125 <ulink url="https://cwrap.org/">cwrap</ulink>,
126 <ulink url="&pypi;/dnspython/">dnspython</ulink>,
127 <ulink url="https://packages.debian.org/stretch/fam">FAM</ulink>,
128 <ulink url="https://packages.debian.org/sid/gamin">Gamin</ulink>,
129 <ulink url="https://www.gluster.org/">GlusterFS</ulink>,
130 <ulink url="https://github.com/heimdal/">Heimdal</ulink> (included),
131 <ulink url="https://pypi.org/project/iso8601/">iso8601</ulink>,
132 <ulink url="https://ldb.samba.org/">ldb</ulink> (included),
133 <ulink url="https://www.openafs.org/">OpenAFS</ulink>,
134 <ulink url="https://github.com/python-poetry/poetry-core">poetry-core (required for ADS)</ulink>,
135 <ulink url="https://pypi.org/project/pyasn1/">pyasn1</ulink>,
136 <ulink url="https://tevent.samba.org/">tevent</ulink> (included),
137 <ulink url="https://tdb.samba.org/">tdb</ulink> (included), and
138 <ulink url="https://download.gnome.org/sources/tracker/2.3/">tracker-2</ulink>
139 </para>
140
141 <bridgehead renderas="sect4">Optional (for the Developer Test Suite)</bridgehead>
142 <para role="optional">
143 Install in listed order:
144 <xref linkend="six"/>,
145 <xref linkend="pytest"/>,
146 <ulink url="&pypi;/argparse/">argparse</ulink>,
147 <ulink url="&pypi;/testtools/">testtools</ulink>,
148 <ulink url="&pypi;/testscenarios/">testscenarios</ulink>, and
149 <ulink url="&pypi;/python-subunit/">python-subunit</ulink>
150 </para>
151
152 <para condition="html" role="usernotes">Editor Notes:
153 <ulink url="&blfs-wiki;/samba4"/></para>
154
155 </sect2>
156
157 <sect2 role="installation">
158 <title>Installation of Samba</title>
159
160 <para>
161 To support the test suite, set up a Python virtual environment
162 for some Python modules out of the scope of BLFS:
163 </para>
164
165<screen><userinput remap="pre">python3 -m venv pyvenv &amp;&amp;
166./pyvenv/bin/pip3 install cryptography pyasn1 iso8601</userinput></screen>
167
168 <para>
169 Install <application>Samba</application> by running the following
170 commands:
171 </para>
172
173<screen revision="sysv"><userinput>PYTHON=$PWD/pyvenv/bin/python3 \
174PATH=$PWD/pyvenv/bin:$PATH \
175./configure \
176 --prefix=/usr \
177 --sysconfdir=/etc \
178 --localstatedir=/var \
179 --with-piddir=/run/samba \
180 --with-pammodulesdir=/usr/lib/security \
181 --enable-fhs \
182 --without-ad-dc \
183 --without-systemd \
184 --enable-selftest &amp;&amp;
185make</userinput></screen>
186
187<screen revision="systemd"><userinput>PYTHON=$PWD/pyvenv/bin/python3 \
188./configure \
189 --prefix=/usr \
190 --sysconfdir=/etc \
191 --localstatedir=/var \
192 --with-piddir=/run/samba \
193 --with-pammodulesdir=/usr/lib/security \
194 --enable-fhs \
195 --without-ad-dc \
196 --enable-selftest &amp;&amp;
197make</userinput></screen>
198
199 <para>
200 To test the results, issue:
201 <command>PATH=$PWD/pyvenv/bin:$PATH make quicktest</command>. The test
202 suite will produce lines that look like failures, but these are innocuous.
203 The last few lines of output should report <emphasis>"ALL OK"</emphasis>
204 for a good test run. A summary of any failures can be found in
205 <filename class="directory">./st/summary</filename>.
206 </para>
207
208 <!--
209 If doing a security update or a new minor version (point releases do not
210 apply here), run 'make testenv' before running 'make test' and 'make
211 subunit-test'. This will set up the test environment and make the tests
212 run faster, as well as point out any glaring issues that might affect
213 the new Samba installation. With 4.10.4, I got 236 failures, 73 errors,
214 and 2 unexpected successes. These were all known upstream, and you can
215 find them in the knownfail list in their git repo. This is per
216 Upstream's recommendation over IRC.
217 -->
218
219 <note>
220 <para>
221 Additionally, developer test suites are available. If you've installed
222 the optional python modules above in the Python virtual environment
223 for building this package, you can run these tests with
224 <command>make test</command>. It is not recommended for the average
225 builder at around 290 SBU and over a gigabyte of disk space, and you
226 should expect ~73 errors and ~30 failures from the 3000+ tests.
227 </para>
228 </note>
229
230 <para>
231 Fix hard coded paths to Python 3 interpreter:
232 </para>
233
234<screen><userinput>sed '1s@^.*$@#!/usr/bin/python3@' \
235 -i ./bin/default/source4/scripting/bin/*.inst</userinput></screen>
236
237 <para>
238 If upgrading from an old version of samba, as the
239 <systemitem class="username">root</systemitem> user, remove the old
240 Python support files to prevent some issues:
241 </para>
242
243<screen role="root"><userinput>rm -rf /usr/lib/python&python3-majorver;/site-packages/samba</userinput></screen>
244
245 <para>
246 Still as the <systemitem class="username">root</systemitem> user,
247 install the package:
248 </para>
249
250<screen role="root"><userinput>make install &amp;&amp;
251
252install -v -m644 examples/smb.conf.default /etc/samba &amp;&amp;
253
254sed -e "s;log file =.*;log file = /var/log/samba/%m.log;" \
255 -e "s;path = /usr/spool/samba;path = /var/spool/samba;" \
256 -i /etc/samba/smb.conf.default &amp;&amp;
257
258mkdir -pv /etc/openldap/schema &amp;&amp;
259
260install -v -m644 examples/LDAP/README \
261 /etc/openldap/schema/README.samba &amp;&amp;
262
263install -v -m644 examples/LDAP/samba* \
264 /etc/openldap/schema &amp;&amp;
265
266install -v -m755 examples/LDAP/{get*,ol*} \
267 /etc/openldap/schema</userinput></screen>
268
269 </sect2>
270
271 <sect2 role="commands">
272 <title>Command Explanations</title>
273
274 <para>
275 <parameter>--enable-fhs</parameter>: Assigns all other file paths in
276 a manner compliant with the Filesystem Hierarchy Standard (FHS).
277 </para>
278
279 <para revision="sysv">
280 <parameter>--without-systemd</parameter>: Disable
281 <application>systemd</application> integration, since it is not built
282 in the System V version of LFS/BLFS.
283 </para>
284
285 <para revision="sysv">
286 <parameter>--with-shared-modules='!vfs_snapper'</parameter>: Disable
287 the vfs_snapper module if you want to build samba without <application>dbus</application> support, for setups without graphical user intefaces.
288 </para>
289
290 <para>
291 <parameter>--without-ad-dc</parameter>: Disables
292 Active Directory Domain Controller functionality. See <ulink url=
293 "https://wiki.samba.org/index.php/Setup_a_Samba_Active_Directory_Domain_Controller">
294 Set up a Samba Active Directory Domain Controller</ulink> for detailed
295 information. Remove this switch if you've installed the Python modules
296 needed for ADS support. Note that BLFS does not provide a samba bootscript
297 or systemd unit for an Active Directory domain controller.
298 </para>
299
300 <para>
301 <option>--with-selftest-prefix=SELFTEST_PREFIX</option>: This option
302 specifies the test suite work directory (default=./st).
303 </para>
304
305 <para>
306 <command>install -v -m644 examples/LDAP/* /etc/openldap/schema</command>:
307 These commands are used to copy sample Samba schemas to the OpenLDAP
308 <filename class='directory'>schema</filename> directory.
309 </para>
310
311 <para>
312 <command>install -v -m644 ../examples/smb.conf.default
313 /etc/samba</command>: This copies a default <filename>smb.conf</filename>
314 file into <filename>/etc/samba</filename>. This sample configuration will
315 not work until you copy it to <filename>/etc/samba/smb.conf</filename> and
316 make the appropriate changes for your installation. See the configuration
317 section for minimum values which must be set.
318 </para>
319
320 </sect2>
321
322 <sect2 role="configuration">
323 <title>Configuring Samba</title>
324
325 <sect3 id="samba-config">
326 <title>Config Files</title>
327
328 <para>
329 /etc/samba/smb.conf
330 </para>
331
332 <indexterm zone="samba samba-config">
333 <primary sortas="e-etc-samba-smb.conf">/etc/samba/smb.conf</primary>
334 </indexterm>
335
336 </sect3>
337
338 <sect3>
339 <title>Printing to SMB Clients</title>
340
341 <para>
342 If you use <application>CUPS</application> for print services, and you
343 wish to print to a printer attached to an SMB client, you need to
344 create an SMB backend device. To create the device, issue the following
345 command as the <systemitem class="username">root</systemitem> user:
346 </para>
347
348<screen role="root"><userinput>install -dvm 755 /usr/lib/cups/backend &amp;&amp;
349ln -v -sf /usr/bin/smbspool /usr/lib/cups/backend/smb</userinput></screen>
350
351 </sect3>
352
353 <sect3>
354 <title>Configuration Information</title>
355
356 <para>
357 Due to the complexity and the many various uses for
358 <application>Samba</application>, complete configuration for all the
359 package's capabilities is well beyond the scope of the BLFS book. This
360 section provides instructions to configure the
361 <filename>/etc/samba/smb.conf</filename> file for two common scenarios.
362 The complete contents of <filename>/etc/samba/smb.conf</filename> will
363 depend on the purpose of <application>Samba</application>
364 installation.
365 </para>
366
367 <note>
368 <para>
369 You may find it easier to copy the configuration parameters shown
370 below into an empty <filename>/etc/samba/smb.conf</filename> file
371 instead of copying and editing the default file as mentioned in the
372 <quote>Command Explanations</quote> section. How you create/edit the
373 <filename>/etc/samba/smb.conf</filename> file will be left up to
374 you. Do ensure the file is only writable by the
375 <systemitem class="username">root</systemitem> user (mode 644).
376 </para>
377 </note>
378
379 <sect4>
380 <title>Scenario 1: Minimal Standalone Client-Only Installation</title>
381
382 <para>
383 Choose this variant if you only want to transfer files using
384 <command>smbclient</command>, mount Windows shares and print to
385 Windows printers, and don't want to share your files and printers to
386 Windows machines.
387 </para>
388
389 <para>
390 A <filename>/etc/samba/smb.conf</filename> file with the following
391 three parameters is sufficient:
392 </para>
393
394<screen role='root'><literal>[global]
395 workgroup = <replaceable>WORKGROUP</replaceable>
396 dos charset = <replaceable>cp850</replaceable>
397 unix charset = <replaceable>ISO-8859-1</replaceable></literal></screen>
398
399 <para>
400 The values in this example specify that the computer belongs to a
401 Windows workgroup named
402 <quote><replaceable>WORKGROUP</replaceable></quote>, uses the
403 <quote><replaceable>cp850</replaceable></quote> character set on the
404 wire when talking to MS-DOS and MS Windows 9x, and that the filenames
405 are stored in the <quote><replaceable>ISO-8859-1</replaceable></quote>
406 encoding on the disk. Adjust these values appropriately for your
407 installation. The <quote>unix charset</quote> value must be the same
408 as the output of <command>locale charmap</command> when executed with
409 the <envar>LANG</envar> variable set to your preferred locale,
410 otherwise the <command>ls</command> command may not display correct
411 filenames of downloaded files.
412 </para>
413
414 <para>
415 There is no need to run any <application>Samba</application>
416 servers in this scenario, thus you don't need to install the provided
417 <phrase revision="sysv">bootscripts.</phrase>
418 <phrase revision="systemd">systemd units.</phrase>
419 </para>
420
421 </sect4>
422
423 <sect4>
424 <title>Scenario 2: Standalone File/Print Server</title>
425
426 <para>
427 Choose this variant if you want to share your files and printers
428 to Windows machines in your workgroup in addition to the capabilities
429 described in Scenario 1.
430 </para>
431
432 <para>
433 In this case, the <filename>/etc/samba/smb.conf.default</filename>
434 file may be a good template to start from. Also, you should add the
435 <quote>dos charset</quote> and <quote>unix charset</quote> parameters
436 to the <quote>[global]</quote> section as described in Scenario 1 in
437 order to prevent filename corruption. For security reasons, you may
438 wish to define
439 <replaceable>path = /home/alice/shared-files</replaceable>,
440 assuming your user name is <replaceable>alice</replaceable> and you
441 only want to share the files in that directory, instead of your entire
442 home. Then, replace <replaceable>homes</replaceable> by
443 <replaceable>shared-files</replaceable> and change also the
444 <quote><literal>comment</literal></quote> if used the configuration
445 file below or the <filename>/etc/samba/smb.conf.default</filename>
446 to create yours.
447 </para>
448
449 <para>
450 The following configuration file creates a separate share for each
451 user's home directory and also makes all printers available to Windows
452 machines:
453 </para>
454
455<screen role='root'><literal>[global]
456 workgroup = <replaceable>WORKGROUP</replaceable>
457 dos charset = <replaceable>cp850</replaceable>
458 unix charset = <replaceable>ISO-8859-1</replaceable>
459
460[homes]
461 comment = Home Directories
462 browseable = no
463 writable = yes
464
465[printers]
466 comment = All Printers
467 path = /var/spool/samba
468 browseable = no
469 guest ok = no
470 printable = yes</literal></screen>
471
472 <para>
473 Other parameters you may wish to customize in the
474 <quote>[global]</quote> section include:
475 </para>
476
477<screen role='root'><literal> server string =
478 security =
479 hosts allow =
480 load printers =
481 log file =
482 max log size =
483 socket options =
484 local master =</literal></screen>
485
486 <para>
487 Reference the comments in the
488 <filename>/etc/samba/smb.conf.default</filename> file for information
489 regarding these parameters.
490 </para>
491
492 <para>
493 Since the <command>smbd</command> and <command>nmbd</command> daemons
494 are needed in this case, install the <filename>samba</filename>
495 <phrase revision="sysv">bootscript.</phrase>
496 <phrase revision="systemd">systemd unit.</phrase>
497 Be sure to run <command>smbpasswd</command> (with the
498 <option>-a</option> option to add users) to enable and set passwords
499 for all accounts that need <application>Samba</application> access.
500 Using the default <application>Samba</application> passdb backend,
501 any user you attempt to add will also be required to exist in the
502 <filename>/etc/passwd</filename> file.
503 </para>
504
505 </sect4>
506
507 <sect4>
508 <title>Advanced Requirements</title>
509
510 <para>
511 More complex scenarios involving domain control or membership are
512 possible. Such setups are advanced topics and cannot be adequately
513 covered in BLFS. Many complete books have been written on these topics
514 alone. Note that in some domain membership scenarios, the
515 <command>winbindd</command> daemon and the corresponding
516 <phrase revision="sysv">bootscript</phrase>
517 <phrase revision="systemd">systemd unit</phrase> are needed.
518 </para>
519
520 </sect4>
521
522 <sect4>
523 <title>Guest account</title>
524
525 <para>
526 The default <application>Samba</application> installation uses the
527 <systemitem class='username'>nobody</systemitem> user for guest
528 access to the server. This can be overridden by setting the
529 <option>guest account =</option> parameter in the
530 <filename>/etc/samba/smb.conf</filename> file. If you utilize the
531 <option>guest account =</option> parameter, ensure this user exists
532 in the <filename>/etc/passwd</filename> file.
533 </para>
534
535 </sect4>
536
537 <sect4 id="samba-init" revision="sysv">
538 <title>Boot Script</title>
539
540 <para>
541 For your convenience, boot scripts have been provided for
542 <application>Samba</application>. There are two included in the
543 <xref linkend="bootscripts"/> package. The first,
544 <filename>samba</filename>, will start the <command>smbd</command>
545 and <command>nmbd</command> daemons needed to provide SMB/CIFS
546 services. The second script, <filename>winbind</filename>, starts
547 the <command>winbindd</command> daemon, used for providing Windows
548 domain services to Linux clients.
549 </para>
550
551 <indexterm zone="samba samba-init">
552 <primary sortas="f-samba">samba</primary>
553 </indexterm>
554
555 <indexterm zone="samba samba-init">
556 <primary sortas="f-winbind">winbind</primary>
557 </indexterm>
558
559<screen role="root"><userinput>make install-samba</userinput></screen>
560
561<screen role="root"><userinput>make install-winbindd</userinput></screen>
562
563 </sect4>
564
565 <sect4 id="samba-init-sysd" revision="systemd">
566 <title>Systemd Units</title>
567
568 <para>
569 To start the <application>Samba</application> daemons at boot,
570 install the systemd units from the <xref linkend="systemd-units"/>
571 package by running the following command as the
572 <systemitem class="username">root</systemitem> user:
573 </para>
574
575 <indexterm zone="samba samba-init-sysd">
576 <primary sortas="f-samba">samba</primary>
577 </indexterm>
578
579<screen role="root"><userinput>make install-samba</userinput></screen>
580
581 <para>
582 To start the <command>winbindd</command> daemon at boot,
583 install the systemd unit from the <xref linkend="systemd-units"/>
584 package by running the following command as the
585 <systemitem class="username">root</systemitem> user:
586 </para>
587
588 <indexterm zone="samba samba-init-sysd">
589 <primary sortas="f-winbindd">winbindd</primary>
590 </indexterm>
591
592<screen role="root"><userinput>make install-winbindd</userinput></screen>
593
594 <note>
595 <para>
596 This package comes with two types of units: A service file and a
597 socket file. The service file will start the smbd daemon once at
598 boot and it will keep running until the system shuts down. The
599 socket file will make systemd listen on the smbd port (Default 445,
600 needs to be edited for anything else) and will start the smbd
601 daemon when something tries to connect to that port and stop the
602 daemon when the connection is terminated. This is called socket
603 activation and is analogous to using
604 <application>{,x}inetd</application> on a SysVinit based system.
605 </para>
606
607 <para>
608 By default, the first method is used - the smbd daemon is started
609 at boot and stopped at shutdown. If the socket method is desired,
610 you need to run the following commands as the <systemitem
611 class="username">root</systemitem> user:
612 </para>
613
614<screen role="root"><userinput>systemctl stop smbd &amp;&amp;
615systemctl disable smbd &amp;&amp;
616systemctl enable smbd.socket &amp;&amp;
617systemctl start smbd.socket</userinput></screen>
618
619 <para>
620 Note that only the smbd daemon can be socket activated.
621 </para>
622 </note>
623 </sect4>
624
625 </sect3>
626
627 </sect2>
628
629 <sect2 role="content">
630 <title>Contents</title>
631
632 <segmentedlist>
633 <segtitle>Installed Programs</segtitle>
634 <segtitle>Installed Libraries</segtitle>
635 <segtitle>Installed Directories</segtitle>
636
637 <seglistitem>
638
639 <seg>
640 cifsdd, dbwrap_tool, dumpmscat, eventlogadm, gentest,
641 ldbadd, ldbdel, ldbedit, ldbmodify, ldbrename, ldbsearch, locktest,
642 masktest, mdsearch, mvxattr, ndrdump, net, nmbd, nmblookup, ntlm_auth,
643 oLschema2ldif, pdbedit, profiles, regdiff, regpatch, regshell,
644 regtree, rpcclient, samba-log-parser, samba-gpupdate, samba-regedit,
645 samba-tool, sharesec, smbcacls, smbclient, smbcontrol, smbcquotas,
646 smbd, smbget, smbpasswd, smbspool, smbstatus, smbtar, smbtorture,
647 smbtree, tdbbackup, tdbdump, tdbrestore, tdbtool, testparm, wbinfo,
648 and winbindd
649 </seg>
650
651 <seg>
652 libdcerpc-binding.so, libdcerpc-samr.so,
653 libdcerpc-server-core.so, libdcerpc.so,
654 libndr-krb5pac.so, libndr-nbt.so, libndr.so,
655 libndr-standard.so, libnetapi.so, libnss_winbind.so, libnss_wins.so,
656 libsamba-credentials.so, libsamba-errors.so,
657 libsamba-hostconfig.so, libsamba-passdb.so,
658 libsamba-policy.cpython-311-x86_64-linux-gnu.so, libsamba-util.so,
659 libsamdb.so, libsmbclient.so,
660 libsmbconf.so, libsmbldap.so, libtevent-util.so,
661 libwbclient.so, and filesystem and support modules under
662 /usr/lib/{python&python3-majorver;,samba}
663 </seg>
664
665 <seg>
666 /etc/samba, /run/samba, /usr/include/samba-4.0,
667 /usr/lib/python&python3-majorver;/site-packages/samba,
668 /usr/{lib,libexec,share}/samba,
669 and /var/{cache,lib,lock,log,run}/samba
670 </seg>
671
672 </seglistitem>
673 </segmentedlist>
674
675 <variablelist>
676 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
677 <?dbfo list-presentation="list"?>
678 <?dbhtml list-presentation="table"?>
679
680 <varlistentry id="cifsdd">
681 <term><command>cifsdd</command></term>
682 <listitem>
683 <para>
684 is the dd command for SMB
685 </para>
686 <indexterm zone="samba cifsdd">
687 <primary sortas="b-cifsdd">cifsdd</primary>
688 </indexterm>
689 </listitem>
690 </varlistentry>
691
692 <varlistentry id="dbwrap_tool">
693 <term><command>dbwrap_tool</command></term>
694 <listitem>
695 <para>
696 is used to read and manipulate TDB/CTDB databases using
697 the dbwrap interface
698 </para>
699 <indexterm zone="samba dbwrap_tool">
700 <primary sortas="b-dbwrap_tool">dbwrap_tool</primary>
701 </indexterm>
702 </listitem>
703 </varlistentry>
704
705 <varlistentry id="dumpmscat">
706 <term><command>dumpmscat</command></term>
707 <listitem>
708 <para>
709 dumps the content of MS catalog files
710 </para>
711 <indexterm zone="samba dumpmscat">
712 <primary sortas="b-dumpmscat">dumpmscat</primary>
713 </indexterm>
714 </listitem>
715 </varlistentry>
716
717 <varlistentry id="eventlogadm">
718 <term><command>eventlogadm</command></term>
719 <listitem>
720 <para>
721 is used to write records to eventlogs from STDIN, add the
722 specified source and DLL eventlog registry entries and display the
723 active eventlog names (from <filename>smb.conf</filename>)
724 </para>
725 <indexterm zone="samba eventlogadm">
726 <primary sortas="b-eventlogadm">eventlogadm</primary>
727 </indexterm>
728 </listitem>
729 </varlistentry>
730
731 <varlistentry id="gentest">
732 <term><command>gentest</command></term>
733 <listitem>
734 <para>
735 is used to run random generic SMB operations against two
736 SMB servers and show the differences in behavior
737 </para>
738 <indexterm zone="samba gentest">
739 <primary sortas="b-gentest">gentest</primary>
740 </indexterm>
741 </listitem>
742 </varlistentry>
743
744 <varlistentry id="ldbadd">
745 <term><command>ldbadd</command></term>
746 <listitem>
747 <para>
748 is a command-line utility for adding records to an LDB
749 database
750 </para>
751 <indexterm zone="samba ldbadd">
752 <primary sortas="b-ldbadd">ldbadd</primary>
753 </indexterm>
754 </listitem>
755 </varlistentry>
756
757 <varlistentry id="ldbdel">
758 <term><command>ldbdel</command></term>
759 <listitem>
760 <para>
761 is a command-line utility for deleting LDB database records
762 </para>
763 <indexterm zone="samba ldbdel">
764 <primary sortas="b-ldbdel">ldbdel</primary>
765 </indexterm>
766 </listitem>
767 </varlistentry>
768
769 <varlistentry id="ldbedit">
770 <term><command>ldbedit</command></term>
771 <listitem>
772 <para>
773 allows you to edit LDB databases using your preferred editor
774 </para>
775 <indexterm zone="samba ldbedit">
776 <primary sortas="b-ldbedit">ldbedit</primary>
777 </indexterm>
778 </listitem>
779 </varlistentry>
780
781 <varlistentry id="ldbmodify">
782 <term><command>ldbmodify</command></term>
783 <listitem>
784 <para>
785 allows you to modify records in an LDB database
786 </para>
787 <indexterm zone="samba ldbmodify">
788 <primary sortas="b-ldbmodify">ldbmodify</primary>
789 </indexterm>
790 </listitem>
791 </varlistentry>
792
793 <varlistentry id="ldbrename">
794 <term><command>ldbrename</command></term>
795 <listitem>
796 <para>
797 allows you to rename LDB databases
798 </para>
799 <indexterm zone="samba ldbrename">
800 <primary sortas="b-ldbrename">ldbrename</primary>
801 </indexterm>
802 </listitem>
803 </varlistentry>
804
805 <varlistentry id="ldbsearch">
806 <term><command>ldbsearch</command></term>
807 <listitem>
808 <para>
809 searches an LDB database for records matching a specified
810 expression
811 </para>
812 <indexterm zone="samba ldbsearch">
813 <primary sortas="b-ldbsearch">ldbsearch</primary>
814 </indexterm>
815 </listitem>
816 </varlistentry>
817
818 <varlistentry id="locktest">
819 <term><command>locktest</command></term>
820 <listitem>
821 <para>
822 is used to find differences in locking between two SMB servers
823 </para>
824 <indexterm zone="samba locktest">
825 <primary sortas="b-locktest">locktest</primary>
826 </indexterm>
827 </listitem>
828 </varlistentry>
829
830 <varlistentry id="masktest">
831 <term><command>masktest</command></term>
832 <listitem>
833 <para>
834 is used to find differences in wildcard matching between
835 Samba's implementation and that of a remote server
836 </para>
837 <indexterm zone="samba masktest">
838 <primary sortas="b-masktest">masktest</primary>
839 </indexterm>
840 </listitem>
841 </varlistentry>
842
843 <varlistentry id="mdsearch">
844 <term><command>mdsearch</command></term>
845 <listitem>
846 <para>
847 runs <application>Spotlight</application> searches against a SMB
848 server
849 </para>
850 <indexterm zone="samba mdsearch">
851 <primary sortas="b-mdsearch">mdsearch</primary>
852 </indexterm>
853 </listitem>
854 </varlistentry>
855
856 <varlistentry id="mvxattr">
857 <term><command>mvxattr</command></term>
858 <listitem>
859 <para>
860 is used to recursively rename extended attributes
861 </para>
862 <indexterm zone="samba mvxattr">
863 <primary sortas="b-mvxattr">mvxattr</primary>
864 </indexterm>
865 </listitem>
866 </varlistentry>
867
868 <varlistentry id="ndrdump">
869 <term><command>ndrdump</command></term>
870 <listitem>
871 <para>
872 is a DCE/RPC Packet Parser and Dumper
873 </para>
874 <indexterm zone="samba ndrdump">
875 <primary sortas="b-ndrdump">ndrdump</primary>
876 </indexterm>
877 </listitem>
878 </varlistentry>
879
880 <varlistentry id="net">
881 <term><command>net</command></term>
882 <listitem>
883 <para>
884 is a tool for administration of <application>Samba</application>
885 and remote CIFS servers, similar to the <command>net</command>
886 utility for DOS/Windows
887 </para>
888 <indexterm zone="samba net">
889 <primary sortas="b-net">net</primary>
890 </indexterm>
891 </listitem>
892 </varlistentry>
893
894 <varlistentry id="nmbd">
895 <term><command>nmbd</command></term>
896 <listitem>
897 <para>
898 is the <application>Samba</application> NetBIOS name server
899 </para>
900 <indexterm zone="samba nmbd">
901 <primary sortas="b-nmbd">nmbd</primary>
902 </indexterm>
903 </listitem>
904 </varlistentry>
905
906 <varlistentry id="nmblookup">
907 <term><command>nmblookup</command></term>
908 <listitem>
909 <para>
910 is used to query NetBIOS names and map them to IP addresses
911 </para>
912 <indexterm zone="samba nmblookup">
913 <primary sortas="b-nmblookup">nmblookup</primary>
914 </indexterm>
915 </listitem>
916 </varlistentry>
917
918 <varlistentry id="ntlm_auth">
919 <term><command>ntlm_auth</command></term>
920 <listitem>
921 <para>
922 is a tool to allow external access to Winbind's
923 NTLM authentication function
924 </para>
925 <indexterm zone="samba ntlm_auth">
926 <primary sortas="b-ntlm_auth">ntlm_auth</primary>
927 </indexterm>
928 </listitem>
929 </varlistentry>
930
931 <varlistentry id="oLschema2ldif">
932 <term><command>oLschema2ldif</command></term>
933 <listitem>
934 <para>
935 converts LDAP schema's to LDB-compatible LDIF
936 </para>
937 <indexterm zone="samba oLschema2ldif">
938 <primary sortas="b-oLschema2ldif">oLschema2ldif</primary>
939 </indexterm>
940 </listitem>
941 </varlistentry>
942
943 <varlistentry id="pdbedit">
944 <term><command>pdbedit</command></term>
945 <listitem>
946 <para>
947 is a tool used to manage the SAM database
948 </para>
949 <indexterm zone="samba pdbedit">
950 <primary sortas="b-pdbedit">pdbedit</primary>
951 </indexterm>
952 </listitem>
953 </varlistentry>
954
955 <varlistentry id="profiles">
956 <term><command>profiles</command></term>
957 <listitem>
958 <para>
959 is a utility that reports and changes SIDs in Windows
960 registry files
961 </para>
962 <indexterm zone="samba profiles">
963 <primary sortas="b-profiles">profiles</primary>
964 </indexterm>
965 </listitem>
966 </varlistentry>
967
968 <varlistentry id="regdiff">
969 <term><command>regdiff</command></term>
970 <listitem>
971 <para>
972 is a Diff program for Windows registry files
973 </para>
974 <indexterm zone="samba regdiff">
975 <primary sortas="b-regdiff">regdiff</primary>
976 </indexterm>
977 </listitem>
978 </varlistentry>
979
980 <varlistentry id="regpatch">
981 <term><command>regpatch</command></term>
982 <listitem>
983 <para>
984 applies registry patches to registry files
985 </para>
986 <indexterm zone="samba regpatch">
987 <primary sortas="b-regpatch">regpatch</primary>
988 </indexterm>
989 </listitem>
990 </varlistentry>
991
992 <varlistentry id="regshell">
993 <term><command>regshell</command></term>
994 <listitem>
995 <para>
996 is a Windows registry file browser using readline
997 </para>
998 <indexterm zone="samba regshell">
999 <primary sortas="b-regshell">regshell</primary>
1000 </indexterm>
1001 </listitem>
1002 </varlistentry>
1003
1004 <varlistentry id="regtree">
1005 <term><command>regtree</command></term>
1006 <listitem>
1007 <para>
1008 is a text-mode registry viewer
1009 </para>
1010 <indexterm zone="samba regtree">
1011 <primary sortas="b-regtree">regtree</primary>
1012 </indexterm>
1013 </listitem>
1014 </varlistentry>
1015
1016 <varlistentry id="rpcclient">
1017 <term><command>rpcclient</command></term>
1018 <listitem>
1019 <para>
1020 is used to execute MS-RPC client side functions
1021 </para>
1022 <indexterm zone="samba rpcclient">
1023 <primary sortas="b-rpcclient">rpcclient</primary>
1024 </indexterm>
1025 </listitem>
1026 </varlistentry>
1027
1028 <varlistentry id="samba-log-parser">
1029 <term><command>samba-log-parser</command></term>
1030 <listitem>
1031 <para>
1032 parses winbind logs generated by Samba
1033 </para>
1034 <indexterm zone="samba samba-log-parser">
1035 <primary sortas="b-samba-log-parser">samba-log-parser</primary>
1036 </indexterm>
1037 </listitem>
1038 </varlistentry>
1039
1040 <varlistentry id="samba-gpupdate">
1041 <term><command>samba-gpupdate</command></term>
1042 <listitem>
1043 <para>
1044 allows you to edit Microsoft Group Policy Objects (GPOs)
1045 </para>
1046 <indexterm zone="samba samba-gpupdate">
1047 <primary sortas="b-samba-gpupdate">samba-gpupdate</primary>
1048 </indexterm>
1049 </listitem>
1050 </varlistentry>
1051
1052 <varlistentry id="samba-regedit">
1053 <term><command>samba-regedit</command></term>
1054 <listitem>
1055 <para>
1056 is a ncurses based tool to manage the Samba registry
1057 </para>
1058 <indexterm zone="samba samba-regedit">
1059 <primary sortas="b-samba-regedit">samba-regedit</primary>
1060 </indexterm>
1061 </listitem>
1062 </varlistentry>
1063
1064 <varlistentry id="samba-tool">
1065 <term><command>samba-tool</command></term>
1066 <listitem>
1067 <para>
1068 is the main Samba administration tool
1069 </para>
1070 <indexterm zone="samba samba-tool">
1071 <primary sortas="b-samba-tool">samba-tool</primary>
1072 </indexterm>
1073 </listitem>
1074 </varlistentry>
1075
1076 <varlistentry id="sharesec">
1077 <term><command>sharesec</command></term>
1078 <listitem>
1079 <para>
1080 manipulates share ACL permissions on SMB file shares
1081 </para>
1082 <indexterm zone="samba sharesec">
1083 <primary sortas="b-sharesec">sharesec</primary>
1084 </indexterm>
1085 </listitem>
1086 </varlistentry>
1087
1088 <varlistentry id="smbcacls">
1089 <term><command>smbcacls</command></term>
1090 <listitem>
1091 <para>
1092 is used to manipulate Windows NT access control lists
1093 </para>
1094 <indexterm zone="samba smbcacls">
1095 <primary sortas="b-smbcacls">smbcacls</primary>
1096 </indexterm>
1097 </listitem>
1098 </varlistentry>
1099
1100 <varlistentry id="smbclient">
1101 <term><command>smbclient</command></term>
1102 <listitem>
1103 <para>
1104 is a SMB/CIFS access utility, similar to FTP
1105 </para>
1106 <indexterm zone="samba smbclient">
1107 <primary sortas="b-smbclient">smbclient</primary>
1108 </indexterm>
1109 </listitem>
1110 </varlistentry>
1111
1112 <varlistentry id="smbcontrol">
1113 <term><command>smbcontrol</command></term>
1114 <listitem>
1115 <para>
1116 is used to control running <command>smbd</command>,
1117 <command>nmbd</command> and <command>winbindd</command> daemons
1118 </para>
1119 <indexterm zone="samba smbcontrol">
1120 <primary sortas="b-smbcontrol">smbcontrol</primary>
1121 </indexterm>
1122 </listitem>
1123 </varlistentry>
1124
1125 <varlistentry id="smbcquotas">
1126 <term><command>smbcquotas</command></term>
1127 <listitem>
1128 <para>
1129 is used to manipulate Windows NT quotas on SMB file shares
1130 </para>
1131 <indexterm zone="samba smbcquotas">
1132 <primary sortas="b-smbcquotas">smbcquotas</primary>
1133 </indexterm>
1134 </listitem>
1135 </varlistentry>
1136
1137 <varlistentry id="smbd">
1138 <term><command>smbd</command></term>
1139 <listitem>
1140 <para>
1141 is the main <application>Samba</application> daemon which
1142 provides SMB/CIFS services to clients
1143 </para>
1144 <indexterm zone="samba smbd">
1145 <primary sortas="b-smbd">smbd</primary>
1146 </indexterm>
1147 </listitem>
1148 </varlistentry>
1149
1150 <varlistentry id="smbget">
1151 <term><command>smbget</command></term>
1152 <listitem>
1153 <para>
1154 is a simple utility with <command>wget</command>-like semantics,
1155 that can download files from SMB servers. You can specify the
1156 files you would like to download on the command-line
1157 </para>
1158 <indexterm zone="samba smbget">
1159 <primary sortas="b-smbget">smbget</primary>
1160 </indexterm>
1161 </listitem>
1162 </varlistentry>
1163
1164 <varlistentry id="smbpasswd">
1165 <term><command>smbpasswd</command></term>
1166 <listitem>
1167 <para>
1168 changes a user's <application>Samba</application> password
1169 </para>
1170 <indexterm zone="samba smbpasswd">
1171 <primary sortas="b-smbpasswd">smbpasswd</primary>
1172 </indexterm>
1173 </listitem>
1174 </varlistentry>
1175
1176 <varlistentry id="smbspool">
1177 <term><command>smbspool</command></term>
1178 <listitem>
1179 <para>
1180 sends a print job to a SMB printer
1181 </para>
1182 <indexterm zone="samba smbspool">
1183 <primary sortas="b-smbspool">smbspool</primary>
1184 </indexterm>
1185 </listitem>
1186 </varlistentry>
1187
1188 <varlistentry id="smbstatus">
1189 <term><command>smbstatus</command></term>
1190 <listitem>
1191 <para>
1192 reports current <application>Samba</application> connections
1193 </para>
1194 <indexterm zone="samba smbstatus">
1195 <primary sortas="b-smbstatus">smbstatus</primary>
1196 </indexterm>
1197 </listitem>
1198 </varlistentry>
1199
1200 <varlistentry id="smbtar">
1201 <term><command>smbtar</command></term>
1202 <listitem>
1203 <para>
1204 is a shell script used for backing up SMB/CIFS shares
1205 directly to Linux tape drives or to a file
1206 </para>
1207 <indexterm zone="samba smbtar">
1208 <primary sortas="b-smbtar">smbtar</primary>
1209 </indexterm>
1210 </listitem>
1211 </varlistentry>
1212
1213 <varlistentry id="smbtorture">
1214 <term><command>smbtorture</command></term>
1215 <listitem>
1216 <para>
1217 is a test suite that runs several tests against a SMB server
1218 </para>
1219 <indexterm zone="samba smbtorture">
1220 <primary sortas="b-smbtorture">smbtorture</primary>
1221 </indexterm>
1222 </listitem>
1223 </varlistentry>
1224
1225 <varlistentry id="smbtree">
1226 <term><command>smbtree</command></term>
1227 <listitem>
1228 <para>
1229 is a text-based SMB network browser
1230 </para>
1231 <indexterm zone="samba smbtree">
1232 <primary sortas="b-smbtree">smbtree</primary>
1233 </indexterm>
1234 </listitem>
1235 </varlistentry>
1236
1237 <varlistentry id="tdbbackup">
1238 <term><command>tdbbackup</command></term>
1239 <listitem>
1240 <para>
1241 is a tool for backing up or validating the integrity of
1242 <application>Samba</application> <filename>.tdb</filename> files
1243 </para>
1244 <indexterm zone="samba tdbbackup">
1245 <primary sortas="b-tdbbackup">tdbbackup</primary>
1246 </indexterm>
1247 </listitem>
1248 </varlistentry>
1249
1250 <varlistentry id="tdbdump">
1251 <term><command>tdbdump</command></term>
1252 <listitem>
1253 <para>
1254 is a tool used to print the contents of a
1255 <application>Samba</application> <filename>.tdb</filename> file
1256 </para>
1257 <indexterm zone="samba tdbdump">
1258 <primary sortas="b-tdbdump">tdbdump</primary>
1259 </indexterm>
1260 </listitem>
1261 </varlistentry>
1262
1263 <varlistentry id="tdbrestore">
1264 <term><command>tdbrestore</command></term>
1265 <listitem>
1266 <para>
1267 is a tool for creating a <application>Samba</application>
1268 <filename>.tdb</filename> file out of a ntdbdump
1269 </para>
1270 <indexterm zone="samba tdbrestore">
1271 <primary sortas="b-tdbrestore">tdbrestore</primary>
1272 </indexterm>
1273 </listitem>
1274 </varlistentry>
1275
1276 <varlistentry id="tdbtool">
1277 <term><command>tdbtool</command></term>
1278 <listitem>
1279 <para>
1280 is a tool which allows simple database manipulation from the
1281 command line
1282 </para>
1283 <indexterm zone="samba tdbtool">
1284 <primary sortas="b-tdbtool">tdbtool</primary>
1285 </indexterm>
1286 </listitem>
1287 </varlistentry>
1288
1289 <varlistentry id="testparm">
1290 <term><command>testparm</command></term>
1291 <listitem>
1292 <para>
1293 checks a <filename>smb.conf</filename> file for proper syntax
1294 </para>
1295 <indexterm zone="samba testparm">
1296 <primary sortas="b-testparm">testparm</primary>
1297 </indexterm>
1298 </listitem>
1299 </varlistentry>
1300
1301 <varlistentry id="wbinfo">
1302 <term><command>wbinfo</command></term>
1303 <listitem>
1304 <para>
1305 queries a running <command>winbindd</command> daemon
1306 </para>
1307 <indexterm zone="samba wbinfo">
1308 <primary sortas="b-wbinfo">wbinfo</primary>
1309 </indexterm>
1310 </listitem>
1311 </varlistentry>
1312
1313 <varlistentry id="winbindd">
1314 <term><command>winbindd</command></term>
1315 <listitem>
1316 <para>
1317 resolves names from Windows NT servers
1318 </para>
1319 <indexterm zone="samba winbindd">
1320 <primary sortas="b-winbindd">winbindd</primary>
1321 </indexterm>
1322 </listitem>
1323 </varlistentry>
1324
1325 <varlistentry id="libnss_winbind">
1326 <term><filename class="libraryfile">libnss_winbind.so</filename></term>
1327 <listitem>
1328 <para>
1329 provides Name Service Switch API functions for resolving names
1330 from NT servers
1331 </para>
1332 <indexterm zone="samba libnss_winbind">
1333 <primary sortas="c-libnss_winbind">libnss_winbind.so</primary>
1334 </indexterm>
1335 </listitem>
1336 </varlistentry>
1337
1338 <varlistentry id="libnss_wins">
1339 <term><filename class="libraryfile">libnss_wins.so</filename></term>
1340 <listitem>
1341 <para>
1342 provides API functions for Samba's implementation of the
1343 Windows Internet Naming Service
1344 </para>
1345 <indexterm zone="samba libnss_wins">
1346 <primary sortas="c-libnss_wins">libnss_wins.so</primary>
1347 </indexterm>
1348 </listitem>
1349 </varlistentry>
1350
1351 <varlistentry id="libnetapi">
1352 <term><filename class="libraryfile">libnetapi.so</filename></term>
1353 <listitem>
1354 <para>
1355 provides API functions for the administration tools used
1356 for Samba and remote CIFS servers
1357 </para>
1358 <indexterm zone="samba libnetapi">
1359 <primary sortas="c-libnetapi">libnetapi.so</primary>
1360 </indexterm>
1361 </listitem>
1362 </varlistentry>
1363
1364 <varlistentry id="libsmbclient">
1365 <term><filename class="libraryfile">libsmbclient.so</filename></term>
1366 <listitem>
1367 <para>
1368 provides API functions for the Samba SMB client tools
1369 </para>
1370 <indexterm zone="samba libsmbclient">
1371 <primary sortas="c-libsmbclient">libsmbclient.so</primary>
1372 </indexterm>
1373 </listitem>
1374 </varlistentry>
1375<!--
1376 <varlistentry id="libsmbsharemodes">
1377 <term><filename class="libraryfile">libsmbsharemodes.so</filename></term>
1378 <listitem>
1379 <para>
1380 provides API functions for accessing SMB share modes (locks etc.)
1381 </para>
1382 <indexterm zone="samba libsmbsharemodes">
1383 <primary sortas="c-libsmbsharemodes">libsmbsharemodes.so</primary>
1384 </indexterm>
1385 </listitem>
1386 </varlistentry>-->
1387
1388 <varlistentry id="libwbclient">
1389 <term><filename class="libraryfile">libwbclient.so</filename></term>
1390 <listitem>
1391 <para>
1392 provides API functions for Windows domain client services
1393 </para>
1394 <indexterm zone="samba libwbclient">
1395 <primary sortas="c-libwbclient">libwbclient.so</primary>
1396 </indexterm>
1397 </listitem>
1398 </varlistentry>
1399
1400 </variablelist>
1401
1402 </sect2>
1403
1404</sect1>
Note: See TracBrowser for help on using the repository browser.