NetBSD/games/wtf/wtf.6

.\"	$NetBSD: wtf.6,v 1.19 2015/04/22 15:04:57 christos Exp $
.\"
.\" Public Domain
.\"
.Dd April 22, 2015
.Dt WTF 6
.Os
.Sh NAME
.Nm wtf
.Nd look up terms
.Sh SYNOPSIS
.Nm
.Op Fl f Ar dbfile
.Op Fl o
.Op Ar is
.Ar term ...
.Sh DESCRIPTION
The
.Nm
utility looks up the meaning of one or more
.Ar term
operands specified on the command line.
.Pp
.Ar term
will first be searched for as an acronym in the acronym databases,
which are expected to be in the format
.Dq acronym[tab]meaning .
If no match has been found,
.Nm
will check to see if the term is known by
.Xr whatis 1 ,
.Xr pkg_info 1 ,
or, when called from within a pkgsrc package directory,
pkgsrc's internal help facility,
.Dq make help topic=XXX .
.Pp
The optional
.Ar is
operand will be ignored, allowing the
fairly natural
.Dq wtf is WTF
usage.
.Pp
The following option is available:
.Bl -tag -width flag
.It Fl f Ar dbfile
Overrides the default list of acronym databases, bypassing the value of the
.Ev ACRONYMDB
variable.
Unlike this variable the
.Fl f
option only accepts one file name as an argument,
but it may be given multiple times to specify more than one file to use.
.It Fl o
Include acronyms that could be considered offensive to some.
Please consult
.Xr fortune 6
for more information about the
.Fl o
flag.
.El
.Sh ENVIRONMENT
.Bl -tag -width ACRONYMDB
.It Ev ACRONYMDB
The default list of acronym databases may be overridden by setting the
environment variable
.Ev ACRONYMDB
to the name of one or more space-separated file names of
acronym databases.
.El
.Sh FILES
.Bl -tag -width /usr/share/misc/acronyms.XXXX -compact
.It Pa /usr/share/misc/acronyms
default acronym database.
.It Pa /usr/share/misc/acronyms-o
default offensive acronym database.
.It Pa /usr/share/misc/acronyms.comp
default computer-related acronym database.
.El
.Sh SEE ALSO
.Xr make 1 ,
.Xr pkg_info 1 ,
.Xr whatis 1 ,
.Xr fortune 6
.Sh HISTORY
.Nm
first appeared in
.Nx 1.5 .
Initially it only translated acronyms;
functionality to look up the meaning of terms in other sources was added later.
PR/49850: Nikolai Lifanov: Document acronyms-o 2015-04-22 18:04:57 +03:00			`.\" $NetBSD: wtf.6,v 1.19 2015/04/22 15:04:57 christos Exp $`
Allen Briggs' wtf(6) to grovel the acronyms database. 1999-07-22 05:03:20 +04:00			`.\"`
			`.\" Public Domain`
			`.\"`
PR/49850: Nikolai Lifanov: Document acronyms-o 2015-04-22 18:04:57 +03:00			`.Dd April 22, 2015`
We're in section 6. 1999-07-26 00:02:48 +04:00			`.Dt WTF 6`
Allen Briggs' wtf(6) to grovel the acronyms database. 1999-07-22 05:03:20 +04:00			`.Os`
			`.Sh NAME`
			`.Nm wtf`
