Original author(s)Richard Stallman
Robert Chassell
Developer(s)Brian Fox[1]
Karl Berry
Initial releaseFebruary 1986[2]
Stable release
7.1[3] Edit this on Wikidata / 18 October 2023
Repository
Written inC, Perl
Operating systemGNU/Linux, BSD
TypeDocumentation
LicenseGPL-3.0-or-later
Websitewww.gnu.org/s/texinfo

Texinfo is a typesetting syntax used for generating documentation in both on-line and printed form (creating filetypes as dvi, html, pdf, etc., and a specific hypertext format, Info) with a single source file. It is implemented by a computer program released as free software of the same name, created and made available by the GNU Project from the Free Software Foundation.[4]

The main purpose of Texinfo is to provide a way to easily typeset software manuals. Similar to the LaTeX syntax, all the normal features of a book, such as chapters, sections, cross references, tables and indices are available for use in documents. Using the various output generators that are available for Texinfo, it is possible to keep several documentation types up-to-date (such as on-line documentation provided via a Web site, and printed documentation, as generated using the TeX typesetting system) using only a single source file.

The official Texinfo documentation states that the first syllable of "Texinfo" is pronounced so as to rhyme with "speck", not "hex"; this pronunciation is derived from the pronunciation of TeX, in which the X represents the Greek letter chi rather than the English letter x. The maintainers state that "Texinfo" should be written with only a capital "T" and the rest of the letters in lower case.

Output formats

In order to make it possible for several documentation output formats to be updated all at once, upon changing the original Texinfo (.texi) source file, several syntax converters are available that can be used to generate translations of the Texinfo file into other formats. Most of these are created using the texi2any program, also known as makeinfo, which is part of the GNU Texinfo distribution.

HTML
(Generated via texi2any --html.) As HTML is the standard language for documents presented on the World Wide Web, this output format can effectively be used to produce online documentation pages. The manual notes that the texi2any output is intentionally quite plain for maximum portability and accessibility. texi2any HTML output is highly customizable.
DVI
(Generated via texi2dvi.) The device independent file format is output by the TeX typesetting system, and can be used for generating device-specific commands that can be viewed or printed; for example, translation to PostScript (ps files).
PDF
(Generated via texi2dvi --pdf or texi2pdf.) Based on the PostScript language, this format was developed by Adobe Systems for portable document interchange. It can represent the exact appearance of a document and supports arbitrary scaling. It is intended to be platform-independent and can be viewed with a large variety of software. By default, Texinfo uses the pdftex program, a variant of TeX, to output PDF.
LaTeX
(Generated via texi2any --latex.) This is a typesetting system built on top of TeX. The LaTeX output can be further processed into DVI, PostScript, or PDF.
Docbook
(Generated via texi2any --docbook.) This is an XML-based markup language for technical documentation that bears some resemblance to Texinfo, in broad outlines. It is also possible to convert Docbook files to Texinfo, using the docbook2X program.
EPUB
(Generated via texi2any --epub3.) EPUB is a format designed for reading electronic books on portable devices. It is a derivative of HTML.
XML
(Generated via texi2any --xml.) Unlike all the other output formats, is a transliteration of the Texinfo source, rather than finished output. The purpose of the Texinfo XML output is to allow further processing by XML tools.
Info
(Generated via texi2any.) This is a specific format which essentially is a plain text transliteration of the original Texinfo source, with the addition of a few control characters to separate nodes and provide navigational elements for menus, cross-references, indices, and so on. Files in Info format can be browsed with the info program, which is distributed along with Texinfo, as well as with several third-party info viewers.
Plain text
(Generated via texi2any --plaintext.) This is almost the same as Info output with the navigational control characters omitted.

Man output

Notably, man is not available as an output format from the standard Texinfo tools. While Texinfo is used for writing the documentation of GNU software, which typically is used in Unix-like environments such as Linux, where man pages are the traditional format for documentation, the rationale for this is that man pages have a strict conventional format, used traditionally as quick reference guides, whereas typical Texinfo applications are for tutorials as well as reference manuals. As such, no benefit is seen in expressing Texinfo content in man page format. Moreover, many GNU projects eschew man pages almost completely, referring the reader of the provided man page (which often describes itself as seldom maintained) to the Info document.

Texinfo source file

Texinfo enables structuring a document like a book with chapters, sections, cross references and indices. The source is almost plain text, but technically it is formatted text marked up by commands that begin with "@". A sample of a part of a source file:

@node Top
@top Short Sample

@node First Chapter
@nodedescription The first chapter is the only chapter in this sample.
@chapter First Chapter

@cindex chapter, first
This is the first chapter.

The commands mark structure such as chapters, mark words, examples, lists and tables or denote a part of the source to be processed only for certain types of output.

History and status

Texinfo is used as the official documentation system for the GNU Project. The GNU Texinfo distribution is licensed under the GNU General Public License.

The Texinfo format was created by Richard M. Stallman, combining another system for print output in use at MIT called BoTeX, with the online Info hyperlinked documentation system, also created by Stallman on top of the TECO implementation of Emacs.[5][6] BoTeX itself was based on an earlier system called Bolio (associated with David A. Moon, and used for documentation of the Lisp Machine[7]), converted to use TeX for its output. Robert Chassell helped Stallman to create the first translator to create Info in Emacs Lisp. Texinfo is "loosely based on Brian Reid's Scribe and other formatting languages of the time".[8]

The Texinfo software distribution development was led by Brian Fox (up to version 3.8), Karl Berry (through version 5.2), and by Gavin Smith (since Dec. 2014).

See also

Notes and references

  1. ^ GNU's Who, The GNU Team has grown larger in the last few months: Brian Fox and Opus Goldstein have joined Jay Fenlason as the only employees of the Foundation. Most recently, Brian created a stand-alone texinfo formatter and browser..., February, 1988, GNU's Bulletin, vol. 1 no. 4
  2. ^ Gnu Status, by Richard M. Stallman. "5. Documentation system. I now have a truly compatible pair of programs which can convert a file of texinfo format documentation into either a printed manual or an Info file. Documentation files are needed for many utilities.", February 1986, GNU's Bulletin, Volume 1 No. 1
  3. ^ Gavin Smith (18 October 2023). "Texinfo 7.1 released". Retrieved 18 October 2023.
  4. ^ What's GNU: Texinfo, Issue 6, Oct 01, 1994, By Arnold Robbins, Linux Journal
  5. ^ GNU Texinfo Manual, Section 1.14 History
  6. ^ Richard Stallman, January 8, 2012, post on emacs-devel mailing list: "...Info has existed since 1976 or so, in the original Emacs. At that time, Info files were written by hand, and everyone could edit system files on ITS."
  7. ^ Daniel Weinreb and David A. Moon (January 1979), Lisp Machine Manual, Second Preliminary Version
  8. ^ Texinfo