2 .\" Copyright (c) 1997-2014 Erez Zadok
3 .\" Copyright (c) 1989 Jan-Simon Pendry
4 .\" Copyright (c) 1989 Imperial College of Science, Technology & Medicine
5 .\" Copyright (c) 1989 The Regents of the University of California.
6 .\" All rights reserved.
8 .\" This code is derived from software contributed to Berkeley by
9 .\" Jan-Simon Pendry at Imperial College, London.
11 .\" Redistribution and use in source and binary forms, with or without
12 .\" modification, are permitted provided that the following conditions
14 .\" 1. Redistributions of source code must retain the above copyright
15 .\" notice, this list of conditions and the following disclaimer.
16 .\" 2. Redistributions in binary form must reproduce the above copyright
17 .\" notice, this list of conditions and the following disclaimer in the
18 .\" documentation and/or other materials provided with the distribution.
19 .\" 3. Neither the name of the University nor the names of its contributors
20 .\" may be used to endorse or promote products derived from this software
21 .\" without specific prior written permission.
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 .\" File: am-utils/hlfsd/hlfsd.8
39 .\" HLFSD was written at Columbia University Computer Science Department, by
40 .\" Erez Zadok <ezk@cs.columbia.edu> and Alexander Dupuy <dupuy@smarts.com>
41 .\" It is distributed under the same terms and conditions as AMD.
48 .Nd home-link file system daemon
53 .Op Fl c Ar cache-interval
55 .Op Fl i Ar reload-interval
57 .Op Fl o Ar mount-options
58 .Op Fl x Ar log-options
59 .Op Fl D Ar debug-options
60 .Op Fl P Ar password-file
61 .Op Ar linkname Op Ar subdir
64 This daemon is obsolete.
65 Users are advised to use
73 is a daemon which implements a file system containing a symbolic link to
74 subdirectory within a user's home directory, depending on the user
75 which accessed that link.
76 It was primarily designed to redirect
77 incoming mail to users' home directories, so that it can read from
83 operates by mounting itself as an NFS server for the directory containing
87 Lookups within that directory are handled by
89 which uses the password map to determine how to resolve the lookup.
90 The directory will be created if it does not already exist.
91 The symbolic link will be to the accessing user's home directory, with
98 This directory will also be created if it does not already exist.
104 will cause it to shutdown.
107 will flush the internal
108 caches, and reload the password map.
109 It will also close and
110 reopen the log file, to enable the original log file to be
114 will cause it to dump its internal
115 table of user IDs and home directories to the file
116 .Pa /usr/tmp/hlfsd.dump.XXXXXX .
118 .Bl -tag -width indent
121 The name of the directory to which
122 the symbolic link returned by
124 will point, if it cannot access the home directory of the user.
128 This directory will be created if it does not exist.
130 that either users will read these files, or the system administrators
131 will run a script to resend this
134 .It Fl c Ar cache-interval
139 will cache the validity of home directories for this interval, in
141 Entries which have been verified within the last
143 seconds will not be verified again, since the operation could
144 be expensive, and the entries are most likely still valid.
145 After the interval has expired,
147 will re-verify the validity of the user's home directory, and
148 reset the cache time-counter.
149 The default value for
151 is 300 seconds (5 minutes).
156 to skip startup-time consistency checks such as existence of mount
157 directory, alternate spool directory, symlink to be hidden under the
158 mount directory, their permissions and validity.
160 Set the special group
166 (which access the mailboxes of other users) must be setgid
171 If no group is provided,
172 and there is no group
174 this feature is disabled.
177 Print a brief help message, and exit.
178 .It Fl i Ar reload-interval
179 Map-reloading interval.
184 will reload the password map.
188 needs the password map for the UIDs and home directory pathnames.
193 to reload the password maps.
198 will force it to reload the maps immediately.
202 is 900 seconds (15 minutes).
204 Specify a log file to which
211 then the log messages will be sent to the system log daemon by
216 This is also the default.
222 will not verify the validity of the symbolic link it will be
223 returning, or that the user's home directory contains
224 sufficient disk-space for spooling.
227 at the cost of possibly returning symbolic links to home
228 directories which are not currently accessible or are full.
231 validates the symbolic-link in the background.
234 option overrides the meaning of the
236 option, since no caching is necessary.
237 .It Fl o Ar mount-options
241 will use to mount itself on top of
247 If the system supports symbolic-link caching, default
252 Outputs the process ID of
254 to standard output where it can be saved into a file.
257 Displays version information to standard error.
258 .It Fl x Ar log-options
259 Specify run-time logging options.
260 The options are a comma separated
262 .Li fatal , error , user , warn , info , map , stats , all .
266 to run on systems that cannot turn off the NFS attribute-cache.
268 this option on those systems is discouraged, as it may result in loss
269 or mis-delivery of mail.
270 The option is ignored on systems that can turn
271 off the attribute-cache.
272 .It Fl D Ar log-options
273 Select from a variety of debugging options.
275 option with the string
277 reverses the effect of that option.
278 Options are cumulative.
279 The most useful option is
281 Since this option is only used for debugging other options are not
283 A fuller description is available in the program
289 will cause it to dump its internal password map to the file
290 .Pa /usr/tmp/hlfsd.dump.XXXXXX .
291 .It Fl P Ar password-file
292 Read the user-name, user-id, and home directory information from the file
298 to read the password database.
299 This option allows you to override the
300 default database, and is useful if you want to map users' mail files to a
301 directory other than their home directory.
302 Only the username, uid, and
303 home-directory fields of the file
305 are read and checked.
306 All other fields are ignored.
309 must otherwise be compliant with
311 System 7 colon-delimited format
315 .Bl -tag -width ".Pa /var/hlfs"
317 directory under which
319 mounts itself and manages the symbolic link
322 default sub-directory in the user's home directory, to which the
324 symbolic link returned by
330 symbolic link returned by
332 points if it is unable to verify the that
333 user's home directory is accessible.
349 .%T HLFSD: Delivering Email to Your $HOME
350 .%B Proc. LISA-VII, The 7th Usenix System Administration Conference
359 .%B "Linux NFS and Automounter Administration"
360 .%O ISBN 0-7821-2739-8
365 .Pa http://www.am-utils.org/
372 .An Erez Zadok Aq ezk@cs.sunysb.edu ,
373 Computer Science Department, Stony Brook University, Stony Brook, New York, USA.
375 .An Alexander Dupuy Aq dupuy@smarts.com ,
376 System Management ARTS, White Plains, New York, USA.
378 Other authors and contributors to am-utils are listed in the
380 file distributed with am-utils.