X-Git-Url: https://git.cameronkatri.com/bsdgames-darwin.git/blobdiff_plain/2780a632a7e2f3095f982adc3e7ba7f7a65490e5..HEAD:/wtf/wtf.6 diff --git a/wtf/wtf.6 b/wtf/wtf.6 index 4e222dd5..c2764e7f 100644 --- a/wtf/wtf.6 +++ b/wtf/wtf.6 @@ -1,69 +1,90 @@ -.\" $NetBSD: wtf.6,v 1.8 2003/04/25 19:08:31 jmmv Exp $ +.\" $NetBSD: wtf.6,v 1.19 2015/04/22 15:04:57 christos Exp $ .\" .\" Public Domain .\" -.Dd April 25, 2003 +.Dd April 22, 2015 .Dt WTF 6 .Os .Sh NAME .Nm wtf -.Nd translates acronyms for you +.Nd look up terms .Sh SYNOPSIS .Nm .Op Fl f Ar dbfile -.Op Fl t Ar type +.Op Fl o .Op Ar is -.Ar acronym Ar ... +.Ar term ... .Sh DESCRIPTION The .Nm -utility displays the expansion of the acronyms -specified on the command line. -If the acronym is unknown, +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 acronym is known by the -.Xr whatis 1 -command. +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 -If -.Dq is -is specified on the command line, it will be ignored, allowing the +The optional +.Ar is +operand will be ignored, allowing the fairly natural .Dq wtf is WTF usage. .Pp -The following options are available: +The following option is available: .Bl -tag -width flag .It Fl f Ar dbfile -Overrides the default acronym database, bypassing the value of the +Overrides the default list of acronym databases, bypassing the value of the .Ev ACRONYMDB variable. -.It Fl t Ar type -Specifies the acronym's type. -Simply put, it makes the program use the acronyms database named -.Pa /usr/share/misc/acronyms.type , -where -.Ar type -is given by the argument. +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 acronym database may be overridden by setting the +The default list of acronym databases may be overridden by setting the environment variable .Ev ACRONYMDB -to the name of a file in the proper format (acronym[tab]meaning). +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 -computer-related acronym database. +default computer-related acronym database. .El .Sh SEE ALSO -.Xr whatis 1 +.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.