pax_global_header00006660000000000000000000000064126326434750014526gustar00rootroot0000000000000052 comment=2f47fb0fda47ee12a17a172c3d6fdebae9f53a5d rubber-1.4/000077500000000000000000000000001263264347500126535ustar00rootroot00000000000000rubber-1.4/.gitignore000066400000000000000000000000771263264347500146470ustar00rootroot00000000000000Makefile settings.py *.pyc src/version.py build build-stamp in rubber-1.4/COPYING000066400000000000000000000431101263264347500137050ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. 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 PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. rubber-1.4/NEWS000066400000000000000000000307411263264347500133570ustar00rootroot00000000000000Version 1.4 (2015-12-11) This version of Rubber officially requires Python 2.6 and up. Note that the code has not been tested with Python 3, so if you run it under Python 3, you're on your own. Bug reports are welcome! Starting with 1.4, the primary repository at Launchpad is a Git tree. Features: - New distutils-based build & install scripts by Nicolas. - Report BibTeX / Biber errors more reliably. - We have support for embedding R code via knitr. http://yihui.name/knitr/ Closes: https://bugs.launchpad.net/rubber/+bug/1422759 Note that since R can run arbitrary external code, --unsafe must be given at the command line: rubber -d --unsafe paper.Rtex creates beautifully typeset PDF from your R script. - Support for PythonTeX package. Also requires --unsafe if you want Rubber to invoke pythontex. - Rubber will no longer attempt to use jpeg2ps on its own, which has been superseded by sam2p. (You can add it back by providing your own rules.ini.) Bugfixes: - Refuse to read logfiles which exceed 1 MB. This avoids out-of-memory situations. The limit may be raised with % rubber: set logfile_limit 1000000 https://bugs.launchpad.net/rubber/+bug/628150 - The command-line parsing of rubber and rubber-info has been merged. Thus, the --inplace and --into options are not only accepted by Rubber (as they were previously), they also take effect. Closes: https://bugs.launchpad.net/rubber/+bug/975376 - Rubber complains properly now for nonexisting directives, and doesn't just print a stacktrace. Closes: https://bugs.launchpad.net/rubber/+bug/1090115 - More refactoring, reducing the number of code paths to test and maintain. Version 1.3 (2015-10-11) This version of rubber has changes in the dependency management. As a result, it may call LaTeX more often than it used to. On the other hand, there are less corner cases when LaTeX or BibTeX should have been called, but wasn't. Thanks to Nicolas Boulenguez for helping with lots of patches. Features: - Rewriting dependency management code with the aims of simplicity, correctness and reduced lines of code. - Support for SyncTeX. You can enable SyncTeX support by calling rubber --synctex, or by having a magic line % rubber: synctex in your document's preamble. https://bugs.launchpad.net/rubber/+bug/414431 - Support for ltxtable, glossaries and biblatex, contributed by Sebastian Reichel. Please test and report any problems! https://bugs.launchpad.net/rubber/+bug/860661 - Support for asymptote, contributed by Nicolas Boulenguez. - Support for bibtopic, contributed by Nicolas Boulenguez. https://bugs.debian.org/460670 - The BibTeX support can now use a different version of BibTeX. The external command for Rubber to run goes into the .tool variable: For example: % rubber: bibtex.tool bibtex8 tells Rubber to use BibTeX8. https://bugs.debian.org/471185 - New directive: "produce" which implies that a file is being generated during LaTeXing and must be cleaned up afterwards. Example: % rubber: produce doc.toc Indicates that during LaTeXing, .toc will be written (produce). Example 2: % rubber: produce doc.toc % rubber: watch doc.toc Indicates that doc.toc will be read (watch) and updated (produce). This also tells rubber to recompile the LaTeX document until doc.toc no longer changes. "produce" implies "clean", i.e. the file will be disposed of when rubber is invoked with --clean. - Beginnings of a test suite. The current code does not pass all the tests (neither did previous Rubbers). Bugfixes: - Fix handling of absolute pathnames by not having absolute pathnames for the most part. https://bugs.debian.org/682892 https://bugs.debian.org/798829 https://bugs.debian.org/798991 - Fix bibtex.path directive. https://bugs.launchpad.net/rubber/+bug/686187 https://bugs.debian.org/694265 - Fix ntheorem support. https://bugs.debian.org/328107 - Fix TeX parser to handle spaces and comments between the macro and its arguments. More radical fix than Debian (https://bugs.debian.org/725355) https://bugs.launchpad.net/rubber/+bug/1049883 - Fix read directive. Patch by Lionel Vaux. https://bugs.debian.org/701898 - Fix dvipdfm, backref and hyperref support. - Fix \includegraphics* https://bugs.launchpad.net/rubber/+bug/1478034 - Fix elatex being called when etex.sty is use'd. https://bugs.launchpad.net/rubber/+bug/856449 - Typos and clarifications in the docs, lots of cleanup and minor fixes in the code. Version 1.2 (2015-06-25) Features: - shell_escape feature to enable -shell-escape in LaTeX. BEWARE: granting shell-escape (write18) to a document permits it to run arbitrary external commands. Use only on trusted (your own) documents! Usage: to mark a document as requiring shell-escape, add the line % rubber: shell_escape near the header. To grant shell-escape to a document, run rubber as rubber --unsafe document.tex There are several older hacks documented on the internet which continue to work, but are deprecated from now on. The 'arguments' variable will be removed in the future. https://bugs.launchpad.net/rubber/+bug/878629 - XeLaTeX support. https://bugs.launchpad.net/rubber/+bug/660426 https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=579757 - Support for gnuplottex (requires --unsafe) - Experimental PythonTeX support contributed by Ferdinand Schwenk (requires --unsafe). Bugfixes: - Fix handling of set{,list} arguments. - Fix BibTeX called with absolute path and refusing to write. https://bugs.launchpad.net/rubber/+bug/1287593 - Fix LaTeX parsing with optional whitespace https://bugs.launchpad.net/rubber/+bug/195258 - Fix behavior when .aux is not generated https://bugs.launchpad.net/rubber/+bug/1208464 https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=402150 - Catch broken working directory and print error https://bugs.launchpad.net/rubber/+bug/529198 - Fix LoadClassWithOptions https://bugs.launchpad.net/rubber/+bug/1266912 https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=718932 - Fix \pdfoutput=1 https://bugs.launchpad.net/rubber/+bug/921444 https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=691305 - Update homepage https://bugs.launchpad.net/rubber/+bug/1169485 - Fix crash on nonexisting directory https://bugs.launchpad.net/rubber/+bug/529198 - Fix CWEB and lhs2tex support which was broken. - Fix stdin being leaked to subprocesses, including LaTeX https://bugs.launchpad.net/rubber/+bug/802169 And many others... Version 1.1 (2006-03-17) Features: - Support for user-defined conversion rules. - Support for xindy and sam2p. - Improved fig2dev support. - Experimental cache system. Bugfixes: - Better parsing of log files. - Improved error reporting (including for BibTeX and Metapost). - Better handling of verbatim environments. - Many other fixes. Version 1.0 (2005-07-11) Features: - More intelligent graphics conversion rules. - New command-line options "--inplace" and "--into". - New command-line option "-W" to report warnings. - New command-line option "--only" for partial compilation. - A completion function for Zsh. Bugfixes: - Modules "index" and "verbatim" fixed. - Fixed path searching in Metapost. - Fixed paper size handling (in dvips, dvipdfm, ps2pdf). - Better handling of aux files from \include'd sources. Version 0.99.8 (2004-08-27) Features: - Support for e-TeX and Omega. - Support for package "index". - New directive "onchange". - Support for \includeonly. - Option --maxerr to display only the first errors. Bugfixes: - Portability improvement (for Cygwin and hopefully others). - Improved the semantics of directives. Version 0.99.7 (2004-02-20) Features: - Support for VTeX. - Directives "watch" and "clean" for tables of contents and such. - Support for graphics conversion using ImageMagick (lots of new formats). - Support for packages "moreverb", "verbatim", "hyperref", "beamer". - Support for post-processing through dvipdfm. - New frontend "rubber-pipe" with the behaviour of a filter. - New module "expand" to expand inputs and bibliographies. - Support for Literate Haskell code (with lhs2TeX). - Error messages are now issued in the style of GNU compilers. - Compilation by pdfTeX into DVI. - Gzipping of the final document, command-line option "-z". Bugfixes: - Error-like messages from pdfTeX are now correctly handled. - Modules are handled correctly when compiling several documents at once. - Better dependency analysis for MetaPost. - Macro arguments can now contain line breaks. Packaging: - Introduced Texinfo documentation. Version 0.99.6 (2003-04-09) Features: - Handling of \graphicspath. - Conversion of XFig figures to combined EPS/LaTeX. - Parsing of MetaPost log files for errors. - Automatic JPEG to EPS conversion (with jpeg2ps). - Support for packages "epsfig" and "natbib". - Rubber directives in source comments. - Directives for specifying paths for LaTeX and BibTeX. - Directives to control the operation of Makeindex. - Paper size specification (for dvips). Bugfixes: - The action "--deps" in rubber-info now lists each dependency only once. - Kpathsea messages are now reported also during compilation. - Avoided some crashes due to file name tracking in rubber-info. - Fixed and improved CWEB support. Version 0.99.5 (2002-12-04) Features: - New format in error and information display. - The command line now provides a meaningful return code. - New "--short" command-line switch for compact error reports. - New (default) action "--check" in rubber-info. - Parsing of BibTeX log files for errors. Bugfixes: - Made the calls to LaTeX and others more portable. - Better date computations (this caused useless compilations). - Avoid crash whith documents with cyclic file inclusion. - The action "--deps" now lists all files the document depends on. Version 0.99.4 (2002-11-06) Features: - Handle correctly multiple .aux files produced by \include. - Support for package "minitoc". - Extraction of bounding boxes from gzipped figures (eps.bb from eps.gz). - Watch for changes in .aux files to avoid useless recompilations. Bugfixes: - Behaves better when the execution of external programs fails. - Made the call to epstopdf(1) more portable. Miscellaneous: - Introduction of the RPM package. - External program execution now requires Unix-specific features. Version 0.99.3 (2002-10-12) Features: - New actions "--refs" and "--warnings" in rubber-info. - Support for XFig figures (with conversion to EPS, PDF and PNG). Bugfixes: - Display problem fixed in Metapost support. - Better parsing of \includegraphics (now handles keyval options). Version 0.99.2 (2002-09-06) Features: - Dependency analysis for Metapost. - New command-line switch "--force" to force recompiling. Bugfixes: - Parsing of starred macros. - Support for compilation of a document from a different directory. - Improved source file name tracking in log files. Packaging: - Included the man page for rubber-info. - Better dependencies for Debian. - Introduction of TODO and ChangeLog. Version 0.99.1 (2002-06-21) Features: - Initial support for "graphics" and "graphicx" (dependency analysis). - Allowed the processing of several documents with one command line. - Handling of the keyboard interrupt (control-C). - Source file name tracking for error reports. - Page number tracking in rubber-info. - Introduction of the modular support for graphics. Bugfixes: - Better error extraction from log files. - Allowed empty suffix for all graphics file names. - Better source searching algorithm. Packaging: - Introduced the Debian package. - Added the description of the modules in the man pages. Version 0.99 (2002-05-31) This was actually the first version of Rubber. It was a rewrite in Python of the now-deceased Eel (that was written in shell script). rubber-1.4/README000066400000000000000000000057041263264347500135410ustar00rootroot00000000000000This is Rubber. Rubber is a building system for LaTeX documents. It is based on a routine that runs just as many compilations as necessary and runs companion programs like BibTeX and Makeindex when needed. The module system provides a great flexibility that virtually allows support for any package with no user intervention, as well as pre- and post-processing of the document. A good number of standard packages are supported, including graphics/graphicx with automatic conversion between various graphics formats and Metapost compilation. The associated tool "rubber-info" extracts information, such as dependency relations or post-compilation diagnostics. * Installation Running Rubber just requires Python version 2.6 or newer. Of course it won't be of much use without a working LaTeX environment (Rubber is known to work on TeXLive and VTeX on various flavors of Unix including Darwin and Cygwin, any feedback is welcome about other systems). For compilation, you will need the Python Distutils, which are usually included in development packages (in Debian, this is the python-dev package). To build the documentation, you need texinfo (Debian package: texinfo). To compile and install Rubber, just follow the usual procedure: # python2 setup.py --help # python2 setup.py install # python2 setup.py clean --all Some useful options to setup.py include: Disabling info docs: # python2 setup.py build --info=False install and similar for --html, --man, --pdf. Changing the installation path for manpages: # python2 setup.py install --mandir=/path/to/man/pages Installing to a staging directory instead of the root/prefix: # python2 setup.py install --root=/staging/directory Note that if you need build and install to be two different steps (for example when building packages for distribution purposes), Python's distutils will forget about any 'build' options, and re-build with default options during the 'install' stage. This is worrysome if you'd like not to build some of the documentation. It is then best to make options permanent by putting them info a setup.cfg file. For example: [build] man = 1 html = 0 pdf = 0 info = 0 txt = 0 [install] prefix = /usr Finally, invoke # python2 setup.py build # python2 setup.py install --root=/staging/directory * Usage As civility requires, saying `rubber --help' and `rubber-info --help' provides a short description of the command line's syntax. The included manual pages (available in English and French) and Texinfo documentation contain more precise usage information. * Author Rubber was originally written by Emmanuel Beffara . It is currently maintained by Sebastian Kapfer . Its homepage can be found at https://launchpad.net/rubber. Thanks to all those who provided testing, comments and suggestions, and re-thanks to those who wrote patches and bugfixes. Any kind of feedback is appreciated, in order to make this program as useful, robust and powerful as possible. rubber-1.4/data/000077500000000000000000000000001263264347500135645ustar00rootroot00000000000000rubber-1.4/data/_rubber000066400000000000000000000054451263264347500151370ustar00rootroot00000000000000#compdef rubber rubber-pipe rubber-info # Original by Emmanuel Hainry # Updated by Emmanuel Beffara local _rubber_version _rubber_path _rubber_modules eval $(rubber --version | sed 's/^.* \([^ ]*\): */_rubber_\1=/') if [[ ${_rubber_version#0} != $_rubber_version ]]; then _rubber_modules=( $(ls $_rubber_path/rubber/modules | sed -n 's/^\([^_].*\)\.py$/\1/p') ) else _rubber_modules=( $(ls $_rubber_path/modules | sed -n 's/.rub$//p') $(ls $_rubber_path/rubber/rules/latex | sed -n 's/^\([^_].*\)\.py$/\1/p') ) fi _rubber_arguments () { _arguments -s \ \*{-c,--command}'=[run the directive CMD before parsing]:command' \ \*{-e,--epilogue}'=[run the directive CMD after parsing]:command' \ {-z,--gzip}'[compress the final document]' \ '(- *)'{-h,--help}'[show help]' \ '--into=[go to directory DIR before compiling]:directory:_files -/' \ {-l,--landscape}'[change paper orientation (if relevant)]' \ {-n,--maxerr}'=[display at most NUM errors]:num' \ \*{-m,--module}'=[use module]:module:($_rubber_modules)' \ '--only=[only include the specified SOURCES]:sources' \ \*{-o,--post}'=[postprocess with module]:postprocessor:($_rubber_modules)' \ {-d,--pdf}'[produce PDF output instead of DVI]' \ {-p,--ps}'[produce a PostScript document]' \ {-q,--quiet}'[suppress messages]' \ \*{-r,--read}'[read additional directives from a file]:directives files:_files' \ {-s,--short}'[display errors in a compact form]' \ \*{-I,--texpath}'=[add DIR to the search path for LaTeX]:tex path:_files -/' \ \*{-v,--verbose}'[increase verbosity]' \ '--version[print version information and exit]' "$@" } case "$service" in rubber) _rubber_arguments \ '--clean[remove produced files instead of compiling]' \ {-f,--force}'[force at least one compilation]' \ '--inplace[compile the documents from their source directory]' \ \*{-W,--warn}'=[report warnings of the given TYPE]:warnings:(all boxes misc refs)' \ '*:LaTeX files:_files -g \*.\(tex\|dtx\|lhs\|w\)' return 0 ;; rubber-pipe) _rubber_arguments \ {-k,--keep}'[keep the temporary files after compiling]' \ \*{-W,--warn}'=[report warnings of the given TYPE]:warnings:(all boxes misc refs)' return 0 ;; rubber-info) _rubber_arguments \ '--boxes[report overfull and underfull boxes]' \ '--check[report errors or warnings default action]' \ '--deps[show the target file s dependencies]' \ '--errors[show all errors that occured during compilation]' \ '--refs[show the list of undefined references]' \ '--warnings[show all LaTeX warnings]' \ ':LaTeX file:_files -g \*.\(tex\|dtx\|lhs\|w\)' return 0 ;; esac return 1 rubber-1.4/doc/000077500000000000000000000000001263264347500134205ustar00rootroot00000000000000rubber-1.4/doc/.gitignore000066400000000000000000000001421263264347500154050ustar00rootroot00000000000000rubber.info rubber.texi man-en/rubber-info.1 man-en/rubber.1 man-fr/rubber-info.1 man-fr/rubber.1 rubber-1.4/doc/man-en/000077500000000000000000000000001263264347500145735ustar00rootroot00000000000000rubber-1.4/doc/man-en/rubber-info.1.in000066400000000000000000000047361263264347500175060ustar00rootroot00000000000000.TH RUBBER-INFO 1 .SH NAME rubber-info \- extract information from LaTeX documents .SH SYNOPSIS .B rubber-info .RI [ options ] .RI [ action ] .I source .SH DESCRIPTION Rubber-info is a utility for extracting various kinds of information from a LaTeX document. Information can be extracted from the source (for instance when calculating dependencies) or from the compilation log files (to extract errors and warnings). This program is a complement for the compilation system .BR rubber (1). The command-line options are those used by .BR rubber (1) plus one of the actions described below. .SH ACTIONS One of the following command-line options must be specified, to decide which information to extract. Of course, for actions that read a log file, a compilation must have been done before. If none of these actions is specified, .I \-\-check is assumed. .TP .B \-\-boxes Extracts from the log file the places in the source where bad boxes appeared (these are the famous overfull and underfull \\hbox and \\vbox) .TP .B \-\-check Report errors if there are any, otherwise report undefined references if there are any, otherwise list warnings and bad boxes. This is the default action. .TP .B \-\-deps Analyse the source files and produce a space-separated list of all the files that the document depends on and that Rubber cannot rebuild. .TP .B \-\-errors Extract from the log file the list of errors that occured during the last compilation. .TP .B \-h, \-\-help Display the list of all available options and exit nicely. .TP .B \-\-refs Report the list of undefined or multiply defined references (i.e. the \\ref's that are not defined by one \\label). .TP .B \-\-rules Analyse the source files and produce a list of dependency rules. One rule is produced for each intermediate target that would be made when running .BR rubber . Rules are formatted in the style of Makefiles. .TP .B \-\-version Print the version number and exit nicely. .TP .B \-\-warnings Stupidly enumerate all LaTeX warnings, i.e. all the lines in the log file that contain the string "Warning". .PP .SH BUGS There are surely a some... This page documents Rubber version @version@. The program and this man-page are maintained by @author@ <@author_email@>. The homepage for Rubber can be found at @url@. .SH SEE ALSO The full documentation for .B rubber is maintained as a Texinfo manual. If the .B info and .B rubber programs are properly installed at your site, the command .IP .B info rubber .PP should give you access to the complete manual. rubber-1.4/doc/man-en/rubber-pipe.1000066400000000000000000000000221263264347500170630ustar00rootroot00000000000000.so man1/rubber.1 rubber-1.4/doc/man-en/rubber.1.in000066400000000000000000000444641263264347500165570ustar00rootroot00000000000000.TH RUBBER 1 .SH NAME rubber \- a building system for LaTeX documents . .SH SYNOPSIS .B rubber .RI [ options ] .I sources ... .br .B rubber\-pipe .RI [ options ] . .SH DESCRIPTION Rubber is a wrapper for LaTeX and companion programs. Its purpose is, given a LaTeX source to process, to compile it enough times to resolve all references, possibly running satellite programs such as BibTeX, makeindex, Metapost, etc. to produce appropriate data files. .PP The command .B rubber builds the specified documents completely. The source files may be either LaTeX sources (in which case the suffix .tex may be omitted) or documents in a format Rubber knows how to translate into LaTeX. If one compilation fails, the whole process stops, including the compilation of the next documents on the command line, and .B rubber returns a non-zero exit code. .PP The command .B rubber\-pipe does the same for one document but it reads the LaTeX source from standard input and dumps the compiled document on standard output. .P Some information cannot be extracted from the LaTeX sources. This is the case, for instance, with the search paths (which can be specified in environment variables like TEXINPUTS), or the style to be used with Makeindex. To address this problem, one can add information for Rubber in the comments of the LaTeX sources, see section .BR DIRECTIVES . . .SH OPTIONS The options are used either to choose the action to be performed or to configure the building process. They are mostly the same in .B rubber and .BR rubber\-pipe . Options are parsed using GNU Getopt conventions. .TP .B \-b, \-\-bzip2 Compress the final document (in .I bzip2 format). This is equivalent to saying .I \-o bzip2 after all other options. .TP .B \-\-clean Remove all files produced by the compilation, instead of building the document. This option is present in \fBrubber\fR only. It applies to the compilation as it would be done with the other options of the command line, i.e. saying "rubber \-\-clean foo" will not delete foo.ps, while saying "rubber \-\-ps \-\-clean foo" will. .TP .BI \-c,\ \-\-command \ Execute the specified command (or directive) .I before parsing the input files. See section .B DIRECTIVES for details. .TP .BI \-e,\ \-\-epilogue \ Execute the specified command (or directive) .I after parsing the input files. See section .B DIRECTIVES for details. .TP .B \-f, \-\-force Force at least one compilation of the source. This may be useful, for instance, if some unusual dependency was modified (e.g. a package in a system directory). This option is irrelevant in .BR rubber\-pipe . .TP .B \-z, \-\-gzip Compress the final document (in .I gzip format). This is equivalent to saying .I \-o gz after all other options. .TP .B \-h, \-\-help Display the list of all available options and exit nicely. .TP .B \-\-inplace Go to the directory of the source files before compiling, so that compilation results are in the same place as their sources. .TP .BI \-\-into \ Go to the specified directory before compiling, so that all files are produced there and not in the current directory. .TP .BI \-\-jobname \ Specify a job name different from the base file name. This changes the name of output files and only applies to the first target. .TP .B \-k, \-\-keep This option is used in .B rubber\-pipe only. With this option, the temporary files will not be removed after compiling the document and dumping the results on standard output. The temporary document is named rubtmpX.tex, where X is a number such that no file of that name exists initially. .TP .B \-l, \-\-landscape Specify that the final document should use landscape orientation. This is relevant only when using .B dvips or .BR dvipdfm . .TP .BI \-n,\ \-\-maxerr \ Set the maximum number of displayed errors. By default, up to 10 errors are reported, saying .I \-n \-1 displays all errors. .TP .BI \-m,\ \-\-module \ [: ] Use the specified module in addition to the document's packages. Arguments can be passed to the package by adding them after a colon, they correspond to the package options in LaTeX. The module is loaded .I before parsing the document's sources. .TP .BI \-\-only \ Compile the document partially, including only the specified sources. This works by inserting a call to \\includeonly on the command line. The argument is a comma-separated list of file names. .TP .BR \-o,\ \-\-post \ [: ] Use the specified module as a post-processor. This is similar to the .I \-m options except that the module is loaded .I after parsing the document. .TP .B \-d, \-\-pdf Produce PDF output. When this option comes after .I \-\-ps (for instance in the form .IR \-pd ) it is a synonym for .IR \-o\ ps2pdf , otherwise it acts as .IR \-m\ pdftex , in order to use pdfLaTeX instead of LaTeX. .TP .B \-p, \-\-ps Process the DVI produced by the process through .BR dvips (1) to produce a PostScript document. This option is a synonym for .IR \-o\ dvips , it cannot come after .IR \-\-pdf . .TP .B \-q, \-\-quiet Decrease the verbosity level. This is the reverse of .IR \-v . .TP .BI \-r,\ \-\-read \ Read additional directives from the specified file (see also the directive "read"). .TP .B \-S, \-\-src\-specials Enable generation of source specials if the compiler supports it. This is equivalent to setting the variable .I src-specials to .IR yes . .TP .B \-s, \-\-short Display LaTeX's error messages in a compact form (one error per line). .TP .BI \-I,\ \-\-texpath \ Add the specified directory to TeX's search path. .TP .BI \-\-synctex Enable SyncTeX support in the LaTeX run. .TP .BI \-\-unsafe Permit the document to invoke arbitrary external programs. This is potentially dangerous, only use this option for documents coming from a trusted source. .TP .B \-v, \-\-verbose Increase the verbosity level. Levels between 0 and 4 exist, the default level is 1 for .B rubber and 0 for .BR rubber\-pipe . Beware, saying .I \-vvv makes Rubber speak a lot. .TP .B \-\-version Print the version number and exit nicely. .TP .BI \-W,\ \-\-warn \ Report information of the given type if there was no error during compilation. The available types are: .B boxes (overfull and underfull boxes), .B refs (undefined or multiply defined references), .B misc (other warnings) and .B all to report all warnings. .PP . .SH MODULES Rubber's action is influenced by modules. Modules take care of the particular features of packages and external programs. . .SS Packages For every package that a document uses, Rubber looks for a module of the same name to perform the tasks that this package my require apart from the compilation by LaTeX. Modules can be added to the ones provided by default to include new features (this is the point of the module system). The standard modules are the following: .TP .B asymptote Process the .asy files generated by the LaTeX package, then triggers a recompilation. .TP .B beamer This module handles Beamer's extra files the same way as other tables of contents. .TP .B bibtex, biblatex Takes care of processing the document's bibliography with BibTeX when needed. This module is automatically loaded if the document contains the macro \\bibliography (see also in .B DIRECTIVES for options). .TP .B combine The combine package is used to gather several LaTeX documents into a single one, and this module handles the dependencies in this case. .TP .B epsfig This modules handles graphics inclusion for the documents that use the old style \\psfig macro. It is actually an interface for the graphics module, see this one for details. .TP .B glossaries Run makeglossaries and recompiles when the .glo file changes. .TP .B graphics, graphicx These modules identify the graphics included in the document and consider them as dependencies for compilation. They also use standard rules to build these files with external programs. See the info documentation for details. .TP .B hyperref Handle the extra files that this package produces in some cases. .TP .B index, makeidx, nomencl Process the document's indexes and nomenclatures with .BR makeindex (1) when needed (see section .B DIRECTIVES for options). .TP .BR ltxtable Add dependencies for files inserted via the ltxtable LaTeX package. .TP .B minitoc, minitoc-hyper On cleaning, remove additional files that produced to make partial tables of contents. .TP .B moreverb, verbatim Adds the files included with \\verbatiminput and similar macros to the list of dependencies. .TP .B multibib Handles the extra bibliographies that this package creates, and removes the extra files on cleaning. .TP .B xr Add additional .aux files used for external references to the list of dependencies, so recompiling is automatic when referenced document are changed. .PP . .SS Pre\-processing The following modules are provided for using programs that generate a LaTeX source from a different file format: .TP .B cweb This module's purpose is to run .BR cweave (1) if needed before the compiling process to produce the LaTeX source. This module is automatically loaded if the file specified on the command line has .B .w as its suffix. .TP .B lhs2TeX This module uses the .B lhs2TeX preprocessor to generate the LaTeX source from a Literate Haskell program. It is automatically triggered if the input file's name ends with .BR .lhs . .PP . .SS Post\-processing The following modules are provided to support different kinds of post\-processings. Note that the order matters when using these modules: if you want to use a processing chain like .RS foo.tex \-> foo.dvi \-> foo.ps \-> foo.pdf \-> foo.pdf.gz .RE you have to load the modules .BR dvips , .B ps2pdf and .B gz in that order, for instance using the command line .RS rubber \-p \-o ps2pdf \-z foo.tex .RE .TP .B bzip2 Produce a version of the final file compressed with .BR bzip2 (1). .TP .B dvipdfm Runs .BR dvipdfm (1) at the end of compilation to produce a PDF document. .TP .B dvips Runs .BR dvips (1) at the end of compilation to produce a PostScript document. This module is also loaded by the command line option .IR \-\-ps . .TP .B expand Produce an expanded LaTeX source by replacing \\input macros by included files, bibliography macros by the bibliography produced by .BR bibtex (1), and local classes and packages by their source. If the main file is .I foo.tex then then expanded file will be named .IR foo\-final.tex . See the info documentation for details. .TP .B gz Produce a version of the final file compressed with .BR gzip (1). .TP .B ps2pdf Assuming that the compilation produces a PostScript document (for instance using module .BR dvips ), convert this document to PDF using .BR ps2pdf (1). .PP . .SS Compiler choice The following modules are used to change the LaTeX compiler: .TP .B aleph Use the Aleph compiler instead of TeX, i.e. compiles the document using .BR lamed (1) instead of .BR latex . .TP .B omega Use the Omega compiler instead of TeX, i.e. compiles the document using .BR lambda (1) instead of .BR latex . If the module .B dvips is used too, it will use .BR odvips (1) to translate the DVI file. Note that this module is triggered automatically when the document uses the package .BR omega . .TP .B pdftex Instructs Rubber to use .BR pdflatex (1) instead of .BR latex (1) to compile the document. By default, this produces a PDF file instead of a DVI, but when loading the module with the option .B dvi (for instance by saying .IR \-m\ pdftex:dvi ) the document is compiled into DVI using .BR pdflatex . This module is also loaded by the command line option .IR \-\-pdf . .TP .B vtex Instructs Rubber to use the VTeX compiler. By default this uses .B vlatex as the compiler to produce PDF output. With the option .B ps (e.g. when saying "rubber \-m vtex:ps foo.tex") the compiler used is .B vlatexp and the result is a PostScript file. .TP .B xelatex Instructs Rubber to use .BR xelatex (1) instead of .BR latex. .PP . .SH DIRECTIVES The automatic behavior of Rubber is based on searching for macros in the LaTeX sources. When this is not enough, directives can be added in the comments of the sources. A directive is a line like .RS % rubber: cmd args .RE The line must begin with a "%", then any sequence of "%" signs and spaces, then the text "rubber:" followed by spaces and a command name, possibly followed by spaces and arguments. . .SS General directives .TP .BI alias \ \ Pretend that the LaTeX macro .I name1 is equivalent to .IR name2 . This can be useful when defining wrappers around supported macros. .TP .BI clean \ Indicates that the specified file should be removed when cleaning using .IR \-\-clean . .TP .BI depend \ Consider the specified file as a dependency, so that its modification time will be checked. .TP .BI make \ \ [ ] Declare that the specified file has to be generated. Options can specify the way it should be produced, the available options are .BI from \ to specify the source and .BI with \ to specify the conversion rule. For instance, saying "make foo.pdf from foo.eps" indicates that .I foo.pdf should be produced from .IR foo.eps , with any conversion rule that can do it. See the info documentation for details on file conversion. .TP .BI module \ \ [ ] Loads the specified module, possibly with options. This is equivalent to the command-line option .IR \-\-module . .TP .BI onchange \ \ Execute the specified shell command after compiling if the contents of the specified file have changed. The file name ends at the first space. .TP .BI paper \ Specify options related to paper size. Currently they are used to give .I \-t options to .B dvips and .I \-p options to .BR dvipdfm . .TP .BI path \ Adds the specified directory to the search path for TeX (and Rubber). The name of the directory is everything that follows the spaces after "path". .TP .BI produce \ Declares that the LaTeX run will create or update the specified file(s). .TP .BI read \ Read the specified file of directives. The file must contain one directive per line. Empty lines and lines that begin with "%" are ignored. .TP .BI rules \ Read extra conversion rules from the specified file. The format of this file is the same as that of .IR rules.ini , see the info documentation for details. .TP .BI set \ \ Set the value of a variable as a string. For details on the existing variables and their meaning, see the info documentation. .TP .BI setlist \ \ Set the value of a variable as a (space-separated) list of strings. For details on the existing variables and their meaning, see the info documentation. .TP .BI shell_escape Mark the document as requiring external programs (shell\-escape or write18). Rubber does not actually enable this unless called with the option \-\-unsafe. .TP .BI synctex Enable SyncTeX support in the LaTeX run. .TP .BI watch \ Watch the specified file for changes. If the contents of this file has changed after a compilation, then another compilation is triggered. This is useful in the case of tables of contents, for instance. .PP . .SS Module-specific directives If a command has the form .IR foo.bar , it is considered a command .I bar for the module .IR foo . If this module is not registered when the directive is found, then the command is silently ignored. For the standard modules, the directives are the following: .TP .BI biblatex.path \ Adds the specified directory to the search path for BibTeX databases (.bib files). .TP .BI bibtex.crossrefs \ Set the minimum number of .I crossref required for automatic inclusion of the referenced entry in the citation list. This sets the option .I -min-crossrefs when calling .BR bibtex (1). .TP .BI bibtex.path \ Adds the specified directory to the search path for BibTeX databases (.bib files). .TP .BI bibtex.stylepath \ Adds the specified directory to the search path for BibTeX styles (.bst files). .TP .BI bibtex.tool \ Use a different bibliography tool instead of BibTeX. .TP .BI dvipdfm.options \ Pass the specified command-line switches to .BR dvipdfm . .TP .BI dvips.options \ Pass the specified command-line switches to .BR dvips . .TP .BI index.tool \ (index)\ Specifies which tool is to be used to process the index. The currently supported tools are .BR makeindex (1) (the default choice) and .BR xindy (1). The argument .I index is optional, it may be used to specify the list of indexes the command applies to. When present, it must be enclosed in parentheses; the list is comma-separated. When the argument is not present, the command applies to all indices. .TP .BI index.language \ (index)\ Selects the language used for sorting the index. This only applies when using .BR xindy (1) as the indexing tool. The optional argument has the same semantics as above. .TP .BI index.modules \ (index)\ ... Specify which modules to use when processing an index with .BR xindy (1). The optional argument has the same semantics as above. .TP .BI index.order \ (index)\ Modifies the sorting options for the indexes. The arguments are words (separated by spaces) among .IR standard , .I german and .IR letter . This only applies when using .BR makeindex (1). The optional argument has the same semantics as above. .TP .BI index.path \ (index)\ Adds the specified directory to the search path for index styles (.ist files). The optional argument has the same semantics as above. .TP .BI index.style \ (index)\