xref: /freebsd/usr.bin/finger/finger.conf.5 (revision f126890ac5386406dadf7c4cfa9566cbb56537c5)
1.\" Copyright (c) 2000 Mark Knight <markk@knigma.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd August 16, 2000
26.Dt FINGER.CONF 5
27.Os
28.Sh NAME
29.Nm finger.conf
30.Nd
31.Xr finger 1
32alias configuration file
33.Sh DESCRIPTION
34The optional
35.Nm
36file is used to provide aliases that can be fingered by local
37and network users.
38This may be useful where a user's login name is not the same
39as their preferred mail address, or for providing virtual login names
40than can be fingered.
41.Pp
42Lines beginning with ``#'' are comments.
43Other lines must consist of an
44alias name and a target name separated by a colon.
45A target name should be either a user, a forward
46reference to another alias or the path of a world readable file.
47.Pp
48Where an alias points to a file, the contents of that file will be displayed
49when the alias is fingered.
50.Sh FILES
51.Bl -tag -width /etc/finger.conf -compact
52.It Pa /etc/finger.conf
53.Xr finger 1
54alias definition data base
55.El
56.Sh EXAMPLES
57.Bd -literal
58# /etc/finger.conf alias definition file
59#
60# Format alias:(user|alias)
61#
62# Individual aliases
63#
64markk:mkn
65john.smith:dev329
66john:dev329
67sue:/etc/finger/sue.txt
68#
69# Network status message
70#
71status:/usr/local/etc/status.txt
72#
73# Administrative redirects
74#
75root:admin
76postmaster:admin
77abuse:admin
78#
79# For the time being, 'sod' is sysadmin.
80#
81admin:sod
82.Ed
83.Sh SEE ALSO
84.Xr finger 1
85.Sh HISTORY
86Support for the
87.Nm
88file was submitted by Mark Knight <markk@knigma.org> and first appeared in
89.Fx 4.2 .
90