タグ: manual

  • texinfoとman pageの概要

    Texinfoとは

    Texinfoは、単一のソースファイルから複数の形式(オンラインドキュメントや印刷用出力)を生成できるドキュメンテーションシステムです。主にソフトウェアのドキュメント作成に使用されます。

    man pageとは

    man page(マニュアルページ)は、Unixライクなオペレーティングシステムで使用される、コマンドラインツールやシステム関数のリファレンスマニュアルです。

    Texinfoの使い方

    1. Texinfoソースファイルの作成
    2. makeinfoコマンドでHTML、Info、またはPDF形式に変換
    3. 生成されたドキュメントの配布や公開

    texinfoはGNUプロジェクトの公式ドキュメンテーションシステムであり、Emacsと深い関わりがあります。Emacsは texinfoファイルを編集・閲覧するための機能を内蔵しており、Info modeを使用してtexinfo形式のドキュメントを直接閲覧できます。また、Emacsのドキュメントもtexinfoで書かれています。

    使い方は以下のコマンドで表示できます:

    man texinfo

    man pageの使い方

    1. manコマンドの基本構文:man [セクション] コマンド名
    2. よく使用されるセクション(1: ユーザーコマンド、5: ファイルフォーマット)
    3. man pageの構造(NAME、SYNOPSIS、DESCRIPTION等)

    日本語のパッケージは以下のコマンドでインストールします1

    sudo apt install manpages-ja manpages-ja-dev

    man pageは通常、8つのセクションに分かれています2が、そうでない場合もあります。man manで表示できます。次のコマンドでも概要を読めます。

    man 1 intro
    man 2 intro
    man 3 intro
    man 4 intro
    man 5 intro
    man 6 intro
    man 7 intro
    man 8 intro

    特定のセクションのman pageを参照するには、man [セクション番号] [コマンド名]の形式で指定します。

    1. manで基本的なコマンドの日本語表示がされない原因は? ↩︎
    2. manの読み方(初心者向け) ↩︎