1.\" Copyright (c) 1980, 1993
2.\" The Regents of the University of California. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by the University of
15.\" California, Berkeley and its contributors.
16.\" 4. 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.\" @(#)xstr.1 8.2 (Berkeley) 12/30/93
| 1.\" Copyright (c) 1980, 1993
2.\" The Regents of the University of California. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by the University of
15.\" California, Berkeley and its contributors.
16.\" 4. 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.\" @(#)xstr.1 8.2 (Berkeley) 12/30/93
|
33.\" $FreeBSD: head/usr.bin/xstr/xstr.1 79755 2001-07-15 08:06:20Z dd $
| 33.\" $FreeBSD: head/usr.bin/xstr/xstr.1 95124 2002-04-20 12:18:28Z charnier $
|
34.\"
35.Dd December 30, 1993
36.Dt XSTR 1
37.Os
38.Sh NAME
39.Nm xstr
40.Nd "extract strings from C programs to implement shared strings"
41.Sh SYNOPSIS
42.Nm
43.Op Fl c
44.Op Fl
45.Op Fl v
46.Op Ar file
47.Sh DESCRIPTION
| 34.\"
35.Dd December 30, 1993
36.Dt XSTR 1
37.Os
38.Sh NAME
39.Nm xstr
40.Nd "extract strings from C programs to implement shared strings"
41.Sh SYNOPSIS
42.Nm
43.Op Fl c
44.Op Fl
45.Op Fl v
46.Op Ar file
47.Sh DESCRIPTION
|
48.Nm Xstr
49maintains a file
| 48The
49.Nm
50utility maintains a file
|
50.Pa strings
51into which strings in component parts of a large program are hashed.
52These strings are replaced with references to this common area.
53This serves to implement shared constant strings, most useful if they
54are also read-only.
55.Pp
56Available options:
57.Bl -tag -width Ds
58.It Fl
| 51.Pa strings
52into which strings in component parts of a large program are hashed.
53These strings are replaced with references to this common area.
54This serves to implement shared constant strings, most useful if they
55are also read-only.
56.Pp
57Available options:
58.Bl -tag -width Ds
59.It Fl
|
59.Nm Xstr
60reads from the standard input.
| 60Read from the standard input.
|
61.It Fl c
| 61.It Fl c
|
62.Nm Xstr
63will extract the strings from the C source
| 62Extract the strings from the C source
|
64.Ar file
65or the standard input
66.Pq Fl ,
67replacing
68string references by expressions of the form (&xstr[number])
69for some number.
70An appropriate declaration of
71.Nm
72is prepended to the file.
73The resulting C text is placed in the file
74.Pa x.c ,
75to then be compiled.
76The strings from this file are placed in the
77.Pa strings
78data base if they are not there already.
79Repeated strings and strings which are suffixes of existing strings
80do not cause changes to the data base.
81.It Fl v
82Verbose mode.
83.El
84.Pp
85After all components of a large program have been compiled a file
86.Pa xs.c
87declaring the common
88.Nm
89space can be created by a command of the form
90.Bd -literal -offset indent
91xstr
92.Ed
93.Pp
94The file
95.Pa xs.c
96should then be compiled and loaded with the rest
97of the program.
98If possible, the array can be made read-only (shared) saving
99space and swap overhead.
100.Pp
| 63.Ar file
64or the standard input
65.Pq Fl ,
66replacing
67string references by expressions of the form (&xstr[number])
68for some number.
69An appropriate declaration of
70.Nm
71is prepended to the file.
72The resulting C text is placed in the file
73.Pa x.c ,
74to then be compiled.
75The strings from this file are placed in the
76.Pa strings
77data base if they are not there already.
78Repeated strings and strings which are suffixes of existing strings
79do not cause changes to the data base.
80.It Fl v
81Verbose mode.
82.El
83.Pp
84After all components of a large program have been compiled a file
85.Pa xs.c
86declaring the common
87.Nm
88space can be created by a command of the form
89.Bd -literal -offset indent
90xstr
91.Ed
92.Pp
93The file
94.Pa xs.c
95should then be compiled and loaded with the rest
96of the program.
97If possible, the array can be made read-only (shared) saving
98space and swap overhead.
99.Pp
|
101.Nm Xstr
102can also be used on a single file.
| 100The
101.Nm
102utility can also be used on a single file.
|
103A command
104.Bd -literal -offset indent
105xstr name
106.Ed
107.Pp
108creates files
109.Pa x.c
110and
111.Pa xs.c
112as before, without using or affecting any
113.Pa strings
114file in the same directory.
115.Pp
116It may be useful to run
117.Nm
118after the C preprocessor if any macro definitions yield strings
119or if there is conditional code which contains strings
120which may not, in fact, be needed.
121An appropriate command sequence for running
122.Nm
123after the C preprocessor is:
124.Pp
125.Bd -literal -offset indent -compact
126cc \-E name.c | xstr \-c \-
127cc \-c x.c
128mv x.o name.o
129.Ed
130.Pp
| 103A command
104.Bd -literal -offset indent
105xstr name
106.Ed
107.Pp
108creates files
109.Pa x.c
110and
111.Pa xs.c
112as before, without using or affecting any
113.Pa strings
114file in the same directory.
115.Pp
116It may be useful to run
117.Nm
118after the C preprocessor if any macro definitions yield strings
119or if there is conditional code which contains strings
120which may not, in fact, be needed.
121An appropriate command sequence for running
122.Nm
123after the C preprocessor is:
124.Pp
125.Bd -literal -offset indent -compact
126cc \-E name.c | xstr \-c \-
127cc \-c x.c
128mv x.o name.o
129.Ed
130.Pp
|
131.Nm Xstr
132does not touch the file
| 131The
132.Nm
133utility does not touch the file
|
133.Pa strings
134unless new items are added, thus
135.Xr make 1
136can avoid remaking
137.Pa xs.o
138unless truly necessary.
139.Sh FILES
140.Bl -tag -width /tmp/xsxx* -compact
141.It Pa strings
142Data base of strings
143.It Pa x.c
144Massaged C source
145.It Pa xs.c
146C source for definition of array `xstr'
147.It Pa /tmp/xs*
148Temp file when `xstr name' doesn't touch
149.Pa strings
150.El
151.Sh SEE ALSO
152.Xr mkstr 1
153.Sh BUGS
154If a string is a suffix of another string in the data base,
155but the shorter string is seen first by
156.Nm
157both strings will be placed in the data base, when just
158placing the longer one there will do.
159.Sh HISTORY
160The
161.Nm
162command appeared in
163.Bx 3.0 .
| 134.Pa strings
135unless new items are added, thus
136.Xr make 1
137can avoid remaking
138.Pa xs.o
139unless truly necessary.
140.Sh FILES
141.Bl -tag -width /tmp/xsxx* -compact
142.It Pa strings
143Data base of strings
144.It Pa x.c
145Massaged C source
146.It Pa xs.c
147C source for definition of array `xstr'
148.It Pa /tmp/xs*
149Temp file when `xstr name' doesn't touch
150.Pa strings
151.El
152.Sh SEE ALSO
153.Xr mkstr 1
154.Sh BUGS
155If a string is a suffix of another string in the data base,
156but the shorter string is seen first by
157.Nm
158both strings will be placed in the data base, when just
159placing the longer one there will do.
160.Sh HISTORY
161The
162.Nm
163command appeared in
164.Bx 3.0 .
|