Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / finger / finger.conf.5
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 .\"$FreeBSD: src/usr.bin/finger/finger.conf.5,v 1.2.2.3 2000/09/01 20:14:16 brian Exp $
26 .\"
27 .Dd August 16, 2000
28 .Dt FINGER.CONF 5
29 .Os
30 .Sh NAME
31 .Nm finger.conf
32 .Nd
33 .Xr finger 1
34 alias configuration file
35 .Sh DESCRIPTION
36 The optional
37 .Nm
38 file is used to provide aliases that can be fingered by local
39 and network users.
40 This may be useful where a user's login name is not the same
41 as their preferred mail address, or for providing virtual login names
42 than can be fingered.
43 .Pp
44 Lines beginning with ``#'' are comments.
45 Other lines must consist of an
46 alias name and a target name separated by a colon.
47 A target name should be either a user, a forward
48 reference to another alias or the path of a world readable file.
49 .Pp
50 Where an alias points to a file, the contents of that file will be displayed
51 when the alias is fingered.
52 .Sh EXAMPLES
53 .Bd -literal
54 # /etc/finger.conf alias definition file
55 #
56 # Format alias:(user|alias)
57 #
58 # Individual aliases
59 #
60 markk:mkn
61 john.smith:dev329
62 john:dev329
63 sue:/etc/finger/sue.txt
64 #
65 # Network status message
66 #
67 status:/usr/local/etc/status.txt
68 #
69 # Administrative redirects
70 #
71 root:admin
72 postmaster:admin
73 abuse:admin
74 #
75 # For the time being, 'sod' is sysadmin.
76 #
77 admin:sod
78 .Ed
79 .Sh FILES
80 .Bl -tag -width /etc/finger.conf -compact
81 .It Pa /etc/finger.conf
82 .Xr finger 1
83 alias definition data base
84 .El
85 .Sh SEE ALSO
86 .Xr finger 1
87 .Sh HISTORY
88 Support for the
89 .Nm
90 file was submitted by Mark Knight <markk@knigma.org> and first appeared in
91 .Fx 4.2 .