contrib/amd/hlfsd/hlfsd.8

   1 .\"
   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.
   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. 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.
  22 .\"
  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
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\" $FreeBSD$
  36 .\"
  37 .\" File: am-utils/hlfsd/hlfsd.8
  38 .\"
  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.
  42 .\"
  43 .Dd February 26, 2016
  44 .Dt HLFSD 8
  45 .Os
  46 .Sh NAME
  47 .Nm hlfsd
  48 .Nd home-link file system daemon
  49 .Sh SYNOPSIS
  50 .Nm
  51 .Op Fl fhnpvC
  52 .Op Fl a Ar alt_dir
  53 .Op Fl c Ar cache-interval
  54 .Op Fl g Ar group
  55 .Op Fl i Ar reload-interval
  56 .Op Fl l Ar logfile
  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
  62 .Sh DESCRIPTION
  63 .Bf -symbolic
  64 This daemon is obsolete.
  65 Users are advised to use
  66 .Xr autofs 5
  67 instead.
  68 .Ef
  69 .Pp
  70 The
  71 .Nm
  72 utility
  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 The
  81 .Nm
  82 utility
  83 operates by mounting itself as an NFS 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 ,
  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
  92 .Ar subdir
  93 appended to it.
  94 If not specified,
  95 .Ar subdir
  96 defaults to
  97 .Pa .hlfsdir .
  98 This directory will also be created if it does not already exist.
  99 .Pp
 100 A
 101 .Dv SIGTERM
 102 sent to
 103 .Nm
 104 will cause it to shutdown.
 105 A
 106 .Dv SIGHUP
 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
 111 removed or rotated.
 112 A
 113 .Dv SIGUSR1
 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 .
 117 .Sh OPTIONS
 118 .Bl -tag -width indent
 119 .It Fl a Ar alt_dir
 120 Alternate directory.
 121 The name of the directory to which
 122 the symbolic link returned by
 123 .Nm
 124 will point, if it cannot access the home directory of the user.
 125 This
 126 defaults to
 127 .Pa /var/hlfs .
 128 This directory will be created if it does not exist.
 129 It is expected
 130 that either users will read these files, or the system administrators
 131 will run a script to resend this
 132 .Dq lost mail
 133 to its owner.
 134 .It Fl c Ar cache-interval
 135 Caching interval.
 136 The
 137 .Nm
 138 utility
 139 will cache the validity of home directories for this interval, in
 140 seconds.
 141 Entries which have been verified within the last
 142 .Ar cache-interval
 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,
 146 .Nm
 147 will re-verify the validity of the user's home directory, and
 148 reset the cache time-counter.
 149 The default value for
 150 .Ar cache-interval
 151 is 300 seconds (5 minutes).
 152 .It Fl f
 153 Force fast startup.
 154 This option tells
 155 .Nm
 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.
 159 .It Fl g Ar group
 160 Set the special group
 161 .Dv HLFS_GID
 162 to
 163 .Ar group .
 164 Programs such as
 165 .Xr comsat 8 ,
 166 (which access the mailboxes of other users) must be setgid
 167 .Dv HLFS_GID
 168 to work properly.
 169 The default group is
 170 .Dq Li hlfs .
 171 If no group is provided,
 172 and there is no group
 173 .Dq Li hlfs ,
 174 this feature is disabled.
 175 .It Fl h
 176 Help.
 177 Print a brief help message, and exit.
 178 .It Fl i Ar reload-interval
 179 Map-reloading interval.
 180 Each
 181 .Ar reload-interval
 182 seconds,
 183 .Nm
 184 will reload the password map.
 185 The
 186 .Nm
 187 utility
 188 needs the password map for the UIDs and home directory pathnames.
 189 The
 190 .Nm
 191 utility schedules a
 192 .Dv SIGALRM
 193 to reload the password maps.
 194 A
 195 .Dv SIGHUP
 196 sent to
 197 .Nm
 198 will force it to reload the maps immediately.
 199 The default
 200 value for
 201 .Ar reload-interval
 202 is 900 seconds (15 minutes).
 203 .It Fl l Ar logfile
 204 Specify a log file to which
 205 .Nm
 206 will record events.
 207 If
 208 .Ar logfile
 209 is the string
 210 .Dq Li syslog
 211 then the log messages will be sent to the system log daemon by
 212 .Xr syslog 3 ,
 213 using the
 214 .Dv LOG_DAEMON
 215 facility.
 216 This is also the default.
 217 .It Fl n
 218 No verify.
 219 The
 220 .Nm
 221 utility
 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.
 225 This can speed up
 226 .Nm
 227 at the cost of possibly returning symbolic links to home
 228 directories which are not currently accessible or are full.
 229 By default,
 230 .Nm
 231 validates the symbolic-link in the background.
 232 The
 233 .Fl n
 234 option overrides the meaning of the
 235 .Fl c
 236 option, since no caching is necessary.
 237 .It Fl o Ar mount-options
 238 Mount options.
 239 Mount options which
 240 .Nm
 241 will use to mount itself on top of
 242 .Ar dirname .
 243 By default,
 244 .Ar mount-options
 245 is set to
 246 .Dq Li ro .
 247 If the system supports symbolic-link caching, default
 248 options are set to
 249 .Dq Li ro,nocache .
 250 .It Fl p
 251 Print PID.
 252 Outputs the process ID of
 253 .Nm
 254 to standard output where it can be saved into a file.
 255 .It Fl v
 256 Version.
 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
 261 list chosen from:
 262 .Li fatal , error , user , warn , info , map , stats , all .
 263 .It Fl C
 264 Force
 265 .Nm
 266 to run on systems that cannot turn off the NFS attribute-cache.
 267 Use of
 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.
 274 Prefixing an
 275 option with the string
 276 .Dq Li no
 277 reverses the effect of that option.
 278 Options are cumulative.
 279 The most useful option is
 280 .Dq Li all .
 281 Since this option is only used for debugging other options are not
 282 documented here.
 283 A fuller description is available in the program
 284 source.
 285 A
 286 .Dv SIGUSR1
 287 sent to
 288 .Nm
 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
 293 .Ar password-file .
 294 Normally,
 295 .Nm
 296 will use
 297 .Xr getpwent 3
 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
 304 .Ar password-file
 305 are read and checked.
 306 All other fields are ignored.
 307 The file
 308 .Ar password-file
 309 must otherwise be compliant with
 310 .Ux
 311 System 7 colon-delimited format
 312 .Xr passwd 5 .
 313 .El
 314 .Sh FILES
 315 .Bl -tag -width ".Pa /var/hlfs"
 316 .It Pa /hlfs
 317 directory under which
 318 .Nm
 319 mounts itself and manages the symbolic link
 320 .Pa home .
 321 .It Pa .hlfsdir
 322 default sub-directory in the user's home directory, to which the
 323 .Pa home
 324 symbolic link returned by
 325 .Nm
 326 points.
 327 .It Pa /var/hlfs
 328 directory to which
 329 .Pa home
 330 symbolic link returned by
 331 .Nm
 332 points if it is unable to verify the that
 333 user's home directory is accessible.
 334 .El
 335 .Sh "SEE ALSO"
 336 .Xr mail 1 ,
 337 .Xr getgrent 3 ,
 338 .Xr getpwent 3 ,
 339 .Xr mnttab 4 ,
 340 .Xr passwd 4 ,
 341 .Xr mtab 5 ,
 342 .Xr amd 8 ,
 343 .Xr automount 8 ,
 344 .Xr cron 8 ,
 345 .Xr mount 8 ,
 346 .Xr sendmail 8 ,
 347 .Xr umount 8
 348 .Rs
 349 .%T HLFSD: Delivering Email to Your $HOME
 350 .%B Proc. LISA-VII, The 7th Usenix System Administration Conference
 351 .%D November 1993
 352 .Re
 353 .Pp
 354 .Dq am-utils
 355 .Xr info 1
 356 entry.
 357 .Rs
 358 .%A Erez Zadok
 359 .%B "Linux NFS and Automounter Administration"
 360 .%O ISBN 0-7821-2739-8
 361 .%I Sybex
 362 .%D 2001
 363 .Re
 364 .Pp
 365 .Pa http://www.am-utils.org/
 366 .Sh HISTORY
 367 The
 368 .Nm
 369 utility appeared in
 370 .Fx 3.0 .
 371 .Sh AUTHORS
 372 .An Erez Zadok Aq ezk@cs.sunysb.edu ,
 373 Computer Science Department, Stony Brook University, Stony Brook, New York, USA.
 374 .Pp
 375 .An Alexander Dupuy Aq dupuy@smarts.com ,
 376 System Management ARTS, White Plains, New York, USA.
 377 .Pp
 378 Other authors and contributors to am-utils are listed in the
 379 .Pa AUTHORS
 380 file distributed with am-utils.