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