It’s common to compile our documents a couple of times to ensure, amongst other things, correct cross-referencing and indices. Sometimes, we also rely on a
in order to make things easier. Now enters
, a powerful tool to help us on our building adventures.
Our first example
According to the
“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.”
All the major Linux distros have
in their repositories. A simple
does the job for me. Let’s see an example, with
We should now run
again. Hm let’s run it again three more times just to be sure (I know I do). Or we could go with
. Done. Of course, don’t mention Macbeth.
There we go!
as many times as need. The
to run the PDF tools instead the DVI ones. Do you think the current folder is messy, full of temporary files? Go with
and voilà, now you’ll have only the resulting PDF file and your
If you want to get rid of all generated files, except of course the sources, just add the
is smart enough to check if the files are updated:
High hopes part II
Yes, there goes another rubber tree plant… again.
Time for more advanced stuff with
I had the opportunity of answering a nice question on TeX.sx about
. It makes use of directives, the hidden gems.
A directive is a comment in the form of
which adds information for
. It’s very simple. Let’s say I want to use a custom
style for my index. A quick look into the
manual gives me the following entry:
: specifies the index style to be used. It’s important to note that each of these directives may be used with an optional first argument of the form(foo,bar,quux)
in order to specify that the directive only applies to the indexes namedfoo
. By default, directives are applied to all indices.
Now, I just need to add a line to
Well, it didn’t work.
Why? I was wondering what happened. Then the manual tells me why:
- When using the package
, the directives must of course be prefixed bymakeidx.
, and the optional first argument is not accepted.
Since I’m using
, a quick fix
does the trick.
There are several directives for you to play with. Have fun!
Mac users, don’t worry!
Of course, there’s an app for that… I mean,
can be used with Mac too! Go to the official
repository and download the current compressed file, e.g,
. Extract it to a folder and use
Update: XeLaTeX, where are you?
offers no XeLaTeX support out of the box. But there a way to fix this.
Wouter Bolsterlee provided an elegant solution. Go here, download the attached
file and copy it to
directory. In my Fedora system, the full path is
. Now, just run
and XeLaTeX is recognized! I’m pretty sure a similar
file might be used for LuaLaTeX.
has a lot more features than the ones I described in these examples. Take a look on the manual by running
for a complete reference. This tool is certainly a great addition to our TeX utility belt.
I should mention an alternative, I’ve been using for a while: CMake with UseLaTeX http://www.vtk.org/Wiki/CMakeUserUseLATEX
It supports the same items that you mentioned in your post, additionally it does out of source builds!
Cool! I used CMake in the past, but not for LaTeX files. I’ll give it a try, thanks!
Hi — I have nothing against rubber, but for the record, there are a number of programs around to do this job. Off the top of my head, three are latexmk, mkjobtexmf, and texi2dvi/texi2pdf. I’m sure that perusing CTAN would turn up more. (For myself, I tend to write the rules I need directly in make instead of involving another tool.)
Hi Karl, thanks a lot for the feedback! Indeed, we have lots of tools around to do this job.
I decided to write about
mostly because there was a question on TeX.sx and I actually put some effort on answering it. Apart from the
pages, I could not find a nice
introduction, so I thought of writing one. 🙂 IMHO
has its merit, unfortunately I miss some important features, like a built-in support for both emerging XeTeX and LuaTeX engines. Anyway, for simple documents, it’s quite suitable. For complex structures, I agree 100% with you, I also tend to write the rules in a
«If you want to get rid of all generated files, except of course the sources, just add the –pdf flag:»
It should be: «just add the –clean flag.»
BTW, I’m a long time fan of rubber. I discovered it just when my carefully handcrafted Makefile was starting to turn into a monster.
Now I use this Makefile to wrap rubber: https://gist.github.com/1299581
Thanks Roberto, fixed the code.
I’m also a fan of
, thanks for sharing your
Thanks for presenting
! I did not know it and have in fact written a less-complete script with similar features.
seems to ignore some files (hardcoded?). If you observe such behaviour, you can add a directive to your LaTeX file. Just put
does not work well for me. I have a document which includes files from several subfolders via
complains that it does not find files via relative paths. Does somebody have a fix?
Any recommendations for runnings rubbe continuously? It seems suited for that kind of usage (
). I was thinking of just putting a call to
into a (timed) loop.
Thanks for the feedback, Raphael!
directive is a lifesaver. In one of my initial attempts with
, two of the auxiliary files weren’t removed at all. I have no idea why some files are ignored, maybe they are indeed hardcoded. Anyway, at least we have a workaround.
I tried to reproduce the error you mentioned, but my code worked. I’ll take a deeper look, your code is probably more sophisticated than mine.
In other news, during my tests, I got surprised. It seems
requires a certain parameters order, with the project name appearing last. I tried
, but the
was generated in the current folder;
I really like the timed loop approach.
I was talking to a friend and he told me about
). It’s similar to
, but it handles filesystem events rather than time periods. He suggested to watch
for changes and call
. I’m quite reticent to try this approach.
I also had the clean directive not cleaning two file (.bbl and .blg). I noticed that using
rubber –clean –pdf file
rubber –clean –pdf file.tex
rubber –clean –pdf file.pdf
will remove the two files.
I should mention an alternative: AutoLaTeX.
It is also available on CTAN.
It is similar to Rubber.
Additionally, it run tools (named translators) to generate PDF files from several figure sources files (svg, dia…) In this way you do not need any more to export manually your figures into PDF/PNG files.
I am trying to install rubber in mac OSX with ./configure and sudo make install and I have the next error:
error: can’t copy ‘doc/rubber.info’: doesn’t exist or not a regular file
make: *** [install] Error 1
Someone knows what is the problem?
Thanks in advanced
It’s been 4 years since this post has been written. I’m really keen on knowing how to make LuaTeX to work with rubber. As of today, I’m not able to compile a LuaTeX project with rubber.
The author of the blog post has gone on to create the
package. In my opinion it is much better than
and any of the other alternatives.