fortune(6): Rework manpages.
authorzrj <rimvydas.jasinskas@gmail.com>
Thu, 1 Sep 2016 08:00:30 +0000 (11:00 +0300)
committerzrj <zrj@dragonflybsd.org>
Thu, 1 Sep 2016 15:36:18 +0000 (18:36 +0300)
Taken-from: FreeBSD

games/fortune/fortune/fortune.6
games/fortune/fortune/fortune.c
games/fortune/strfile/strfile.8
games/fortune/strfile/strfile.c

index 38029c8..ad69744 100644 (file)
@@ -29,7 +29,7 @@
 .\" SUCH DAMAGE.
 .\"
 .\"    @(#)fortune.6   8.3 (Berkeley) 4/19/94
-.\" $FreeBSD: src/games/fortune/fortune/fortune.6,v 1.9.2.6 2001/12/14 14:26:32 ru Exp $
+.\" $FreeBSD: head/usr.bin/fortune/fortune/fortune.6 277954 2015-01-30 23:26:03Z cperciva $
 .\"
 .Dd September 1, 2016
 .Dt FORTUNE 6
@@ -43,7 +43,7 @@
 .Op Fl m Ar pattern
 .Oo
 .Op Ar \&N%
-.Ar file/dir/all
+.Ar file Ns / Ns Ar directory Ns / Ns Cm all
 .Oc
 .Sh DESCRIPTION
 When
@@ -53,7 +53,7 @@ Epigrams are divided into several categories, where each category
 is subdivided into those which are potentially offensive and those
 which are not.
 The options are as follows:
-.Bl -tag -width flag
+.Bl -tag -width indent
 .It Fl a
 Choose from all lists of maxims, both offensive and not.
 (See the
@@ -62,16 +62,17 @@ option for more information on offensive fortunes.)
 .It Fl D
 Enable additional debugging output.
 Specify this option multiple times for more verbose output.
-Only available if compiled with -DDEBUG.
+Only available if compiled with
+.Li -DDEBUG .
 .It Fl e
 Consider all fortune files to be of equal size (see discussion below
 on multiple files).
 .It Fl f
-Print out the list of files which would be searched, but don't
+Print out the list of files which would be searched, but do not
 print a fortune.
 .It Fl l
 Long dictums only.
-.It Fl m
+.It Fl m Ar pattern
 Print out all fortunes which match the regular expression
 .Ar pattern .
 See
@@ -83,7 +84,7 @@ Choose only from potentially offensive aphorisms.
 Please, please, please request a potentially offensive fortune if and
 only if you believe, deep down in your heart, that you are willing
 to be offended.
-(And that if you are not willing, you'll just quit using
+(And that if you are not willing, you will just quit using
 .Fl o
 rather than give us
 grief about it, okay?)
@@ -111,12 +112,12 @@ to guarantee that the message can be read before the screen is cleared.
 The user may specify alternate sayings.
 You can specify a specific file, a directory which contains one or
 more files, or the special word
-.Em all
+.Cm all
 which says to use all the standard databases.
 Any of these may be preceded by a percentage, which is a number
 .Ar N
 between 0 and 100 inclusive, followed by a
-.Ar % .
+.Ql % .
 If it is, there will be a
 .Ar N
 percent probability that an adage will be picked from that file
@@ -127,41 +128,37 @@ and/or directories, in which case the probability of selecting from
 one of them will be based on their relative sizes.
 .Pp
 As an example, given two databases
-.Em funny
+.Pa funny
 and
-.Em not-funny ,
+.Pa not-funny ,
 with
-.Em funny
+.Pa funny
 twice as big, saying
-.Bd -literal -offset indent
-fortune funny not-funny
-.Ed
+.Pp
+.Dl "fortune funny not-funny"
 .Pp
 will get you fortunes out of
-.Em funny
+.Pa funny
 two-thirds of the time.
 The command
-.Bd -literal -offset indent
-fortune 90% funny 10% not-funny
-.Ed
+.Pp
+.Dl "fortune 90% funny 10% not-funny"
 .Pp
 will pick out 90% of its fortunes from
-.Em funny
+.Pa funny
 (the
-.Dq 10% not-funny
-is unnecessary, since 10% is all that's left).
+.Dq Li "10% not-funny"
+is unnecessary, since 10% is all that is left).
 The
 .Fl e
 option says to consider all files equal;
 thus
-.Bd -literal -offset indent
-fortune -e funny not-funny
-.Ed
+.Pp
+.Dl "fortune -e funny not-funny"
 .Pp
 is equivalent to
-.Bd -literal -offset indent
-fortune 50% funny 50% not-funny
-.Ed
+.Pp
+.Dl "fortune 50% funny 50% not-funny"
 .Sh ENVIRONMENT
 .Bl -tag -width ".Ev FORTUNE_SAVESTATE"
 .It Ev FORTUNE_PATH
@@ -177,19 +174,17 @@ If set, fortune will save some state about what fortune
 it was up to on disk.
 .El
 .Sh FILES
-.Bl -tag -width Pa -compact
+.Bl -tag -width ".Pa /usr/share/games/fortune/*"
 .It Pa /usr/games/fortune
-.Pp
 .It Pa /usr/share/games/fortune/*
 the fortunes databases (those files ending
-.Dq -o
+.Dq Pa -o
 contain the
-.Bf -symbolic
-offensive
-.Ef
+.Sy offensive
 fortunes)
 .El
 .Sh SEE ALSO
+.Xr arc4random_uniform 3 ,
 .Xr regcomp 3 ,
 .Xr regex 3 ,
 .Xr strfile 8
index 568e44b..61c527b 100644 (file)
@@ -1364,11 +1364,9 @@ usage(void)
 #ifdef DEBUG
        fprintf(stderr, "D");
 #endif /* DEBUG */
-       fprintf(stderr, "f");
-       fprintf(stderr, "i");
-       fprintf(stderr, "losw]");
+       fprintf(stderr, "efilosw]");
        fprintf(stderr, " [-m pattern]");
-       fprintf(stderr, "[[#%%] file/directory/all]\n");
+       fprintf(stderr, " [[N%%] file/directory/all]\n");
        exit(1);
 }
 
