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$
  34 .\"
  35 .Dd November 1, 2002
  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 mesgfile
  45 .Ar prefix Ar
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility creates a file 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 files,
  62 placing a restructured version of the input in a file whose name
  63 consists of the specified
  64 .Ar prefix
  65 and the original name.
  66 A typical usage of
  67 .Nm
  68 is
  69 .Pp
  70 .Dl "mkstr pistrings xx *.c"
  71 .Pp
  72 This command causes all the error messages from the C source
  73 files in the current directory to be placed in the file
  74 .Pa pistrings
  75 and restructured copies of the sources to be placed in
  76 files whose names are prefixed with
  77 .Dq Li xx .
  78 .Pp
  79 Options:
  80 .Bl -tag -width indent
  81 .It Fl
  82 Error messages are placed at the end of the specified
  83 message file for recompiling part of a large
  84 .Nm Ns ed
  85 program.
  86 .El
  87 .Pp
  88 The
  89 .Nm
  90 utility finds error messages in the source by
  91 searching for the string
  92 .Sq Li error("
  93 in the input stream.
  94 Each time it occurs, the C string starting at the
  95 .Ql \&"
  96 is stored
  97 in the message file followed by a null character and a new-line character;
  98 The new source is restructured with
  99 .Xr lseek 2
 100 pointers into the error message file for retrieval.
 101 .Bd -literal -offset indent
 102 char efilname = "/usr/lib/pi_strings";
 103 int efil = -1;
 104
 105 error(a1, a2, a3, a4)
 106 {
 107         char buf[256];
 108
 109         if (efil < 0) {
 110                 efil = open(efilname, 0);
 111                 if (efil < 0)
 112                         err(1, "%s", efilname);
 113         }
 114         if (lseek(efil, (off_t)a1, SEEK_SET) < 0 ||
 115             read(efil, buf, 256) <= 0)
 116                 err(1, "%s", efilname);
 117         printf(buf, a2, a3, a4);
 118 }
 119 .Ed
 120 .Sh SEE ALSO
 121 .Xr gencat 1 ,
 122 .Xr xstr 1 ,
 123 .Xr lseek 2
 124 .Sh HISTORY
 125 An
 126 .Nm
 127 utility appeared in
 128 .Bx 3.0 .
 129 .Sh BUGS
 130 The
 131 .Nm
 132 utility was intended for the limited architecture of the PDP 11 family.
 133 Very few programs actually use it.
 134 The memory savings are negligible in modern computers.