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