/usr/share/doc/auctex/HTML/preview-latex/preview-latex

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
<html>
<!-- This manual is for preview-latex, a LaTeX preview mode for AUCTeX
(version 11.86 from 2010-02-21).

Copyright C 2001, 2002, 2003,
2004, 2005, 2006 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts and no Back-Cover Texts.  A
copy of the license is included in the section entitled "GNU Free
Documentation License."

 -->
<!-- Created on November 4, 2010 by texi2html 1.82
texi2html was written by: 
            Lionel Cons <Lionel.Cons@cern.ch> (original author)
            Karl Berry  <karl@freefriends.org>
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
            and many others.
Maintained by: Many creative people.
Send bugs and suggestions to <texi2html-bug@nongnu.org>
-->
<head>
<title>preview-latex 11.86: 3. Key bindings and user-level lisp functions</title>

<meta name="description" content="preview-latex 11.86: 3. Key bindings and user-level lisp functions">
<meta name="keywords" content="preview-latex 11.86: 3. Key bindings and user-level lisp functions">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2html 1.82">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
pre.display {font-family: serif}
pre.format {font-family: serif}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: serif; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: serif; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.roman {font-family:serif; font-weight:normal;}
span.sansserif {font-family:sans-serif; font-weight:normal;}
ul.toc {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">

<a name="Keys-and-lisp"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="preview-latex_3.html#Installation" title="Previous section in reading order"> &lt; </a>]</td>
<td valign="middle" align="left">[<a href="preview-latex_5.html#Simple-customization" title="Next section in reading order"> &gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="preview-latex_3.html#Installation" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
<td valign="middle" align="left">[<a href="preview-latex.html#Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="preview-latex_5.html#Simple-customization" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="preview-latex.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="preview-latex_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="preview-latex_11.html#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="preview-latex_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Key-bindings-and-user_002dlevel-lisp-functions"></a>
<h1 class="chapter">3. Key bindings and user-level lisp functions</h1>

<a name="index-Menu-entries"></a>
<p>preview-latex adds key bindings starting with <kbd>C-c C-p</kbd> to the
supported modes of AUCTeX (See <a href="../auctex/Key-Index.html#Key-Index">(auctex)Key Index</a>).  It will
also add its own &lsquo;<samp>Preview</samp>&rsquo; menu in the menu bar, as well as an icon
in the toolbar.
</p>
<p>The following only describes the interactive use: view the documentation
strings with <kbd>C-h f</kbd> if you need the Lisp information.
</p>
<dl compact="compact">
<dt> <kbd>C-c C-p C-p</kbd></dt>
<dt> <code>preview-at-point</code></dt>
<dt> Preview/Generate previews (or toggle) at point</dt>
<dd><p>If the cursor is positioned on or inside of a preview area, this
toggles its visibility, regenerating the preview if necessary. If not,
it will run the surroundings through preview. The surroundings include
all areas up to the next valid preview, unless invalid previews occur
before, in which case the area will include the last such preview in
either direction.  And overriding any other
action, if a region is active (<code>transient-mark-mode</code> or
<code>zmacs-regions</code>), it is run through <code>preview-region</code>.
<a name="index-C_002dc-C_002dp-C_002dp"></a>
<a name="index-preview_002dat_002dpoint"></a>
</p>
</dd>
<dt> <kbd>&lt;mouse-2&gt;</kbd></dt>
<dd><p>The middle mouse button has a similar action bound to it as
<code>preview-at-point</code>, only that it knows which preview to apply it to
according to the position of the click.  You can click either anywhere
on a previewed image, or when the preview is opened and showing the
source text, you can click on the icon preceding the source text.  In
other areas, the usual mouse key action (typically: paste) is not
affected.
</p>
</dd>
<dt> <kbd>&lt;mouse-3&gt;</kbd></dt>
<dd><p>The right mouse key pops up a context menu with several options:
toggling the preview, regenerating it, removing it (leaving the
unpreviewed text), copying the text inside of the preview, and copying
it in a form suitable for copying as an image into a mail or news
article.  This is a one-image variant of the following command:
</p>
</dd>
<dt> <kbd>C-c C-p C-w</kbd></dt>
<dt> <code>preview-copy-region-as-mml</code></dt>
<dt> Copy a region as MML</dt>
<dd><a name="index-C_002dc-C_002dp-C_002dw"></a>
<a name="index-preview_002dcopy_002dregion_002das_002dmml"></a>
<p>This command is also available as a variant in the context menu on the
right mouse button (where the region is the preview that has been
clicked on).  It copies the current region into the kill buffer in a
form suitable for copying as a text including images into a mail or news
article using mml-mode (see <a href="../emacs-mime/Composing.html#Composing">(emacs-mime)Composing</a> section &lsquo;Composing&rsquo; in <cite>Emacs MIME</cite>).
</p>
<p>If you regenerate or otherwise kill the preview in its source buffer
before the mail or news gets posted, this will fail.  Also you should
generate images you want to send with <code>preview-transparent-border</code>
<a name="index-preview_002dtransparent_002dborder"></a>
set to <code>nil</code>, or the images will have an ugly border.
preview-latex detects this condition and asks whether to regenerate
the region with borders switched off.  As this is an asynchronous
operation running in the background, you&rsquo;ll need to call this command
explicitly again to get the newly generated images into the kill ring.
</p>
<p>Preview your articles with <code>mml-preview</code> (on <kbd>M-m P</kbd>, or
<kbd>C-c C-m P</kbd> in Emacs 22)
<a name="index-M_002dm-P"></a>
<a name="index-C_002dc-C_002dm-P"></a>
to make sure they look fine.
</p>
</dd>
<dt> <kbd>C-c C-p C-e</kbd></dt>
<dt> <code>preview-environment</code></dt>
<dt> Preview/Generate previews for environment</dt>
<dd><p>Run preview on LaTeX environment.  The environments in
<code>preview-inner-environments</code> are treated as inner levels so that
for instance, the <code>split</code> environment in
<code>\begin{equation}\begin{split}&hellip;\end{split}\end{equation}</code>
is properly displayed.  If called with a numeric argument, the
corresponding number of outward nested environments is treated as inner
levels.
<a name="index-C_002dc-C_002dp-C_002de"></a>
<a name="index-preview_002denvironment"></a>
</p>
</dd>
<dt> <kbd>C-c C-p C-s</kbd></dt>
<dt> <code>preview-section</code> </dt>
<dt> Preview/Generate previews for section</dt>
<dd><p>Run preview on this LaTeX section.
<a name="index-C_002dc-C_002dp-C_002ds"></a>
<a name="index-preview_002dsection"></a>
</p>
</dd>
<dt> <kbd>C-c C-p C-r</kbd></dt>
<dt> <code>preview-region</code></dt>
<dt> Preview/Generate previews for region</dt>
<dd><p>Run preview on current region.
<a name="index-C_002dc-C_002dp-C_002dr"></a>
<a name="index-preview_002dregion"></a>
</p>
</dd>
<dt> <kbd>C-c C-p C-b</kbd></dt>
<dt> <code>preview-buffer</code> </dt>
<dt> Preview/Generate previews for buffer</dt>
<dd><p>Run preview on the current buffer.
<a name="index-C_002dc-C_002dp-C_002db"></a>
<a name="index-preview_002dbuffer"></a>
</p>
</dd>
<dt> <kbd>C-c C-p C-d</kbd></dt>
<dt> <code>preview-document</code> </dt>
<dt> Preview/Generate previews for document</dt>
<dd><p>Run preview on the current document.
<a name="index-C_002dc-C_002dp-C_002dd"></a>
<a name="index-preview_002ddocument"></a>
</p>
</dd>
<dt> <kbd>C-c C-p C-c C-p</kbd></dt>
<dt> <code>preview-clearout-at-point</code></dt>
<dt> Preview/Remove previews at point</dt>
<dd><a name="index-C_002dc-C_002dp-C_002dc-C_002dp"></a>
<a name="index-preview_002dclearout_002dat_002dpoint"></a>
<p>Clear out (remove) the previews that are immediately adjacent to point.
</p>
</dd>
<dt> <kbd>C-c C-p C-c C-s</kbd></dt>
<dt> <code>preview-clearout-section</code></dt>
<dt> Preview/Remove previews from section</dt>
<dd><a name="index-C_002dc-C_002dp-C_002dc-C_002ds"></a>
<a name="index-preview_002dclearout_002ddocument"></a>
<p>Clear out all previews in current section.
</p>
</dd>
<dt> <kbd>C-c C-p C-c C-r</kbd></dt>
<dt> <code>preview-clearout</code></dt>
<dt> Preview/Remove previews from region</dt>
<dd><a name="index-C_002dc-C_002dp-C_002dc-C_002dr"></a>
<a name="index-preview_002dclearout"></a>
<p>Clear out all previews in the current region.
</p>
</dd>
<dt> <kbd>C-c C-p C-c C-b</kbd></dt>
<dt> <code>preview-clearout-buffer</code></dt>
<dt> Preview/Remove previews from buffer</dt>
<dd><a name="index-C_002dc-C_002dp-C_002dc-C_002db"></a>
<a name="index-preview_002dclearout_002dbuffer"></a>
<p>Clear out all previews in current buffer. This makes the current buffer
lose all previews.
</p>
</dd>
<dt> <kbd>C-c C-p C-c C-d</kbd></dt>
<dt> <code>preview-clearout-document</code></dt>
<dt> Preview/Remove previews from document</dt>
<dd><a name="index-C_002dc-C_002dp-C_002dc-C_002dd"></a>
<a name="index-preview_002dclearout_002ddocument-1"></a>
<p>Clear out all previews in current document.  The document consists of
all buffers that have the same master file as the current buffer.  This
makes the current document lose all previews.
</p>
</dd>
<dt> <kbd>C-c C-p C-f</kbd></dt>
<dt> <code>preview-cache-preamble</code></dt>
<dt> Preview/Turn preamble cache on</dt>
<dd><a name="index-C_002dc-C_002dp-C_002df"></a>
<a name="index-preview_002dcache_002dpreamble"></a>
<p>Dump a pregenerated format file.  For the rest of the session, this file
is used when running on the same master file.  Use this if you know your
LaTeX takes a long time to start up, the speedup will be most
noticeable when generating single or few previews.  If you change your
preamble, do this again.  preview-latex will try to detect the
necessity of that automatically when editing changes to the preamble are
done from within Emacs, but it will not notice if the preamble
effectively changes because some included file or style file is
tampered with.
</p>
</dd>
<dt> <kbd>C-c C-p C-c C-f</kbd></dt>
<dt> <code>preview-cache-preamble-off</code></dt>
<dt> Preview/Turn preamble cache off</dt>
<dd><a name="index-C_002du-C_002dc-C_002dp-C_002df"></a>
<a name="index-preview_002dcache_002dpreamble_002doff"></a>
<p>Clear the pregenerated format file and stop using preambles for the
current document. If the caching gives you problems, use this.
</p>
</dd>
<dt> <kbd>C-c C-p C-i</kbd></dt>
<dt> <code>preview-goto-info-page</code></dt>
<dt> Preview/Read Documentation</dt>
<dd><a name="index-C_002dc-C_002dp-C_002di"></a>
<a name="index-preview_002dgoto_002dinfo_002dpage"></a>
<p>Read
the
info manual.
</p>
</dd>
<dt> <kbd>M-x preview-report-bug &lt;RET&gt;</kbd></dt>
<dt> <code>preview-report-bug</code></dt>
<dt> Preview/Report Bug</dt>
<dd><a name="index-M_002dx-preview_002dreport_002dbug-RET"></a>
<a name="index-preview_002dreport_002dbug"></a>
<a name="index-Report-a-bug"></a>
<p>This is the preferred way of reporting bugs as it will fill in what
version of preview-latex you are using as well as versions of
relevant other software, and also some of the more important
settings. Please use this method of reporting, if at all possible and
before reporting a bug, have a look at <a href="preview-latex_6.html#Known-problems">Known problems</a>.
</p>
</dd>
<dt> <kbd>C-c C-k</kbd></dt>
<dt> LaTeX/TeX Output/Kill Job</dt>
<dd><a name="index-C_002dc-C_002dk"></a>
<a name="index-Kill-preview_002dgenerating-process"></a>
<p>Kills the preview-generating process. This is really an AUCTeX
keybinding, but it is included here as a hint. If you are generating
a preview and then make a change to the buffer, preview-latex may be
confused and place the previews wrong.
</p></dd>
</dl>

<hr size="6">
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="preview-latex_3.html#Installation" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
<td valign="middle" align="left">[<a href="preview-latex_5.html#Simple-customization" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="preview-latex.html#Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="preview-latex_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="preview-latex_11.html#Index" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="preview-latex_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<p>
 <font size="-1">
  This document was generated by <em>Build Daemon user</em> on <em>November 4, 2010</em> using <a href="http://www.nongnu.org/texi2html/"><em>texi2html 1.82</em></a>.
 </font>
 <br>

</p>
</body>
</html>
auctex 11.86-2ubuntu1 / usr / share / doc / auctex / HTML / preview-latex / preview-latex_4.html
