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