up_menus - Update node links and menus in Texinfo documents
up_menus [-cdv] FILE
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.
@include
@inlcude
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.
@node
@chapter
@section
@appendix
A node can supply a menu description with a comment in the form:
@c DESC: Menu description
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.
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.
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).
Display usage information and exit.
Display version number and exit.
up_menus requires Getopt::Long 2.17 or later, which is distributed with recent versions of Perl.
up_menus cannot handle @include inside a menu.
Christopher J. Madsen <perl AT cjmweb.net>
<perl AT cjmweb.net>
Please report any bugs or feature requests to <bug-Texinfo-Menus AT rt.cpan.org>, or through the web interface at http://rt.cpan.org/Public/Bug/Report.html?Queue=Texinfo-Menus
<bug-Texinfo-Menus AT rt.cpan.org>
Copyright 1994-2007 Christopher J. Madsen. All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
To install Texinfo::Menus, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Texinfo::Menus
CPAN shell
perl -MCPAN -e shell install Texinfo::Menus
For more information on module installation, please visit the detailed CPAN module installation guide.