BSD 1 development

[unix-history] / man6 / mkstr.6

.th MKSTR VI 8/22/77
.sh NAME
mkstr \- create an error message file by massaging C source
.sh SYNOPSIS
.bd mkstr
[
.bd \-
]
message-file prefix file ...
.sh DESCRIPTION
.it Mkstr
is used to create files of error messages.
Its use can make programs with large numbers of error diagnostics much
smaller, and reduce system overhead in running the program as the
error messages do not have to be constantly swapped in and out.
.s3
.it Mkstr
will process each of the specified
.it files,
placing a massaged version of the input file in a file whose name
consists of the specified
.it prefix 
and the original name.
A typical usage of
.it mkstr
would be
.dt
.s3
	mkstr pi_strings temp/ *.c
.s3
This command would cause all the error messages from the C source
files in the current directory to be placed in the file
.it pi_strings
and processed copies of the source for these files to be placed in
the (existing) directory
.it temp.
.s3
To process the error messages in the source to the message file
.it mkstr
keys on the string
\%``error("''
in the input stream.
Each time it occurs, the C string starting at the `"' is placed
in the message file followed by a null character and a new-line character;
the null character terminates the message so it can be easily used
when retrieved, the new-line character makes it possible to sensibly
.it cat
the error message file to see its contents.
The massaged copy of the input file then contains a
.it seek
pointer into the file which can be used to retrieve the message, i.e.:
.s3
        \fBchar\fR efilname[] "/usr/lib/pi_strings";
        \fBint\fR efil -1;

        error(a1, a2, a3, a4)
        {
                char buf[256];

                \fBif\fR (efil < 0) {
                        efil = open(efilname, 0);
                        \fBif\fR (efil < 0) {
.br
oops:
                                perror(efilname);
                                exit(1);
                        }
                }
                \fBif\fR (seek(efil, a1, 0))
                        \fBgoto\fR oops;
                \fBif\fR (read(efil, buf, 256) <= 0)
                        \fBgoto\fR oops;
                printf(buf, a2, a3, a4);
        }
.s3
The optional
.bd \-
causes the error messages to be placed at the end of the specified
message file for recompiling part of a large
\fImkstr\fR\|ed
program.
.sh SEE\ ALSO
seek (II)
.sh AUTHORS
William Joy and Charles Haley
.sh BUGS