xref: /netbsd-src/games/wtf/wtf.6 (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1.\"	$NetBSD: wtf.6,v 1.16 2012/11/20 12:40:54 abs Exp $
2.\"
3.\" Public Domain
4.\"
5.Dd November 20, 2012
6.Dt WTF 6
7.Os
8.Sh NAME
9.Nm wtf
10.Nd look up terms
11.Sh SYNOPSIS
12.Nm
13.Op Fl f Ar dbfile
14.Op Ar is
15.Ar term ...
16.Sh DESCRIPTION
17The
18.Nm
19utility looks up the meaning of one or more
20.Ar term
21operands specified on the command line.
22.Pp
23.Ar term
24will first be searched for as an acronym in the acronym databases,
25which are expected to be in the format
26.Dq acronym[tab]meaning .
27If no match has been found,
28.Nm
29will check to see if the term is known by
30.Xr whatis 1 ,
31.Xr pkg_info 1 ,
32or, when called from within a pkgsrc package directory,
33pkgsrc's internal help facility,
34.Dq make help topic=XXX .
35.Pp
36The optional
37.Ar is
38operand will be ignored, allowing the
39fairly natural
40.Dq wtf is WTF
41usage.
42.Pp
43The following option is available:
44.Bl -tag -width flag
45.It Fl f Ar dbfile
46Overrides the default list of acronym databases, bypassing the value of the
47.Ev ACRONYMDB
48variable.
49Unlike this variable the
50.Fl f
51option only accepts one file name as an argument,
52but it may be given multiple times to specify more than one file to use.
53.El
54.Sh ENVIRONMENT
55.Bl -tag -width ACRONYMDB
56.It Ev ACRONYMDB
57The default list of acronym databases may be overridden by setting the
58environment variable
59.Ev ACRONYMDB
60to the name of one or more space-separated file names of
61acronym databases.
62.El
63.Sh FILES
64.Bl -tag -width /usr/share/misc/acronyms.XXXX -compact
65.It Pa /usr/share/misc/acronyms
66default acronym database.
67.It Pa /usr/share/misc/acronyms.comp
68default computer-related acronym database.
69.El
70.Sh SEE ALSO
71.Xr make 1 ,
72.Xr pkg_info 1 ,
73.Xr whatis 1
74.Sh HISTORY
75.Nm
76first appeared in
77.Nx 1.5 .
78Initially it only translated acronyms;
79functionality to look up the meaning of terms in other sources was added later.
80