blob: 22dc693ada1a098f03f257268d0612b67c36c537 [file] [log] [blame]
<!DOCTYPE html>
<html>
<!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.
Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 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, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
"GNU Free Documentation License". -->
<title>@point (GNU Texinfo 6.8dev)</title>
<meta name="description" content="@point (GNU Texinfo 6.8dev)">
<meta name="keywords" content="@point (GNU Texinfo 6.8dev)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Glyphs-for-Programming.html" rel="up" title="Glyphs for Programming">
<link href="Click-Sequences.html" rel="next" title="Click Sequences">
<link href="_0040equiv.html" rel="prev" title="@equiv">
<style type="text/css">
<!--
div.example {margin-left: 3.2em}
-->
</style>
</head>
<body lang="en">
<div class="subsection-level-extent" id="g_t_0040point">
<div class="nav-panel">
<p>
Next: <a href="Click-Sequences.html" accesskey="n" rel="next">Click Sequences</a>, Previous: <a href="_0040equiv.html" accesskey="p" rel="prev"><code class="code">@equiv{}</code> (&equiv;): Indicating Equivalence</a>, Up: <a href="Glyphs-for-Programming.html" accesskey="u" rel="up">Glyphs for Programming</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsection" id="g_t_0040point_007b_007d-_0028_2605_0029_003a-Indicating-Point-in-a-Buffer">11.9.7 <code class="code">@point{}</code> (&lowast;): Indicating Point in a Buffer</h4>
<a class="anchor" id="Point-Glyph"></a><a class="index-entry-id" id="index-Point_002c-indicating-in-a-buffer"></a>
<a class="index-entry-id" id="index-point"></a>
<p>Sometimes you need to show an example of text in an Emacs buffer. In
such examples, the convention is to include the entire contents of the
buffer in question between two lines of dashes containing the buffer
name.
</p>
<p>You can use the &lsquo;<samp class="samp">@point{}</samp>&rsquo; command to show the location of
point in the text in the buffer. (The symbol for point, of course, is
not part of the text in the buffer; it indicates the place
<em class="emph">between</em> two characters where point is located.)
</p>
<p>The <code class="code">@point{}</code> command is displayed as &lsquo;<samp class="samp">&lowast;</samp>&rsquo;, either
a pointed star or (when that is not available) the ASCII sequence
&lsquo;<samp class="samp">-!-</samp>&rsquo;.
</p>
<p>The following example shows the contents of buffer <samp class="file">foo</samp> before
and after evaluating a Lisp command to insert the word <code class="code">changed</code>.
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">---------- Buffer: foo ----------
This is the &lowast;contents of foo.
---------- Buffer: foo ----------
</pre></div></div>
<div class="example">
<div class="group"><pre class="example-preformatted">(insert &quot;changed &quot;)
&rArr; nil
---------- Buffer: foo ----------
This is the changed &lowast;contents of foo.
---------- Buffer: foo ----------
</pre></div></div>
<p>In a Texinfo source file, the example is written like this:
</p>
<div class="example">
<pre class="example-preformatted">@example
---------- Buffer: foo ----------
This is the @point{}contents of foo.
---------- Buffer: foo ----------
(insert &quot;changed &quot;)
@result{} nil
---------- Buffer: foo ----------
This is the changed @point{}contents of foo.
---------- Buffer: foo ----------
@end example
</pre></div>
</div>
</body>
</html>