usr.bin/xstr/xstr.1

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