texinfo-doc-nonfree 4.13a-1 / usr / share / doc / texinfo / html / Debugging-with-TeX.html

This file is indexed.

/usr/share/doc/texinfo/html/Debugging-with-TeX.html is in texinfo-doc-nonfree 4.13a-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<html lang="en">
<head>
<title>Debugging with TeX - GNU Texinfo 4.13</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Texinfo 4.13">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Catching-Mistakes.html#Catching-Mistakes" title="Catching Mistakes">
<link rel="prev" href="Debugging-with-Info.html#Debugging-with-Info" title="Debugging with Info">
<link rel="next" href="Using-texinfo_002dshow_002dstructure.html#Using-texinfo_002dshow_002dstructure" title="Using texinfo-show-structure">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual is for GNU Texinfo (version 4.13, 18 September 2008),
a documentation system that can produce both online information and a
printed manual from a single source.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
Free Software Foundation, Inc.

     Permission is granted to copy, distribute and/or modify this
     document under the terms of the GNU Free Documentation License,
     Version 1.2 or any later version published by the Free Software
     Foundation; with no Invariant Sections, with the Front-Cover Texts
     being ``A GNU Manual'', and with the Back-Cover Texts as in (a)
     below.  A copy of the license is included in the section entitled
     ``GNU Free Documentation License.''

     (a) The FSF's Back-Cover Text is: ``You are free to copy and modify
     this GNU Manual.  Buying copies from GNU Press supports the FSF in
     developing GNU and promoting software freedom.''
  -->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<a name="Debugging-with-TeX"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Using-texinfo_002dshow_002dstructure.html#Using-texinfo_002dshow_002dstructure">Using texinfo-show-structure</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Debugging-with-Info.html#Debugging-with-Info">Debugging with Info</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Catching-Mistakes.html#Catching-Mistakes">Catching Mistakes</a>
<hr>
</div>

<!-- node-name,  next,  previous,  up -->
<h3 class="section">F.3 Catching Errors with TeX Formatting</h3>

<p><a name="index-Catching-errors-with-_0040TeX_007b_007d-formatting-1461"></a><a name="index-Debugging-with-_0040TeX_007b_007d-formatting-1462"></a>
You can also catch mistakes when you format a file with TeX.

  <p>Usually, you will want to do this after you have run
<code>texinfo-format-buffer</code> (or, better, <code>makeinfo-buffer</code>) on
the same file, because <code>texinfo-format-buffer</code> sometimes displays
error messages that make more sense than TeX.  (See <a href="Debugging-with-Info.html#Debugging-with-Info">Debugging with Info</a>, for more information.)

  <p>For example, TeX was run on a Texinfo file, part of which is shown
here:

<pre class="example">     ---------- Buffer: texinfo.texi ----------
     name of the Texinfo file as an extension.  The
     @samp{??} are `wildcards' that cause the shell to
     substitute all the raw index files.  (@xref{sorting
     indices, for more information about sorting
     indices.)@refill
     ---------- Buffer: texinfo.texi ----------
</pre>
  <p class="noindent">(The cross reference lacks a closing brace.) 
TeX produced the following output, after which it stopped:

<pre class="example">     ---------- Buffer: *tex-shell* ----------
     Runaway argument?
     {sorting indices, for more information about sorting
     indices.) @refill @ETC.
     ! Paragraph ended before @xref was complete.
     &lt;to be read again&gt;
                       @par
     l.27
     
     ?
     ---------- Buffer: *tex-shell* ----------
</pre>
  <p>In this case, TeX produced an accurate and
understandable error message:

<pre class="example">     Paragraph ended before @xref was complete.
</pre>
  <p class="noindent">&lsquo;<samp><span class="samp">@par</span></samp>&rsquo; is an internal TeX command of no relevance to Texinfo. 
&lsquo;<samp><span class="samp">l.27</span></samp>&rsquo; means that TeX detected the problem on line 27 of the
Texinfo file.  The &lsquo;<samp><span class="samp">?</span></samp>&rsquo; is the prompt TeX uses in this
circumstance.

  <p>Unfortunately, TeX is not always so helpful, and sometimes you must
truly be a Sherlock Holmes to discover what went wrong.

  <p>In any case, if you run into a problem like this, you can do one of three
things.

     <ol type=1 start=1>
<li>You can tell TeX to continue running and ignore just this error by
typing &lt;RET&gt; at the &lsquo;<samp><span class="samp">?</span></samp>&rsquo; prompt.

     <li>You can tell TeX to continue running and to ignore all errors as best
it can by typing <kbd>r &lt;RET&gt;</kbd> at the &lsquo;<samp><span class="samp">?</span></samp>&rsquo; prompt.

     <p>This is often the best thing to do.  However, beware: the one error
may produce a cascade of additional error messages as its consequences
are felt through the rest of the file.  To stop TeX when it is
producing such an avalanche of error messages, type <kbd>C-c</kbd> (or
<kbd>C-c C-c</kbd>, if you are running a shell inside Emacs).

     <li>You can tell TeX to stop this run by typing <kbd>x &lt;RET&gt;</kbd>
at the &lsquo;<samp><span class="samp">?</span></samp>&rsquo; prompt.
       </ol>

  <p>If you are running TeX inside Emacs, you need to switch to the shell
buffer and line at which TeX offers the &lsquo;<samp><span class="samp">?</span></samp>&rsquo; prompt.

  <p>Sometimes TeX will format a file without producing error messages even
though there is a problem.  This usually occurs if a command is not ended
but TeX is able to continue processing anyhow.  For example, if you fail
to end an itemized list with the <code>@end itemize</code> command, TeX will
write a DVI file that you can print out.  The only error message that
TeX will give you is the somewhat mysterious comment that

<pre class="example">     (@end occurred inside a group at level 1)
</pre>
  <p class="noindent">However, if you print the DVI file, you will find that the text
of the file that follows the itemized list is entirely indented as if
it were part of the last item in the itemized list.  The error message
is the way TeX says that it expected to find an <code>@end</code>
command somewhere in the file; but that it could not determine where
it was needed.

  <p>Another source of notoriously hard-to-find errors is a missing
<code>@end group</code> command.  If you ever are stumped by
incomprehensible errors, look for a missing <code>@end group</code> command
first.

  <p>If the Texinfo file lacks header lines,
TeX may stop in the
beginning of its run and display output that looks like the following. 
The &lsquo;<samp><span class="samp">*</span></samp>&rsquo; indicates that TeX is waiting for input.

<pre class="example">     This is TeX, Version 3.14159 (Web2c 7.0)
     (test.texinfo [1])
     *
</pre>
  <p class="noindent">In this case, simply type <kbd>\end &lt;RET&gt;</kbd> after the asterisk.  Then
write the header lines in the Texinfo file and run the TeX command
again. (Note the use of the backslash, &lsquo;<samp><span class="samp">\</span></samp>&rsquo;.  TeX uses &lsquo;<samp><span class="samp">\</span></samp>&rsquo;
instead of &lsquo;<samp><span class="samp">@</span></samp>&rsquo;; and in this circumstance, you are working
directly with TeX, not with Texinfo.)

  </body></html>

APT Browse - Built by Thomas Orozco.