PR/47178 from Bug Hunting src/games/wtf/wtf: - Correct `usage' (to match new `SYNOPSIS' from man page); - augment comment on quering pkgsrc's help facility; - correct interpretation of pkgsrc' help facility query result. src/games/wtf/wtf.6: - enhance `SYNOPSIS', document description (`.Dd'), and overal program description; - augment description about quering pkgsrc's help facility; - improve wording; - augment `HISTORY' section; - bump date. 2012-11-20 16:40:54 +04:00			`.Nd look up terms`
Allen Briggs' wtf(6) to grovel the acronyms database. 1999-07-22 05:03:20 +04:00			`.Sh SYNOPSIS`
			`.Nm`
Implement the `-f' command line option to specify which acronyms database to use. Overrides ACRONYMDB's value, if given. 2003-04-10 13:18:24 +04:00			`.Op Fl f Ar dbfile`
Add -o flag. 2015-04-22 01:49:46 +03:00			`.Op Fl o`
Allen Briggs' wtf(6) to grovel the acronyms database. 1999-07-22 05:03:20 +04:00			`.Op Ar is`
PR/47178 from Bug Hunting src/games/wtf/wtf: - Correct `usage' (to match new `SYNOPSIS' from man page); - augment comment on quering pkgsrc's help facility; - correct interpretation of pkgsrc' help facility query result. src/games/wtf/wtf.6: - enhance `SYNOPSIS', document description (`.Dd'), and overal program description; - augment description about quering pkgsrc's help facility; - improve wording; - augment `HISTORY' section; - bump date. 2012-11-20 16:40:54 +04:00			`.Ar term ...`
Allen Briggs' wtf(6) to grovel the acronyms database. 1999-07-22 05:03:20 +04:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
PR/47178 from Bug Hunting src/games/wtf/wtf: - Correct `usage' (to match new `SYNOPSIS' from man page); - augment comment on quering pkgsrc's help facility; - correct interpretation of pkgsrc' help facility query result. src/games/wtf/wtf.6: - enhance `SYNOPSIS', document description (`.Dd'), and overal program description; - augment description about quering pkgsrc's help facility; - improve wording; - augment `HISTORY' section; - bump date. 2012-11-20 16:40:54 +04:00			`utility looks up the meaning of one or more`
			`.Ar term`
			`operands specified on the command line.`
			`.Pp`
			`.Ar term`
			`will first be searched for as an acronym in the acronym databases,`
- improve wording and overall program description (notably for `-f'); - improve macro usage; - bump date. From Bug Hunting. 2012-10-03 23:50:11 +04:00			`which are expected to be in the format`
PR/47178 from Bug Hunting src/games/wtf/wtf: - Correct `usage' (to match new `SYNOPSIS' from man page); - augment comment on quering pkgsrc's help facility; - correct interpretation of pkgsrc' help facility query result. src/games/wtf/wtf.6: - enhance `SYNOPSIS', document description (`.Dd'), and overal program description; - augment description about quering pkgsrc's help facility; - improve wording; - augment `HISTORY' section; - bump date. 2012-11-20 16:40:54 +04:00			`.Dq acronym[tab]meaning .`
			`If no match has been found,`
Check whatis(1) if we don't find an acronym matching the argument 1999-07-26 00:29:04 +04:00			`.Nm`
PR/47178 from Bug Hunting src/games/wtf/wtf: - Correct `usage' (to match new `SYNOPSIS' from man page); - augment comment on quering pkgsrc's help facility; - correct interpretation of pkgsrc' help facility query result. src/games/wtf/wtf.6: - enhance `SYNOPSIS', document description (`.Dd'), and overal program description; - augment description about quering pkgsrc's help facility; - improve wording; - augment `HISTORY' section; - bump date. 2012-11-20 16:40:54 +04:00			`will check to see if the term is known by`
Teach wtf(6) about pkgsrc's help facility: % cd /usr/pkgsrc/audio/qsynth % wtf subst subst: ===> mk/subst.mk: # This Makefile fragment implements a general text replacement facility. ... 2007-08-07 01:14:36 +04:00			`.Xr whatis 1 ,`
			`.Xr pkg_info 1 ,`
PR/47178 from Bug Hunting src/games/wtf/wtf: - Correct `usage' (to match new `SYNOPSIS' from man page); - augment comment on quering pkgsrc's help facility; - correct interpretation of pkgsrc' help facility query result. src/games/wtf/wtf.6: - enhance `SYNOPSIS', document description (`.Dd'), and overal program description; - augment description about quering pkgsrc's help facility; - improve wording; - augment `HISTORY' section; - bump date. 2012-11-20 16:40:54 +04:00			`or, when called from within a pkgsrc package directory,`
			`pkgsrc's internal help facility,`
Teach wtf(6) about pkgsrc's help facility: % cd /usr/pkgsrc/audio/qsynth % wtf subst subst: ===> mk/subst.mk: # This Makefile fragment implements a general text replacement facility. ... 2007-08-07 01:14:36 +04:00			`.Dq make help topic=XXX .`
Allen Briggs' wtf(6) to grovel the acronyms database. 1999-07-22 05:03:20 +04:00			`.Pp`
PR/47178 from Bug Hunting src/games/wtf/wtf: - Correct `usage' (to match new `SYNOPSIS' from man page); - augment comment on quering pkgsrc's help facility; - correct interpretation of pkgsrc' help facility query result. src/games/wtf/wtf.6: - enhance `SYNOPSIS', document description (`.Dd'), and overal program description; - augment description about quering pkgsrc's help facility; - improve wording; - augment `HISTORY' section; - bump date. 2012-11-20 16:40:54 +04:00			`The optional`
			`.Ar is`
			`operand will be ignored, allowing the`
Whitespace and/or punctuation fixes. 2001-04-03 02:42:37 +04:00			`fairly natural`
Allen Briggs' wtf(6) to grovel the acronyms database. 1999-07-22 05:03:20 +04:00			`.Dq wtf is WTF`
			`usage.`
Implement the `-f' command line option to specify which acronyms database to use. Overrides ACRONYMDB's value, if given. 2003-04-10 13:18:24 +04:00			`.Pp`
PR/47178 from Bug Hunting src/games/wtf/wtf: - Correct `usage' (to match new `SYNOPSIS' from man page); - augment comment on quering pkgsrc's help facility; - correct interpretation of pkgsrc' help facility query result. src/games/wtf/wtf.6: - enhance `SYNOPSIS', document description (`.Dd'), and overal program description; - augment description about quering pkgsrc's help facility; - improve wording; - augment `HISTORY' section; - bump date. 2012-11-20 16:40:54 +04:00			`The following option is available:`
Implement the `-f' command line option to specify which acronyms database to use. Overrides ACRONYMDB's value, if given. 2003-04-10 13:18:24 +04:00			`.Bl -tag -width flag`
			`.It Fl f Ar dbfile`
- improve wording and overall program description (notably for `-f'); - improve macro usage; - bump date. From Bug Hunting. 2012-10-03 23:50:11 +04:00			`Overrides the default list of acronym databases, bypassing the value of the`
Implement the `-f' command line option to specify which acronyms database to use. Overrides ACRONYMDB's value, if given. 2003-04-10 13:18:24 +04:00			`.Ev ACRONYMDB`
			`variable.`
- improve wording and overall program description (notably for `-f'); - improve macro usage; - bump date. From Bug Hunting. 2012-10-03 23:50:11 +04:00			`Unlike this variable the`
			`.Fl f`
			`option only accepts one file name as an argument,`
			`but it may be given multiple times to specify more than one file to use.`
Add -o flag. 2015-04-22 01:49:46 +03:00			`.It Fl o`
			`Include acronyms that could be considered offensive to some.`
			`Please consult`
Fix typo, remove trailing space. 2015-04-22 17:00:46 +03:00			`.Xr fortune 6`
Add -o flag. 2015-04-22 01:49:46 +03:00			`for more information about the`
Fix typo, remove trailing space. 2015-04-22 17:00:46 +03:00			`.Fl o`
Add -o flag. 2015-04-22 01:49:46 +03:00			`flag.`
Implement the `-f' command line option to specify which acronyms database to use. Overrides ACRONYMDB's value, if given. 2003-04-10 13:18:24 +04:00			`.El`
Allen Briggs' wtf(6) to grovel the acronyms database. 1999-07-22 05:03:20 +04:00			`.Sh ENVIRONMENT`
			`.Bl -tag -width ACRONYMDB`
			`.It Ev ACRONYMDB`
- improve wording and overall program description (notably for `-f'); - improve macro usage; - bump date. From Bug Hunting. 2012-10-03 23:50:11 +04:00			`The default list of acronym databases may be overridden by setting the`
Allen Briggs' wtf(6) to grovel the acronyms database. 1999-07-22 05:03:20 +04:00			`environment variable`
			`.Ev ACRONYMDB`
Fix typo or mispelling. 2006-06-17 08:58:14 +04:00			`to the name of one or more space-separated file names of`
* Change program logic to not nest needlessly * Search all acronyms databases, and don't force the user to know in which category to look (-t is gone) * If an acronym is not found in the database or by whatis(1), also check pkg_info(1). Per PR bin/30539 by Geert Hendrickx (geert.hendrickx@ua.ac.be) OK'd by Julio M. Merino Vidal <jmmv> 2005-06-23 00:11:03 +04:00			`acronym databases.`
Allen Briggs' wtf(6) to grovel the acronyms database. 1999-07-22 05:03:20 +04:00			`.El`
			`.Sh FILES`
Mention the /usr/share/misc/acronyms.comp database. 2003-04-11 15:13:34 +04:00			`.Bl -tag -width /usr/share/misc/acronyms.XXXX -compact`
Allen Briggs' wtf(6) to grovel the acronyms database. 1999-07-22 05:03:20 +04:00			`.It Pa /usr/share/misc/acronyms`
			`default acronym database.`
PR/49850: Nikolai Lifanov: Document acronyms-o 2015-04-22 18:04:57 +03:00			`.It Pa /usr/share/misc/acronyms-o`
			`default offensive acronym database.`
Mention the /usr/share/misc/acronyms.comp database. 2003-04-11 15:13:34 +04:00			`.It Pa /usr/share/misc/acronyms.comp`
- improve wording and overall program description (notably for `-f'); - improve macro usage; - bump date. From Bug Hunting. 2012-10-03 23:50:11 +04:00			`default computer-related acronym database.`
Allen Briggs' wtf(6) to grovel the acronyms database. 1999-07-22 05:03:20 +04:00			`.El`
Check whatis(1) if we don't find an acronym matching the argument 1999-07-26 00:29:04 +04:00			`.Sh SEE ALSO`
Teach wtf(6) about pkgsrc's help facility: % cd /usr/pkgsrc/audio/qsynth % wtf subst subst: ===> mk/subst.mk: # This Makefile fragment implements a general text replacement facility. ... 2007-08-07 01:14:36 +04:00			`.Xr make 1 ,`
* Change program logic to not nest needlessly * Search all acronyms databases, and don't force the user to know in which category to look (-t is gone) * If an acronym is not found in the database or by whatis(1), also check pkg_info(1). Per PR bin/30539 by Geert Hendrickx (geert.hendrickx@ua.ac.be) OK'd by Julio M. Merino Vidal <jmmv> 2005-06-23 00:11:03 +04:00			`.Xr pkg_info 1 ,`
Add -o flag. 2015-04-22 01:49:46 +03:00			`.Xr whatis 1 ,`
			`.Xr fortune 6`
Allen Briggs' wtf(6) to grovel the acronyms database. 1999-07-22 05:03:20 +04:00			`.Sh HISTORY`
			`.Nm`
			`first appeared in`
			`.Nx 1.5 .`
PR/47178 from Bug Hunting src/games/wtf/wtf: - Correct `usage' (to match new `SYNOPSIS' from man page); - augment comment on quering pkgsrc's help facility; - correct interpretation of pkgsrc' help facility query result. src/games/wtf/wtf.6: - enhance `SYNOPSIS', document description (`.Dd'), and overal program description; - augment description about quering pkgsrc's help facility; - improve wording; - augment `HISTORY' section; - bump date. 2012-11-20 16:40:54 +04:00			`Initially it only translated acronyms;`
			`functionality to look up the meaning of terms in other sources was added later.`