index 84cc755..cde3ee3 100644 (file)
@@ -30,9 +30,9 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)strfile.8  8.1 (Berkeley) 6/9/93
-.\" $FreeBSD: src/games/fortune/strfile/strfile.8,v 1.5.2.3 2001/08/16 10:08:23 ru Exp $
+.\" $FreeBSD: head/usr.bin/fortune/strfile/strfile.8 203926 2010-02-15 15:10:21Z uqs $
 .\"
-.Dd February 8, 2009
+.Dd September 1, 2016
 .Dt STRFILE 8
 .Os
 .Sh NAME
 .Nm unstr
 .Ar source_file
 .Sh DESCRIPTION
-.Nm Strfile
+The
+.Nm
+utility
 reads a file containing groups of lines separated by a line containing
 a single percent
-.Ql \&%
+.Ql %
 sign and creates a data file which contains
 a header structure and a table of file offsets for each group of lines.
 This allows random access of the strings.
 .Pp
 The output file, if not specified on the command line, is named
-.Ar source_file Ns Sy .dat .
+.Ar source_file Ns Pa .dat .
 .Pp
 The options are as follows:
-.Bl -tag -width "-c char"
+.Bl -tag -width ".Fl c Ar char"
 .It Fl C
-Flag the file as containing comments. This option cases the
+Flag the file as containing comments.
+This option causes the
 .Dv STR_COMMENTS
 bit in the header
-.Ar str_flags
+.Fa str_flags
 field to be set.
 Comments are designated by two delimiter characters at the
 beginning of the line, though
@@ -84,7 +87,7 @@ Any initial non-alphanumeric characters are ignored.
 This option causes the
 .Dv STR_ORDERED
 bit in the header
-.Ar str_flags
+.Fa str_flags
 field to be set.
 .It Fl r
 Randomize access to the strings.
@@ -92,17 +95,17 @@ Entries in the offset table will be randomly ordered.
 This option causes the
 .Dv STR_RANDOM
 bit in the header
-.Ar str_flags
+.Fa str_flags
 field to be set.
 .It Fl s
-Run silently; don't give a summary message when finished.
+Run silently; do not give a summary message when finished.
 .It Fl x
 Note that each alphabetic character in the groups of lines is rotated
 13 positions in a simple caesar cypher.
 This option causes the
 .Dv STR_ROTATED
 bit in the header
-.Ar str_flags
+.Fa str_flags
 field to be set.
 .El
 .Pp
@@ -116,8 +119,9 @@ unsigned long       str_shortlen;   /* length of shortest string */
 #define        STR_RANDOM      0x1     /* randomized pointers */
 #define        STR_ORDERED     0x2     /* ordered pointers */
 #define        STR_ROTATED     0x4     /* rot-13'd text */
+#define        STR_COMMENTS    0x8     /* embedded comments */
 unsigned long  str_flags;      /* bit field for flags */
-char str_delim;                        /* delimiting character */
+char           str_delim;      /* delimiting character */
 .Ed
 .Pp
 All fields are written in network byte order.
@@ -140,7 +144,7 @@ is run and then using
 .Nm unstr
 to dump them out in the table order.
 .Sh FILES
-.Bl -tag -width strfile.dat -compact
+.Bl -tag -width ".Pa strfile.dat" -compact
 .It Pa strfile.dat
 default output file.
 .El
index 14ea83b..846e542 100644 (file)
@@ -299,7 +299,7 @@ void
 usage(void)
 {
        fprintf(stderr,
-           "strfile [-Ciorsx] [-c char] sourcefile [datafile]\n");
+           "strfile [-Ciorsx] [-c char] source_file [output_file]\n");
        exit(1);
 }