/usr/share/doc/texinfo/html/Minimum.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 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: Minimum</title>

<meta name="description" content="GNU Texinfo 5.2: Minimum">
<meta name="keywords" content="GNU Texinfo 5.2: Minimum">
<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="Overview.html#Overview" rel="up" title="Overview">
<link href="Six-Parts.html#Six-Parts" rel="next" title="Six Parts">
<link href="Comments.html#Comments" rel="previous" title="Comments">
<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="Minimum"></a>
<div class="header">
<p>
Next: <a href="Six-Parts.html#Six-Parts" accesskey="n" rel="next">Six Parts</a>, Previous: <a href="Comments.html#Comments" accesskey="p" rel="previous">Comments</a>, Up: <a href="Overview.html#Overview" accesskey="u" rel="up">Overview</a> &nbsp; [<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="What-a-Texinfo-File-Must-Have"></a>
<h3 class="section">1.11 What a Texinfo File Must Have</h3>
<a name="index-Minimal-Texinfo-file-_0028requirements_0029"></a>
<a name="index-Must-have-in-Texinfo-file"></a>
<a name="index-Required-in-Texinfo-file"></a>
<a name="index-Texinfo-file-minimum"></a>

<p>By convention, the name of a Texinfo file ends with (in order of
preference) one of the extensions <samp>.texinfo</samp>, <samp>.texi</samp>,
<samp>.txi</samp>, or <samp>.tex</samp>.  The longer extensions are preferred
since they describe more clearly to a human reader the nature of the
file.  The shorter extensions are for operating systems that cannot
handle long file names.
</p>
<p>In order to be made into a good printed manual and other output
formats, a Texinfo file <em>must</em> begin with lines like this:
</p>
<div class="example">
<pre class="example">\input texinfo
@setfilename <var>info-file-name</var>
@settitle <var>name-of-manual</var>
</pre></div>

<p>The contents of the file follow this beginning, and then you
<em>must</em> end the Texinfo source with a line like this:
</p>
<div class="example">
<pre class="example">@bye
</pre></div>

<a name="index-_005cinput-_0028raw-TeX-startup_0029"></a>
<p>Here&rsquo;s an explanation:
</p>
<ul>
<li> The &lsquo;<samp>\input texinfo</samp>&rsquo; line tells TeX to use the
<samp>texinfo.tex</samp> file, which tells TeX how to translate the Texinfo
@-commands into TeX typesetting commands.  (Note the use of the
backslash, &lsquo;<samp>\</samp>&rsquo;; this is correct for TeX.)

</li><li> The <code>@setfilename</code> line provides a name for the Info file and
tells TeX to open auxiliary files.  <strong>All text before
<code>@setfilename</code> is ignored!</strong>

</li><li> The <code>@settitle</code> line specifies a title for the page headers (or
footers) of the printed manual, and the default title and document
description for the &lsquo;<samp>&lt;head&gt;</samp>&rsquo; in HTML.  Strictly speaking,
<code>@settitle</code> is optional&mdash;if you don&rsquo;t mind your document being
titled &lsquo;Untitled&rsquo;.

</li><li> The <code>@bye</code> line at the end of the file on a line of its own tells
the formatters that the file is ended and to stop formatting.
</li></ul>

<p>If you use Emacs, it is also useful to include mode setting and
start-of-header and end-of-header lines at the beginning of a Texinfo
file, like this:
</p>
<div class="example">
<pre class="example">\input texinfo   @c -*-texinfo-*-
@c %**start of header
@setfilename <var>info-file-name</var>
@settitle <var>name-of-manual</var>
@c %**end of header
</pre></div>

<p>In the first line, &lsquo;<samp>-*-texinfo-*-</samp>&rsquo; causes Emacs to switch into
Texinfo mode when you edit the file.
</p>
<p>The <code>@c ...header</code> lines above which surround the
<code>@setfilename</code> and <code>@settitle</code> lines allow you to process,
within Emacs, just part of the Texinfo source.  (See <a href="Start-of-Header.html#Start-of-Header">Start of Header</a>.)
</p>
<p>Furthermore, you will usually provide a Texinfo file with a title page,
indices, and the like, all of which are explained in this manual.  But
the minimum, which can be useful for short documents, is just the three
lines at the beginning and the one line at the end.
</p>

<hr>
<div class="header">
<p>
Next: <a href="Six-Parts.html#Six-Parts" accesskey="n" rel="next">Six Parts</a>, Previous: <a href="Comments.html#Comments" accesskey="p" rel="previous">Comments</a>, Up: <a href="Overview.html#Overview" accesskey="u" rel="up">Overview</a> &nbsp; [<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>
texinfo-doc-nonfree 5.2.0-1 / usr / share / doc / texinfo / html / Minimum.html
