xref: /netbsd-src/games/wtf/wtf.6 (revision 82ad575716605df31379cf04a2f3efbc97b8a6f5)
1.\"	$NetBSD: wtf.6,v 1.15 2012/10/03 19:50:43 wiz Exp $
2.\"
3.\" Public Domain
4.\"
5.Dd October 3, 2012
6.Dt WTF 6
7.Os
8.Sh NAME
9.Nm wtf
10.Nd translate acronyms
11.Sh SYNOPSIS
12.Nm
13.Op Fl f Ar dbfile
14.Op Ar is
15.Ar acronym ...
16.Sh DESCRIPTION
17The
18.Nm
19utility displays the expansion of one or more acronyms
20specified on the command line.
21If an acronym is not in any of the acronym databases,
22which are expected to be in the format
23.Dq acronym[tab]meaning ,
24.Nm
25will check to see if it is known by
26.Xr whatis 1 ,
27.Xr pkg_info 1 ,
28or via pkgsrc's internal help mechanism,
29.Dq make help topic=XXX .
30.Pp
31If
32.Dq is
33is specified on the command line, it will be ignored, allowing the
34fairly natural
35.Dq wtf is WTF
36usage.
37.Pp
38The following options are available:
39.Bl -tag -width flag
40.It Fl f Ar dbfile
41Overrides the default list of acronym databases, bypassing the value of the
42.Ev ACRONYMDB
43variable.
44Unlike this variable the
45.Fl f
46option only accepts one file name as an argument,
47but it may be given multiple times to specify more than one file to use.
48.El
49.Sh ENVIRONMENT
50.Bl -tag -width ACRONYMDB
51.It Ev ACRONYMDB
52The default list of acronym databases may be overridden by setting the
53environment variable
54.Ev ACRONYMDB
55to the name of one or more space-separated file names of
56acronym databases.
57.El
58.Sh FILES
59.Bl -tag -width /usr/share/misc/acronyms.XXXX -compact
60.It Pa /usr/share/misc/acronyms
61default acronym database.
62.It Pa /usr/share/misc/acronyms.comp
63default computer-related acronym database.
64.El
65.Sh SEE ALSO
66.Xr make 1 ,
67.Xr pkg_info 1 ,
68.Xr whatis 1
69.Sh HISTORY
70.Nm
71first appeared in
72.Nx 1.5 .
73