Skip to content

Options

Randy Lai edited this page Sep 18, 2016 · 1 revision

view_on_success - view pdf on success complication

bring_forward_on_success - bring the viewer to the front on success complication. Disabled when view_on_success is false. Doesn't work on some platforms

forward_sync_on_success - forward sync on success complication. Disabled when view_on_success is false.

cmd - the build command for LaTeXBox

"cmd": [
        "latexmk", "-quiet", "-pdf", "-e",
        "$pdflatex='pdflatex -synctex=1 --shell-escape %O %S'"
],

cmd_variants - define other build systems

"cmd_variants": {
    "PdfLaTeX (Default)" : [
            "latexmk", "-quiet", "-pdf", "-e",
            "$pdflatex='pdflatex -synctex=1 --shell-escape %O %S'"
    ],
     "LaTeX-DVI-PDF" : [
            "latexmk", "-quiet", "-pdfdvi", "-e", "$dvipdf = 'dvipdfmx %O -o %D %S'", "-e",
            "$latex='latex %O -interaction=nonstopmode -synctex=1 --shell-escape %S'"
     ],
     "LaTeX-PS" : [
            "latexmk", "-quiet", "-pdfps", "-e",
            "$latex = 'latex %O -interaction=nonstopmode --shell-escape -synctex=1 %S'"
     ],
     "XeLaTeX" : [
            "latexmk", "-quiet", "-pdf", "-e",
            "$pdflatex = 'xelatex %O -interaction=nonstopmode --shell-escape -synctex=1 %S'"
     ]
},

clean_ext and clean_ext_force define file extensions to be cleaned via the cleaning commands.

"clean_ext" : [
        ".aux", ".dvi", ".lis", ".log", ".blg", ".bbl", ".toc", ".idx", ".ind",
        ".ilg", ".thm", ".out", ".fdb_latexmk", ".fls", ".nav", ".snm"
],

"clean_ext_force" :[
        ".synctex.gz"
],

For OSX

If LaTeXBox fails to find latexmk, please manually edit the path variable.

"osx": {
    	// envirnoment path
    	// it is on by default since paths on mac are set by launchctl
    	"path": "/usr/texbin:/usr/local/bin:$PATH"
}

For Windows

If LaTeXBox cannot find latexmk or SumatraPDF. Please edit the following in your user "LaTeXBox.sublime-settings" file.

"windows": {
    // envirnoment path
    // "path": "C:\\Program Files\\MiKTeX 2.9\\miktex\\bin\\;$PATH"

    // path to SumatraPDF
    // "sumatrapdf" : "C:\\Program Files\\SumatraPDF\\SumatraPDF.exe"
}

For Linux

It may happen that LaTeXBox fails to find latexmk or the sublime binary. Put the following in your user "LaTeXBox.sublime-settings" file.

"linux": {
    // envirnoment path
    // "path": "/usr/local/texlive/2013/bin/x86_64-linux:$PATH"

    // path to sublime
    // "sublime": "/usr/bin/subl",

    // which viewer to use: evince, okular or zathura (default is evince)
    // "viewer": "evince"
},