Na}{

File Content: `debug.html`

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head>
<link rel=stylesheet type="text/css" href="anlgdocs.css">
<LINK REL="SHORTCUT ICON" HREF="favicon.ico">
<title>Readme for analog -- debugging</title>
</head>

<body>
[ <a href="Readme.html">Top</a> | <a href="custom.html">Up</a> |
<a href="lowmem.html">Prev</a> | <a href="form.html">Next</a> |
<a href="map.html">Map</a> | <a href="indx.html">Index</a> ]
<h1><img src="analogo.gif" alt=""> Analog 6.0: Debugging</h1>
<hr size=2 noshade>

This section lists commands to help you debug analog, if you think it's
going wrong. There's another section later which lists all the
<a href="errors.html">errors and warnings</a> which analog can generate,
and what they all mean, and another section which tells you
<a href="mailing.html">how to report bugs</a>.

<p>
First, remember the option we mentioned before, to list the current settings
of all of analog's variables. To get this, just put <kbd>-settings</kbd> on
the command line, or <kbd>SETTINGS ON</kbd> in one of your configuration
files, along with your other commands. Then analog will produce the list of
settings instead of running in the normal way.

<hr size=1 noshade>
<a name="debugs">There are commands</a> which control how much debugging
information and warning
information analog gives out while it is running. By default you get all the
warnings and no debugging, but you can change this by means of the commands
<kbd>DEBUG</kbd> and <kbd>WARNINGS</kbd>. If you say
<pre>
DEBUG ON
</pre>
you get all the debugging. (And <kbd>DEBUG OFF</kbd> turns it all off.)
You can also get just certain categories of debugging. The categories are
<dl compact>
  <dt><kbd>C</kbd><dd>list all corrupt logfile lines
  <dt><kbd>D</kbd><dd>information about DNS lookups
  <dt><kbd>F</kbd><dd>information about file opening and closing
  <dt><kbd>S</kbd><dd>summary information about each logfile when it's closed
  <dt><kbd>U</kbd><dd>list unknown domains
  <dt><kbd>V</kbd><dd>list hosts without a domain (i.e., without a dot)
</dl>
So, for example, the command
<pre>
DEBUG FS
</pre>
would give you information about file opening and closing, and what was in
each logfile, but none of the other sorts of debugging. Each line of debugging
information is prepended with its code letter. You can also specify
<pre>
DEBUG +CD
</pre>
to add <kbd>C</kbd> and <kbd>D</kbd> category debugging to whatever you've
already got, and
<pre>
DEBUG -CD
</pre>
to remove those two categories.
<p>
There is also a command line abbreviation for this command. Use
<kbd>+V</kbd> (for <kbd>ON</kbd>), <kbd>-V</kbd> (for <kbd>OFF</kbd>),
<kbd>+VFS</kbd> (to select exactly options <kbd>FS</kbd>), <kbd>+V+FS</kbd>
(to add those options), and <kbd>+V-FS</kbd> (to remove them).
<p>
The <kbd>C</kbd> messages actually come on two lines. The first line gives the
logfile line which was corrupt. The second line indicates where analog first
noticed a problem. (This is usually, but not always, close to where the
problem
actually was!) In fact, each &quot;line&quot; of the message may spread over
more than one line on your screen, and you have to be careful to take that into
account when trying to find out where the logfile line was corrupt.
<hr size=1 noshade>
<a name="WARNINGS">The <kbd>WARNINGS</kbd></a> command acts similarly to the
<kbd>DEBUG</kbd> command (see the syntax <a href="#debugs">above</a>). By
default all warnings are on. As well as <kbd>WARNINGS ON</kbd> and
<kbd>WARNINGS OFF</kbd>, you can turn warnings on and off in the following
categories.
<dl compact>
  <dt><kbd>C</kbd><dd>invalid configuration specified
  <dt><kbd>D</kbd><dd>dubious configuration specified
  <dt><kbd>E</kbd><dd><kbd>ERRFILE</kbd> command used (see below)
  <dt><kbd>F</kbd><dd>files missing or corrupt
  <dt><kbd>L</kbd><dd>apparent problems in logfiles
  <dt><kbd>M</kbd><dd>possible problems in logfiles
  <dt><kbd>R</kbd><dd>turning off empty reports
</dl>
See the section on <cite><a href="errors.html#warns">Errors and
warnings</a></cite> for more details about the various categories. Again,
warnings are printed with their code letters.
<p>
Warnings range from the probably harmless to the usually serious.
So it is generally not a good idea to turn all warnings off, or you might miss
some important information. If you want to ignore a particular warning, turn
just its category off.
<p>
There is also a command line version of the <kbd>WARNINGS</kbd> command,
looking like <kbd>+q</kbd>, <kbd>-q</kbd>, <kbd>+q&lt;options&gt;</kbd>,
<kbd>+q+&lt;options&gt;</kbd> or <kbd>+q-&lt;options&gt;</kbd>. (The syntax is
the same as the <kbd>+V</kbd> command <a href="#debugs">above</a>.)
<hr size=1 noshade>
<a name="ERRFILE">By default</a> all these messages go to <i>standard
error</i>, which is
normally just the screen. But you can change that by means of a command like
<pre>
ERRFILE newfile
</pre>
If you do this, analog will warn you that it's redirecting the messages, just
so that you don't miss any. To change back to standard error, use
<pre>
ERRFILE stderr
</pre>
The <kbd>ERRFILE</kbd> command will also erase any previous contents of that
file. (So don't use the same <kbd>ERRFILE</kbd> command twice, or you may lose
messages!)
If the name of the <kbd>ERRFILE</kbd> doesn't include a directory, it will be
put in whichever directory was specified for that purpose when the program was
compiled. For example, on Windows it would be in the same folder as the analog
executable.

<hr size=1 noshade>
<a name="ERRLINELENGTH">There is a command</a> called <kbd>ERRLINELENGTH</kbd>
to tell analog the width of screen you want these messages to fit in. As a
special case,
<pre>
ERRLINELENGTH 0
</pre>
specifies an unlimited screen width.

<hr size=1 noshade>
<a name="PROGRESSFREQ">There is one more command</a> which is useful when
trying to debug analog. If you give the command
<pre>
PROGRESSFREQ 20000  # say
</pre>
then analog will produce a little message after every 20,000 lines it reads
from the logfile. (This message is sent to the screen and to the
<kbd><a href="#ERRFILE">ERRFILE</a></kbd>.) This is useful to determine
whether the program has really stopped or (as is more likely) is just being
slow for some reason (such as using DNS lookups).

<hr size=1 noshade>
There is just one more section about analog's configuration commands and
command line arguments, but it's a rather long one, on the
<a href="form.html">form interface</a>. (This is a way of running analog by
selecting options from a web page.) You might prefer to go straight onto the
section on <cite><a href="meaning.html">What the results mean</a></cite>.
<hr size=2 noshade>
Go to the <a href="http://www.analog.cx/">analog home page</a>.
<p>
<address>Stephen Turner
<br>19 December 2004</address>
<p><em>Need help with analog? <a href="mailing.html">Use the analog-help
mailing list</a>.</em>
<p>
[ <a href="Readme.html">Top</a> | <a href="custom.html">Up</a> |
<a href="lowmem.html">Prev</a> | <a href="form.html">Next</a> |
<a href="map.html">Map</a> | <a href="indx.html">Index</a> ]
</body> </html>

Name	Size	Permission
LicBSD.txt	1802 bytes	0644
Licbzip2.txt	1738 bytes	0644
Licgd.txt	2252 bytes	0644
Licpcre.txt	1044 bytes	0644
Licpng.txt	2413 bytes	0644
Licunzip.txt	1323 bytes	0644
Liczlib.txt	1721 bytes	0644
Readme.html	3614 bytes	0644
acknow.html	8406 bytes	0644
alias.html	10421 bytes	0644
analogo.gif	567 bytes	0644
anlgdocs.css	147 bytes	0644
args.html	9484 bytes	0644
bara8.gif	50 bytes	0644
barb1.gif	67 bytes	0644
barb32.gif	165 bytes	0644
barb8.gif	100 bytes	0644
barc8.gif	145 bytes	0644
bard8.gif	76 bytes	0644
bare8.gif	142 bytes	0644
barf8.gif	76 bytes	0644
barg8.gif	175 bytes	0644
barh8.gif	194 bytes	0644
bari8.gif	103 bytes	0644
barj8.gif	185 bytes	0644
basiccmd.html	8068 bytes	0644
cache.html	9734 bytes	0644
compout.html	6292 bytes	0644
custom.html	2787 bytes	0644
debug.html	7100 bytes	0644
defns.html	7433 bytes	0644
dns.html	6512 bytes	0644
domfile.html	4262 bytes	0644
errors.html	16607 bytes	0644
faq.html	50854 bytes	0644
favicon.ico	1078 bytes	0644
form.html	23914 bytes	0644
helpers.html	1782 bytes	0644
hierreps.html	8045 bytes	0644
include.html	14135 bytes	0644
indx.html	38439 bytes	0644
logfile.html	17720 bytes	0644
logfmt.html	18207 bytes	0644
lowmem.html	4007 bytes	0644
mailing.html	8190 bytes	0644
map.html	3293 bytes	0644
meaning.html	1867 bytes	0644
othreps.html	17768 bytes	0644
output.html	23199 bytes	0644
quickref.html	41087 bytes	0644
reports.html	15416 bytes	0644
start.html	2200 bytes	0644
startmac.html	3752 bytes	0644
startpc.html	4398 bytes	0644
startux.html	5807 bytes	0644
syntax.html	7266 bytes	0644
timereps.html	7710 bytes	0644
update.html	25983 bytes	0644
wasnew1.html	5630 bytes	0644
wasnew2.html	7982 bytes	0644
wasnew3.html	12779 bytes	0644
wasnew4.html	10921 bytes	0644
wasnew5.html	16667 bytes	0644
webworks.html	14106 bytes	0644
whatsnew.html	4424 bytes	0644

File Content: debug.html

File Content: `debug.html`