source: networking/netprogs/cifsutils.xml@ 17aa21c

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 17aa21c was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 18 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.

  • 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 "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 &lfs112_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 <para condition="html" role="usernotes">User Notes:
90 <ulink url="&blfs-wiki;/cifsutils"/></para>
91
92 </sect2>
93
94 <sect2 role="kernel" id="cifsutils-kernel">
95 <title>Kernel Configuration</title>
96
97 <para>
98 Enable the following options in the kernel configuration and recompile the
99 kernel if necessary:
100 </para>
101
102<screen><literal>File systems ---&gt;
103 [*] Network File Systems ---&gt; [CONFIG_NETWORK_FILESYSTEMS]
104 &lt;*/M&gt; SMB3 and CIFS support (advanced network filesystem) [CONFIG_CIFS]</literal></screen>
105
106 <para>
107 Depending on your server configuration, additional kernel options may be
108 required.
109 </para>
110
111 <indexterm zone="cifsutils cifsutils-kernel">
112 <primary sortas="d-cifsutils">cifs-utils</primary>
113 </indexterm>
114
115 </sect2>
116
117 <sect2 role="installation">
118 <title>Installation of cifs-utils</title>
119
120 <para>
121 Install <application>cifs-utils</application> by running the following
122 commands:
123 </para>
124
125<screen revision="sysv"><userinput>./configure --prefix=/usr \
126 --disable-pam \
127 --disable-systemd &amp;&amp;
128make</userinput></screen>
129
130<screen revision="systemd"><userinput>./configure --prefix=/usr \
131 --disable-pam &amp;&amp;
132make</userinput></screen>
133
134 <para>
135 This package does not come with a test suite.
136 </para>
137
138 <para>
139 Now, as the <systemitem class="username">root</systemitem> user:
140 </para>
141
142<!-- Note to editors: You need to define ROOTSBINDIR and man8dir, like this:
143 ROOTSBINDIR=<DESTDIR>/sbin man8dir=<DESTDIR>/usr/share/man/man8
144 This is due to a bug in the makefile for cifs-utils-6.10, since it tries
145 to install symlinks for mount.smb3 without thinking about DESTDIR
146 installations. -->
147
148<screen role="root"><userinput>make install</userinput></screen>
149
150 </sect2>
151
152 <sect2 role="commands">
153 <title>Command Explanations</title>
154
155 <para>
156 <parameter>--disable-pam</parameter>: Do not build PAM support.
157 Remove it and use <option>--with-pamdir</option> (see below),
158 if <xref linkend="linux-pam"/> is installed and you wish
159 PAM support.
160 </para>
161
162 <para revision="sysv">
163 <parameter>--disable-systemd</parameter>: Disable systemd specific
164 behavior for <command>mount.cifs</command>.
165 </para>
166
167 <para>
168 <option>--with-pamdir=/usr/lib/security</option>: Install the PAM
169 module in <filename class="directory">/usr/lib/security</filename>.
170 </para>
171
172 </sect2>
173
174 <sect2 role="content">
175 <title>Contents</title>
176
177 <segmentedlist>
178 <segtitle>Installed Programs</segtitle>
179 <segtitle>Installed Library</segtitle>
180 <segtitle>Installed Directory</segtitle>
181
182 <seglistitem>
183 <seg> cifs.idmap, cifs.upcall, cifscreds, getcifsacl,
184 mount.cifs, mount.smb3, setcifsacl, smb2-quota, and smbinfo</seg>
185 <seg>/usr/lib/cifs-utils/idmapwb.so and optionally
186 PAM module /usr/lib/security/pam_cifscreds.so</seg>
187 <seg>/usr/lib/cifs-utils</seg>
188 </seglistitem>
189 </segmentedlist>
190
191 <variablelist>
192 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
193 <?dbfo list-presentation="list"?>
194 <?dbhtml list-presentation="table"?>
195
196 <varlistentry id="cifs.idmap">
197 <term><command>cifs.idmap</command></term>
198 <listitem>
199 <para>
200 is a userspace helper program for the linux CIFS client filesystem.
201 There are a number of activities that the kernel cannot easily do
202 itself. This program is a callout program that does these
203 things for the kernel and then returns the result. It is not
204 intended to be run from the command-line
205 </para>
206 <indexterm zone="cifsutils cifs.idmap">
207 <primary sortas="b-cifs.idmap">cifs.idmap</primary>
208 </indexterm>
209 </listitem>
210 </varlistentry>
211
212 <varlistentry id="cifs.upcall">
213 <term><command>cifs.upcall</command></term>
214 <listitem>
215 <para>
216 is a userspace helper program for the linux CIFS client
217 filesystem. It is intended to be run when the kernel calls
218 request-key for a particular key type. It is not intended to be
219 run from the command-line
220 </para>
221 <indexterm zone="cifsutils cifs.upcall">
222 <primary sortas="b-cifs.upcall">cifs.upcall</primary>
223 </indexterm>
224 </listitem>
225 </varlistentry>
226
227 <varlistentry id="cifscreds">
228 <term><command>cifscreds</command></term>
229 <listitem>
230 <para>
231 is a tool for managing credentials (username and password)
232 for the purpose of establishing sessions in multiuser mounts
233 </para>
234 <indexterm zone="cifsutils cifscreds">
235 <primary sortas="b-cifscreds">cifscreds</primary>
236 </indexterm>
237 </listitem>
238 </varlistentry>
239
240 <varlistentry id="getcifsacl">
241 <term><command>getcifsacl</command></term>
242 <listitem>
243 <para>
244 is a userspace helper to display an ACL in a security
245 descriptor for Common Internet File System (CIFS)
246 </para>
247 <indexterm zone="cifsutils getcifsacl">
248 <primary sortas="b-getcifsacl">getcifsacl</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="mount.cifs">
254 <term><command>mount.cifs</command></term>
255 <listitem>
256 <para>
257 mounts a Linux CIFS filesystem. It is usually invoked
258 indirectly by the mount(8) command when using the "-t cifs" option
259 </para>
260 <indexterm zone="cifsutils mount.cifs">
261 <primary sortas="b-mount.cifs">mount.cifs</primary>
262 </indexterm>
263 </listitem>
264 </varlistentry>
265
266 <varlistentry id="mount.smb3">
267 <term><command>mount.smb3</command></term>
268 <listitem>
269 <para>
270 mounts a SMB3-based filesystem. It is usually invoked
271 indirectly by the mount(8) command when using the "-t smb3" option
272 </para>
273 <indexterm zone="cifsutils mount.smb3">
274 <primary sortas="b-mount.smb3">mount.smb3</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="setcifsacl">
280 <term><command>setcifsacl</command></term>
281 <listitem>
282 <para>
283 is intended to alter an ACL of a security descriptor for a file
284 system object
285 </para>
286 <indexterm zone="cifsutils setcifsacl">
287 <primary sortas="b-setcifsacl">setcifsacl</primary>
288 </indexterm>
289 </listitem>
290 </varlistentry>
291
292 <varlistentry id="smb2-quota">
293 <term><command>smb3-quota</command></term>
294 <listitem>
295 <para>
296 displays quota information for a SMB filesystem
297 </para>
298 <indexterm zone="cifsutils smb2-quota">
299 <primary sortas="b-smb2-quota">smb2-quota</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="smbinfo">
305 <term><command>smbinfo</command></term>
306 <listitem>
307 <para>
308 displays SMB-specific file information, such as security
309 descriptors and quotas
310 </para>
311 <indexterm zone="cifsutils smbinfo">
312 <primary sortas="b-smbinfo">smbinfo</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 </variablelist>
318
319 </sect2>
320
321</sect1>
Note: See TracBrowser for help on using the repository browser.