Commit | Line | Data |
---|---|---|
1c34e897 WJ |
1 | .\" Copyright (c) 1980, 1990 The Regents of the University of California. |
2 | .\" 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 6.6 (Berkeley) 5/9/91 | |
33 | .\" | |
34 | .Dd May 9, 1991 | |
35 | .Dt MKSTR 1 | |
36 | .Os | |
37 | .Sh NAME | |
38 | .Nm mkstr | |
39 | .Nd create an error message file by massaging C source | |
40 | .Sh SYNOPSIS | |
41 | .Nm mkstr | |
42 | .Op Fl | |
43 | .Ar messagefile | |
44 | .Ar prefix file ... | |
45 | .Sh DESCRIPTION | |
46 | .Nm Mkstr | |
47 | creates files containing error messages extracted from C source, | |
48 | and restructures the same C source, to utilize the created error message | |
49 | file. | |
50 | The intent of | |
51 | .Nm mkstr | |
52 | was to reduce the size of large programs and | |
53 | reduce swapping (see | |
54 | .Sx BUGS | |
55 | section below). | |
56 | .Pp | |
57 | .Nm Mkstr | |
58 | 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 mkstr | |
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 mkstr | |
84 | ed | |
85 | program. | |
86 | .El | |
87 | .Pp | |
88 | .Nm mkstr | |
89 | 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 | oops: | |
112 | perror(efilname); | |
113 | exit 1 ; | |
114 | } | |
115 | } | |
116 | if (lseek(efil, (long) a1, 0) \ read(efil, buf, 256) <= 0) | |
117 | goto oops; | |
118 | printf(buf, a2, a3, a4); | |
119 | } | |
120 | .Ed | |
121 | .Sh SEE ALSO | |
122 | .Xr lseek 2 , | |
123 | .Xr xstr 1 | |
124 | .Sh HISTORY | |
125 | .Nm Mkstr | |
126 | appeared in | |
127 | .Bx 3.0 . | |
128 | .Sh BUGS | |
129 | .Nm mkstr | |
130 | was intended for the limited architecture of the PDP 11 family. | |
131 | Very few programs actually use it. The pascal interpreter, | |
132 | .Xr \&pi 1 | |
133 | and the editor, | |
134 | .Xr \&ex 1 | |
135 | are two programs that are built this way. | |
136 | It is not an efficient method, the error messages | |
137 | should be stored in the program text. |