CODEWITHSUNDEEP
emacslatexauctex
prosseek
prosseek

Reputation: 190829

Using minted (source code LaTeX package) with emacs/auctex

As is explained in here, I find minted package is pretty cool for source code listing.

My question is how to use minted package with AucTeX/emacs? For command line I can use pdflatex -shell-escape SOURCE, but

Upvotes: 14

Views: 4817

Answers (4)

hackerb9
hackerb9

Reputation: 1912

Use this .dir-locals.el file

((latex-mode . ((TeX-command-extra-options . "-shell-escape")
                (tex-start-options . "-shell-escape")
                (eval
                 . (setq-local tex-verbatim-environments
                               (cons "minted" tex-verbatim-environments))))))

Discussion

Put the above .dir-locals.el file in the same directory as the latex files which use minted.

This causes Ctrlc Ctrlc to use the -shell-escape option. The first line sets it up for AUCTeX and the second sets it for emacs's builtin latex-mode, when AUCTeX is not installed.

The remainder of the file hints to emacs that the "minted" environment should be styled like a verbatim environment. Normally emacs's latex-mode displays the character after an underscore as a subscript, like_this_for_example.

Why not the .emacs file?

Using .emacs is convenient, but risky. Enabling -shell-escape globally is considered dangerous — there's a reason it is not on by default — and it should be used sparingly. Using a .dir-locals.el file instead allows one to choose to enable -shell-escape only for the documents that actually need it.

Upvotes: 1

Mike
Mike

Reputation: 20216

In recent versions of auctex, it looks like it'll be more reliable to set TeX-command-extra-options, which is designed for just this purpose, and doesn't make you override the various forms of TeX-command. As I understand it (might be wrong), this can't be set globally, but must be set for each file. You can do this with a hook. For example, in .emacs you might add this:

(add-hook 'TeX-mode-hook
  (lambda ()
    (setq TeX-command-extra-options "-shell-escape")
  )
)

And since you don't fully overwrite the latex command call, other features will still work -- like turning on synctex support with (setq TeX-source-correlate-mode t) [which can happen outside the hook].

Upvotes: 11

Simon Byrne
Simon Byrne

Reputation: 7864

Q1: You need to edit the way LaTeX is called by AucTeX. One way of doing this is to add the following to your .emacs file:

(eval-after-load "tex" 
  '(setcdr (assoc "LaTeX" TeX-command-list)
          '("%`%l%(mode) -shell-escape%' %t"
          TeX-run-TeX nil (latex-mode doctex-mode) :help "Run LaTeX")
    )
  )

Q2: Once you have made the changes, all calls to LaTeX with C-c C-c will use the -shell-escape option.

Q3: See Konrad's answer. Note that this method will enable -shell-escape for all files edited in AucTeX, so can be a potential security risk if using other peoples packages or files.

Upvotes: 14

Konrad Rudolph
Konrad Rudolph

Reputation: 545618

I can only answer question 3:

What is the '-shell-escape' for?

minted uses a third-party application, pygmentize, to process the source code. LaTeX usually doesn’t allow calling other applications for security reasons (a rogue package could otherwise call aribtrary code). To explicitly enable calling external applications, you need to enable this so-called escape to the shell – which, on most LaTeX installations, is done via the -shell-escape switch.

Upvotes: 8

Related Questions