/usr/share/doc/texinfo/html/Sample-Function-Definition.html is in texinfo-doc-nonfree 5.2.0-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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | <!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 5.2, 26 September 2013),
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 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 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 have the freedom to copy and
modify this GNU manual. Buying copies from the FSF supports it in
developing GNU and promoting software freedom." -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Texinfo 5.2: Sample Function Definition</title>
<meta name="description" content="GNU Texinfo 5.2: Sample Function Definition">
<meta name="keywords" content="GNU Texinfo 5.2: Sample Function Definition">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Command-and-Variable-Index.html#Command-and-Variable-Index" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Definition-Commands.html#Definition-Commands" rel="up" title="Definition Commands">
<link href="Internationalization.html#Internationalization" rel="next" title="Internationalization">
<link href="Def-Cmd-Conventions.html#Def-Cmd-Conventions" rel="previous" title="Def Cmd Conventions">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {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}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Sample-Function-Definition"></a>
<div class="header">
<p>
Previous: <a href="Def-Cmd-Conventions.html#Def-Cmd-Conventions" accesskey="p" rel="previous">Def Cmd Conventions</a>, Up: <a href="Definition-Commands.html#Definition-Commands" accesskey="u" rel="up">Definition Commands</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="A-Sample-Function-Definition"></a>
<h3 class="section">16.7 A Sample Function Definition</h3>
<a name="index-Function-definitions"></a>
<a name="index-Command-definitions"></a>
<a name="index-Macro-definitions_002c-programming_002dlanguage"></a>
<a name="index-Sample-function-definition"></a>
<p>A function definition uses the <code>@defun</code> and <code>@end defun</code>
commands. The name of the function follows immediately after the
<code>@defun</code> command and it is followed, on the same line, by the
parameter list.
</p>
<p>Here is a definition from <a href="http://www.gnu.org/software/emacs/manual/html_node/elisp/Calling-Functions.html#Calling-Functions">Calling Functions</a> in <cite>The GNU Emacs
Lisp Reference Manual</cite>.
</p>
<blockquote>
<dl>
<dt><a name="index-apply"></a>Function: <strong>apply</strong> <em>function &rest arguments</em></dt>
<dd><p><code>apply</code> calls <var>function</var> with <var>arguments</var>, just
like <code>funcall</code> but with one difference: the last of
<var>arguments</var> is a list of arguments to give to
<var>function</var>, rather than a single argument. We also say
that this list is <em>appended</em> to the other arguments.
</p>
<p><code>apply</code> returns the result of calling <var>function</var>.
As with <code>funcall</code>, <var>function</var> must either be a Lisp
function or a primitive function; special forms and macros
do not make sense in <code>apply</code>.
</p>
<div class="example">
<pre class="example">(setq f 'list)
⇒ list
(apply f 'x 'y 'z)
error→ Wrong type argument: listp, z
(apply '+ 1 2 '(3 4))
⇒ 10
(apply '+ '(1 2 3 4))
⇒ 10
(apply 'append '((a b c) nil (x y z) nil))
⇒ (a b c x y z)
</pre></div>
<p>An interesting example of using <code>apply</code> is found in the description
of <code>mapcar</code>.
</p></dd></dl>
</blockquote>
<p>In the Texinfo source file, this example looks like this:
</p>
<div class="example">
<pre class="example">@defun apply function &rest arguments
@code{apply} calls @var{function} with
@var{arguments}, just like @code{funcall} but with one
difference: the last of @var{arguments} is a list of
arguments to give to @var{function}, rather than a single
argument. We also say that this list is @dfn{appended}
to the other arguments.
</pre><pre class="example">
</pre><pre class="example">@code{apply} returns the result of calling
@var{function}. As with @code{funcall},
@var{function} must either be a Lisp function or a
primitive function; special forms and macros do not make
sense in @code{apply}.
</pre><pre class="example">
</pre><pre class="example">@example
(setq f 'list)
@result{} list
(apply f 'x 'y 'z)
@error{} Wrong type argument: listp, z
(apply '+ 1 2 '(3 4))
@result{} 10
(apply '+ '(1 2 3 4))
@result{} 10
(apply 'append '((a b c) nil (x y z) nil))
@result{} (a b c x y z)
@end example
</pre><pre class="example">
</pre><pre class="example">An interesting example of using @code{apply} is found
in the description of @code{mapcar}.
@end defun
</pre></div>
<p>In this manual, this function is listed in the Command and Variable
Index under <code>apply</code>.
</p>
<p>Ordinary variables and user options are described using a format like
that for functions except that variables do not take arguments.
</p>
<hr>
<div class="header">
<p>
Previous: <a href="Def-Cmd-Conventions.html#Def-Cmd-Conventions" accesskey="p" rel="previous">Def Cmd Conventions</a>, Up: <a href="Definition-Commands.html#Definition-Commands" accesskey="u" rel="up">Definition Commands</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|