diff options
Diffstat (limited to 'contrib/amd/hlfsd/hlfsd.8')
| -rw-r--r-- | contrib/amd/hlfsd/hlfsd.8 | 145 |
1 files changed, 89 insertions, 56 deletions
diff --git a/contrib/amd/hlfsd/hlfsd.8 b/contrib/amd/hlfsd/hlfsd.8 index a21f0e6..9ef049f 100644 --- a/contrib/amd/hlfsd/hlfsd.8 +++ b/contrib/amd/hlfsd/hlfsd.8 @@ -50,7 +50,7 @@ .Nm hlfsd .Nd home-link file system daemon .Sh SYNOPSIS -.Nm +.Nm .Op Fl fhnpvC .Op Fl a Ar alt_dir .Bk -words @@ -69,10 +69,11 @@ .Ek .Op linkname Op subdir .Sh DESCRIPTION -.Nm +.Nm is a daemon which implements a file system containing a symbolic link to subdirectory within a user's home directory, depending on the user -which accessed that link. It was primarily designed to redirect +which accessed that link. +It was primarily designed to redirect incoming mail to users' home directories, so that it can read from anywhere. .Pp @@ -85,21 +86,26 @@ which defaults to .Pa /hlfs/home . Lookups within that directory are handled by .Nm hlfsd , -which uses the password map to determine how to resolve the lookup. The -directory will be created if it does not already exist. The symbolic link will +which uses the password map to determine how to resolve the lookup. +The +directory will be created if it does not already exist. +The symbolic link will be to the accessing user's home directory, with .Ar subdir -appended to it. If not specified, +appended to it. +If not specified, .Ar subdir -defaults to +defaults to .Pa .hlfsdir . This directory will also be created if it does not already exist. .Pp A .Er SIGHUP -will flush the internal caches, and reload the password map. It will also +will flush the internal caches, and reload the password map. +It will also close and reopen the log file, to enable the original log file to be removed -or rotated. A +or rotated. +A .Er SIGUSR1 will cause it to dump its internal table of user IDs and home directories to the file @@ -107,13 +113,16 @@ the file .Sh OPTIONS .Bl -tag -width Ds .It Fl a Ar alt_dir -Alternate directory. The name of the directory to which +Alternate directory. +The name of the directory to which the symbolic link returned by .Nm -will point, if it cannot access the home directory of the user. This +will point, if it cannot access the home directory of the user. +This defaults to .Pa /var/hlfs . -This directory will be created if it does not exist. It is expected +This directory will be created if it does not exist. +It is expected that either users will read these files, or the system administrators will run a script to resend this .Dq lost mail @@ -122,19 +131,22 @@ to its owner. Caching interval. .Nm will cache the validity of home directories for this interval, in -seconds. Entries which have been verified within the last +seconds. +Entries which have been verified within the last .Ar cache-interval seconds will not be verified again, since the operation could be expensive, and the entries are most likely still valid. After the interval has expired, .Nm will re-verify the validity of the user's home directory, and -reset the cache time-counter. The default value for +reset the cache time-counter. +The default value for .Ar cache-interval -is 300 seconds +is 300 seconds (5 minutes). -.It Fl f -Force fast startup. This option tells +.It Fl f +Force fast startup. +This option tells .Nm to skip startup-time consistency checks such as existence of mount directory, alternate spool directory, symlink to be hidden under the @@ -149,15 +161,18 @@ Programs such as (which access the mailboxes of other users) must be setgid .Va HLFS_GID -to work properly. The default group is +to work properly. +The default group is .Dq hlfs . -If no group is provided, and there is no group -.Dq hlfs , +If no group is provided, and there is no group +.Dq hlfs , this feature is disabled. .It Fl h -Help. Print a brief help message, and exit. +Help. +Print a brief help message, and exit. .It Fl i Ar reload-interval -Map-reloading interval. Each +Map-reloading interval. +Each .Ar reload-interval seconds, .Nm @@ -165,47 +180,53 @@ will reload the password map. .Nm needs the password map for the UIDs and home directory pathnames. .Nm -schedules a -.Va SIGALRM -to reload the password maps. A -.Va SIGHUP +schedules a +.Va SIGALRM +to reload the password maps. +A +.Va SIGHUP sent to .Nm -will force it to reload the maps immediately. The default value for +will force it to reload the maps immediately. +The default value for .Ar reload-interval -is 900 seconds +is 900 seconds (15 minutes). .It Fl l Ar logfile Specify a log file to which .Nm -will record events. If +will record events. +If .Pa logfile is the string .Pa syslog then the log messages will be sent to the system log daemon by .Xr syslog 3 , -using the +using the .Va LOG_DAEMON -facility. This is also the default. +facility. +This is also the default. .It Fl n No verify. .Nm will not verify the validity of the symbolic link it will be returning, or that the user's home directory contains -sufficient disk-space for spooling. This can speed up +sufficient disk-space for spooling. +This can speed up .Nm at the cost of possibly returning symbolic links to home directories which are not currently accessible or are full. By default, .Nm validates the symbolic-link in the background. -The +The .Fl n option overrides the meaning of the .Fl c option, since no caching is necessary. .It Fl o Ar mount-options -Mount options. Mount options which +Mount options. +Mount options which .Nm will use to mount itself on top of .Pa dirname . @@ -214,36 +235,44 @@ By default, is set to .Qq ro . If the system supports symbolic-link caching, default -options are set to +options are set to .Qq ro,nocache . .It Fl p -Prints +Prints .Va PID . Outputs the process-id of .Nm to standard output where it can be saved into a file. .It Fl v -Version. Displays version information to standard error. +Version. +Displays version information to standard error. .It Fl x Ar log-options -Specify run-time logging options. The options are a comma separated +Specify run-time logging options. +The options are a comma separated list chosen from: fatal, error, user, warn, info, map, stats, all. .It Fl C Force .Nm -to run on systems that cannot turn off the NFS attribute-cache. Use of +to run on systems that cannot turn off the NFS attribute-cache. +Use of this option on those systems is discouraged, as it may result in loss -or mis-delivery of mail. The option is ignored on systems that can turn +or mis-delivery of mail. +The option is ignored on systems that can turn off the attribute-cache. .It Fl D Ar log-options -Select from a variety of debugging options. Prefixing an +Select from a variety of debugging options. +Prefixing an option with the string .Qq no -reverses the effect of that option. Options are cumulative. +reverses the effect of that option. +Options are cumulative. The most useful option is .Em all . Since this option is only used for debugging other options are not -documented here. A fuller description is available in the program -source. A +documented here. +A fuller description is available in the program +source. +A .Va SIGUSR1 sent to .Nm @@ -256,15 +285,19 @@ Normally, .Nm will use .Xr getpwent 3 -to read the password database. This option allows you to override the +to read the password database. +This option allows you to override the default database, and is useful if you want to map users' mail files to a -directory other than their home directory. Only the username, uid, and +directory other than their home directory. +Only the username, uid, and home-directory fields of the file .Ar password-file -are read and checked. All other fields are ignored. The file +are read and checked. +All other fields are ignored. +The file .Ar password-file -must be compliant with -.Ux +must be compliant with +.Ux System 7 colon-delimited format .Xr passwd 5 . .El @@ -296,15 +329,20 @@ user's home directory is accessible. .Xr mtab 5 , .Xr passwd 5 , .Xr amd 8 , -.Xr cron 8 , +.Xr cron 8 , .Xr mount 8 , .Xr sendmail 8 , .Xr umount 8 .Rs -.%T HLFSD: Delivering Email to Your $HOME +.%T HLFSD: Delivering Email to Your $HOME .%B Proc. LISA-VII, The 7th Usenix System Administration Conference .%D November 1993 .Re +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 3.0 . .Sh AUTHORS .An Erez Zadok Aq ezk@cs.columbia.edu , Department of Computer Science, Columbia University, @@ -312,8 +350,3 @@ New York, USA. .Pp .An Alexander Dupuy Aq dupuy@smarts.com , System Management ARTS, White Plains, New York, USA. -.Sh HISTORY -The -.Nm -utility appeared in -.Fx 3.0 . |
