texinfo-doc-nonfree 4.13a-1 / usr / share / doc / texinfo / html / Variables-Commands.html

This file is indexed.

/usr/share/doc/texinfo/html/Variables-Commands.html is in texinfo-doc-nonfree 4.13a-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<html lang="en">
<head>
<title>Variables Commands - GNU Texinfo 4.13</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Texinfo 4.13">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Def-Cmds-in-Detail.html#Def-Cmds-in-Detail" title="Def Cmds in Detail">
<link rel="prev" href="Functions-Commands.html#Functions-Commands" title="Functions Commands">
<link rel="next" href="Typed-Functions.html#Typed-Functions" title="Typed Functions">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual is for GNU Texinfo (version 4.13, 18 September 2008),
a documentation system that can produce both online information and a
printed manual from a single source.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
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.2 or any later version published by the Free Software
     Foundation; with no Invariant Sections, with the Front-Cover Texts
     being ``A GNU Manual'', and with the Back-Cover Texts as in (a)
     below.  A copy of the license is included in the section entitled
     ``GNU Free Documentation License.''

     (a) The FSF's Back-Cover Text is: ``You are free to copy and modify
     this GNU Manual.  Buying copies from GNU Press supports the FSF in
     developing GNU and promoting software freedom.''
  -->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<a name="Variables-Commands"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Typed-Functions.html#Typed-Functions">Typed Functions</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Functions-Commands.html#Functions-Commands">Functions Commands</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Def-Cmds-in-Detail.html#Def-Cmds-in-Detail">Def Cmds in Detail</a>
<hr>
</div>

<h4 class="subsection">16.5.2 Variables and Similar Entities</h4>

<p>Here are the commands for defining variables and similar
entities:

     
<a name="index-defvr-963"></a>
<dl><dt><code>@defvr </code><var>category</var> <var>name</var><dd>The <code>@defvr</code> command is a general definition command for
something like a variable&mdash;an entity that records a value.  You must
choose a term to describe the category of entity being defined; for
example, &ldquo;Variable&rdquo; could be used if the entity is a variable. 
Write the <code>@defvr</code> command at the beginning of a line and
follow it on the same line by the category of the entity and the
name of the entity.

     <p>Capitalize the category name like a title.  If the name of the category
contains spaces, as in the name &ldquo;User Option&rdquo;, enclose it in braces. 
Otherwise, the second word will be mistaken for the name of the entity. 
For example,

     <pre class="example">          @defvr {User Option} fill-column
          This buffer-local variable specifies
          the maximum width of filled lines.
          ...
          @end defvr
</pre>
     <p>Terminate the definition with <code>@end defvr</code> on a line of its
own.

     <p>The template is:

     <pre class="example">          @defvr <var>category</var> <var>name</var>
          <var>body-of-definition</var>
          @end defvr
</pre>
     <p><code>@defvr</code> creates an entry in the index of variables for <var>name</var>.

     <p><a name="index-defvar-964"></a><br><dt><code>@defvar </code><var>name</var><dd>The <code>@defvar</code> command is the definition command for variables. 
<code>@defvar</code> is equivalent to &lsquo;<samp><span class="samp">@defvr Variable
...</span></samp>&rsquo;.

     <p>For example:

     <pre class="example">          @defvar kill-ring
          ...
          @end defvar
</pre>
     <p>The template is:

     <pre class="example">          @defvar <var>name</var>
          <var>body-of-definition</var>
          @end defvar
</pre>
     <p><code>@defvar</code> creates an entry in the index of variables for
<var>name</var>.

     <p><a name="index-defopt-965"></a><br><dt><code>@defopt </code><var>name</var><dd><a name="index-User-options_002c-marking-966"></a>The <code>@defopt</code> command is the definition command for <dfn>user
options</dfn>, i.e., variables intended for users to change according to
taste; Emacs has many such (see <a href="../emacs/Variables.html#Variables">Variables</a>).  <code>@defopt</code> is equivalent to &lsquo;<samp><span class="samp">@defvr {User
Option} ...</span></samp>&rsquo; and works like <code>@defvar</code>.  It creates an entry
in the index of variables. 
</dl>

  </body></html>

APT Browse - Built by Thomas Orozco.