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