texinfo-doc-nonfree 4.13a-1 / usr / share / doc / texinfo / html / set-value.html

This file is indexed.

/usr/share/doc/texinfo/html/set-value.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
<html lang="en">
<head>
<title>set value - 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="set-clear-value.html#set-clear-value" title="set clear value">
<link rel="next" href="ifset-ifclear.html#ifset-ifclear" title="ifset ifclear">
<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="set-value"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="ifset-ifclear.html#ifset-ifclear">ifset ifclear</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="set-clear-value.html#set-clear-value">set clear value</a>
<hr>
</div>

<h4 class="subsection">17.4.1 <code>@set</code> and <code>@value</code></h4>

<p><a name="index-set-1027"></a><a name="index-value-1028"></a><a name="index-clear-1029"></a>
You use the <code>@set</code> command to specify a value for a flag, which
is later expanded by the <code>@value</code> command.

  <p>A <dfn>flag</dfn> (aka <dfn>variable</dfn>) is an identifier.  It is best to use
only letters and numerals in a flag name, not &lsquo;<samp><span class="samp">-</span></samp>&rsquo; or
&lsquo;<samp><span class="samp">_</span></samp>&rsquo;&mdash;they will work in some contexts, but not all, due to
limitations in TeX.

  <p>The value is the remainder of the input line, and can contain anything.

  <p>Write the <code>@set</code> command like this:

<pre class="example">     @set foo This is a string.
</pre>
  <p class="noindent">This sets the value of the flag <code>foo</code> to &ldquo;This is a string.&rdquo;.

  <p>The Texinfo formatters then replace an <code>@value{</code><var>flag</var><code>}</code>
command with the string to which <var>flag</var> is set.  Thus, when
<code>foo</code> is set as shown above, the Texinfo formatters convert this:

<pre class="example">     @value{foo}
<br><span class="roman">to this:</span><br>
     This is a string.
</pre>
  <p>You can write an <code>@value</code> command within a paragraph; but you
must write an <code>@set</code> command on a line of its own.

  <p>If you write the <code>@set</code> command like this:

<pre class="example">     @set foo
</pre>
  <p class="noindent">without specifying a string, the value of <code>foo</code> is the empty string.

  <p>If you clear a previously set flag with <code>@clear </code><var>flag</var>, a
subsequent <code>@value{flag}</code> command will report an error.

  <p>For example, if you set <code>foo</code> as follows:

<pre class="example">     @set howmuch very, very, very
</pre>
  <p class="noindent">then the formatters transform

<pre class="example">     It is a @value{howmuch} wet day.
<br><span class="roman">into</span><br>
     It is a very, very, very wet day.
</pre>
  <p>If you write

<pre class="example">     @clear howmuch
</pre>
  <p class="noindent">then the formatters transform

<pre class="example">     It is a @value{howmuch} wet day.
<br><span class="roman">into</span><br>
     It is a {No value for "howmuch"} wet day.
</pre>
  </body></html>

APT Browse - Built by Thomas Orozco.