source: networking/netprogs/cifsutils.xml@ 4c24eb0a

10.1 11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt 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 4c24eb0a was 4c24eb0a, checked in by Pierre Labastie <pieere@…>, 3 years ago

Remove period at the end of short descriptions.
In the process, some attributes in single quotes have been changed to double
quotes, and a few attribute lists have been written on one line instead of
several lines.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@24236 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 10.1 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 cifsutils-download-http "https://www.samba.org/ftp/linux-cifs/cifs-utils/cifs-utils-&cifsutils-version;.tar.bz2">
8 <!ENTITY cifsutils-download-ftp " ">
9 <!ENTITY cifsutils-md5sum "b49b10692bcae7f28669173a472077dd">
10 <!ENTITY cifsutils-size "404 KB">
11 <!ENTITY cifsutils-buildsize "4.7 MB">
12 <!ENTITY cifsutils-time "0.1 SBU">
13]>
14
15<sect1 id="cifsutils" xreflabel="cifs-utils-&cifsutils-version;">
16 <?dbhtml filename="cifsutils.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>cifs-utils-&cifsutils-version;</title>
24
25 <indexterm zone="cifsutils">
26 <primary sortas="a-cifsutils">cifs-utils</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to cifs-utils</title>
31
32 <para>
33 The <application>cifs-utils</application> package provides a means for
34 mounting SMB/CIFS shares on a Linux system.
35 </para>
36
37 &lfs10_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>
43 Download (HTTP): <ulink url="&cifsutils-download-http;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download (FTP): <ulink url="&cifsutils-download-ftp;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download MD5 sum: &cifsutils-md5sum;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download size: &cifsutils-size;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated disk space required: &cifsutils-buildsize;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated build time: &cifsutils-time;
69 </para>
70 </listitem>
71 </itemizedlist>
72
73 <bridgehead renderas="sect3">cifs-utils Dependencies</bridgehead>
74
75 <bridgehead renderas="sect4">Required</bridgehead>
76 <para role="required">
77 <xref linkend="talloc"/>
78 </para>
79
80 <bridgehead renderas="sect4">Optional</bridgehead>
81 <para role="optional">
82 <xref linkend="keyutils"/> (required to build PAM module),
83 <xref linkend="linux-pam"/>,
84 <xref linkend="mitkrb"/>,
85 <xref linkend="samba"/>, and
86 <xref linkend="libcap-pam"/> or
87 <ulink url="http://people.redhat.com/sgrubb/libcap-ng/">
88 libcap-ng
89 </ulink>
90 </para>
91
92 <para condition="html" role="usernotes">User Notes:
93 <ulink url="&blfs-wiki;/cifsutils"/></para>
94
95 </sect2>
96
97 <sect2 role="kernel" id="cifsutils-kernel">
98 <title>Kernel Configuration</title>
99
100 <para>
101 Enable the following options in the kernel configuration and recompile the
102 kernel if necessary:
103 </para>
104
105<screen><literal>File systems ---&gt;
106 [*] Network File Systems ---&gt; [CONFIG_NETWORK_FILESYSTEMS]
107 &lt;*/M&gt; SMB3 and CIFS support (advanced network filesystem) [CONFIG_CIFS]</literal></screen>
108
109 <para>
110 Depending on your server configuration, additional kernel options may be
111 required.
112 </para>
113
114 <indexterm zone="cifsutils cifsutils-kernel">
115 <primary sortas="d-cifsutils">cifs-utils</primary>
116 </indexterm>
117
118 </sect2>
119
120 <sect2 role="installation">
121 <title>Installation of cifs-utils</title>
122
123 <para>
124 Install <application>cifs-utils</application> by running the following
125 commands:
126 </para>
127
128<screen revision="sysv"><userinput>./configure --prefix=/usr \
129 --disable-pam \
130 --disable-systemd &amp;&amp;
131make</userinput></screen>
132
133<screen revision="systemd"><userinput>./configure --prefix=/usr \
134 --disable-pam &amp;&amp;
135make</userinput></screen>
136
137 <para>
138 This package does not come with a test suite.
139 </para>
140
141 <para>
142 Now, as the <systemitem class="username">root</systemitem> user:
143 </para>
144
145<!-- Note to editors: You need to define ROOTSBINDIR and man8dir, like this:
146 ROOTSBINDIR=<DESTDIR>/sbin man8dir=<DESTDIR>/usr/share/man/man8
147 This is due to a bug in the makefile for cifs-utils-6.10, since it tries
148 to install symlinks for mount.smb3 without thinking about DESTDIR
149 installations. -->
150
151<screen role="root"><userinput>make install</userinput></screen>
152
153 </sect2>
154
155 <sect2 role="commands">
156 <title>Command Explanations</title>
157
158 <para>
159 <parameter>--disable-pam</parameter>: Do not build PAM support.
160 Remove it and use <option>--with-pamdir</option> (see below),
161 if <xref linkend="linux-pam"/> is installed and you wish
162 PAM support.
163 </para>
164
165 <para revision="sysv">
166 <parameter>--disable-systemd</parameter>: Disable systemd specific
167 behavior for <command>mount.cifs</command>.
168 </para>
169
170 <para>
171 <option>--with-pamdir=/lib/security</option>: Install the PAM
172 module in <filename class="directory">/lib/security</filename>.
173 </para>
174
175 </sect2>
176
177 <sect2 role="content">
178 <title>Contents</title>
179
180 <segmentedlist>
181 <segtitle>Installed Programs</segtitle>
182 <segtitle>Installed Library</segtitle>
183 <segtitle>Installed Directory</segtitle>
184
185 <seglistitem>
186 <seg> cifs.idmap, cifs.upcall, cifscreds, getcifsacl,
187 mount.cifs, mount.smb3, setcifsacl, smb2-quota, and smbinfo</seg>
188 <seg>/usr/lib/cifs-utils/idmapwb.so and optionally
189 PAM module /lib/security/pam_cifscreds.so</seg>
190 <seg>/usr/lib/cifs-utils</seg>
191 </seglistitem>
192 </segmentedlist>
193
194 <variablelist>
195 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
196 <?dbfo list-presentation="list"?>
197 <?dbhtml list-presentation="table"?>
198
199 <varlistentry id="cifs.idmap">
200 <term><command>cifs.idmap</command></term>
201 <listitem>
202 <para>
203 is a userspace helper program for the linux CIFS client filesystem.
204 There are a number of activities that the kernel cannot easily do
205 itself. This program is a callout program that does these
206 things for the kernel and then returns the result. It is not
207 intended to be run from the command-line
208 </para>
209 <indexterm zone="cifsutils cifs.idmap">
210 <primary sortas="b-cifs.idmap">cifs.idmap</primary>
211 </indexterm>
212 </listitem>
213 </varlistentry>
214
215 <varlistentry id="cifs.upcall">
216 <term><command>cifs.upcall</command></term>
217 <listitem>
218 <para>
219 is a userspace helper program for the linux CIFS client
220 filesystem. It is intended to be run when the kernel calls
221 request-key for a particular key type. It is not intended to be
222 run from the command-line
223 </para>
224 <indexterm zone="cifsutils cifs.upcall">
225 <primary sortas="b-cifs.upcall">cifs.upcall</primary>
226 </indexterm>
227 </listitem>
228 </varlistentry>
229
230 <varlistentry id="cifscreds">
231 <term><command>cifscreds</command></term>
232 <listitem>
233 <para>
234 is a tool for managing credentials (username and password)
235 for the purpose of establishing sessions in multiuser mounts
236 </para>
237 <indexterm zone="cifsutils cifscreds">
238 <primary sortas="b-cifscreds">cifscreds</primary>
239 </indexterm>
240 </listitem>
241 </varlistentry>
242
243 <varlistentry id="getcifsacl">
244 <term><command>getcifsacl</command></term>
245 <listitem>
246 <para>
247 is a userspace helper to display an ACL in a security
248 descriptor for Common Internet File System (CIFS)
249 </para>
250 <indexterm zone="cifsutils getcifsacl">
251 <primary sortas="b-getcifsacl">getcifsacl</primary>
252 </indexterm>
253 </listitem>
254 </varlistentry>
255
256 <varlistentry id="mount.cifs">
257 <term><command>mount.cifs</command></term>
258 <listitem>
259 <para>
260 mounts a Linux CIFS filesystem. It is usually invoked
261 indirectly by the mount(8) command when using the "-t cifs" option
262 </para>
263 <indexterm zone="cifsutils mount.cifs">
264 <primary sortas="b-mount.cifs">mount.cifs</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="mount.smb3">
270 <term><command>mount.smb3</command></term>
271 <listitem>
272 <para>
273 mounts a SMB3-based filesystem. It is usually invoked
274 indirectly by the mount(8) command when using the "-t smb3" option
275 </para>
276 <indexterm zone="cifsutils mount.smb3">
277 <primary sortas="b-mount.smb3">mount.smb3</primary>
278 </indexterm>
279 </listitem>
280 </varlistentry>
281
282 <varlistentry id="setcifsacl">
283 <term><command>setcifsacl</command></term>
284 <listitem>
285 <para>
286 is intended to alter an ACL of a security descriptor for a file
287 system object
288 </para>
289 <indexterm zone="cifsutils setcifsacl">
290 <primary sortas="b-setcifsacl">setcifsacl</primary>
291 </indexterm>
292 </listitem>
293 </varlistentry>
294
295 <varlistentry id="smb2-quota">
296 <term><command>smb3-quota</command></term>
297 <listitem>
298 <para>
299 displays quota information for a SMB filesystem
300 </para>
301 <indexterm zone="cifsutils smb2-quota">
302 <primary sortas="b-smb2-quota">smb2-quota</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="smbinfo">
308 <term><command>smbinfo</command></term>
309 <listitem>
310 <para>
311 displays SMB-specific file information, such as security
312 descriptors and quotas
313 </para>
314 <indexterm zone="cifsutils smbinfo">
315 <primary sortas="b-smbinfo">smbinfo</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
320 </variablelist>
321
322 </sect2>
323
324</sect1>
Note: See TracBrowser for help on using the repository browser.