如何为我自己的电动工具添加手册页条目?让我思考:如何创建一个信息页面?
答案1
要创建 Info 文档,首先需要一个 texi 文件。
.texi
-德克萨斯信息网是一种排版语法,用于使用单个源文件生成在线和打印形式的文档(创建 dvi、html、pdf 等文件类型及其自己的超文本格式 info)。它由作为同名自由软件发布的计算机程序实现,由自由软件基金会的 GNU 项目创建并提供。
.info
- Info(通过 生成makeinfo
。)这是一种特定的格式,本质上是原始 Texinfo 语法的纯文本版本,结合一些控制字符来分隔节点并为菜单、交叉引用、部分等提供导航元素。可以使用该info
程序查看信息格式。
makeinfo
是一个将 Texinfo 文件转换为 Info 文件的实用程序;它是 texinfo 包的一部分。texinfo-format-region
和texinfo-format-buffer
是具有相同功能的 GNU Emacs 函数。
\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
makeinfo mytool.texi
dir
要将新的信息文件添加到系统中,请在目录中文件的菜单中为其写入一个菜单项info
(/usr/share/info/
在 Ubuntu 上)。另外,将新的 Info 文件本身移至该info
目录。例如,如果您要添加 GDB 文档,您将编写以下新条目:
* GDB: (gdb). The source-level C debugger.
菜单项的第一部分是菜单项名称,后跟冒号。第二部分是信息文件的名称,位于括号中,后跟句点。第三部分是说明。
按照惯例,信息文件的名称具有.info
扩展名。因此,您可以像这样列出文件的名称:
* GDB: (gdb.info). The source-level C debugger.
.info
但是,如果 Info 没有找到菜单中给定名称下的文件,它将查找带有扩展名的文件。这意味着您可以将该文件引用gdb.info
为gdb
,如第一个示例所示。这看起来更好。