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