私の電動工具のマニュアルページ項目をどのように追加しますか?気がつきました。情報ページの作成方法は?
ベストアンサー1
Info ドキュメントを生成するには、まず texi ファイルが必要です。
.texi
-テキサス情報ネットワーク単一のソースファイルからオンラインおよび印刷形式で文書を生成するための組版構文(dvi、html、pdfなどのファイルタイプ、および独自のハイパーテキスト形式情報を生成)。これは、フリーソフトウェア財団のGNUプロジェクトによって作成され提供される同じ名前のフリーソフトウェアとしてリリースされたコンピュータプログラムによって実装されています。
.info
- Info(世代別makeinfo
)これは、基本的に元のTexinfo構文のプレーンテキストバージョンである特定の形式で、ノードを分離し、メニュー、相互参照、セクションなどのナビゲーション要素を提供するためにいくつかの制御文字と組み合わせられます。このinfo
プログラムを使用して情報形式を表示できます。
makeinfo
TexinfoファイルをInfoファイルに変換するユーティリティプログラム。texinfo パッケージの一部です。。同じ機能を持つGNU Emacs関数ですtexinfo-format-region
。texinfo-format-buffer
\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.
メニュー項目の最初の部分はメニュー項目名で、その後にコロンが続きます。 2番目の部分は情報ファイルの名前で、括弧で囲まれ、その後にピリオドが続きます。 3番目の部分は説明です。
通常、情報ファイルの名前は.info
拡張子で指定されます。したがって、次のようにファイル名を一覧表示できます。
* GDB: (gdb.info). The source-level C debugger.
.info
ただし、Infoがメニュー内の特定の名前のファイルを見つけられない場合は、拡張子を持つファイルを見つけます。これは、最初の例に示すようにファイルをgdb.info
として参照できることを意味します。gdb
これが良く見えますね。