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