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