source: general/sysutils/autofs.xml@ 89265b09

11.0 ken/refactor-virt lazarus qt5new trunk upgradedb
Last change on this file since 89265b09 was 89265b09, checked in by Thomas Trepl (Moody) <thomas@…>, 7 months ago

Tweak autofs for merged-/usr mode

  • Property mode set to 100644
File size: 13.8 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 autofs-download-http "&kernel-dl;/linux/daemons/autofs/v5/autofs-&autofs-version;.tar.xz">
8 <!ENTITY autofs-download-ftp " ">
9 <!ENTITY autofs-md5sum "6bd1ea8a9e5dc3a7dc95119e3bbaf52c">
10 <!ENTITY autofs-size "324 KB">
11 <!ENTITY autofs-buildsize "6.7 MB">
12 <!ENTITY autofs-time "0.1 SBU">
13]>
14
15<sect1 id="autofs" xreflabel="Autofs-&autofs-version;">
16 <?dbhtml filename="autofs.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>autofs-&autofs-version;</title>
23
24 <indexterm zone="autofs">
25 <primary sortas="a-Autofs">Autofs</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Autofs</title>
30
31 <para>
32 <application>Autofs</application> controls the operation of the automount
33 daemons. The automount daemons automatically mount filesystems when they
34 are accessed and unmount them after a period of inactivity. This is done
35 based on a set of pre-configured maps.
36 </para>
37
38 &lfs101_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&autofs-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&autofs-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &autofs-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &autofs-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &autofs-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &autofs-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74 <bridgehead renderas="sect3">Autofs Dependencies</bridgehead>
75
76 <bridgehead renderas="sect4">Required</bridgehead>
77 <para role="required">
78 <xref linkend="libtirpc"/> and
79 <xref linkend="rpcsvc-proto"/>
80 </para>
81
82 <bridgehead renderas="sect4">Optional</bridgehead>
83 <para role="optional">
84 <xref linkend="nfs-utils"/>,
85 <xref linkend="libnsl"/>,
86 <xref linkend="libxml2"/>,
87 <xref linkend="mitkrb"/>,
88 <xref linkend="openldap"/> (client only), and
89 <xref linkend="cyrus-sasl"/>
90 </para>
91
92 <para condition="html" role="usernotes">User Notes:
93 <ulink url="&blfs-wiki;/autofs"/></para>
94
95 </sect2>
96
97 <sect2 role="kernel" id="autofs-kernel">
98 <title>Kernel Configuration</title>
99
100 <indexterm zone="autofs autofs-kernel">
101 <primary sortas="d-Automounter">Automounter</primary>
102 </indexterm>
103
104 <para>
105 Verify that automounter kernel support has been enabled:
106 </para>
107
108<screen><literal>File systems ---&gt;
109 &lt;*/M&gt; Kernel automounter support (supports v3, v4, and v5) [CONFIG_AUTOFS_FS]</literal></screen>
110
111 <para>
112 Optionally, enable the following options in the kernel configuration:
113 </para>
114
115<screen><literal>File systems ---&gt;
116 [*] Network File Systems ---&gt; [CONFIG_NETWORK_FILESYSTEMS]
117 &lt;*/M&gt; NFS client support [CONFIG_NFS_FS]
118 &lt;*/M&gt; SMB3 and CIFS support (advanced network filesystem) [CONFIG_CIFS]</literal></screen>
119
120 <para>
121 Recompile and install the new kernel, if necessary.
122 </para>
123
124 </sect2>
125
126 <sect2 role="installation">
127
128 <title>Installation of Autofs</title>
129
130 <para>
131 Install <application>Autofs</application> by running the following
132 commands:
133 </para>
134
135<screen revision="sysv"><userinput>./configure --prefix=/usr \
136 --with-mapdir=/etc/autofs \
137 --with-libtirpc \
138 --without-openldap \
139 --mandir=/usr/share/man &amp;&amp;
140make</userinput></screen>
141
142<screen revision="systemd"><userinput>./configure --prefix=/usr \
143 --with-mapdir=/etc/autofs \
144 --with-libtirpc \
145 --with-systemd \
146 --without-openldap \
147 --mandir=/usr/share/man &amp;&amp;
148make</userinput></screen>
149
150 <para>
151 This package does not come with a test suite.
152 </para>
153
154 <para>
155 Now, as the <systemitem class="username">root</systemitem> user:
156 </para>
157
158<screen role="root"><userinput>make install</userinput></screen>
159
160<!-- As of version 5.1.5, the configuration files are not installed anymore -->
161 <caution>
162 <para>
163 If <application>autofs</application> is already installed on your
164 system, be sure to backup your configuration files. They'll be
165 overwritten by the following command.
166 </para>
167 </caution>
168
169 <para>
170 Install the default configuration files, still as the
171 <systemitem class="username">root</systemitem> user:
172 </para>
173
174<screen role="root"><userinput>make install_samples</userinput></screen>
175
176 </sect2>
177
178 <sect2 role="commands">
179 <title>Command Explanations</title>
180
181 <para>
182 <parameter>--with-libtirpc</parameter>: This switch forces the package to
183 use libtirpc for RPC functionality instead of relying on implementation
184 from Glibc, which was removed in LFS 8.1.
185 </para>
186
187 <para revision="systemd">
188 <parameter>--with-systemd</parameter>: This switch enables installation
189 of the bundled systemd units.
190 </para>
191
192 <para>
193 <parameter>--without-openldap</parameter>: This switch disables openldap
194 if found. If openldap is desired, omit this switch. Note that openldap
195 support in autofs requires <xref linkend="mitkrb"/>.
196 </para>
197
198 </sect2>
199
200 <sect2 role="configuration">
201 <title>Configuring Autofs</title>
202
203 <sect3 id="autofs-config">
204 <title>Config Files</title>
205
206 <para>
207 <filename>/etc/sysconfig/autofs.conf</filename>,
208 <filename>/etc/autofs/auto.master</filename>,
209 <filename>/etc/autofs/auto.misc</filename>, and
210 <filename>/etc/autofs/auto.net</filename>
211 </para>
212
213 <indexterm zone="autofs autofs-config" >
214 <primary sortas="e-etc-sysconfig-autofs.conf">/etc/sysconfig/autofs.conf</primary>
215 </indexterm>
216
217 <indexterm zone="autofs autofs-config">
218 <primary sortas="e-etc-auto.master">/etc/autofs/auto.master</primary>
219 </indexterm>
220
221 <indexterm zone="autofs autofs-config">
222 <primary sortas="e-etc-auto.misc">/etc/autofs/auto.misc</primary>
223 </indexterm>
224
225 <indexterm zone="autofs autofs-config">
226 <primary sortas="e-etc-auto.net">/etc/autofs/auto.net</primary>
227 </indexterm>
228
229 </sect3>
230
231 <sect3>
232 <title>Configuration Information</title>
233
234 <para>
235 The installation process creates <filename>auto.master</filename>,
236 <filename>auto.misc</filename>, <filename>auto.smb</filename>, and
237 <filename>auto.net</filename>. Replace the
238 <filename>auto.master</filename> file with the following commands
239 as the <systemitem class="username">root</systemitem> user:
240 </para>
241
242<screen role="root"><userinput>mv /etc/autofs/auto.master /etc/autofs/auto.master.bak &amp;&amp;
243cat &gt; /etc/autofs/auto.master &lt;&lt; "EOF"
244<literal># Begin /etc/autofs/auto.master
245
246/media/auto /etc/autofs/auto.misc --ghost
247#/home /etc/autofs/auto.home
248
249# End /etc/autofs/auto.master</literal>
250EOF</userinput></screen>
251
252 <para>
253 This file creates a new media directory,
254 <filename>/media/auto</filename> that will overlay any existing
255 directory of the same name. In this example, the file,
256 <filename>/etc/autofs/auto.misc</filename>, has a line:
257 </para>
258
259<screen>cd -fstype=iso9660,ro,nosuid,nodev :/dev/cdrom</screen>
260
261 <para>
262 that will mount a cdrom as <filename>/media/auto/cd</filename> if
263 that directory is accessed. The <option>--ghost</option> option tells
264 the automounter to create <quote>ghost</quote> versions (i.e. empty
265 directories) of all the mount points listed in the configuration file
266 regardless whether any of the file systems are actually mounted or not.
267 This is very convenient and highly recommended, because it will show
268 you the available auto-mountable file systems as existing directories,
269 even when their file systems aren't currently mounted. Without the
270 <option>--ghost</option> option, you'll have to remember the names of
271 the directories. As soon as you try to access one of them, the
272 directory will be created and the file system will be mounted. When
273 the file system gets unmounted again, the directory is destroyed too,
274 unless the <option>--ghost</option> option was given.
275 </para>
276
277 <note>
278 <para>
279 An alternative method would be to specify another automount
280 location such as <filename
281 class='directory'>/var/lib/auto/cdrom</filename> and create a
282 symbolic link from <filename
283 class='directory'>/media/cdrom</filename> to the automount location.
284 </para>
285 </note>
286
287 <para>
288 The <filename>auto.misc</filename> file must be configured to your
289 working hardware. The loaded configuration file should load your cdrom
290 if <filename>/dev/cdrom</filename> is active or it can be edited to
291 match your device setup. Examples for floppies are available in the
292 file and easily activated. Documentation for this file is available
293 using the <command>man 5 autofs</command> command.
294 </para>
295
296 <para>
297 In the second line, if enabled, a user's home directory would be
298 mounted via NFS upon login. The <filename>/etc/home.auto</filename>
299 would need to exist and have an entry similar to:
300 </para>
301
302<screen>joe example.org:/export/home/joe</screen>
303
304 <para>
305 where the directory <filename>/export/home/joe</filename> is
306 exported via NFS from the system example.org. NFS shares
307 are covered on the next page.
308 </para>
309
310 <para>
311 This package could also be used to mount SMB shares, however that
312 feature is not configured in these instructions. For additional
313 configuration information, see the man pages for auto.master(5). There
314 are also web resources such as this <ulink
315 url='http://wiki.gentoo.org/wiki/AutoFS'>AUTOFS
316 HOWTO</ulink> available.
317 </para>
318
319 </sect3>
320
321 <sect3 id="autofs-init">
322 <title><phrase revision="sysv">Boot Script</phrase>
323 <phrase revision="systemd">Systemd Unit</phrase></title>
324
325 <para revision="sysv">
326 <application>autofs</application> installs its own
327 boot script, but it has no capability for logging or visual conformance
328 with other BLFS scripts. It will be replaced by an enhanced version.
329 </para>
330
331 <para revision="sysv">
332 Install the <filename>/etc/init.d/autofs</filename>
333 mount script included with the <xref linkend="bootscripts"/>
334 package.
335 </para>
336
337 <para revision="systemd">
338 To start <application>Autofs</application> at boot, enable the
339 previously installed systemd unit by running the following command as
340 the <systemitem class="username">root</systemitem> user:
341 </para>
342
343 <indexterm zone="autofs autofs-init">
344 <primary sortas="f-autofs-init">autofs</primary>
345 </indexterm>
346
347<screen role="root" revision="sysv"><userinput>make install-autofs</userinput></screen>
348
349<screen role="root" revision="systemd"><userinput>systemctl enable autofs</userinput></screen>
350
351 <para revision="sysv">
352 The time-out variable is set in
353 <filename>/etc/sysconfig/autofs.conf</filename>. The installed file sets
354 a default of 60 seconds of inactivity before unmounting the device. A
355 much shorter time may be necessary to protect buffer writing to a floppy
356 if users tend to remove the media prior to the timeout setting.
357 </para>
358
359 <note revision="systemd">
360 <para>
361 You can also specify <envar>OPTIONS</envar> variable in the
362 <filename>/etc/sysconfig/autofs</filename> file with any additional
363 parameters that you might want to pass to the automount daemon.
364 </para>
365 </note>
366
367 </sect3>
368
369 </sect2>
370
371 <sect2 role="content">
372 <title>Contents</title>
373
374 <segmentedlist>
375 <segtitle>Installed Program</segtitle>
376 <segtitle>Installed Libraries</segtitle>
377 <segtitle>Installed Directories</segtitle>
378
379 <seglistitem>
380 <seg>automount</seg>
381 <seg>
382 lookup_dir.so, lookup_file.so, lookup_files.so, lookup_hosts.so,
383 lookup_ldap.so, lookup_multi.so, lookup_nis.so, lookup_nisplus.so,
384 lookup_program.so, lookup_userhome.so, lookup_yp.so, mount_afs.so,
385 mount_autofs.so, mount_bind.so, mount_changer.so, mount_ext2.so,
386 mount_ext3.so, mount_ext4.so, mount_generic.so, mount_nfs.so,
387 mount_nfs4.so, parse_amd.so, and parse_sun.so
388 </seg>
389 <seg>/usr/lib/autofs, /etc/autofs</seg>
390 </seglistitem>
391 </segmentedlist>
392
393 <variablelist>
394 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
395 <?dbfo list-presentation="list"?>
396 <?dbhtml list-presentation="table"?>
397
398 <varlistentry id="automount">
399 <term><command>automount</command></term>
400 <listitem>
401 <para>
402 is the daemon that performs the mounting when a request is
403 made for the device
404 </para>
405 <indexterm zone="autofs automount">
406 <primary sortas="b-automount">automount</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410
411 </variablelist>
412
413 </sect2>
414
415</sect1>
Note: See TracBrowser for help on using the repository browser.