Google
 

Trailing-Edge - PDP-10 Archives - BB-J710A-BM - tools/dsr/ndxdmp.doc
There is 1 other file named ndxdmp.doc in the archive. Click here to see a list.


                    Notes for NDXDMP, version 1(01)





1.0  INTRODUCTION

NDXDMP is a    DSR-related utility program that is used to  help  verify
an  index.   You  can use NDXDMP to examine the contents of a .BIX file.
It serves the same purpose as saying /DEBUG:INDEX, except that

      o  You don't need to make an extra    DSR pass.

      o  It's a bit more precise in showing page numbers near the bottom
         of pages than is /DEBUG:INDEX

      o  The generated report is easier to read  than  is  a  .MEM  file
         generated via /DEBUG:INDEX


To generate input for NDXDMP specify the /INDEX  switch  on  the     DSR
command line.  See the description of the /INDEX switch that is supplied
with the new    DSR.

In order to use this version of NDXDMP, you need the new    DSR, version
1(53)  or  newer.   Other     DSRs  cannot  generate the input needed by
NDXDMP.

By definition, you see only "traditional" style page numbers.  I.e.,  it
is not possible to see running page numbers.



2.0  OPERATION

Use the /INDEX switch of    DSR to generate  a  binary  index  for  your
document.  Then run NDXDMP.  When NDXDMP requests the name of your input
file, respond with the name of your .BIX file.  NDXDMP  assumes  a  file
type of .BIX, unless you specify otherwise.  Output is always written to
a file of type .XMP having the same name as that of the input file.

For example, suppose you said
                               DSR ABC/INDEX
Then the binary index file is called ABC.BIX.  When NDXDMP asks for  the
name of your input specify either just ABC (in which case NDXDMP assumes
.BIX) or you can specify .BIX in addition.




3.0  CREATING A MASTER INDEX

NDXDMP  allows  you  to  segment  your  document,     DSR  each  section
separately,  and then dump the master index later.  To do this, generate
the .BIX files as usual.  Then append the binary index files together in
the same order in which you would arrange the segments of your document.
Then proceed as if you had just a single .BIX file to process.



3.1  Output Processing

NDXDMP generates a file with file type .XMP which is to be  printed,  or
processed just like any type of text file.



4.0  RESTRICTIONS

This version  of  NDXDMP  does  not  have  a  "standard"  command  line.
Further,  there  are  no command line switches.  And you cannot override
the name or type of the output file generated.



5.0  MESSAGES AND HINTS

NDXDMP contains few error messages.  All I/O error messages cause NDXDMP
to  terminate.   In addition, the message 'CONFUSED' is output if NDXDMP
doesn't like the looks of your BIX file.

NDXDMP also knows whether  or  not  it  can  understand  the  .BIX  file
generated by your particular version of    DSR.  If you get the message

               INCOMPATIBLE VERSIONS OF RUNOFF AND NDXDMP

you are trying to get NDXDMP to process a .BIX file that is not  in  the
desired format;  the results are undefined.



[End of NDXDMP.RND]