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