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