mksigen-sigen(5)

名前

書式

説明

地球流体電脳倶楽部の資源にはすべて説明ファイルをつけます。 そのファイル名は資源本体 (ファイルまたはディレクトリ) の名前に .SIGEN という接尾辞をつけたものです。 ファイルの字句的形式はインターネットの電子メールに類似しています。 詳細は mksigen-email(5) を参照してください。

ここでは有効なフィールド名について説明します。 これ以外のフィールドは無視されます。

フィールド

必須

Subject:

資源の題名をあらわします。

Maintainer:

資源提供者をあらわします。

Update:

資源が更新された日付をあらわします。 Subject: や Maintainer: はこの時点で妥当なものでなければなりません。

あってもなくてもよいもの

Prune:

このフィールドが存在し、かつ値が空でも "0" でもない場合 (ただし "1" を用いることを推奨します)、 mksigen(8) は対応する資源本体がディレクトリであってもその内部の資源を探索しません。

Description:

資源に関するより詳細な説明です。

Note:

資源の取扱などに対する注意を記入します。

テキストフィールドの扱い

Description: フィールドと Note: フィールドに書かれた文字列は 基本的にはそのまま SIGEN.htm に出力されます。 HTML ではクォートしなければならない <, >, ", & もそのまま 出力されますので注意してください。

例外として relative:relative_url で始まる語と url の形式の文字列がハイパーリンクに変換されます。 前者は資源ファイルのあるディレクトリ (資源がディレクトリの場合そのディレクトリも探索されます) からの相対 URL と解釈されます。 もしファイルが見付からない場合はリンクは張られません。 後者は自動的にハイパーリンクに変換されるので相対パスを書く場合には 注意してください。 また file:path のようにファイルプロトコルの参照をしても http 経由では見られないので、 http に乗らないものだけをファイルプロトコルで参照してください。

例

あるディレクトリの説明ファイル:

Subject: 地球流体理論マニュアル
Maintainer: 林 祥介
Update: 1998/03/16
Note: 目次は relative:index.htm である
Prune: 0
Description: 資源に関する詳細な説明です.

履歴


	1998/03/11 石岡圭一


	1998/05/11 林 祥介

参照

履歴

1998/02/23 豊田英司
1998/05/13 豊田英司  相対パスのリンクのしかたを file: から relative: に変更