make generates a sequence of intermediate files in the process of creating an online document. Some are specific to individual source files; others are compilations of information generated from all the source files for a book. All of these files appear in your document directory. They are generated automatically as part of the online build process. However, by using different make commands, you can produce various sets of these files.

Error files list errors from the various intermediate files. For instructions on how to find and fix errors, see Chapter 6, “Debugging Bookbuild Errors.”

When you run a version of make that generates an online book, it produces a directory called ~/books/parent_directory/partnumber that contains the online version of the book. See “Viewing and Testing an Uninstalled Book” for instructions on how to view a built book.

As a first step in the debugging process, use the make book.full command to build the SGML files with full error reports. This does not produce a viewable book. Try to eliminate as many of the easy, obvious errors as you can before you try and view your book. After you've fixed the errors, you can build the viewable book using make book.

To run make book.full, follow this procedure:

The make book.full command converts your FrameMaker files into SGML and creates a complete error report file that you can use to “debug” your book. (Chapter 6, “Debugging Bookbuild Errors” explains how to do this.) This complete error report is called shortname.full, where shortname is the short_title of your book. make book.full usually takes between 30 seconds and 30 minutes to convert a new book, depending on the size and contents of the book.

It's rarely worth trying to rebuild the entire book every time you make a change. This takes time and CPU cycles, and in many cases the amount of noticeable change is minimal. A better strategy is clean up and rebuild files individually. This way, you can work on some files while others are building in the background.

The error report you need to produce is the .err file. To produce a .err file for a single source file, enter

make filename.err 

See Chapter 6, “Debugging Bookbuild Errors” for instructions on fixing errors.

make book.err produces concatenated files containing error information for entire books. This can be very helpful, but it can take some time if a number of your source files have changed and make has to go back and produce all the required intermediate files before creating your error report. Be sure you really want to do this rather than produce individual .err files.

---

Note: If you just want to see a concatenated version of all your .err files, use this command: more *.err. To save the output in a file, add > filename to the end of your command.

---

To produce a .err file for a book, enter

make book.err 

If you want to view your book online and aren't interested in the error reports:

This command builds the files needed to display your book in the IRIS InSight viewer. “Viewing and Testing an Uninstalled Book” explains how to view the book in IRIS InSight.

The last thing you should do is to run make book.full to verify that you have cleaned out all the errors in your book, then run make book to verify that your online book builds and that it looks the way you want it to. Chances are at least some (if not most) of your files have not been touched since you last built them (either individually or as part of a book build), and make is smart enough to use intermediate files if the source remains unchanged.

To build your book with make book.full:

As described in “Building the Localized Book,” European books are built from their FrameMaker source.

To build the book:

To install the book, follow the directions in “Installing a Localized Book for Testing”.

To set up the side-by-side test of a European manual against its English equivalent, follow the directions in “Preparing for Comparative Testing”.

As described in “Building the Localized Book,” Japanese books cannot be built from their FrameMaker source.

To install the book, follow the directions in “Installing a Localized Book for Testing”. To set up the side-by-side test of a Japanese manual against its English equivalent, following the directions in “Preparing for Comparative Testing”.

FrameMaker reports error -1 “File already locked by login @ machine on date
*** Error code 1
smake: 1 error

login is a login name (probably yours), machine is a machine name (probably yours), and date is a date (probably the current date). This means make book can't open one (or more) of the FrameMaker files because it's locked. Close all your FrameMaker files and try again. If you don't have any open FrameMaker files, look through your book directory and remove any files that end in .lck. Try make book again. Another possible problem could be that someone else has logged in to your machine and moved or opened your files.

========Building master SGML File========
cat: cannot open .sgml.tmp
*** Error code 2
---Shortname ---
cat: cannot open .sgml.tmp
***Error code 2
smake: 2 errors

Here, Shortname is the short_title of your book. This error message isn't quite so informative. If you get something like this, open your Makefile and look at the line that lists the short_title of the book. Look for extra spaces or punctuation. In this case, there is an extra space following the short name of the book. Make sure the short name listed here is the same as the directory name for your FrameMaker files.

"Makefile", line 16: Could not find /e/templates/make/commonbookdefs
"Makefile", line 51: Could not find include file '${COMMONBOOKRULES}'
Fatal errors encountered -- cannot continue

The online tools are not properly installed.

--- shortname.sgm.mif ---
starting maker ...
 
No call from FrameMaker after 360 seconds
Giving up.
maker: Using //e/frame/.fminit2.0.ps

---

Note: This example is not applicable to Japanese books.

---

Here, shortname is the short_title of your book. This message means that the tools can't start up FrameMaker. If you're running automount, that's probably your problem. Kill automount. Otherwise, it's probably your network connection to king. Make a copy of the /e/.env file, putting it in your home directory. Edit your new .env file, changing the FMHOME variable to point to your local copy of FrameMaker. Then, enter

source ~/.env 

Try to make the book again. If it's still unsuccessful, contact your production editor.