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