usr.bin/mkstr/mkstr.1

   1 .\" Copyright (c) 1980, 1990, 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 .\"     @(#)mkstr.1     8.1 (Berkeley) 6/6/93
  33 .\" $FreeBSD: src/usr.bin/mkstr/mkstr.1,v 1.7.2.3 2002/07/15 07:10:07 keramida Exp $
  34 .\"
  35 .Dd June 6, 1993
  36 .Dt MKSTR 1
  37 .Os
  38 .Sh NAME
  39 .Nm mkstr
  40 .Nd create an error message file by massaging C source
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl
  44 .Ar messagefile
  45 .Ar prefix Ar
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility creates files containing error messages extracted from C source,
  50 and restructures the same C source, to utilize the created error message
  51 file.
  52 The intent of
  53 .Nm
  54 was to reduce the size of large programs and
  55 reduce swapping (see
  56 .Sx BUGS
  57 section below).
  58 .Pp
  59 The
  60 .Nm
  61 utility processes each of the specified
  62 .Ar files ,
  63 placing a restructured version of the input in a file whose name
  64 consists of the specified
  65 .Ar prefix
  66 and the original name.
  67 A typical usage of
  68 .Nm
  69 is
  70 .Bd -literal -offset indent
  71 mkstr pistrings xx *.c
  72 .Ed
  73 .Pp
  74 This command causes all the error messages from the C source
  75 files in the current directory to be placed in the file
  76 .Ar pistrings
  77 and restructured copies of the sources to be placed in
  78 files whose names are prefixed with
  79 .Ar \&xx .
  80 .Pp
  81 Options:
  82 .Bl -tag -width indent
  83 .It Fl
  84 Error messages are placed at the end of the specified
  85 message file for recompiling part of a large
  86 .Nm Ns ed
  87 program.
  88 .El
  89 .Pp
  90 The
  91 .Nm
  92 utility finds error messages in the source by
  93 searching for the string
  94 .Li \&`error("'
  95 in the input stream.
  96 Each time it occurs, the C string starting at the
  97 .Sq \&"\&
  98 is stored
  99 in the message file followed by a null character and a new-line character;
 100 The new source is restructured with
 101 .Xr lseek 2
 102 pointers into the error message file for retrieval.
 103 .Bd -literal -offset indent
 104 char efilname = "/usr/lib/pi_strings";
 105 int efil = -1;
 106
 107 error(a1, a2, a3, a4)
 108 \&{
 109         char buf[256];
 110
 111         if (efil < 0) {
 112                 efil = open(efilname, 0);
 113                 if (efil < 0)
 114                         err(1, "%s", efilname);
 115         }
 116         if (lseek(efil, (off_t)a1, SEEK_SET) < 0 ||
 117             read(efil, buf, 256) <= 0)
 118                 err(1, "%s", efilname);
 119         printf(buf, a2, a3, a4);
 120 }
 121 .Ed
 122 .Sh SEE ALSO
 123 .Xr xstr 1 ,
 124 .Xr lseek 2
 125 .Sh HISTORY
 126 A
 127 .Nm
 128 utility appeared in
 129 .Bx 3.0 .
 130 .Sh BUGS
 131 The
 132 .Nm
 133 utility was intended for the limited architecture of the PDP 11 family.
 134 Very few programs actually use it.
 135 The Pascal interpreter,
 136 .Xr \&pi 1
 137 and the editor,
 138 .Xr \&ex 1
 139 are two programs that are built this way.
 140 It is not an efficient method, the error messages
 141 should be stored in the program text.