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 .\" $DragonFly: src/games/fortune/strfile/strfile.8,v 1.4 2007/10/20 17:56:47 swildner Exp $
  39 .\"
  40 .Dd June 9, 1993
  41 .Dt STRFILE 8
  42 .Os
  43 .Sh NAME
  44 .Nm strfile ,
  45 .Nm unstr
  46 .Nd "create a random access file for storing strings"
  47 .Sh SYNOPSIS
  48 .Nm
  49 .Op Fl iorsx
  50 .Op Fl c Ar char
  51 .Ar source_file
  52 .Op Ar output_file
  53 .Nm unstr
  54 .Ar source_file
  55 .Sh DESCRIPTION
  56 .Nm Strfile
  57 reads a file containing groups of lines separated by a line containing
  58 a single percent
  59 .Ql \&%
  60 sign and creates a data file which contains
  61 a header structure and a table of file offsets for each group of lines.
  62 This allows random access of the strings.
  63 .Pp
  64 The output file, if not specified on the command line, is named
  65 .Ar source_file Ns Sy .dat .
  66 .Pp
  67 The options are as follows:
  68 .Bl -tag -width "-c char"
  69 .It Fl C
  70 Flag the file as containing comments. This option cases the
  71 .Dv STR_COMMENTS
  72 bit in the header
  73 .Ar str_flags
  74 field to be set.
  75 Comments are designated by two delimiter characters at the
  76 beginning of the line, though
  77 .Nm
  78 does not give any special treatment to comment lines.
  79 .It Fl c Ar char
  80 Change the delimiting character from the percent sign to
  81 .Ar char .
  82 .It Fl i
  83 Ignore case when ordering the strings.
  84 .It Fl o
  85 Order the strings in alphabetical order.
  86 The offset table will be sorted in the alphabetical order of the
  87 groups of lines referenced.
  88 Any initial non-alphanumeric characters are ignored.
  89 This option causes the
  90 .Dv STR_ORDERED
  91 bit in the header
  92 .Ar str_flags
  93 field to be set.
  94 .It Fl r
  95 Randomize access to the strings.
  96 Entries in the offset table will be randomly ordered.
  97 This option causes the
  98 .Dv STR_RANDOM
  99 bit in the header
 100 .Ar str_flags
 101 field to be set.
 102 .It Fl s
 103 Run silently; don't give a summary message when finished.
 104 .It Fl x
 105 Note that each alphabetic character in the groups of lines is rotated
 106 13 positions in a simple caesar cypher.
 107 This option causes the
 108 .Dv STR_ROTATED
 109 bit in the header
 110 .Ar str_flags
 111 field to be set.
 112 .El
 113 .Pp
 114 The format of the header is:
 115 .Bd -literal
 116 #define VERSION 1
 117 unsigned long   str_version;    /* version number */
 118 unsigned long   str_numstr;     /* # of strings in the file */
 119 unsigned long   str_longlen;    /* length of longest string */
 120 unsigned long   str_shortlen;   /* length of shortest string */
 121 #define STR_RANDOM      0x1     /* randomized pointers */
 122 #define STR_ORDERED     0x2     /* ordered pointers */
 123 #define STR_ROTATED     0x4     /* rot-13'd text */
 124 unsigned long   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 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 .