source: networking/netprogs/cifsutils.xml@ 401174c0

12.0 12.1 gimp3 ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/for-12.3 xry111/llvm18 xry111/spidermonkey128
Last change on this file since 401174c0 was 5f3bda7, checked in by Xi Ruoyao <xry111@…>, 14 months ago

network: Remove non-exist User Notes link

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