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