Viewing File: /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 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>Minimum (GNU Texinfo 6.7)</title>

<meta name="description" content="Minimum (GNU Texinfo 6.7)">
<meta name="keywords" content="Minimum (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="Writing-a-Texinfo-File.html" rel="up" title="Writing a Texinfo File">
<link href="Short-Sample.html" rel="next" title="Short Sample">
<link href="Comments.html" rel="prev" title="Comments">
<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="Minimum"></span><div class="header">
<p>
Next: <a href="Short-Sample.html" accesskey="n" rel="next">Short Sample</a>, Previous: <a href="Comments.html" accesskey="p" rel="prev">Comments</a>, Up: <a href="Writing-a-Texinfo-File.html" accesskey="u" rel="up">Writing a Texinfo File</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="What-a-Texinfo-File-Must-Have"></span><h3 class="section">2.3 What a Texinfo File Must Have</h3>
<span id="index-Minimal-Texinfo-file-_0028requirements_0029"></span>
<span id="index-Must-have-in-Texinfo-file"></span>
<span id="index-Required-in-Texinfo-file"></span>
<span id="index-Texinfo-file-minimum"></span>

<p>By convention, the name of a Texinfo file ends with one of the 
extensions <samp>.texi</samp>, <samp>.texinfo</samp>, <samp>.txi</samp>, or 
<samp>.tex</samp>.
</p>
<p>In order to be made into a printed manual and other output
formats, a Texinfo file must begin with lines like this:
</p>
<div class="example">
<pre class="example">\input texinfo
@settitle <var>name-of-manual</var>
</pre></div>

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

<span id="index-_005cinput-_0028raw-TeX-startup_0029"></span>
<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>@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.  If you 
leave this out, you&rsquo;ll be dumped at TeX&rsquo;s prompt at the end of the 
run.
</li></ul>

<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 two
lines at the beginning and the one line at the end.
</p>


<hr>
<div class="header">
<p>
Next: <a href="Short-Sample.html" accesskey="n" rel="next">Short Sample</a>, Previous: <a href="Comments.html" accesskey="p" rel="prev">Comments</a>, Up: <a href="Writing-a-Texinfo-File.html" accesskey="u" rel="up">Writing a Texinfo File</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>



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