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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)mkstr.1     8.1 (Berkeley) 6/6/93
  29 .\"
  30 .Dd June 6, 2015
  31 .Dt MKSTR 1
  32 .Os
  33 .Sh NAME
  34 .Nm mkstr
  35 .Nd create an error message file by massaging C source
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl
  39 .Ar mesgfile
  40 .Ar prefix Ar
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 utility creates a file containing error messages extracted from C source,
  45 and restructures the same C source, to utilize the created error message
  46 file.
  47 The intent of
  48 .Nm
  49 was to reduce the size of large programs and
  50 reduce swapping (see
  51 .Sx BUGS
  52 section below).
  53 .Pp
  54 The
  55 .Nm
  56 utility processes each of the specified files,
  57 placing a restructured version of the input in a file whose name
  58 consists of the specified
  59 .Ar prefix
  60 and the original name.
  61 A typical usage of
  62 .Nm
  63 is
  64 .Pp
  65 .Dl "mkstr pistrings xx *.c"
  66 .Pp
  67 This command causes all the error messages from the C source
  68 files in the current directory to be placed in the file
  69 .Pa pistrings
  70 and restructured copies of the sources to be placed in
  71 files whose names are prefixed with
  72 .Dq Li xx .
  73 .Pp
  74 Options:
  75 .Bl -tag -width indent
  76 .It Fl
  77 Error messages are placed at the end of the specified
  78 message file for recompiling part of a large
  79 .Nm Ns ed
  80 program.
  81 .El
  82 .Pp
  83 The
  84 .Nm
  85 utility finds error messages in the source by
  86 searching for the string
  87 .Sq Li error("
  88 in the input stream.
  89 Each time it occurs, the C string starting at the
  90 .Ql \&"
  91 is stored
  92 in the message file followed by a null character and a new-line character;
  93 The new source is restructured with
  94 .Xr lseek 2
  95 pointers into the error message file for retrieval.
  96 .Bd -literal -offset indent
  97 char efilname = "/usr/lib/pi_strings";
  98 int efil = -1;
  99
 100 error(a1, a2, a3, a4)
 101 {
 102         char buf[256];
 103
 104         if (efil < 0) {
 105                 efil = open(efilname, 0);
 106                 if (efil < 0)
 107                         err(1, "%s", efilname);
 108         }
 109         if (lseek(efil, (off_t)a1, SEEK_SET) < 0 ||
 110             read(efil, buf, 256) <= 0)
 111                 err(1, "%s", efilname);
 112         printf(buf, a2, a3, a4);
 113 }
 114 .Ed
 115 .Sh SEE ALSO
 116 .Xr gencat 1 ,
 117 .Xr xstr 1 ,
 118 .Xr lseek 2
 119 .Sh HISTORY
 120 The
 121 .Nm
 122 utility first appeared in
 123 .Bx 1 .
 124 .Sh AUTHORS
 125 .An -nosplit
 126 .An Bill Joy
 127 and
 128 .An Chuck Haley ,
 129 1977.
 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 memory savings are negligible in modern computers.