contrib/amd/hlfsd/hlfsd.8

   1 .\"
   2 .\" Copyright (c) 1997-2004 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.
   7 .\"
   8 .\" This code is derived from software contributed to Berkeley by
   9 .\" Jan-Simon Pendry at Imperial College, London.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  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.
  26 .\"
  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
  37 .\" SUCH DAMAGE.
  38 .\"
  39 .\" $Id: hlfsd.8,v 1.3.2.5 2004/01/06 03:15:23 ezk Exp $
  40 .\" $FreeBSD$
  41 .\"
  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.
  45 .\"
  46 .Dd September 14, 1993
  47 .Dt HLFSD 8
  48 .Os
  49 .Sh NAME
  50 .Nm hlfsd
  51 .Nd home-link file system daemon
  52 .Sh SYNOPSIS
  53 .Nm
  54 .Op Fl fhnpvC
  55 .Op Fl a Ar alt_dir
  56 .Bk -words
  57 .Op Fl c Ar cache-interval
  58 .Ek
  59 .Op Fl g Ar group
  60 .Bk -words
  61 .Op Fl i Ar reload-interval
  62 .Ek
  63 .Op Fl l Ar logfile
  64 .Bk -words
  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
  69 .Ek
  70 .Op linkname Op subdir
  71 .Sh DESCRIPTION
  72 .Nm
  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
  78 anywhere.
  79 .Pp
  80 .Nm
  81 operates by mounting itself as an
  82 .Tn NFS
  83 server for the directory containing
  84 .Ar linkname ,
  85 which defaults to
  86 .Pa /hlfs/home .
  87 Lookups within that directory are handled by
  88 .Nm hlfsd ,
  89 which uses the password map to determine how to resolve the lookup.
  90 The
  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
  94 .Ar subdir
  95 appended to it.
  96 If not specified,
  97 .Ar subdir
  98 defaults to
  99 .Pa .hlfsdir .
 100 This directory will also be created if it does not already exist.
 101 .Pp
 102 A
 103 .Er SIGHUP
 104 will flush the internal caches, and reload the password map.
 105 It will also
 106 close and reopen the log file, to enable the original log file to be removed
 107 or rotated.
 108 A
 109 .Er SIGUSR1
 110 will cause it to dump its internal table of user IDs and home directories to
 111 the file
 112 .Pa /usr/tmp/hlfsd.dump.XXXXXX .
 113 .Sh OPTIONS
 114 .Bl -tag -width Ds
 115 .It Fl a Ar alt_dir
 116 Alternate directory.
 117 The name of the directory to which
 118 the symbolic link returned by
 119 .Nm
 120 will point, if it cannot access the home directory of the user.
 121 This
 122 defaults to
 123 .Pa /var/hlfs .
 124 This directory will be created if it does not exist.
 125 It is expected
 126 that either users will read these files, or the system administrators
 127 will run a script to resend this
 128 .Dq lost mail
 129 to its owner.
 130 .It Fl c Ar cache-interval
 131 Caching interval.
 132 .Nm
 133 will cache the validity of home directories for this interval, in
 134 seconds.
 135 Entries which have been verified within the last
 136 .Ar cache-interval
 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,
 140 .Nm
 141 will re-verify the validity of the user's home directory, and
 142 reset the cache time-counter.
 143 The default value for
 144 .Ar cache-interval
 145 is 300 seconds
 146 (5 minutes).
 147 .It Fl f
 148 Force fast startup.
 149 This option tells
 150 .Nm
 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.
 154 .It Fl g Ar group
 155 Set the special group
 156 .Va HLFS_GID
 157 to
 158 .Ar group .
 159 Programs such as
 160 .Ic comsat ,
 161 (which access the mailboxes of other users)
 162 must be setgid
 163 .Va HLFS_GID
 164 to work properly.
 165 The default group is
 166 .Dq hlfs .
 167 If no group is provided, and there is no group
 168 .Dq hlfs ,
 169 this feature is disabled.
 170 .It Fl h
 171 Help.
 172 Print a brief help message, and exit.
 173 .It Fl i Ar reload-interval
 174 Map-reloading interval.
 175 Each
 176 .Ar reload-interval
 177 seconds,
 178 .Nm
 179 will reload the password map.
 180 .Nm
 181 needs the password map for the UIDs and home directory pathnames.
 182 .Nm
 183 schedules a
 184 .Va SIGALRM
 185 to reload the password maps.
 186 A
 187 .Va SIGHUP
 188 sent to
 189 .Nm
 190 will force it to reload the maps immediately.
 191 The default value for
 192 .Ar reload-interval
 193 is 900 seconds
 194 (15 minutes).
 195 .It Fl l Ar logfile
 196 Specify a log file to which
 197 .Nm
 198 will record events.
 199 If
 200 .Pa logfile
 201 is the string
 202 .Pa syslog
 203 then the log messages will be sent to the system log daemon by
 204 .Xr syslog 3 ,
 205 using the
 206 .Va LOG_DAEMON
 207 facility.
 208 This is also the default.
 209 .It Fl n
 210 No verify.
 211 .Nm
 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.
 215 This can speed up
 216 .Nm
 217 at the cost of possibly returning symbolic links to home
 218 directories which are not currently accessible or are full.
 219 By default,
 220 .Nm
 221 validates the symbolic-link in the background.
 222 The
 223 .Fl n
 224 option overrides the meaning of the
 225 .Fl c
 226 option, since no caching is necessary.
 227 .It Fl o Ar mount-options
 228 Mount options.
 229 Mount options which
 230 .Nm
 231 will use to mount itself on top of
 232 .Pa dirname .
 233 By default,
 234 .Ar mount-options
 235 is set to
 236 .Qq ro .
 237 If the system supports symbolic-link caching, default
 238 options are set to
 239 .Qq ro,nocache .
 240 .It Fl p
 241 Prints
 242 .Va PID .
 243 Outputs the process-id of
 244 .Nm
 245 to standard output where it can be saved into a file.
 246 .It Fl v
 247 Version.
 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.
 253 .It Fl C
 254 Force
 255 .Nm
 256 to run on systems that cannot turn off the NFS attribute-cache.
 257 Use of
 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.
 264 Prefixing an
 265 option with the string
 266 .Qq no
 267 reverses the effect of that option.
 268 Options are cumulative.
 269 The most useful option is
 270 .Em all .
 271 Since this option is only used for debugging other options are not
 272 documented here.
 273 A fuller description is available in the program
 274 source.
 275 A
 276 .Va SIGUSR1
 277 sent to
 278 .Nm
 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
 283 .Ar password-file .
 284 Normally,
 285 .Nm
 286 will use
 287 .Xr getpwent 3
 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
 294 .Ar password-file
 295 are read and checked.
 296 All other fields are ignored.
 297 The file
 298 .Ar password-file
 299 must be compliant with
 300 .Ux
 301 System 7 colon-delimited format
 302 .Xr passwd 5 .
 303 .El
 304 .Sh FILES
 305 .Bl -tag -width /axx
 306 .It Pa /hlfs
 307 directory under which
 308 .Nm
 309 mounts itself and manages the symbolic link
 310 .Pa home .
 311 .It Pa .hlfsdir
 312 default sub-directory in the user's home directory, to which the
 313 .Pa home
 314 symbolic link returned by
 315 .Nm
 316 points.
 317 .It Pa /var/hlfs
 318 directory to which
 319 .Pa home
 320 symbolic link returned by
 321 .Nm
 322 points if it is unable to verify the that
 323 user's home directory is accessible.
 324 .El
 325 .Sh SEE ALSO
 326 .Xr mail 1 ,
 327 .Xr getgrent 3 ,
 328 .Xr getpwent 3 ,
 329 .Xr mtab 5 ,
 330 .Xr passwd 5 ,
 331 .Xr amd 8 ,
 332 .Xr cron 8 ,
 333 .Xr mount 8 ,
 334 .Xr sendmail 8 ,
 335 .Xr umount 8
 336 .Rs
 337 .%T HLFSD: Delivering Email to Your $HOME
 338 .%B Proc. LISA-VII, The 7th Usenix System Administration Conference
 339 .%D November 1993
 340 .Re
 341 .Sh HISTORY
 342 The
 343 .Nm
 344 utility appeared in
 345 .Fx 3.0 .
 346 .Sh AUTHORS
 347 .An Erez Zadok Aq ezk@cs.columbia.edu ,
 348 Department of Computer Science, Columbia University,
 349 New York, USA.
 350 .Pp
 351 .An Alexander Dupuy Aq dupuy@smarts.com ,
 352 System Management ARTS, White Plains, New York, USA.