games/fortune/fortune/fortune.6

   1 .\" Copyright (c) 1985, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Ken Arnold.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     @(#)fortune.6   8.3 (Berkeley) 4/19/94
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd November 7, 2007
  35 .Dt FORTUNE 6
  36 .Os
  37 .Sh NAME
  38 .Nm fortune
  39 .Nd "print a random, hopefully interesting, adage"
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl aDefilosw
  43 .Op Fl m Ar pattern
  44 .Oo
  45 .Op Ar \&N%
  46 .Ar file Ns / Ns Ar directory Ns / Ns Cm all
  47 .Oc
  48 .Sh DESCRIPTION
  49 When
  50 .Nm
  51 is run with no arguments it prints out a random epigram.
  52 Epigrams are divided into several categories, where each category
  53 is subdivided into those which are potentially offensive and those
  54 which are not.
  55 The options are as follows:
  56 .Bl -tag -width indent
  57 .It Fl a
  58 Choose from all lists of maxims, both offensive and not.
  59 (See the
  60 .Fl o
  61 option for more information on offensive fortunes.)
  62 .It Fl D
  63 Enable additional debugging output.
  64 Specify this option multiple times for more verbose output.
  65 Only available if compiled with
  66 .Li -DDEBUG .
  67 .It Fl e
  68 Consider all fortune files to be of equal size (see discussion below
  69 on multiple files).
  70 .It Fl f
  71 Print out the list of files which would be searched, but do not
  72 print a fortune.
  73 .It Fl l
  74 Long dictums only.
  75 .It Fl m Ar pattern
  76 Print out all fortunes which match the regular expression
  77 .Ar pattern .
  78 See
  79 .Xr regex 3
  80 for a description of patterns.
  81 .It Fl o
  82 Choose only from potentially offensive aphorisms.
  83 .Bf -symbolic
  84 Please, please, please request a potentially offensive fortune if and
  85 only if you believe, deep down in your heart, that you are willing
  86 to be offended.
  87 (And that if you are not willing, you will just quit using
  88 .Fl o
  89 rather than give us
  90 grief about it, okay?)
  91 .Ef
  92 .Bd -unfilled -offset indent
  93 \&... let us keep in mind the basic governing philosophy
  94 of The Brotherhood, as handsomely summarized in these words:
  95 we believe in healthy, hearty laughter -- at the expense of
  96 the whole human race, if needs be.
  97 Needs be.
  98                            --H. Allen Smith, "Rude Jokes"
  99 .Ed
 100 .It Fl s
 101 Short apothegms only.
 102 .It Fl i
 103 Ignore case for
 104 .Fl m
 105 patterns.
 106 .It Fl w
 107 Wait before termination for an amount of time calculated from the
 108 number of characters in the message.
 109 This is useful if it is executed as part of the logout procedure
 110 to guarantee that the message can be read before the screen is cleared.
 111 .El
 112 .Pp
 113 The user may specify alternate sayings.
 114 You can specify a specific file, a directory which contains one or
 115 more files, or the special word
 116 .Cm all
 117 which says to use all the standard databases.
 118 Any of these may be preceded by a percentage, which is a number
 119 .Ar N
 120 between 0 and 100 inclusive, followed by a
 121 .Ql % .
 122 If it is, there will be an
 123 .Ar N
 124 percent probability that an adage will be picked from that file
 125 or directory.
 126 If the percentages do not sum to 100, and there are specifications
 127 without percentages, the remaining percent will apply to those files
 128 and/or directories, in which case the probability of selecting from
 129 one of them will be based on their relative sizes.
 130 .Pp
 131 As an example, given two databases
 132 .Pa funny
 133 and
 134 .Pa not-funny ,
 135 with
 136 .Pa funny
 137 twice as big, saying
 138 .Pp
 139 .Dl "fortune funny not-funny"
 140 .Pp
 141 will get you fortunes out of
 142 .Pa funny
 143 two-thirds of the time.
 144 The command
 145 .Pp
 146 .Dl "fortune 90% funny 10% not-funny"
 147 .Pp
 148 will pick out 90% of its fortunes from
 149 .Pa funny
 150 (the
 151 .Dq Li "10% not-funny"
 152 is unnecessary, since 10% is all that is left).
 153 The
 154 .Fl e
 155 option says to consider all files equal;
 156 thus
 157 .Pp
 158 .Dl "fortune -e funny not-funny"
 159 .Pp
 160 is equivalent to
 161 .Pp
 162 .Dl "fortune 50% funny 50% not-funny"
 163 .Sh ENVIRONMENT
 164 .Bl -tag -width ".Ev FORTUNE_PATH"
 165 .It Ev FORTUNE_PATH
 166 The search path for the data files.
 167 It is a colon-separated list of directories in which
 168 .Nm
 169 looks for data files.
 170 If not set it will default to
 171 .Pa /usr/games/fortune .
 172 If none of the directories specified exist, it will print a warning and exit.
 173 .It Ev FORTUNE_SAVESTATE
 174 If set, fortune will save some state about what fortune
 175 it was up to on disk.
 176 .El
 177 .Sh FILES
 178 .Bl -tag -width ".Pa /usr/share/games/fortune/*"
 179 .It Pa /usr/games/fortune
 180 .It Pa /usr/share/games/fortune/*
 181 the fortunes databases (those files ending
 182 .Dq Pa -o
 183 contain the
 184 .Sy offensive
 185 fortunes)
 186 .El
 187 .Sh SEE ALSO
 188 .Xr arc4random_uniform 3 ,
 189 .Xr regcomp 3 ,
 190 .Xr regex 3 ,
 191 .Xr strfile 8