JezK
Edit File: GNU-Sample-Texts.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <!-- This manual is for GNU Texinfo (version 6.8, 8 June 2021), a documentation system that can produce both online information and a printed manual from a single source using semantic markup. Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2021 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". --> <title>GNU Sample Texts (GNU Texinfo 6.8)</title> <meta name="description" content="GNU Sample Texts (GNU Texinfo 6.8)"> <meta name="keywords" content="GNU Sample Texts (GNU Texinfo 6.8)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2any"> <meta name="viewport" content="width=device-width,initial-scale=1"> <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="Sample-Texinfo-Files.html" rel="up" title="Sample Texinfo Files"> <link href="Verbatim-Copying-License.html" rel="next" title="Verbatim Copying License"> <style type="text/css"> <!-- a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {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} span:hover a.copiable-anchor {visibility: visible} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <div class="section" id="GNU-Sample-Texts"> <div class="header"> <p> Next: <a href="Verbatim-Copying-License.html" accesskey="n" rel="next">Verbatim Copying License</a>, Up: <a href="Sample-Texinfo-Files.html" accesskey="u" rel="up">Sample Texinfo Files</a> [<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="GNU-Sample-Texts-1"></span><h3 class="section">C.1 GNU Sample Texts</h3> <span id="index-GNU-sample-texts"></span> <span id="index-Sample-texts_002c-GNU"></span> <span id="index-Full-texts_002c-GNU"></span> <p>Following is a sample Texinfo document with the full texts that should be used (adapted as necessary) in GNU manuals. </p> <p>As well as the legal texts, it also serves as a practical example of how many elements in a GNU system can affect the manual. If you’re not familiar with all these different elements, don’t worry. They’re not required and a perfectly good manual can be written without them. They’re included here nonetheless because many manuals do (or could) benefit from them. </p> <p>See <a href="Short-Sample-Texinfo-File.html#Short-Sample">Short Sample</a>, for a minimal example of a Texinfo file. </p> <p>Here are some notes on the example: </p> <ul> <li> <span id="index-automake_002c-and-version-info"></span> <span id="index-UPDATED-Automake-variable"></span> <span id="index-UPDATED_002dMONTH-Automake-variable"></span> <span id="index-VERSION-Automake-variable"></span> <span id="index-time_002dstamp_002eel"></span> The <samp>version.texi</samp> in the <code>@include</code> command is maintained automatically by Automake (see <a data-manual="automake" href="../automake/Texinfo.html#Texinfo">Texinfo</a> in <cite>GNU Automake</cite>). It sets the ‘<samp>VERSION</samp>’, ‘<samp>UPDATED</samp>’ and ‘<samp>UPDATED-MONTH</samp>’ values used elsewhere. If your distribution doesn’t use Automake, but you do use Emacs, you may find the time-stamp.el package helpful (see <a data-manual="emacs" href="../emacs/Time-Stamps.html#Time-Stamps">Time Stamps</a> in <cite>The GNU Emacs Manual</cite>). </li><li> The <code>@syncodeindex</code> command reflects the recommendation to use only one index where possible, to make it easier for readers to look up index entries. </li><li> The <code>@dircategory</code> is for constructing the Info directory. See <a href="Installing-Dir-Entries.html">Installing Info Directory Files</a>, which includes a variety of recommended category names. </li><li> The ‘Invoking’ node is a GNU standard to help users find the basic information about command-line usage of a given program. See <a data-manual="standards" href="../standards/Manual-Structure-Details.html#Manual-Structure-Details">Manual Structure Details</a> in <cite>GNU Coding Standards</cite>. </li><li> <span id="index-GNU-Free-Documentation-License_002c-including-entire"></span> <span id="index-Free-Documentation-License_002c-including-entire"></span> This sample shows how to includes the FDL in a manual using the <code>@include</code> command. The <samp>fdl.texi</samp> file is available in the Texinfo and other GNU source distributions. It is also available on the GNU website (at <a href="https://www.gnu.org/licenses/fdl-1.3.html">https://www.gnu.org/licenses/fdl-1.3.html</a>) along with guidance for using it. </li><li> If the FSF is not the copyright holder, then use the appropriate name. </li><li> For documents that express your personal views, feelings or experiences, it is more appropriate to use a license permitting only verbatim copying, rather than the FDL. See <a href="Verbatim-Copying-License.html">Verbatim Copying License</a>. </li></ul> <p>Here is the sample document: </p> <pre class="verbatim">\input texinfo @c -*-texinfo-*- @comment %**start of header @include version.texi @settitle GNU Sample @value{VERSION} @syncodeindex pg cp @comment %**end of header @copying This manual is for GNU Sample (version @value{VERSION}, @value{UPDATED}), which is an example in the Texinfo documentation. Copyright @copyright{} 2016 Free Software Foundation, Inc. @quotation 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''. @end quotation @end copying @dircategory Texinfo documentation system @direntry * sample: (sample)Invoking sample. @end direntry @titlepage @title GNU Sample @subtitle for version @value{VERSION}, @value{UPDATED} @author A.U. Thor (@email{bug-sample@@gnu.org}) @page @vskip 0pt plus 1filll @insertcopying @end titlepage @contents @node Top @top GNU Sample This manual is for GNU Sample (version @value{VERSION}, @value{UPDATED}). @menu * Invoking sample:: * GNU Free Documentation License:: * Index:: @end menu @node Invoking sample @chapter Invoking sample @pindex sample @cindex invoking @command{sample} This is a sample manual. There is no sample program to invoke, but if there were, you could see its basic usage and command line options here. @node GNU Free Documentation License @appendix GNU Free Documentation License @include fdl.texi @node Index @unnumbered Index @printindex cp @bye </pre> </div> <hr> <div class="header"> <p> Next: <a href="Verbatim-Copying-License.html">Verbatim Copying License</a>, Up: <a href="Sample-Texinfo-Files.html">Sample Texinfo Files</a> [<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>