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