Para criar documentação informativa, primeiro você precisa de um arquivo texi.
.texi - Texinfo é uma sintaxe de composição usada para gerar documentação tanto on-line quanto impressa (criando tipos de arquivos como dvi, html, pdf, etc., e seu próprio formato de hipertexto, info) com um único arquivo de origem. É implementado por um programa de computador lançado como software livre de mesmo nome, criado e disponibilizado pelo Projeto GNU da Free Software Foundation.
.info - Info (Gerado via makeinfo .) Este é um formato específico que é essencialmente uma versão em texto puro da sintaxe Texinfo original em conjunto com alguns caracteres de controle para separar nós e fornecer elementos navegacionais para menus, referências cruzadas, seções e assim por diante. O formato Info pode ser visualizado com o programa info .
makeinfo é um utilitário que converte um arquivo Texinfo em um arquivo Info; faz parte do pacote texinfo . texinfo-format-region e texinfo-format-buffer são funções do GNU Emacs que fazem o mesmo.
Aqui está um exemplo de texi para usar como modelo :
\input texinfo @c -*-texinfo-*-
@comment $Id@w{$}
@comment %**start of header
@setfilename sample.info
@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{} 2013 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
@ifnottex
@node Top
@top GNU Sample
This manual is for GNU Sample (version @value{VERSION}, @value{UPDATED}).
@end ifnottex
@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
Converta isso em documentação de informação com:
makeinfo mytool.texi
Listando um novo arquivo de informações
Para adicionar um novo arquivo de informações ao seu sistema, escreva uma entrada de menu para ele no menu no arquivo dir no diretório info ( /usr/share/info/ no Ubuntu). Além disso, mova o novo arquivo Info para o diretório info . Por exemplo, se você estivesse adicionando documentação para o GDB, você escreveria a seguinte nova entrada:
* GDB: (gdb). The source-level C debugger.
A primeira parte da entrada do menu é o nome da entrada do menu, seguido por dois pontos. A segunda parte é o nome do arquivo Info, entre parênteses, seguido por um ponto final. A terceira parte é a descrição.
Convencionalmente, o nome de um arquivo de informações tem uma extensão .info . Assim, você pode listar o nome do arquivo assim:
* GDB: (gdb.info). The source-level C debugger.
No entanto, o Info procurará um arquivo com a extensão .info se não encontrar o arquivo sob o nome dado no menu. Isso significa que você pode consultar o arquivo gdb.info as gdb , conforme mostrado no primeiro exemplo. Isso parece melhor.