168 lines
4.5 KiB
Groff
168 lines
4.5 KiB
Groff
.\" Copyright (c) 1980, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" @(#)xstr.1 8.2 (Berkeley) 12/30/93
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd December 30, 1993
|
|
.Dt XSTR 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm xstr
|
|
.Nd "extract strings from C programs to implement shared strings"
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl cv
|
|
.Op Fl
|
|
.Op Ar
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
utility maintains a file
|
|
.Pa strings
|
|
into which strings in component parts of a large program are hashed.
|
|
These strings are replaced with references to this common area.
|
|
This serves to implement shared constant strings, most useful if they
|
|
are also read-only.
|
|
.Pp
|
|
The following options are available:
|
|
.Bl -tag -width indent
|
|
.It Fl
|
|
Read from the standard input.
|
|
.It Fl c
|
|
Extract the strings from the C source
|
|
.Ar file
|
|
or the standard input
|
|
.Pq Fl ,
|
|
replacing
|
|
string references by expressions of the form
|
|
.Li (&xstr[number])
|
|
for some
|
|
.Ar number .
|
|
An appropriate declaration of
|
|
.Va xstr
|
|
is prepended to the file.
|
|
The resulting C text is placed in the file
|
|
.Pa x.c ,
|
|
to then be compiled.
|
|
The strings from this file are placed in the
|
|
.Pa strings
|
|
data base if they are not there already.
|
|
Repeated strings and strings which are suffixes of existing strings
|
|
do not cause changes to the data base.
|
|
.It Fl v
|
|
Verbose mode.
|
|
.El
|
|
.Pp
|
|
After all components of a large program have been compiled a file
|
|
.Pa xs.c
|
|
declaring the common
|
|
.Va xstr
|
|
space can be created by a command of the form
|
|
.Pp
|
|
.Dl xstr
|
|
.Pp
|
|
The file
|
|
.Pa xs.c
|
|
should then be compiled and loaded with the rest
|
|
of the program.
|
|
If possible, the array can be made read-only (shared) saving
|
|
space and swap overhead.
|
|
.Pp
|
|
The
|
|
.Nm
|
|
utility can also be used on a single file.
|
|
A command
|
|
.Bd -literal -offset indent
|
|
xstr name
|
|
.Ed
|
|
.Pp
|
|
creates files
|
|
.Pa x.c
|
|
and
|
|
.Pa xs.c
|
|
as before, without using or affecting any
|
|
.Pa strings
|
|
file in the same directory.
|
|
.Pp
|
|
It may be useful to run
|
|
.Nm
|
|
after the C preprocessor if any macro definitions yield strings
|
|
or if there is conditional code which contains strings
|
|
which may not, in fact, be needed.
|
|
An appropriate command sequence for running
|
|
.Nm
|
|
after the C preprocessor is:
|
|
.Pp
|
|
.Bd -literal -offset indent -compact
|
|
cc -E name.c | xstr -c -
|
|
cc -c x.c
|
|
mv x.o name.o
|
|
.Ed
|
|
.Pp
|
|
The
|
|
.Nm
|
|
utility does not touch the file
|
|
.Pa strings
|
|
unless new items are added, thus
|
|
.Xr make 1
|
|
can avoid remaking
|
|
.Pa xs.o
|
|
unless truly necessary.
|
|
.Sh FILES
|
|
.Bl -tag -width ".Pa /tmp/xs*" -compact
|
|
.It Pa strings
|
|
data base of strings
|
|
.It Pa x.c
|
|
massaged C source
|
|
.It Pa xs.c
|
|
C source for definition of array
|
|
.Va xstr
|
|
.It Pa /tmp/xs*
|
|
temporary file when
|
|
.Dq Li "xstr name"
|
|
does not touch
|
|
.Pa strings
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr mkstr 1
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
command appeared in
|
|
.Bx 3.0 .
|
|
.Sh BUGS
|
|
If a string is a suffix of another string in the data base,
|
|
but the shorter string is seen first by
|
|
.Nm
|
|
both strings will be placed in the data base, when just
|
|
placing the longer one there will do.
|