source: networking/netprogs/cifsutils.xml@ 45ab6c7

11.0 qt5new trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 5 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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