texbuilder: View your latex output while editing

[ gpl, latex, program ] [ Propose Tags ]

This program allows you to view your latex document in your pdf viewer while editing it in your favorite editor. When you save your document, this program will recompile it, overwrite the output pdf file and send a signal to your pdf reader to reload the file. This effectively allows for a "continous preview"-like experience. This will run on Linux only at the moment.


[Skip to Readme]
Versions 0.1.0.1, 0.1.1.0, 0.1.1.1, 0.1.1.2, 0.1.1.3, 0.1.2.0, 0.1.3.0, 0.1.4.0, 0.1.4.1 (info)
Change log ChangeLog.md
Dependencies ansi-wl-pprint (>=0.6.8 && <0.7), base (==4.10.*), bytestring (>=0.10.8 && <0.11), containers (>=0.5.7 && <0.6), cryptonite (>=0.23 && <=0.25), deepseq (>=1.4.2 && <1.5), directory (==1.3.*), extra (>=1.5.3 && <1.7), filepath (==1.4.*), hinotify (==0.3.*), mtl (>=2.2.1 && <2.3), optparse-applicative (>=0.13 && <0.15), process (>=1.4 && <1.7), temporary (==1.2.*), unix (==2.7.*) [details]
License GPL-3.0-only
Author Dominik Xaver Hörl
Maintainer Dominik Xaver Hörl
Category LaTeX
Home page https://gitlab.com/xaverdh/tex-builder#texbuilder
Source repo head: git clone https://gitlab.com/xaverdh/tex-builder/
Uploaded by xaverdh at Sun Apr 15 12:05:14 UTC 2018
Distributions NixOS:0.1.4.0
Executables texbuilder
Downloads 1103 total (33 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
All reported builds failed as of 2018-04-15 [all 3 reports]
Hackage Matrix CI

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for texbuilder-0.1.4.1

[back to package description]

texbuilder

What it is

This program allows you to view your latex document in your pdf reader while editing it in your favorite editor. When you save your document, it will recompile it, overwrite the output pdf file and send a signal to your pdf reader to reload the file. This effectively allows for a "continuous preview"-like experience.

This will run with mupdf and only on Linux at the moment.

Prerequisites and Dependencies

  • linux (we use inotify)
  • a recent cabal / ghc
  • (currently only works with) mupdf
  • working latex with lualatex, xelatex or pdflatex and ideally latexmk
  • make sure to compile this with the -threaded ghc option, otherwise it will not work!

Build with Cabal from Hackage

cabal install --bindir . --ghc-option=-threaded texbuilder

How to build from git

git clone https://gitlab.com/xaverdh/tex-builder
cd tex-builder
cabal sandbox init
cabal install --bindir . --ghc-option=-threaded

Alternatively you can use the provided build script. So assuming you have wget you cound do:

wget -O - https://gitlab.com/xaverdh/tex-builder/raw/master/build | sh

Usage

Say you want to compile a tex file thesis.tex then standard usage would be:

texbuilder -t thesis.tex

By default texbuilder will use a fresh environment for every compile run. This may sound wasteful, but is quite feasible with average sized tex files on modern hardware. And it does avoid problems with messed up state, when something goes wrong.

Still if you do have problems with performance, use the --stateful flag.

Finally if you really really need all those intermediate representation files in your directory, use --persistent.

Notes

Early Versions (up to 0.1.2.0) of this program are deprecated, because the cabal file did not enforce use of the -threaded ghc option. If that option was not passed to cabal / ghc on the command line, the resulting builds were broken.

Legal

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 any later version.

See LICENSE for more details.