annotate docs/nitros9guide/printerr.refentry @ 1988:b96143206d83

Added more definitions as I have worked them out :)
author afra
date Mon, 30 Jan 2006 23:13:04 +0000
parents 4dae346c4969
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
1 <refentry id="printerr">
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
2 <refnamediv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
3 <refname>PRINTERR</refname>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
4 <refpurpose>Print Full Text Error Messages</refpurpose>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
5 </refnamediv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
6
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
7 <refsynopsisdiv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
8 <cmdsynopsis>
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1053
diff changeset
9 <command>printerr</command>
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
10 </cmdsynopsis>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
11 </refsynopsisdiv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
12
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
13 <refsect1><title>Description</title>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
14 <para>
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1053
diff changeset
15 This command replaces the basic OS-9 error printing routine (F$Perr
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
16 service request) which only prints error code numbers, with a
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
17 routine the reads and displays textual error messages from the file
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 138
diff changeset
18 <filename>/d0/SYS/errmsg</filename>. Printerr's effect is system-wide.
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
19 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
20 <para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
21 A standard error message file is supplied with OS-9. This file can
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
22 be edited or replaced by the system manager. The file is a normal
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
23 text file with variable length line. Each error message line begins
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
24 with the error number code (in ASCII characters), a delimiter, and
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
25 the error message text. The error messages need not be in any
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
26 particular order. Delimiters are spaces or any character numerically lower then
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
27 $20. Any line having a delimiter as its first
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1053
diff changeset
28 character is considered a continuation of the previous line(s) which
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
29 permits multi-line error messages.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
30 </para>
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1053
diff changeset
31 <warning>
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
32 <para>
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1053
diff changeset
33 Once the <command>printerr</command> command has been used,
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 138
diff changeset
34 it can not be undone. Once
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 138
diff changeset
35 installed, the <command>printerr</command> module should not be unlinked.
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 138
diff changeset
36 <command>Printerr</command> uses the current user's stack for an I/O buffer, so users
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
37 are encouraged to reserve reasonably large stacks.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
38 </para>
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1053
diff changeset
39 </warning>
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
40 <para>
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1053
diff changeset
41 For more information see: <xref linkend="sec4.7"/>, <xref linkend="sec6.2"/>.
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
42 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
43 </refsect1>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
44 <refsect1><title>Examples</title>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
45 <screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
46
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
47 OS9: printerr
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
48
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
49 </screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
50 </refsect1>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
51 </refentry>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
52