.\" Copyright (C) 2001 Michael Baumer, baumi@vis.ethz.ch
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either
.\" version 2 of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
.\" General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the
.\" Free Software Foundation, Inc., 59 Temple Place - Suite 330,
.\" Boston, MA 02111-1307, USA.
.\"
.\" $Id: fingerconf.5,v 1.2 2001/04/26 09:20:33 baumi Exp $
.\"
.TH fingerconf 5 "$Date: 2001/04/26 09:20:33 $" PFinger "UNIX Reference Manual"
.LO 1
.SH NAME
fingerconf \- configuration file for pfinger
.SH DESCRIPTION
1. Format
.PP
The
.I fingerconf
file is a simple XML-like file. This means every option
has the form <option>value</option>.
.PP
2. Most important options
.PP
.ta 1.5i
<siteinfo>	Contains a text that is displayed for a 
.br
	"finger .site@sample.org"
.br
<specialfile>	Special "dot"-Files in the users home 
	directory that can be retrieved with finger
	(e.g. finger user.pgpkey@sample.org 
	returns the file ~user/.pgpkey, if pgpkey 
	is defined as special file)
.br
<option>	enables an option:
.br
	showidle:	 Display the idle-time of the users
.br
	showfrom:	 Display from where a user is connected
.br
	hidemail:	 Hide the user mail information
.br		     
<dbpath>	see section 3.3
.br
<sitehost>	see section 3.5
.br
<clientlist>	""
.br
<client>	""
.br
<poll>	""
.br
<sitemaster>	same as <sitehost> (backwards compatibilty)
.br
.PP
3. /usr/share/finger/statusdb
.PP
PFinger uses a database to store the users that are logged in on a
remote host. Its default path is /usr/share/finger/. However if you
are using GNU Finger compatibility mode (see below) the default is
/usr/local/etc/fingerdir/. The default path can be overridden in the
configfile with the directive <dbpath>/path/to/dbdir/</dbpath>.
.PP
The file must be writeable by the Site Finger Deamon (see below) and
readable by the finger deamon. 
.PP
If you are not using PFinger as a Site deamon the statusdb file is not
entirely necessary but the deamon will complain about it in the
syslog.
.PP
4. GNU Finger compatibility
.PP
Enable GNU Finger compatibility mode by starting in.fingerd with the
"-g" option.  (Set this in the inetd.conf). Further explanation of
this mode can be found in the README.
.PP
5. Site Finger Deamon
.PP
PFinger provides a site finger deamon, which allows you to provide
finger information for a whole cluster at a single host. We call the
hosts of the cluster "clients" and the Server were the fingerd
programs runs "master".
.PP
Example Scenario:
.PP
We have several Computers in a laboratory. All computers have the same
configuration (e.g. the same logins). None of them is assigned to a
single person. This means it is not predictable which host someone
will use, which makes the finger service somewhat unusable.
Now we are able to install the PFinger in.fingerd on all hosts and
the PFinger fingerd on a Server. Now everyone can query the Server and
gets the same information as if he or she were querying all hosts of
the cluster.
.PP
Installation: 
.PP
On every client you need to install the "in.fingerd" program as shown
above. Also you need on every host a simple configuration file
pointing to the master:
.br
Example /etc/fingerconf:
.br
<fingerconf>
.br
<sitehost>master_hostname</sitehost>
.br
</fingerconf>
.PP
On the master you need to run the "fingerd" program. This program
automatically gathers the online information from the clients all 30
seconds (configurable). 
The users need not to be able to log into the master. They must
however be known (via /etc/passwd, yp/NIS or similar).
.PP
In the /etc/fingerconf file you need to specify
.br
- for every client:
.br
  <client>client_hostname</client>
.br
  in the <clientlist> directive
.PP
- for another interval than 30 seconds:
.br
 <poll>seconds</poll>
.PP
Exapmle server /etc/fingerconf:
.br
(Poll clients (lab1 and lab2) all 150 seconds)
.PP
.nf
<fingerconf>
<poll>150</poll>		
<clientlist>
<client>lab1</client>
<client>lab2</client>
</clientlist>
</fingerconf>  

.SH EXAMPLE SYSTEM FINGERCONF
.nf
<!-- Sample Finger configuration file for the server -->
<!-- this file is read by the finger deamon at startup time -->
<fingerconf>
<siteinfo>
.			Welcome to a cool site
</siteinfo>
<option>
showidle
</option>
<option>
showfrom
</option>
<option>
hidemail
</option>
<specialfile>
plan
</specialfile>
<specialfile>
key
<desc>Public key</desc>
</specialfile>
<specialfile>
pgpkey
<desc>PGP public key</desc>
</specialfile>
<desc>User face bitmap</desc>
</specialfile>
</fingerconf>

.SH FILES
.PD 0
.TP 28n
.B ~/.fingerconf
Personal information.
.TP
.B /etc/fingerconf
The system configuration file.
.TP
.B ~/.key
A public key file.
.TP
.B ~/.pgpkey
The PGP public key.
.TP
.B ~/.face
Private face bitmap.
.TP
.B ~/.plan
Plan description.
.TP
.B ~/.fingerrc
Personalized finger info script.
.TP
.B ~/.nofinger
If this file exists no user information is given away
.SH "SEE ALSO"
pfinger(1), finger(1),  in.fingerd(8)
.PP

.SH BUGS
Report bugs to 
.B pfinger@xelia.ch