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
85 server for the directory containing
89 Lookups within that directory are handled by
91 which uses the password map to determine how to resolve the lookup.
92 The directory will be created if it does not already exist.
93 The symbolic link will be to the accessing user's home directory, with
100 This directory will also be created if it does not already exist.
106 will cause it to shutdown.
109 will flush the internal
110 caches, and reload the password map.
111 It will also close and
112 reopen the log file, to enable the original log file to be
116 will cause it to dump its internal
117 table of user IDs and home directories to the file
118 .Pa /usr/tmp/hlfsd.dump.XXXXXX .
120 .Bl -tag -width indent
123 The name of the directory to which
124 the symbolic link returned by
126 will point, if it cannot access the home directory of the user.
130 This directory will be created if it does not exist.
132 that either users will read these files, or the system administrators
133 will run a script to resend this
136 .It Fl c Ar cache-interval
141 will cache the validity of home directories for this interval, in
143 Entries which have been verified within the last
145 seconds will not be verified again, since the operation could
146 be expensive, and the entries are most likely still valid.
147 After the interval has expired,
149 will re-verify the validity of the user's home directory, and
150 reset the cache time-counter.
151 The default value for
153 is 300 seconds (5 minutes).
158 to skip startup-time consistency checks such as existence of mount
159 directory, alternate spool directory, symlink to be hidden under the
160 mount directory, their permissions and validity.
162 Set the special group
168 (which access the mailboxes of other users) must be setgid
173 If no group is provided,
174 and there is no group
176 this feature is disabled.
179 Print a brief help message, and exit.
180 .It Fl i Ar reload-interval
181 Map-reloading interval.
186 will reload the password map.
190 needs the password map for the UIDs and home directory pathnames.
195 to reload the password maps.
200 will force it to reload the maps immediately.
204 is 900 seconds (15 minutes).
206 Specify a log file to which
213 then the log messages will be sent to the system log daemon by
218 This is also the default.
224 will not verify the validity of the symbolic link it will be
225 returning, or that the user's home directory contains
226 sufficient disk-space for spooling.
229 at the cost of possibly returning symbolic links to home
230 directories which are not currently accessible or are full.
233 validates the symbolic-link in the background.
236 option overrides the meaning of the
238 option, since no caching is necessary.
239 .It Fl o Ar mount-options
243 will use to mount itself on top of
249 If the system supports symbolic-link caching, default
254 Outputs the process ID of
256 to standard output where it can be saved into a file.
259 Displays version information to standard error.
260 .It Fl x Ar log-options
261 Specify run-time logging options.
262 The options are a comma separated
264 .Li fatal , error , user , warn , info , map , stats , all .
268 to run on systems that cannot turn off the NFS attribute-cache.
270 this option on those systems is discouraged, as it may result in loss
271 or mis-delivery of mail.
272 The option is ignored on systems that can turn
273 off the attribute-cache.
274 .It Fl D Ar log-options
275 Select from a variety of debugging options.
277 option with the string
279 reverses the effect of that option.
280 Options are cumulative.
281 The most useful option is
283 Since this option is only used for debugging other options are not
285 A fuller description is available in the program
291 will cause it to dump its internal password map to the file
292 .Pa /usr/tmp/hlfsd.dump.XXXXXX .
293 .It Fl P Ar password-file
294 Read the user-name, user-id, and home directory information from the file
300 to read the password database.
301 This option allows you to override the
302 default database, and is useful if you want to map users' mail files to a
303 directory other than their home directory.
304 Only the username, uid, and
305 home-directory fields of the file
307 are read and checked.
308 All other fields are ignored.
311 must otherwise be compliant with
313 System 7 colon-delimited format
317 .Bl -tag -width ".Pa /var/hlfs"
319 directory under which
321 mounts itself and manages the symbolic link
324 default sub-directory in the user's home directory, to which the
326 symbolic link returned by
332 symbolic link returned by
334 points if it is unable to verify the that
335 user's home directory is accessible.
351 .%T HLFSD: Delivering Email to Your $HOME
352 .%B Proc. LISA-VII, The 7th Usenix System Administration Conference
361 .%B "Linux NFS and Automounter Administration"
362 .%O ISBN 0-7821-2739-8
367 .Pa http://www.am-utils.org/
374 .An Erez Zadok Aq ezk@cs.sunysb.edu ,
375 Computer Science Department, Stony Brook University, Stony Brook, New York, USA.
377 .An Alexander Dupuy Aq dupuy@smarts.com ,
378 System Management ARTS, White Plains, New York, USA.
380 Other authors and contributors to am-utils are listed in the
382 file distributed with am-utils.