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$
  38 .\"
  39 .Dd February 17, 2005
  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 Ciorsx
  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 The
  56 .Nm
  57 utility
  58 reads a file containing groups of lines separated by a line containing
  59 a single percent
  60 .Ql %
  61 sign and creates a data file which contains
  62 a header structure and a table of file offsets for each group of lines.
  63 This allows random access of the strings.
  64 .Pp
  65 The output file, if not specified on the command line, is named
  66 .Ar source_file Ns Pa .dat .
  67 .Pp
  68 The options are as follows:
  69 .Bl -tag -width ".Fl c Ar char"
  70 .It Fl C
  71 Flag the file as containing comments.
  72 This option cases the
  73 .Dv STR_COMMENTS
  74 bit in the header
  75 .Va str_flags
  76 field to be set.
  77 Comments are designated by two delimiter characters at the
  78 beginning of the line, though
  79 .Nm
  80 does not give any special
  81 treatment to comment lines.
  82 .It Fl c Ar char
  83 Change the delimiting character from the percent sign to
  84 .Ar char .
  85 .It Fl i
  86 Ignore case when ordering the strings.
  87 .It Fl o
  88 Order the strings in alphabetical order.
  89 The offset table will be sorted in the alphabetical order of the
  90 groups of lines referenced.
  91 Any initial non-alphanumeric characters are ignored.
  92 This option causes the
  93 .Dv STR_ORDERED
  94 bit in the header
  95 .Va str_flags
  96 field to be set.
  97 .It Fl r
  98 Randomize access to the strings.
  99 Entries in the offset table will be randomly ordered.
 100 This option causes the
 101 .Dv STR_RANDOM
 102 bit in the header
 103 .Va str_flags
 104 field to be set.
 105 .It Fl s
 106 Run silently; do not give a summary message when finished.
 107 .It Fl x
 108 Note that each alphabetic character in the groups of lines is rotated
 109 13 positions in a simple caesar cypher.
 110 This option causes the
 111 .Dv STR_ROTATED
 112 bit in the header
 113 .Va str_flags
 114 field to be set.
 115 .El
 116 .Pp
 117 The format of the header is:
 118 .Bd -literal
 119 #define VERSION 1
 120 uint32_t        str_version;    /* version number */
 121 uint32_t        str_numstr;     /* # of strings in the file */
 122 uint32_t        str_longlen;    /* length of longest string */
 123 uint32_t        str_shortlen;   /* length of shortest string */
 124 #define STR_RANDOM      0x1     /* randomized pointers */
 125 #define STR_ORDERED     0x2     /* ordered pointers */
 126 #define STR_ROTATED     0x4     /* rot-13'd text */
 127 #define STR_COMMENTS    0x8     /* embedded comments */
 128 uint32_t        str_flags;      /* bit field for flags */
 129 char            str_delim;      /* delimiting character */
 130 .Ed
 131 .Pp
 132 All fields are written in network byte order.
 133 .Pp
 134 The purpose of
 135 .Nm unstr
 136 is to undo the work of
 137 .Nm .
 138 It prints out the strings contained in the file
 139 .Ar source_file
 140 in the order that they are listed in
 141 the header file
 142 .Ar source_file Ns Pa .dat
 143 to standard output.
 144 It is possible to create sorted versions of input files by using
 145 .Fl o
 146 when
 147 .Nm
 148 is run and then using
 149 .Nm unstr
 150 to dump them out in the table order.
 151 .Sh FILES
 152 .Bl -tag -width ".Pa strfile.dat" -compact
 153 .It Pa strfile.dat
 154 default output file.
 155 .El
 156 .Sh SEE ALSO
 157 .Xr byteorder 3 ,
 158 .Xr fortune 6
 159 .Sh HISTORY
 160 The
 161 .Nm
 162 utility first appeared in
 163 .Bx 4.4 .