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