texinfo

Texinfo - The GNU Documentation System

Texinfo is the official documentation format of the GNU project. It was invented by Richard Stallman and Bob Chassell many years ago, loosely based on Brian Reid's Scribe and other formatting languages of the time. It is used by many non-GNU projects as well.

Texinfo uses a single source file to produce output in a number of formats, both online and printed (dvi, html, info, pdf, xml, etc.). This means that instead of writing different documents for online information and another for a printed manual, you need write only one document. And when the work is revised, you need revise only that one document. The Texinfo system is well-integrated with GNU Emacs.

Basics

• Texinfo project page on savannah.gnu.org.
• Download the latest official release as a compressed tar file (also on all GNU mirrors). Older releases are also available.
• The Texinfo manual and standalone Info reader manual from the latest official release, in various formats. See the GNU documentation page for manuals for other GNU packages (and more).
• The Texinfo reference card formatted for letter-size paper (four landscape pages) and for A4-size paper.
• The latest texinfo.tex macro file used for converting Texinfo source to DVI or PDF files for printing and viewing, using the TeX typesetting system. The latest texinfo.tex is also available via the Savannah gnulib project and ftp.gnu.org mirrors, among other places. (texinfo.tex is updated much more frequently than full Texinfo releases are made; please use the latest version.)
• If available, the latest pretest. Pretests are inherently unstable. Please try them and report problems—that's why they are done, so the official release will be as reliable as it can be.
• The development source tree.
• The NEWS file listing notable changes by release, the ChangeLog file detailing all changes, and the TODO file with future projects large and small, awaiting volunteers.

Mailing lists

bug-texinfo@gnu.org

The main address for bug reporting, developer discussion, pretest announcements, and more (info, web archive, plain text archive).

help-texinfo@gnu.org

For Texinfo authoring help and discussion (info, web archive, plain text archive).

texinfo-commits@gnu.org

To get mail with every commit to the repository (info, web archive, plain text archive).

To subscribe to these or any GNU mailing lists, please send an empty mail with a Subject: header of just subscribe to the relevant -request list. For example, to subscribe yourself to the GNU announcement list, you would send mail to <info-gnu-request@gnu.org>. Or you can use the mailing list web interface.

More information

• The official GNU documentation page contains much more information about Texinfo and GNU manuals.
• You can search all GNU documentation (among other interesting things).
• An article by Joel Sherrill on converting RTEMS to Texinfo 5.
• An introductory article written by Arnold Robbins.

Other programs/etc.

• GNU help2man, for generating reasonable man pages from --help output.
• gdoc, for extracting Texinfo (and other format) documentation from source files.
• ltxindex, for typesetting indices of LaTeX documents with Texinfo's texindex program.
• my-bib-macros.texi, a start at bibliography support via Texinfo macros. For a start at integration with BibTeX, see the Web2C manual sources.
• Textadept, a customizable editor that includes a Texinfo lexer with fold/unfold functions for large documents.

Conversion to/from Texinfo

• GNU a2ps, for generating printable files from plain text, has a Texinfo style option.
• docbook2x, conversion from Docbook to Texinfo.
• man2texi, generate Texinfo from man pages.
• Scheme Scribe, which can convert Texinfo to Scribe and generate Info files.
• Sphinx Python documentation generator has support for Texinfo, used by MediaGoblin.
• texi2latex, converting Texinfo to LaTeX via XML, no longer maintained.
• texi2roff, an old standalone program that converts to troff format; it is not maintained and not up to date.

Literate programming

• TexiWEB, a literate programming system based on Texinfo and C, by Ben Pfaff as part of his GNU AVL package.
• TexiWeb Jr., another literate programming system, built on top of Texinfo and implemented in awk.

Info readers

• pinfo, a curses-based Info reader with color support and a lynx-like interface.
• tkinfo, a Tk-based Info reader.

HTML styling and processing

• Texinfo CSS by sirgazil
• datamash-texinfo.css, a CSS style sheet (sample output)
• janix-texinfo.css, a CSS style sheet
• infodoc-styles, CSS and post-processing for HTML generated from Texinfo source
• The Kawa manual shows styling of HTML via transformation of Texinfo's DocBook output with XSLT.

If you know of other free software or documentation that would be useful to add here, please email.

Translating Texinfo

To translate Texinfo's messages into other languages, please see the Translation Project texinfo domain and texinfo_document. If you have a new translation of the message strings, or updates to the existing strings, please have the changes made in this repository. Only translations from this site will be incorporated into Texinfo. For more information, see the Translation Project welcome page.

Please send FSF & GNU inquiries to <gnu@gnu.org>. There are also other ways to contact the FSF.
Please send broken links and other corrections or suggestions to <bug-texinfo@gnu.org>.

Copyright © 2016 Free Software Foundation, Inc.

This page is licensed under a Creative Commons Attribution-NoDerivs 3.0 United States License.

Updated: $Date: 2016/12/08 00:19:59 $

https://www.gnu.org/software/texinfo/