games/fortune/strfile/strfile.8

   1 .\" Copyright (c) 1989, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\"
   5 .\" This code is derived from software contributed to Berkeley by
   6 .\" Ken Arnold.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)strfile.8   8.1 (Berkeley) 6/9/93
  37 .\" $FreeBSD: src/games/fortune/strfile/strfile.8,v 1.5.2.3 2001/08/16 10:08:23 ru Exp $
  38 .\"
  39 .Dd June 9, 1993
  40 .Dt STRFILE 8
  41 .Os
  42 .Sh NAME
  43 .Nm strfile ,
  44 .Nm unstr
  45 .Nd "create a random access file for storing strings"
  46 .Sh SYNOPSIS
  47 .Nm
  48 .Op Fl iorsx
  49 .Op Fl c Ar char
  50 .Ar source_file
  51 .Op Ar output_file
  52 .Nm unstr
  53 .Ar source_file
  54 .Sh DESCRIPTION
  55 .Nm Strfile
  56 reads a file containing groups of lines separated by a line containing
  57 a single percent
  58 .Ql \&%
  59 sign and creates a data file which contains
  60 a header structure and a table of file offsets for each group of lines.
  61 This allows random access of the strings.
  62 .Pp
  63 The output file, if not specified on the command line, is named
  64 .Ar source_file Ns Sy .dat .
  65 .Pp
  66 The options are as follows:
  67 .Bl -tag -width "-c char"
  68 .It Fl C
  69 Flag the file as containing comments. This option cases the
  70 .Dv STR_COMMENTS
  71 bit in the header
  72 .Ar str_flags
  73 field to be set.
  74 Comments are designated by two delimiter characters at the
  75 beginning of the line, though strfile does not give any special
  76 treatment to comment lines.
  77 .It Fl c Ar char
  78 Change the delimiting character from the percent sign to
  79 .Ar char .
  80 .It Fl i
  81 Ignore case when ordering the strings.
  82 .It Fl o
  83 Order the strings in alphabetical order.
  84 The offset table will be sorted in the alphabetical order of the
  85 groups of lines referenced.
  86 Any initial non-alphanumeric characters are ignored.
  87 This option causes the
  88 .Dv STR_ORDERED
  89 bit in the header
  90 .Ar str_flags
  91 field to be set.
  92 .It Fl r
  93 Randomize access to the strings.
  94 Entries in the offset table will be randomly ordered.
  95 This option causes the
  96 .Dv STR_RANDOM
  97 bit in the header
  98 .Ar str_flags
  99 field to be set.
 100 .It Fl s
 101 Run silently; don't give a summary message when finished.
 102 .It Fl x
 103 Note that each alphabetic character in the groups of lines is rotated
 104 13 positions in a simple caesar cypher.
 105 This option causes the
 106 .Dv STR_ROTATED
 107 bit in the header
 108 .Ar str_flags
 109 field to be set.
 110 .El
 111 .Pp
 112 The format of the header is:
 113 .Bd -literal
 114 #define VERSION 1
 115 unsigned long   str_version;    /* version number */
 116 unsigned long   str_numstr;     /* # of strings in the file */
 117 unsigned long   str_longlen;    /* length of longest string */
 118 unsigned long   str_shortlen;   /* length of shortest string */
 119 #define STR_RANDOM      0x1     /* randomized pointers */
 120 #define STR_ORDERED     0x2     /* ordered pointers */
 121 #define STR_ROTATED     0x4     /* rot-13'd text */
 122 unsigned long   str_flags;      /* bit field for flags */
 123 char str_delim;                 /* delimiting character */
 124 .Ed
 125 .Pp
 126 All fields are written in network byte order.
 127 .Pp
 128 The purpose of
 129 .Nm unstr
 130 is to undo the work of
 131 .Nm .
 132 It prints out the strings contained in the file
 133 .Ar source_file
 134 in the order that they are listed in
 135 the header file
 136 .Ar source_file Ns Pa .dat
 137 to standard output.
 138 It is possible to create sorted versions of input files by using
 139 .Fl o
 140 when
 141 .Nm
 142 is run and then using
 143 .Nm unstr
 144 to dump them out in the table order.
 145 .Sh SEE ALSO
 146 .Xr byteorder 3 ,
 147 .Xr fortune 6
 148 .Sh FILES
 149 .Bl -tag -width strfile.dat -compact
 150 .It Pa strfile.dat
 151 default output file.
 152 .El
 153 .Sh HISTORY
 154 The
 155 .Nm
 156 utility first appeared in
 157 .Bx 4.4 .