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