1 .\" Copyright (c) 1989, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
5 .\" This code is derived from software contributed to Berkeley by
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
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.
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
36 .\" @(#)strfile.8 8.1 (Berkeley) 6/9/93
45 .Nd "create a random access file for storing strings"
56 reads a file containing groups of lines separated by a line containing
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.
63 The output file, if not specified on the command line, is named
64 .Ar source_file Ns Sy .dat .
66 The options are as follows:
67 .Bl -tag -width "-c char"
69 Flag the file as containing comments. This option cases the
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.
78 Change the delimiting character from the percent sign to
81 Ignore case when ordering the strings.
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
93 Randomize access to the strings.
94 Entries in the offset table will be randomly ordered.
95 This option causes the
101 Run silently; don't give a summary message when finished.
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
112 The format of the header is:
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 */
126 All fields are written in network byte order.
130 is to undo the work of
132 It prints out the strings contained in the file
134 in the order that they are listed in
136 .Ar source_file Ns Pa .dat
138 It is possible to create sorted versions of input files by using
142 is run and then using
144 to dump them out in the table order.
149 .Bl -tag -width strfile.dat -compact
156 utility first appeared in