Viewing File: /usr/share/doc/texinfo/html/_0040point.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 6.7, 23 September 2019),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 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". -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>@point (GNU Texinfo 6.7)</title>

<meta name="description" content="@point (GNU Texinfo 6.7)">
<meta name="keywords" content="@point (GNU Texinfo 6.7)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<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">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<span id="g_t_0040point"></span><div class="header">
<p>
Next: <a href="Click-Sequences.html" accesskey="n" rel="next">Click Sequences</a>, Previous: <a href="_0040equiv.html" accesskey="p" rel="prev"><code>@equiv</code></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>
<span id="g_t_0040point_007b_007d-_0028_2605_0029_003a-Indicating-Point-in-a-Buffer"></span><h4 class="subsection">12.9.7 <code>@point{}</code> (&lowast;): Indicating Point in a Buffer</h4>

<span id="Point-Glyph"></span><span id="index-Point_002c-indicating-in-a-buffer"></span>
<span id="index-point"></span>

<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>@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>between</em> two characters where point is located.)
</p>
<p>The <code>@point{}</code> command is displayed as &lsquo;<samp>&lowast;</samp>&rsquo;, either
a pointed star or (when that is not available) the ASCII sequence
&lsquo;<samp>-!-</samp>&rsquo;.
</p>
<p>The following example shows the contents of buffer <samp>foo</samp> before
and after evaluating a Lisp command to insert the word <code>changed</code>.
</p>
<div class="example">
<pre class="example">---------- Buffer: foo ----------
This is the &lowast;contents of foo.
---------- Buffer: foo ----------

</pre></div>

<div class="example">
<pre class="example">(insert &quot;changed &quot;)
    &rArr; nil
---------- Buffer: foo ----------
This is the changed &lowast;contents of foo.
---------- Buffer: foo ----------

</pre></div>

<p>In a Texinfo source file, the example is written like this:
</p>
<div class="example">
<pre class="example">@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>





</body>
</html>
Back to Directory File Manager