[fcc6d60] | 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 |
|
---|
[8dfc5c3] | 7 | <!ENTITY cifsutils-download-http "https://www.samba.org/ftp/linux-cifs/cifs-utils/cifs-utils-&cifsutils-version;.tar.bz2">
|
---|
[1c73261] | 8 | <!ENTITY cifsutils-download-ftp " ">
|
---|
[45c3b20] | 9 | <!ENTITY cifsutils-md5sum "743e6fbfa9a1d3f28ab81f675a7f5831">
|
---|
| 10 | <!ENTITY cifsutils-size "407 KB">
|
---|
[9556a94] | 11 | <!ENTITY cifsutils-buildsize "4.1 MB">
|
---|
[3f3f2c8] | 12 | <!ENTITY cifsutils-time "0.1 SBU">
|
---|
[fcc6d60] | 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">
|
---|
[9accaa6] | 25 | <primary sortas="a-cifsutils">cifs-utils</primary>
|
---|
[fcc6d60] | 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to cifs-utils</title>
|
---|
| 30 |
|
---|
[b51fe6e] | 31 | <para>
|
---|
[fb078c8] | 32 | The <application>cifs-utils</application> package provides a means for
|
---|
[b51fe6e] | 33 | mounting SMB/CIFS shares on a Linux system.
|
---|
| 34 | </para>
|
---|
[fcc6d60] | 35 |
|
---|
[ca783379] | 36 | &lfs111_checked;
|
---|
[fcc6d60] | 37 |
|
---|
| 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
[b51fe6e] | 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&cifsutils-download-http;"/>
|
---|
| 43 | </para>
|
---|
[fcc6d60] | 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
[b51fe6e] | 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&cifsutils-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
[fcc6d60] | 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
[b51fe6e] | 51 | <para>
|
---|
| 52 | Download MD5 sum: &cifsutils-md5sum;
|
---|
| 53 | </para>
|
---|
[fcc6d60] | 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
[b51fe6e] | 56 | <para>
|
---|
| 57 | Download size: &cifsutils-size;
|
---|
| 58 | </para>
|
---|
[fcc6d60] | 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
[b51fe6e] | 61 | <para>
|
---|
| 62 | Estimated disk space required: &cifsutils-buildsize;
|
---|
| 63 | </para>
|
---|
[fcc6d60] | 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
[b51fe6e] | 66 | <para>
|
---|
| 67 | Estimated build time: &cifsutils-time;
|
---|
| 68 | </para>
|
---|
[fcc6d60] | 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect3">cifs-utils Dependencies</bridgehead>
|
---|
| 73 |
|
---|
[dae3099] | 74 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 75 | <para role="recommended">
|
---|
| 76 | <xref linkend="talloc"/> (required if krb is installed),
|
---|
| 77 | <xref linkend="mitkrb"/>
|
---|
[880a026] | 78 | </para>
|
---|
| 79 |
|
---|
[fcc6d60] | 80 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[5e8ab95] | 81 | <para role="optional">
|
---|
[dae3099] | 82 | <xref linkend="docutils"/> (to create the man pages),
|
---|
[c22aa86] | 83 | <xref linkend="keyutils"/> (required to build PAM module),
|
---|
[9c1fbda4] | 84 | <xref linkend="linux-pam"/>,
|
---|
[3e96e6c6] | 85 | <xref linkend="samba"/>, and
|
---|
[b51fe6e] | 86 | <xref linkend="libcap-pam"/> or
|
---|
[c6b192c] | 87 | <ulink url="https://people.redhat.com/sgrubb/libcap-ng/">
|
---|
[b51fe6e] | 88 | libcap-ng
|
---|
| 89 | </ulink>
|
---|
[5e8ab95] | 90 | </para>
|
---|
[fcc6d60] | 91 |
|
---|
| 92 | <para condition="html" role="usernotes">User Notes:
|
---|
| 93 | <ulink url="&blfs-wiki;/cifsutils"/></para>
|
---|
| 94 |
|
---|
| 95 | </sect2>
|
---|
| 96 |
|
---|
[3e96e6c6] | 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 --->
|
---|
[a69ca8e] | 106 | [*] Network File Systems ---> [CONFIG_NETWORK_FILESYSTEMS]
|
---|
[3f3f2c8] | 107 | <*/M> 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>
|
---|
[3e96e6c6] | 113 |
|
---|
| 114 | <indexterm zone="cifsutils cifsutils-kernel">
|
---|
| 115 | <primary sortas="d-cifsutils">cifs-utils</primary>
|
---|
| 116 | </indexterm>
|
---|
[f3429309] | 117 |
|
---|
| 118 | </sect2>
|
---|
[3e96e6c6] | 119 |
|
---|
[fcc6d60] | 120 | <sect2 role="installation">
|
---|
| 121 | <title>Installation of cifs-utils</title>
|
---|
| 122 |
|
---|
[b51fe6e] | 123 | <para>
|
---|
| 124 | Install <application>cifs-utils</application> by running the following
|
---|
| 125 | commands:
|
---|
| 126 | </para>
|
---|
[fcc6d60] | 127 |
|
---|
[5a38f35] | 128 | <screen revision="sysv"><userinput>./configure --prefix=/usr \
|
---|
[b3cc6d3] | 129 | --disable-pam \
|
---|
| 130 | --disable-systemd &&
|
---|
[fcc6d60] | 131 | make</userinput></screen>
|
---|
| 132 |
|
---|
[5a38f35] | 133 | <screen revision="systemd"><userinput>./configure --prefix=/usr \
|
---|
[7b478500] | 134 | --disable-pam &&
|
---|
| 135 | make</userinput></screen>
|
---|
| 136 |
|
---|
[b51fe6e] | 137 | <para>
|
---|
| 138 | This package does not come with a test suite.
|
---|
| 139 | </para>
|
---|
[fcc6d60] | 140 |
|
---|
[b51fe6e] | 141 | <para>
|
---|
| 142 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 143 | </para>
|
---|
[fcc6d60] | 144 |
|
---|
[3f3f2c8] | 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 |
|
---|
[fcc6d60] | 151 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 152 |
|
---|
| 153 | </sect2>
|
---|
| 154 |
|
---|
[b3cc6d3] | 155 | <sect2 role="commands">
|
---|
[b51fe6e] | 156 | <title>Command Explanations</title>
|
---|
[b3cc6d3] | 157 |
|
---|
[b51fe6e] | 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>
|
---|
[b3cc6d3] | 164 |
|
---|
[b51fe6e] | 165 | <para revision="sysv">
|
---|
| 166 | <parameter>--disable-systemd</parameter>: Disable systemd specific
|
---|
| 167 | behavior for <command>mount.cifs</command>.
|
---|
| 168 | </para>
|
---|
[b3cc6d3] | 169 |
|
---|
[b51fe6e] | 170 | <para>
|
---|
[2081610e] | 171 | <option>--with-pamdir=/usr/lib/security</option>: Install the PAM
|
---|
| 172 | module in <filename class="directory">/usr/lib/security</filename>.
|
---|
[b51fe6e] | 173 | </para>
|
---|
[b3cc6d3] | 174 |
|
---|
| 175 | </sect2>
|
---|
| 176 |
|
---|
[fcc6d60] | 177 | <sect2 role="content">
|
---|
| 178 | <title>Contents</title>
|
---|
| 179 |
|
---|
| 180 | <segmentedlist>
|
---|
| 181 | <segtitle>Installed Programs</segtitle>
|
---|
[9c1fbda4] | 182 | <segtitle>Installed Library</segtitle>
|
---|
[04f3ba30] | 183 | <segtitle>Installed Directory</segtitle>
|
---|
[fcc6d60] | 184 |
|
---|
| 185 | <seglistitem>
|
---|
[8558044] | 186 | <seg> cifs.idmap, cifs.upcall, cifscreds, getcifsacl,
|
---|
[3f3f2c8] | 187 | mount.cifs, mount.smb3, setcifsacl, smb2-quota, and smbinfo</seg>
|
---|
[b3cc6d3] | 188 | <seg>/usr/lib/cifs-utils/idmapwb.so and optionally
|
---|
[2081610e] | 189 | PAM module /usr/lib/security/pam_cifscreds.so</seg>
|
---|
[04f3ba30] | 190 | <seg>/usr/lib/cifs-utils</seg>
|
---|
[fcc6d60] | 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>
|
---|
[b51fe6e] | 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
|
---|
[4c24eb0a] | 207 | intended to be run from the command-line
|
---|
[b51fe6e] | 208 | </para>
|
---|
[fcc6d60] | 209 | <indexterm zone="cifsutils cifs.idmap">
|
---|
| 210 | <primary sortas="b-cifs.idmap">cifs.idmap</primary>
|
---|
| 211 | </indexterm>
|
---|
| 212 | </listitem>
|
---|
| 213 | </varlistentry>
|
---|
| 214 |
|
---|
[5e8ab95] | 215 | <varlistentry id="cifs.upcall">
|
---|
| 216 | <term><command>cifs.upcall</command></term>
|
---|
| 217 | <listitem>
|
---|
[b51fe6e] | 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
|
---|
[4c24eb0a] | 222 | run from the command-line
|
---|
[b51fe6e] | 223 | </para>
|
---|
[5e8ab95] | 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>
|
---|
[b51fe6e] | 233 | <para>
|
---|
| 234 | is a tool for managing credentials (username and password)
|
---|
[4c24eb0a] | 235 | for the purpose of establishing sessions in multiuser mounts
|
---|
[b51fe6e] | 236 | </para>
|
---|
[5e8ab95] | 237 | <indexterm zone="cifsutils cifscreds">
|
---|
| 238 | <primary sortas="b-cifscreds">cifscreds</primary>
|
---|
| 239 | </indexterm>
|
---|
| 240 | </listitem>
|
---|
| 241 | </varlistentry>
|
---|
| 242 |
|
---|
[fcc6d60] | 243 | <varlistentry id="getcifsacl">
|
---|
| 244 | <term><command>getcifsacl</command></term>
|
---|
| 245 | <listitem>
|
---|
[b51fe6e] | 246 | <para>
|
---|
| 247 | is a userspace helper to display an ACL in a security
|
---|
[4c24eb0a] | 248 | descriptor for Common Internet File System (CIFS)
|
---|
[b51fe6e] | 249 | </para>
|
---|
[fcc6d60] | 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>
|
---|
[b51fe6e] | 259 | <para>
|
---|
| 260 | mounts a Linux CIFS filesystem. It is usually invoked
|
---|
[4c24eb0a] | 261 | indirectly by the mount(8) command when using the "-t cifs" option
|
---|
[fcc6d60] | 262 | </para>
|
---|
| 263 | <indexterm zone="cifsutils mount.cifs">
|
---|
| 264 | <primary sortas="b-mount.cifs">mount.cifs</primary>
|
---|
| 265 | </indexterm>
|
---|
| 266 | </listitem>
|
---|
| 267 | </varlistentry>
|
---|
| 268 |
|
---|
[3f3f2c8] | 269 | <varlistentry id="mount.smb3">
|
---|
| 270 | <term><command>mount.smb3</command></term>
|
---|
| 271 | <listitem>
|
---|
[b51fe6e] | 272 | <para>
|
---|
| 273 | mounts a SMB3-based filesystem. It is usually invoked
|
---|
[4c24eb0a] | 274 | indirectly by the mount(8) command when using the "-t smb3" option
|
---|
[3f3f2c8] | 275 | </para>
|
---|
| 276 | <indexterm zone="cifsutils mount.smb3">
|
---|
| 277 | <primary sortas="b-mount.smb3">mount.smb3</primary>
|
---|
| 278 | </indexterm>
|
---|
| 279 | </listitem>
|
---|
| 280 | </varlistentry>
|
---|
| 281 |
|
---|
[fcc6d60] | 282 | <varlistentry id="setcifsacl">
|
---|
| 283 | <term><command>setcifsacl</command></term>
|
---|
| 284 | <listitem>
|
---|
[b51fe6e] | 285 | <para>
|
---|
| 286 | is intended to alter an ACL of a security descriptor for a file
|
---|
[4c24eb0a] | 287 | system object
|
---|
[b51fe6e] | 288 | </para>
|
---|
[fcc6d60] | 289 | <indexterm zone="cifsutils setcifsacl">
|
---|
| 290 | <primary sortas="b-setcifsacl">setcifsacl</primary>
|
---|
| 291 | </indexterm>
|
---|
| 292 | </listitem>
|
---|
| 293 | </varlistentry>
|
---|
| 294 |
|
---|
[3f3f2c8] | 295 | <varlistentry id="smb2-quota">
|
---|
| 296 | <term><command>smb3-quota</command></term>
|
---|
| 297 | <listitem>
|
---|
[b51fe6e] | 298 | <para>
|
---|
[4c24eb0a] | 299 | displays quota information for a SMB filesystem
|
---|
[b51fe6e] | 300 | </para>
|
---|
[3f3f2c8] | 301 | <indexterm zone="cifsutils smb2-quota">
|
---|
| 302 | <primary sortas="b-smb2-quota">smb2-quota</primary>
|
---|
| 303 | </indexterm>
|
---|
| 304 | </listitem>
|
---|
| 305 | </varlistentry>
|
---|
| 306 |
|
---|
[5c2345ff] | 307 | <varlistentry id="smbinfo">
|
---|
| 308 | <term><command>smbinfo</command></term>
|
---|
| 309 | <listitem>
|
---|
[b51fe6e] | 310 | <para>
|
---|
| 311 | displays SMB-specific file information, such as security
|
---|
[4c24eb0a] | 312 | descriptors and quotas
|
---|
[b51fe6e] | 313 | </para>
|
---|
[5c2345ff] | 314 | <indexterm zone="cifsutils smbinfo">
|
---|
| 315 | <primary sortas="b-smbinfo">smbinfo</primary>
|
---|
| 316 | </indexterm>
|
---|
| 317 | </listitem>
|
---|
| 318 | </varlistentry>
|
---|
| 319 |
|
---|
[fcc6d60] | 320 | </variablelist>
|
---|
| 321 |
|
---|
| 322 | </sect2>
|
---|
| 323 |
|
---|
| 324 | </sect1>
|
---|