NAME

up_menus - Update node links and menus in Texinfo documents

SYNOPSIS

up_menus [-cdv] FILE

DESCRIPTION

up_menus updates the menus and node links in a Texinfo file based on its chapter structure. The FILE may use @include to include other files, which may also @inlcude other files. Unlike the similar Emacs functions, up_menus does not require that each chapter be in a separate file.

The first node in FILE should be named `Top'.

Each @node command must be followed immediately by a Texinfo structuring command (e.g, @chapter, @section, @appendix). A comment may come between them, but nothing else.

A node can supply a menu description with a comment in the form:

 @c DESC: Menu description

OPTIONS

-c, --nocomments

up_menus normally adds comments to the master menu to retain the descriptions of subsection and lesser nodes. (This is useful when the subfiles are automatically generated and the descriptions are added by hand.) The -c option prevents this.

-d, --nodetail

Normally, up_menus generates a detailed node listing (consisting of the section nodes for each chapter) following the master menu. The -d option omits the detailed node listing.

-v, --verbose

The -v option causes up_menus to generate a warning message if it finds multiple descriptions for a node (only one of which will be used).

-?, --help

Display usage information and exit.

--version

Display version number and exit.

REQUIREMENTS

up_menus requires Getopt::Long 2.17 or later, which is distributed with recent versions of Perl.

BUGS

up_menus cannot handle @include inside a menu.

AUTHOR

Christopher J. Madsen <cjm@pobox.com>