2 .\" Copyright (c) 1997-2006 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. All advertising materials mentioning features or use of this software
20 .\" must display the following acknowledgment:
21 .\" This product includes software developed by the University of
22 .\" California, Berkeley and its contributors.
23 .\" 4. Neither the name of the University nor the names of its contributors
24 .\" may be used to endorse or promote products derived from this software
25 .\" without specific prior written permission.
27 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 .\" $Id: hlfsd.8,v 1.11.2.1 2006/01/02 18:48:25 ezk Exp $
42 .\" HLFSD was written at Columbia University Computer Science Department, by
43 .\" Erez Zadok <ezk@cs.columbia.edu> and Alexander Dupuy <dupuy@smarts.com>
44 .\" It is distributed under the same terms and conditions as AMD.
51 .Nd home-link file system daemon
57 .Op Fl c Ar cache-interval
61 .Op Fl i Ar reload-interval
65 .Op Fl o Ar mount-options
66 .Op Fl x Ar log-options
67 .Op Fl D Ar debug-options
68 .Op Fl P Ar password-file
70 .Op linkname Op subdir
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
81 operates by mounting itself as an
83 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.
91 directory will be created if it does not already exist.
92 The symbolic link will
93 be to the accessing user's home directory, with
100 This directory will also be created if it does not already exist.
104 will flush the internal caches, and reload the password map.
106 close and reopen the log file, to enable the original log file to be removed
110 will cause it to dump its internal table of user IDs and home directories to
112 .Pa /usr/tmp/hlfsd.dump.XXXXXX .
117 The name of the directory to which
118 the symbolic link returned by
120 will point, if it cannot access the home directory of the user.
124 This directory will be created if it does not exist.
126 that either users will read these files, or the system administrators
127 will run a script to resend this
130 .It Fl c Ar cache-interval
133 will cache the validity of home directories for this interval, in
135 Entries which have been verified within the last
137 seconds will not be verified again, since the operation could
138 be expensive, and the entries are most likely still valid.
139 After the interval has expired,
141 will re-verify the validity of the user's home directory, and
142 reset the cache time-counter.
143 The default value for
151 to skip startup-time consistency checks such as existence of mount
152 directory, alternate spool directory, symlink to be hidden under the
153 mount directory, their permissions and validity.
155 Set the special group
161 (which access the mailboxes of other users)
167 If no group is provided, and there is no group
169 this feature is disabled.
172 Print a brief help message, and exit.
173 .It Fl i Ar reload-interval
174 Map-reloading interval.
179 will reload the password map.
181 needs the password map for the UIDs and home directory pathnames.
185 to reload the password maps.
190 will force it to reload the maps immediately.
191 The default value for
196 Specify a log file to which
203 then the log messages will be sent to the system log daemon by
208 This is also the default.
212 will not verify the validity of the symbolic link it will be
213 returning, or that the user's home directory contains
214 sufficient disk-space for spooling.
217 at the cost of possibly returning symbolic links to home
218 directories which are not currently accessible or are full.
221 validates the symbolic-link in the background.
224 option overrides the meaning of the
226 option, since no caching is necessary.
227 .It Fl o Ar mount-options
231 will use to mount itself on top of
237 If the system supports symbolic-link caching, default
243 Outputs the process-id of
245 to standard output where it can be saved into a file.
248 Displays version information to standard error.
249 .It Fl x Ar log-options
250 Specify run-time logging options.
251 The options are a comma separated
252 list chosen from: fatal, error, user, warn, info, map, stats, all.
256 to run on systems that cannot turn off the NFS attribute-cache.
258 this option on those systems is discouraged, as it may result in loss
259 or mis-delivery of mail.
260 The option is ignored on systems that can turn
261 off the attribute-cache.
262 .It Fl D Ar log-options
263 Select from a variety of debugging options.
265 option with the string
267 reverses the effect of that option.
268 Options are cumulative.
269 The most useful option is
271 Since this option is only used for debugging other options are not
273 A fuller description is available in the program
279 will cause it to dump its internal password map to the file
280 .Pa /usr/tmp/hlfsd.dump.XXXXXX .
281 .It Fl P Ar password-file
282 Read the user-name, user-id, and home directory information from the file
288 to read the password database.
289 This option allows you to override the
290 default database, and is useful if you want to map users' mail files to a
291 directory other than their home directory.
292 Only the username, uid, and
293 home-directory fields of the file
295 are read and checked.
296 All other fields are ignored.
299 must be compliant with
301 System 7 colon-delimited format
307 directory under which
309 mounts itself and manages the symbolic link
312 default sub-directory in the user's home directory, to which the
314 symbolic link returned by
320 symbolic link returned by
322 points if it is unable to verify the that
323 user's home directory is accessible.
337 .%T HLFSD: Delivering Email to Your $HOME
338 .%B Proc. LISA-VII, The 7th Usenix System Administration Conference
347 .An Erez Zadok Aq ezk@cs.sunysb.edu ,
348 Computer Science Department, Stony Brook University, Stony Brook, New York, USA.
350 .An Alexander Dupuy Aq dupuy@smarts.com ,
351 System Management ARTS, White Plains, New York, USA.
353 Other authors and contributors to am-utils are listed in the
355 file distributed with am-utils.