pax_global_header00006660000000000000000000000064140623371070014515gustar00rootroot0000000000000052 comment=ce680bd9b6fe5ec68e8fc084b5f3408331c033c9 rubber-1.6.0/000077500000000000000000000000001406233710700130025ustar00rootroot00000000000000rubber-1.6.0/.git-blame-ignore-revs000066400000000000000000000002411406233710700170770ustar00rootroot00000000000000# Yapf format the codebase, add .style.yapf 31f54a8ae2ba9864cc866b35c940c6d6ea13c53e # Replace tabulations with 4-spaces 31cfa58ec58237b0ea94642de36a638d0c9517f8rubber-1.6.0/.gitlab-ci.yml000066400000000000000000000004331406233710700154360ustar00rootroot00000000000000image: "flowdalic/debian-testing-dev:1.12" build: script: - make build test: script: - | cd tests touch cweb-latex/disable touch graphicx-dotted-files/disable touch pythontex/disable ./run.sh --debchroot * lint: script: - make lint rubber-1.6.0/.style.yapf000066400000000000000000000000611406233710700150760ustar00rootroot00000000000000[style] based_on_style: google column_limit: 100 rubber-1.6.0/COPYING000066400000000000000000001045151406233710700140430ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. 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 them 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 prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. 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. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey 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; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If 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 convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU 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 that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. 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. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 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. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. 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 state 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 3 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, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program 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, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU 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 Lesser General Public License instead of this License. But first, please read . rubber-1.6.0/Makefile000066400000000000000000000011051406233710700144370ustar00rootroot00000000000000.PHONY: build check check-license format lint pyflakes pylint test yapf MODULES_AND_PACKAGES := setup.py rubber bin build: python3 ./setup.py build check: lint test check-license: ./tools/check-license format: yapf --in-place --recursive --parallel . lint: pyflakes pylint yapf check-license pyflakes: pyflakes $(MODULES_AND_PACKAGES) pylint: pylint --errors-only $(MODULES_AND_PACKAGES) yapf: yapf --diff --recursive --parallel . test: (cd tests && ./run.sh *) .PHONY: gitlab-runner gitlab-runner: gitlab-runner exec docker test gitlab-runner exec docker lint rubber-1.6.0/NEWS000066400000000000000000000331731406233710700135100ustar00rootroot00000000000000Upcoming Version Nothing so far… Version 1.6.0 (2021-06-16) - Add support for LuaTeX via the lualatex module - Introduce rubbercache for faster compilations Version 1.5.1 (2018-09-12) Fix two severe regressions in the python3 port. Bugfixes: - Restore support for 8-bits encoded .tex sources (Debian: #907937, #907988). - Fix many crashing log/warning/error messages. Version 1.5 (2018-08-06) This version requires Python3. It assumes that all files are encoded in utf-8. This should not cause new problems, previous versions were silently assuming ASCII. Features: - Remove support for selection of paper size and orientation. - Prohibit onchange directive unless --unsafe mode. Bugfixes: - Fix stacktrace when parsing BibTeX errors (LP: #1533723). - Use open mode r+ for /dev/null instead of rw (LP: #1543622) - Always give a relative source path to fig2dev (Debian: #345954). - Detect "Missing character" messages in log files (Debian: #384155). - Update hooks for all parsers (Debian: #813855, LP: #1470988). - Accept uppercase image extensions (LP: #1583475). Patch from Matthias Goldhoorn . Version 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.6.0/README000066400000000000000000000125551406233710700136720ustar00rootroot00000000000000This 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 3.5. 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 python3-dev package). To build the documentation, you need texinfo (Debian package: texinfo). To compile and install Rubber, just follow the usual procedure: # python3 setup.py --help # python3 setup.py install # python3 setup.py clean --all Some useful options to setup.py include: Disabling info docs: # python3 setup.py build --info=False install and similar for --html, --man, --pdf. Changing the installation path for manpages: # python3 setup.py install --mandir=/path/to/man/pages Installing to a staging directory instead of the root/prefix: # python3 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 # python3 setup.py build # python3 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. * Known Bugs Rubber is generally working fine, though there are some known issues. 1) Rubber tries to do too much. Rubber attempts to provide a one-stop solution to compiling a TeX document, and run a lot of related software as needed. This approach is fragile for three reasons: a) It does so by parsing the .tex file itself, and all included files, and discovering any related input files. TeX is a hard language to parse correctly without embedding a full TeX interpreter, which rubber does not do. b) To do its work, Rubber needs to be taught about every version of every package in the TeX ecosystem in order to gauge its impact on the compilation of a TeX document. It needs to know the preferences of any TeX compiler with regards to image formats, search paths etc. All this information is hard to keep up to date. c) In some cases (like image conversion), it needs to outright guess what the user intends to do, and may in fact guess incorrectly. In a future release, some of these features may be taken out in favor of more modern ways to accomplish the same thing, with to goal to render Rubber simpler and more robust. One might want to make use of the -recorder feature (.fls) for example instead of attempting to read the same information from the human-readable log file. 2) The codebase has been cleaned up considerably, has been converted to Python3 and is generally in a sane state. Nevertheless, it has been written over a number of years, and some features would be implemented differently or skipped altogether if a rewrite were attempted (e.g. the onchange mechanism, modules, ...). 3) In some cases, Rubber will trigger a recompile that is arguably unnecessary. Rubber tries to err on the side of caution here. * Author Rubber was originally written by Emmanuel Beffara . It is currently maintained by Florian Schmaus , Sebastian Kapfer and Nicolas Boulenguez . Its homepage can be found at https://gitlab.com/latex-rubber/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 and robust as possible. * License Rubber 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 3 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, see . SPDX-License-Identifier: GPL-3.0-or-laterrubber-1.6.0/bin/000077500000000000000000000000001406233710700135525ustar00rootroot00000000000000rubber-1.6.0/bin/rubber000077500000000000000000000014211406233710700147570ustar00rootroot00000000000000#!/usr/bin/env python3 # SPDX-License-Identifier: GPL-3.0-or-later # (c) Sebastian Kapfer, 2015 # vim: et:ts=4 from pathlib import Path RUBBER_BIN_DIR = Path(__file__).parent.absolute() POTENTIAL_RUBBER_SOURCE_TREE_PYTHONPATH = RUBBER_BIN_DIR.parent POTENTIAL_RUBBER_MODULE_DIR = POTENTIAL_RUBBER_SOURCE_TREE_PYTHONPATH / 'rubber' if Path(POTENTIAL_RUBBER_MODULE_DIR / '__init__.py').is_file(): RUBBER_SOURCE_TREE_PYTHONPATH = str(POTENTIAL_RUBBER_SOURCE_TREE_PYTHONPATH) print(f"Rubber invoked from VCS, prepending {RUBBER_SOURCE_TREE_PYTHONPATH} to sys.path") import sys if RUBBER_SOURCE_TREE_PYTHONPATH not in sys.path: sys.path.insert(0, RUBBER_SOURCE_TREE_PYTHONPATH) import rubber.cmdline rubber.cmdline.main(command_name=rubber.cmdline.RUBBER_PLAIN) rubber-1.6.0/bin/rubber-info000077500000000000000000000014201406233710700157070ustar00rootroot00000000000000#!/usr/bin/env python3 # SPDX-License-Identifier: GPL-3.0-or-later # (c) Sebastian Kapfer, 2015 # vim: et:ts=4 from pathlib import Path RUBBER_BIN_DIR = Path(__file__).parent.absolute() POTENTIAL_RUBBER_SOURCE_TREE_PYTHONPATH = RUBBER_BIN_DIR.parent POTENTIAL_RUBBER_MODULE_DIR = POTENTIAL_RUBBER_SOURCE_TREE_PYTHONPATH / 'rubber' if Path(POTENTIAL_RUBBER_MODULE_DIR / '__init__.py').is_file(): RUBBER_SOURCE_TREE_PYTHONPATH = str(POTENTIAL_RUBBER_SOURCE_TREE_PYTHONPATH) print(f"Rubber invoked from VCS, prepending {RUBBER_SOURCE_TREE_PYTHONPATH} to sys.path") import sys if RUBBER_SOURCE_TREE_PYTHONPATH not in sys.path: sys.path.insert(0, RUBBER_SOURCE_TREE_PYTHONPATH) import rubber.cmdline rubber.cmdline.main(command_name=rubber.cmdline.RUBBER_INFO) rubber-1.6.0/bin/rubber-lsmod000077500000000000000000000013641406233710700161010ustar00rootroot00000000000000#!/usr/bin/env python3 # SPDX-License-Identifier: GPL-3.0-or-later from pathlib import Path RUBBER_BIN_DIR = Path(__file__).parent.absolute() POTENTIAL_RUBBER_SOURCE_TREE_PYTHONPATH = RUBBER_BIN_DIR.parent POTENTIAL_RUBBER_MODULE_DIR = POTENTIAL_RUBBER_SOURCE_TREE_PYTHONPATH / 'rubber' if Path(POTENTIAL_RUBBER_MODULE_DIR / '__init__.py').is_file(): RUBBER_SOURCE_TREE_PYTHONPATH = str(POTENTIAL_RUBBER_SOURCE_TREE_PYTHONPATH) print(f"Rubber invoked from VCS, prepending {RUBBER_SOURCE_TREE_PYTHONPATH} to sys.path") import sys if RUBBER_SOURCE_TREE_PYTHONPATH not in sys.path: sys.path.insert(0, RUBBER_SOURCE_TREE_PYTHONPATH) from rubber.util import iter_rubber_modules for module in iter_rubber_modules(): print(module) rubber-1.6.0/bin/rubber-pipe000077500000000000000000000014201406233710700157110ustar00rootroot00000000000000#!/usr/bin/env python3 # SPDX-License-Identifier: GPL-3.0-or-later # (c) Sebastian Kapfer, 2015 # vim: et:ts=4 from pathlib import Path RUBBER_BIN_DIR = Path(__file__).parent.absolute() POTENTIAL_RUBBER_SOURCE_TREE_PYTHONPATH = RUBBER_BIN_DIR.parent POTENTIAL_RUBBER_MODULE_DIR = POTENTIAL_RUBBER_SOURCE_TREE_PYTHONPATH / 'rubber' if Path(POTENTIAL_RUBBER_MODULE_DIR / '__init__.py').is_file(): RUBBER_SOURCE_TREE_PYTHONPATH = str(POTENTIAL_RUBBER_SOURCE_TREE_PYTHONPATH) print(f"Rubber invoked from VCS, prepending {RUBBER_SOURCE_TREE_PYTHONPATH} to sys.path") import sys if RUBBER_SOURCE_TREE_PYTHONPATH not in sys.path: sys.path.insert(0, RUBBER_SOURCE_TREE_PYTHONPATH) import rubber.cmdline rubber.cmdline.main(command_name=rubber.cmdline.RUBBER_PIPE) rubber-1.6.0/doc/000077500000000000000000000000001406233710700135475ustar00rootroot00000000000000rubber-1.6.0/doc/man-en/000077500000000000000000000000001406233710700147225ustar00rootroot00000000000000rubber-1.6.0/doc/man-en/rubber-info.1.in000066400000000000000000000047471406233710700176370ustar00rootroot00000000000000.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 occurred 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 @maintainer@ <@maintainer_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.6.0/doc/man-en/rubber-pipe.1000066400000000000000000000000221406233710700172120ustar00rootroot00000000000000.so man1/rubber.1 rubber-1.6.0/doc/man-en/rubber.1.in000066400000000000000000000440051406233710700166750ustar00rootroot00000000000000.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 .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 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)\