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