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