Merge from vendor branch TNFTP:
[dragonfly.git] / games / quiz / quiz.6
1 .\" Copyright (c) 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 .\" Jim R. Oldroyd at The Instruction Set.
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 .\"     @(#)quiz.6      8.1 (Berkeley) 5/31/93
36 .\" $FreeBSD: src/games/quiz/quiz.6,v 1.3.2.1 2000/12/08 13:40:05 ru Exp $
37 .\" $DragonFly: src/games/quiz/quiz.6,v 1.2 2003/06/17 04:25:24 dillon Exp $
38 .\"
39 .Dd May 31, 1993
40 .Dt QUIZ 6
41 .Os
42 .Sh NAME
43 .Nm quiz
44 .Nd random knowledge tests
45 .Sh SYNOPSIS
46 .Nm
47 .Op Fl t
48 .Op Fl i Ar file
49 .Op Ar question answer
50 .Sh DESCRIPTION
51 The
52 .Nm
53 utility tests your knowledge of random facts.
54 It has a database of subjects from which you can choose.
55 With no arguments,
56 .Nm
57 displays the list of available subjects.
58 .Pp
59 The options are as follows:
60 .Bl -tag -width indent
61 .It Fl t
62 Use tutorial mode, in which questions are repeated later if you didn't get
63 them right the first time, and new questions are presented less frequently
64 to help you learn the older ones.
65 .It Fl i
66 Specify an alternate index file.
67 .El
68 .Pp
69 Subjects are divided into categories.
70 You can pick any two categories from the same subject.
71 .Nm Quiz
72 will ask questions from the first category and it expects answers from
73 the second category.
74 For example, the command ``quiz victim killer'' asks questions which are
75 the names of victims, and expects you to answer with the cause of their
76 untimely demise, whereas the command ``quiz killer victim'' works the
77 other way around.
78 .Pp
79 If you get the answer wrong,
80 .Nm
81 lets you try again.
82 To see the right answer, enter a blank line.
83 .Sh "Index and Data File Syntax"
84 The index and data files have a similar syntax.
85 Lines in them consist of several categories separated by colons.
86 The categories are regular expressions formed using the following
87 meta-characters:
88 .Pp
89 .Bl -tag -width "pat|pat" -compact -offset indent
90 .It pat|pat
91 alternate patterns
92 .It {pat}
93 optional pattern
94 .It [pat]
95 delimiters, as in pat[pat|pat]pat
96 .El
97 .Pp
98 In an index file, each line represents a subject.
99 The first category in each subject is the pathname of the data file for
100 the subject.
101 The remaining categories are regular expressions for the titles of each
102 category in the subject.
103 .Pp
104 In data files, each line represents a question/answer set.
105 Each category is the information for the question/answer for that category.
106 .Pp
107 The backslash character (``\e'') is used to quote syntactically significant
108 characters, or at the end of a line to signify that a continuation line
109 follows.
110 .Pp
111 If either a question or its answer is empty,
112 .Nm
113 will refrain from asking it.
114 .Sh FILES
115 .Bl -tag -width /usr/share/games/quiz.db -compact
116 .It Pa /usr/share/games/quiz.db
117 The default index and data files.
118 .El
119 .Sh BUGS
120 .Nm Quiz
121 is pretty cynical about certain subjects.