OSDN Git Service

add dejagnu man*
authorribbon <ribbon@users.osdn.me>
Wed, 6 Apr 2022 23:08:00 +0000 (08:08 +0900)
committerribbon <ribbon@users.osdn.me>
Wed, 6 Apr 2022 23:08:00 +0000 (08:08 +0900)
manual/GNU_dejagnu/release/man1/dejagnu-help.1 [new file with mode: 0644]
manual/GNU_dejagnu/release/man1/dejagnu-report-card.1 [new file with mode: 0644]
manual/GNU_dejagnu/release/man1/dejagnu.1 [new file with mode: 0644]
manual/GNU_dejagnu/release/man1/runtest.1 [new file with mode: 0644]

diff --git a/manual/GNU_dejagnu/release/man1/dejagnu-help.1 b/manual/GNU_dejagnu/release/man1/dejagnu-help.1
new file mode 100644 (file)
index 0000000..74a4e6a
--- /dev/null
@@ -0,0 +1,56 @@
+.\" Copyright (C) 2018  Free Software Foundation, Inc.
+.\" You may distribute this file under the terms of the GNU Free
+.\" Documentation License.
+.\"*******************************************************************
+.\"
+.\" This file was generated with po4a. Translate the source file.
+.\"
+.\"*******************************************************************
+.\"
+.\" translated 2022-04-06
+.\"
+.Dd 2018/12/19
+.Os GNU
+.Dt DEJAGNU-HELP 1 URM
+.Sh 名前
+.Nm dejagnu\ help
+.Nd DejaGNU の補助コマンドに対する man ページの表示
+.Sh 書式
+.Nm dejagnu\ help
+.Op Ar options...
+.Ao Ar command Ac
+.Sh 説明
+.Nm
+コマンドは、 DejaGnu の補助コマンドに対する長い形式のドキュメントを表示します。
+.Sh オプション
+.Bl -tag -width ".Fl v , -verbose"
+.It Fl v , -verbose
+.Nm
+の操作自体を説明する追加情報を出力します。
+.It Fl w , -path
+このオプションは、 このまま
+.Nm man
+に渡されます。
+.It Fl W
+このオプションは、 このまま
+.Nm man
+に渡されます。
+.El
+.Sh ファイル
+.Nm
+コマンドは、 このスクリプトが置かれている
+.Pa commands/
+ディレクトリの横並びの
+.Pa doc/
+ディレクトリにある man ページをチェックします。 man ページがそこに存在した場合、 ファイルのフルネームが
+.Nm man
+に与えられます。 そうでない場合はコマンド名のみが与えられ、
+.Xr man 1
+に説明されている検索処理が実行されます。
+.Sh 関連項目
+.Xr man 1
+.Sh 著者
+Jacob Bachmeyer
+.Sh バグ
+現在は man ページのみサポートしています。
+.\"  LocalWords:  Dt URM Nm DejaGnu Ao Xr
diff --git a/manual/GNU_dejagnu/release/man1/dejagnu-report-card.1 b/manual/GNU_dejagnu/release/man1/dejagnu-report-card.1
new file mode 100644 (file)
index 0000000..d185739
--- /dev/null
@@ -0,0 +1,148 @@
+.\" Copyright (C) 2018  Free Software Foundation, Inc.
+.\" You may distribute this file under the terms of the GNU Free
+.\" Documentation License.
+.\"*******************************************************************
+.\"
+.\" This file was generated with po4a. Translate the source file.
+.\"
+.\"*******************************************************************
+.\"
+.\" translated 2022-04-06
+.\"
+.Dd 2018/12/31
+.Os GNU
+.Dt DEJAGNU-REPORT-CARD 1 URM
+.Sh 名前
+.Nm dejagnu\ report\ card
+.Nd 複数ツールに対するテスト結果の取りまとめ
+.Sh 書式
+.Nm dejagnu\ report\ card
+.Oo Ao Ar option Ac \*(Ba Ao Ar tool Ac \*(Ba Ao Ar file Ac Oc ...
+.Sh 説明
+The
+.Nm
+コマンドは、 複数ツールによるテスト結果を表形式で表示します。 生成されるこの表においては、 以下の項目を一覧表示します。
+各ツールごとに (そして複数パスが実行された場合には、 各パスごとに)、 テストの成功数 (passed)、 失敗数 (failed)、 未対応数
+(unsupported)、 未解決数 (unresolved)、 未実施数 (untested) です。 失敗することが予想されるテストは、
+成功することが予想されるテストとは、 別カラムに分けてカウントされます。 ただし失敗することが分かっている ("known") テストと、
+失敗が予想される ("expected") テストは、 まとめられます。 テストが警告やエラーを生成した場合、 関連する行の終わりに
+.Ql !W!
+や
+.Ql !E!
+というタグがつきます。
+.Pp
+オプションでなく引数リストの場合には、 ツール名またはファイル名が含まれる場合があります。
+.Nm
+コマンドは、 DejaGnu 概要ファイル
+(summary file) を読み込もうとします。 そして、 その場合には名称の翻訳を行います。
+.Bl -tag -width ".Pa *.sum"
+.It Pa *.sum
+そのまま用います。
+.It Pa *.log
+同じベース名を用いて
+.Pa *.sum
+に書き換えます。
+.It Pa *.
+概要ファイルを用いるために、 文字列
+.Pa sum
+が後ろにつけられます。 この処理は、 シェル上の Readline によって、
+ファイル名補完を用いた場合の利便性のために行われるものであり、 補完がドットまで行われるからです。
+.It Pa *
+ツール名として扱われます。 後ろに
+.Pa .sum
+がつけられます。
+.El
+.Sh オプション
+.Bl -tag -width ".Fl v , -verbose"
+.It Fl v , -verbose
+.Nm
+の操作自体を説明する追加情報を出力します。
+.El
+.Sh ファイル
+.Nm
+コマンドが出力を生成する際には、 DejaGnu によって作られた概要ファイルを読み込んで、 "PASS" や "FAIL"
+などの数をカウントします。
+.Pp
+引数に名前が指定されなかった場合、 カレントディレクトリ内の
+.Pa *.sum
+に一致するファイルすべてが読み込まれます。
+.Sh 例
+.Ss DejaGnu 自体のテストスイートから、 単純な例を示します。 
+.Bd -literal
+$ dejagnu report card
+\             __________________________________________________
+\            /    PASS   FAIL  ?PASS  ?FAIL  UNSUP  UNRES UNTEST
+\            |--------------------------------------------------
+\  launcher  |      52      0      0      0      0      0      0
+libdejagnu  |       5      0      0      0      0      0      0
+\   runtest  |     135      0      0      0      0      0      0
+\            |--------------------------------------------------
+\            |     192      0      0      0      0      0      0
+\            \e__________________________________________________
+.Ed
+.Pp
+3 つのツールがテストされました。 そこでは全部で 192 個のテストがあり、 すべて成功することが予想されているものです。 この例において、
+テストはすべて成功 (pass) しています。 したがってこれ以外のカラムは、 すべてゼロになっています。
+.Ql ?PASS
+と
+.Ql ?FAIL
+のカラムは、 それぞれ失敗することが分かっている (known) ものと、 失敗が予想される (expected) ものであったもので、
+実際には、 予想に反して成功したものと、 予想どおりに失敗したものを、 それぞれ示しています。 残りの 3 つのカラムは、
+例外的な結果を示しているもので、 サポートされていない (unsupported) テスト、 未解決 (unresolved) のテスト、
+単純にテストしない (untested) ものとして宣言されているスタブテストをそれぞれ示しています。
+.Pp
+.ne 16v
+.Ss dejagnu-report-card に対するテストが追加された後の同様の結果例
+.Bd -literal
+$ dejagnu report-card
+\                    __________________________________________________
+\                   /    PASS   FAIL  ?PASS  ?FAIL  UNSUP  UNRES UNTEST
+\                   |--------------------------------------------------
+\   launcher        |      52      0      0      0      0      0      0
+\ libdejagnu        |       5      0      0      0      0      0      0
+report-card / awk  |      36      0      0      0      0      0      0
+report-card / sh   |      36      0      0      0      0      0      0
+report-card / tcl  |      36      0      0      0      0      0      0
+\    runtest        |     135      0      0      0      0      0      0
+\                   |--------------------------------------------------
+\              awk  |      36      0      0      0      0      0      0
+\              sh   |      36      0      0      0      0      0      0
+\              tcl  |      36      0      0      0      0      0      0
+\                   |--------------------------------------------------
+\                   |     300      0      0      0      0      0      0
+\                   \e__________________________________________________
+.Ed
+.Pp
+.Ql report-card
+ツールに対して、 各実装ごとに 1 つ、 合計で 3 つのパスが追加されています。 (この後に shell と
+Tcl による実装は、 将来のメンテナンス負荷を減らすために、 取り除かれます。) 前の例と同じく、 テストはすべて期待どおりに成功しています。
+ただ前の例と違って興味深いのは、 DejaGnu によるマルチパスのテスト機能が利用されている点です。 これに従って、
+パスごとの概要行が追加されています。 この例において、 マルチパスのテストを行っているのは
+.Ql report-card
+ツールだけです。
+そこで各パスの合計値は、 他の合計値とは違って、 単に
+.Ql report-card
+のテスト数にすぎません。
+.Pp
+また、
+.Nm
+の実行に用いたコマンドが、 ここでは多少異なっている点を確認してください。
+.Xr dejagnu 1
+の実行にあたっては、
+複数単語をダッシュ文字でつなぎ合わせて 1 つの引数として受け渡すことができます。 こうすることによって、 1 つのコマンド名に含まれる複数単語を、
+ダッシュや空白により交互に区切って、 コマンドライン上から指定することができます。
+.Sh 関連項目
+.Xr dejagnu 1
+.Xr runtest 1
+.Pp
+DejaGnu の完全なドキュメントは Texinfo マニュアルとしてメンテナンスされています。
+.Nm info
+プログラムが適切にインストールされていれば、 コマンド
+.Li info dejagnu
+の実行によって、 完全なマニュアルを参照できます。
+.Sh 著者
+.An Jacob Bachmeyer
+.\".Sh BUGS
+.\"  LocalWords:  Dt dejagnu URM Nm Ao Oo Oc DejaGnu Xr runtest DejaGnu's Bd Ql
+.\"  LocalWords:  testsuite UNSUP UNRES UNTEST libdejagnu Readline Ss tcl awk
+.\"  LocalWords:  ne multipass
diff --git a/manual/GNU_dejagnu/release/man1/dejagnu.1 b/manual/GNU_dejagnu/release/man1/dejagnu.1
new file mode 100644 (file)
index 0000000..634d8d0
--- /dev/null
@@ -0,0 +1,137 @@
+.\" Copyright (C) 2018  Free Software Foundation, Inc.
+.\" You may distribute this file under the terms of the GNU Free
+.\" Documentation License.
+.\"*******************************************************************
+.\"
+.\" This file was generated with po4a. Translate the source file.
+.\"
+.\"*******************************************************************
+.\"
+.\" translated 2022-04-06
+.\"
+.Dd 2018/12/17
+.Os GNU
+.Dt DEJAGNU 1 URM
+.Sh 名前
+.Nm dejagnu
+.Nd DejaGnu の補助コマンド起動
+.Sh 書式
+.Nm dejagnu
+.Ao Ar command Ac
+.Op Fl -help \*(Ba Ar options...
+.Nm
+.Fl -help
+.Nm
+.Fl -version
+.Sh 説明
+.Nm
+コマンドは、 要求された
+.Ar command
+を実装しているスクリプトを検索します。 複数の実装が利用可能である場合には、
+内部の固定リストに基づいて、 対象を選び出します。 そしてそのコマンドを実行します。
+.Sh オプション
+.Bl -tag -width ".Fl -version"
+.It Fl -help
+コマンドを実行せず、 ヘルプメッセージを表示します。 コマンドが指定されなかった場合、
+.Nm
+自体の簡単な使用方法を表示します。
+.It Fl V , -version
+DejaGnu のバージョンを含めた、 本ツールのバージョン情報を表示します。 コマンドが指定されていても無視されます。
+.It Fl v , -verbose
+.Nm
+自体の操作を説明する追加情報を出力します。 このオプションは、 起動されるコマンドにも受け渡されます。
+.El
+.Pp
+コマンド名の後ろに指定された引数は、 起動されるコマンドにすべて受け渡されます。
+.Sh 環境変数
+.Bl -tag -width ".Ev DEJAGNULIBS"
+.It Ev DEJAGNULIBS
+設定する場合は、 ファイルシステム上の DejaGnu ライブラリの場所を設定します。
+.Ev DEJAGNULIBS
+が設定された場合、
+.Sx FILES
+に説明する検索処理は行われません。
+.It Ev AWK
+Awk インタープリターへのフルパスを指定します。 これは GNU Awk の場合もあり、 そうでない場合もあります。 これが設定されていない場合、
+.Nm awk
+プログラムは
+.Ev PATH
+から検索されます。 Awk インタープリターが GNU Awk であった場合、 Awk
+インタープリターの実行時には
+.Fl -posix
+オプションが与えられます。
+.It Ev GAWK
+GNU Awk へのフルパスを指定します。 これが設定されていない場合、
+.Nm gawk
+プログラムは 
+.Ev PATH
+から検索されます。
+.It Ev BASH
+GNU Bash へのフルパスを指定します。 これが設定されていない場合、
+.Nm bash
+プログラムは
+.Ev PATH
+から検索されます。 なおスクリプトの実行中には、 たとえ
+.Nm sh
+として実行していても、 この変数を設定するのは Bash です。
+.It Ev EXPECT
+Expect へのフルパスを指定します。 これは、 すでにロードされている Expect 拡張を使った Tcl インタープリターです。
+これが設定されていない場合、
+.Nm expect
+プログラムは
+.Ev PATH
+から検索されます。 なお DejaGnu コアは
+Expect によって記述されているため、 このインタープリターはいつでも利用可能となっています。
+.It Ev TCLSH
+Tcl インタープリターのフルパスを指定します。 これが設定されていない場合、
+.Nm tclsh
+プログラムは 
+.Ev PATH
+から検索されます。
+.El
+.Pp
+なお GNU Awk は Awk のスーパーセットであり、 Expect は Tcl のスーパーセットとみなされています。 そしていずれも、
+前者のプログラムを利用して、 後者のプログラムで書かれたスクリプトを実行できるようにしています。 このことから、 一般に Awk プログラムの実行は
+GNU 拡張を無効にして行われます。 それは GNU Awk に対する
+.Fl -posix
+オプションを使って実現しています。 Tcl
+プログラムは、
+.Nm tclsh
+または
+.Nm expect
+のいずれかによって実行される場合があるため、
+これに合わせて作成しておく必要があります。
+.Sh ファイル
+.Bl -tag -width ".Pa $DEJAGNULIBS/commands"
+.It Pa $DEJAGNULIBS/commands
+.Ev DEJAGNULIBS
+が設定されている場合、 コマンドスクリプトは、 すべてこのディレクトリ内にあるものとして動作します。
+.El
+設定されていない場合、 以下に示すディレクトリの中から、 実際に存在する最初のディレクトリが用いられます。 なお
+.Pa @bindir@
+は
+.Nm
+自体が存在しているディレクトリです。
+.Bl -item -offset indent
+.It 
+.Pa @bindir@/../share/dejagnu/commands
+.It 
+.Pa @bindir@/../../share/dejagnu/commands
+.It 
+.Pa /usr/share/dejagnu/commands
+.It 
+.Pa /usr/local/share/dejagnu/commands
+.El
+.\" .Sh EXAMPLES
+.Sh 関連項目
+DejaGnu の完全なドキュメントは Texinfo マニュアルとしてメンテナンスされています。
+.Nm info
+プログラムが適切にインストールされていれば、 コマンド
+.Li info dejagnu
+の実行によって、 完全なマニュアルを参照できます。
+.Sh 著者
+.An "Jacob Bachmeyer"
+.Sh バグ
+シェルの利用制限により、 コマンド名は引数よりも前に記述する必要があります。
+.\"  LocalWords:  Dt URM Nm DejaGnu Ao DEJAGNULIBS DejaGnu's Sx awk posix tclsh
+.\"  LocalWords:  tcl superset bindir usr Texinfo
diff --git a/manual/GNU_dejagnu/release/man1/runtest.1 b/manual/GNU_dejagnu/release/man1/runtest.1
new file mode 100644 (file)
index 0000000..f776213
--- /dev/null
@@ -0,0 +1,138 @@
+.\" Copyright (C) 1993, 1995, 2001, 2002, 2003, 2004, 2005, 2008,
+.\"               2009, 2012, 2015, 2016, 2017, 2018, 2020
+.\"               Free Software Foundation, Inc.
+.\" You may distribute this file under the terms of the GNU Free
+.\" Documentation License.
+.\"*******************************************************************
+.\"
+.\" This file was generated with po4a. Translate the source file.
+.\"
+.\"*******************************************************************
+.\"
+.\" translated 2022-04-06
+.\"
+.TH runtest 1 2018\-12\-01  
+.SH 名前
+runtest \- DejaGnu テストドライバー
+.SH 書式
+\fBruntest\fP [OPTION]...
+.SH 説明
+\fIDejaGnu\fP は Expect を利用したプログラムテストのためのフレームワークです。 \fBruntest\fP は \fIDejaGnu\fP
+におけるドライバープログラムです。 これは実行するテストと、 その実行方法を制御します。
+.SH オプション
+.TP 
+\fB\-\-all,\ \-a\fP
+テスト結果をすべて出力します。 デフォルトでは、 期待どおりではない結果が出力されます。
+.TP 
+\fB\-\-build\fP\fI\ TRIPLET\fP
+ビルドシステムにおける TRIPLET を設定します。
+.TP 
+\fB\-\-debug\fP
+\fBExpect\fP の内部的なデバッグ出力をオンにします。 処理結果は \fBdbg.log\fP というファイルにログ出力されます。
+.TP 
+\fB\-\-directory\fP\fI\ DIRECTORY\fP
+指定された DIRECTORY に対してのみテストが実行されます。
+.TP 
+\fB\-\-global_init\fP\fI\ NAME\fP
+libdir にあるグローバルな初期化ファイルに用いる NAME を指定します。 このオプションが指定されなかった場合のデフォルトは
+\fBsite.exp\fP です。
+.TP 
+\fB\-\-help\fP
+使用方法に関するメッセージを表示して終了します。
+.TP 
+\fB\-\-host\fP\fI\ TRIPLET\fP
+ホストシステムにおける TRIPLET を設定します。
+.TP 
+\fB\-\-host_board\fP\fI\ NAME\fP
+利用するホストボード (host board) を定義します。
+.TP 
+\fB\-\-ignore\fP\fI\ test1.exp\ test2.exp\ ...\fP
+指定するテストを実行しません。
+.TP 
+\fB\-\-local_init\fP\fI\ NAME\fP
+カレントディレクトリと objdir の両方にある、 テストスイート用のローカル初期化ファイルに用いる NAME を指定します。
+このオプションが指定されなかった場合のデフォルトは \fBsite.exp\fP です。
+.TP 
+\fB\-\-log_dialog\fP
+Expect による出力を標準出力に書き出します。
+.TP 
+\fB\-\-mail\fP\fI\ \'name1\ name2\ ...\'\fP
+テスト結果を受け取るメールアドレスを指定します。
+.TP 
+\fB\-\-objdir\fP\fI\ PATH\fP
+\fIPATH\fP には、 コンパイル済のテストコードを含むディレクトリを指定します。
+.TP 
+\fB\-\-outdir\fP\fI\ DIRECTORY\fP
+テストログ結果を出力する DIRECTORY 名を指定します。
+.TP 
+\fB\-\-reboot\fP
+\fBruntest\fP が初期化を行う際に (対応していれば)、 ターゲットボードを再起動します。
+.TP 
+\fB\-\-srcdir\fP\fI\ PATH\fP
+\fIPATH\fP には、 テストディレクトリを指定します。
+.TP 
+\fB\-\-strace\fP\fI\ N\fP
+\fBExpect\fP の内部トレースレベルを \fIN\fP まで上げます。 処理結果は \fBdbg.log\fP というファイルにログ出力されます。
+.TP 
+\fB\-\-target\fP\fI\ TRIPLET\fP
+ターゲットの TRIPLET を設定します。
+.TP 
+\fB\-\-target_board\fP\fI\ NAME\fP
+テスト実行するターゲットボードの NAME 一覧を設定します。
+.TP 
+\fB\-\-tool\fP\fI\ TOOLNAME\fP
+テストされるツールを指定します。 \fITOOLNAME\fP は、 適用されるテストスイートおよび関連初期化モジュールを制御します。
+.TP 
+\fB\-\-tool_exec\fP\fI\ PATH\fP
+テストする実行ファイルへのパスを指定します。
+.TP 
+\fB\-\-tool_opts\fP\fI\ OPTIONS\fP
+ツールに受け渡す追加の OPTIONS を指定します。
+.TP 
+\fB\-v,\ \-\-verbose\fP
+テストケースや DejaGnu ユーティリティーコードから、 詳細なデバッグ出力を行うようにします。 複数指定すれば、 より詳細な出力が得られます。
+.TP 
+\fB\-V,\ \-\-version\fP
+DejaGNU, Expect, Tcl のバージョンを表示します。
+.TP 
+\fB\-x,\ \-\-xml\fP
+XML 出力を生成します。 出力ファイル名は、 ツール名に拡張子 .xml をつけたものになります。
+.TP 
+\fB\-D[number]\fP
+Tcl デバッガーを有効にします。 \fBnumber\fP には 1 か 0 を指定します。 これが 1 の場合、 Expect
+シェルは起動後にブレークします。 インタラプトキー (interrupt key) を入力すれば、 DejaGnu のデバッガープロンプトになります。
+0 の場合は DejaGnu が普通に起動しますが、 Control\-C を入力すればデバッガープロンプトになります。
+.TP  0
+コマンドラインからファイル名を指定すると、
+それが実行するテスト名になります。 普通はテストスクリプトの名前とします (たとえば foo.exp)。
+.PP
+Makefile 風の変数を使って、 ツール名やそれに対するフラグを指定することができます。 こういった指定やその他の構成に依存する値は、
+設定の際に生成され、 ファイル \fBsite.exp\fP に保存されます。
+.SS 終了ステータス
+.TP 
+0
+失敗が想定されているテスト、 あるいは対応していないテストを含めた、 すべてのテストが成功した場合。
+.TP 
+1
+テストに失敗した場合、 期待どおりにならなかった場合、 未解決の場合。
+.TP 
+2
+テストスクリプト内において Expect が何らかのエラーとなった場合。
+.SH 著者
+Rob Savoye (rob@welcomehome.org)
+.SH バグ報告
+バグ報告は <bug\-dejagnu@gnu.org> までお願いします。
+.SH 著作権
+Copyright \(co 2005\-2016, 2018, 2020 Free Software Foundation, Inc.
+.PP
+This is free software.  You may redistribute copies of it under the terms of
+the GNU General Public License
+<http://www.gnu.org/licenses/gpl.html>.  There is NO WARRANTY, to
+the extent permitted by law.
+.SH 関連項目
+\fBDejaGnu\fP の完全なドキュメントは Texinfo マニュアルとしてメンテナンスされています。 \fBinfo\fP
+プログラムが適切にインストールされていれば、 以下のコマンド
+.IP
+\fBinfo dejagnu\fP
+.PP
+を実行して完全なマニュアルを参照できます。