.\" DO NOT MODIFY THIS FILE! it was generated by rd2
.TH CUTTER 1 "February 2014" "Cutter" "Cutterのマニュアル"
.SH ["名前"]
.PP
cutter \- C言語・C++言語用のxUnit系テスティングフレームワーク
.SH ["書式"]
.PP
\&\fBcutter\fP [\fIオプション...\fP] \fIテストディレクトリ\fP
.PP
\&\fBcutter\fP \-\-mode=analyze [\fIオプション ...\fP] \fIログディレクトリ\fP
.SH ["説明"]
.PP
CutterはC言語・C++言語用のxUnit系単体テスト（ユニットテスト） フレームワークです。Cutterはプログラマに2つの重要なインターフェ イスを提供します。
.TP
1.
簡単にテストが書けるAPI
.TP
2.
簡単にデバッグできるユーザインターフェイス
.PP
Cutterはプログラマが新しいテストを書くこと、すでにあるテスト を実行すること、実行したテストからフィードバックを得ることを 支援します。
.PP
\fIテストディレクトリ\fPにはtest_*.soがあるディレクトリを指 定します。Cutterはtest_*.soは再帰的に検索します。
.PP
\fIログディレクトリ\fPにはCutterのログファイルがあるディレク トリを指定します。Cutterは\-\-stream\-directoryオプションがして いされるとテスト結果をログファイルに出力します。
.SH ["オプション"]
.TP
.fi
.B
\-\-version
バージョンを表示して終了します。
.TP
.fi
.B
\-\-log\-level=LEVEL
ログレベルをLEVELに設定します。

LEVELは「error|warning」というように「|」で区切って指定できます。

「+trace|+info」というようにレベルの前に「+」をつけるとデフォルトのレベルに 指定したレベルを追加できます。

「\-error|\-warning」というようにレベルの前に「\-」をつけるとデフォルト のレベルから指定したレベルを取り除けます。

指定できるレベルは以下の通りです。
.IP
.B
\(bu
default: 「critical|error|warning|message」と同じ。
.IP
.B
\(bu
none: なにも出力しない。
.IP
.B
\(bu
critical: 致命的な問題のみ出力。
.IP
.B
\(bu
error: エラーのみ出力。
.IP
.B
\(bu
warning: 警告のみ出力。
.IP
.B
\(bu
message: 通常のメッセージのみ出力。
.IP
.B
\(bu
info: 付加情報のみ出力。
.IP
.B
\(bu
debug: デバッグ情報のみ出力。
.IP
.B
\(bu
traces: トレース情報のみ出力。
.IP
.B
\(bu
all: すべての情報を出力。

デフォルトは「default」です。
.TP
.fi
.B
\-\-mode=[test|analyze]
実行モードを指定します。testモードのときはテストを実行し ます。analyzeモードのときはテスト結果を解析します。

デフォルトはtestです。
.TP
.fi
.B
\-s DIRECTORY, \-\-source\-directory=DIRECTORY
テストが失敗した場合にファイル名の前にDIRECTORYを付加しま す。Cutterの出力からテストが失敗した箇所にジャンプするツー ル（Emacsなど）と連携するための機能です。
.TP
.fi
.B
\-t TEST_CASE_NAME, \-\-test\-case=TEST_CASE_NAME
TEST_CASE_NAMEにマッチしたテストケースを実行します。もし、 TEST_CASE_NAMEが"/"で囲まれていた場合は（例: /test_/）正 規表現として扱います。

このオプションは複数回指定できます。その場合は、どれかの TEST_CASE_NAMEにマッチしたテストケースを実行します。（OR）
.TP
.fi
.B
\-n TEST_NAME, \-\-name=TEST_NAME
TEST_NAMEにマッチしたテストを実行します。もし、TEST_NAME が"/"で囲まれていた場合は（例: /test_/）正規表現として扱 います。

このオプションは複数回指定できます。その場合は、どれかの TEST_NAMEにマッチしたテストケースを実行します。（OR）
.TP
.fi
.B
\-m, \-\-multi\-thread
各テストケースを新しいスレッドで実行します。

デフォルトでは無効です。
.TP
.fi
.B
\-\-max\-threads=MAX_THREADS
最大MAX_THREADSスレッドを同時に動かしてテストケースと繰り 返しテストを実行します。\-1を指定すると最大同時スレッド数 を制限しません。

デフォルトは最大10スレッドです。
.TP
.fi
.B
\-\-disable\-signal\-handling
C\-cでのテスト途中終了や、SEGV時のバックトレース取得などを 行うシグナル処理機能を無効にします。シグナルを用いてるラ イブラリをテストする場合はこの機能が障害になることがあり ます。その場合はこのオプションでCutterのシグナル処理機能 を無効にしてください。

デフォルトでは有効です。
.TP
.fi
.B
\-\-test\-case\-order=[none|name|name\-desc]
各テストケースの実行順を並び替えます。

noneを指定すると並び替えません。nameを指定するとテストケー ス名で昇順に並び替えます。name\-descを指定するとテストケー ス名で降順に並び替えます。

デフォルトはnoneです。
.TP
.fi
.B
\-\-exclude\-file=FILE
テストを集めるときにFILEを読み込みません。
.TP
.fi
.B
\-\-exclude\-directory=DIRECTORY
DIRECTORY以下にあるテストを検索しません。
.TP
.fi
.B
\-\-fatal\-failures
失敗を致命的な問題として扱います。つまり、表明に失敗する とテストの実行を中断します。

デフォルトでは無効です。
.TP
.fi
.B
\-\-keep\-opening\-modules
ロードしたモジュールを開いたままにします。シンボルを解決 できるようになるため、デバッグ時に便利です。

デフォルトでは無効です。
.TP
.fi
.B
\-\-enable\-convenience\-attribute\-definition
便利ですが、危険でもある、 "#{属性名}_#{テスト名 \- 'test_'プリフィックス}"属性設定関 数を有効にします。

デフォルトでは無効です。
.TP
.fi
.B
\-\-stop\-before\-test
テスト関数を実行する直前にブレークポイントを設定します。 デバッガ上でcutterを実行し、ステップインすれば、簡単にテ スト関数に入ることができます。

デフォルトでは無効です。
.TP
.fi
.B
\-u=[console|gtk], \-\-ui=[console|gtk]
UIを指定します。

デフォルトはコンソールUIです。
.TP
.fi
.B
\-v[s|silent|n|normal|v|verbose], \-\-verbose=[s|silent|n|normal|v|verbose]
出力の詳細さを指定します。

このオプションはコンソールUIを使用する場合だけ有効です。
.TP
.fi
.B
\-c[yes|true|no|false|auto], \-\-color=[yes|true|no|false|auto]
yesまたはtrueが指定された場合はCutterはエスケープシーケン スで色付けして出力します。noまたはfalseが指定された場合は 色付けしません。autoあるいは値が省略された時は、可能なら 色付けをします。

このオプションはコンソールUIを使用する場合だけ有効です。
.TP
.fi
.B
\-\-pdf\-report=FILE
FILEにPDF形式でテスト結果を出力します。
.TP
.fi
.B
\-\-xml\-report=FILE
FILEにXML形式でテスト結果を出力します。
.TP
.fi
.B
\-\-stream=[xml]
ストリームバックエンドを指定します。ストリームバックエン ドはテスト結果を配信します。

現在はXMLストリームバックエンドがあります。
.TP
.fi
.B
\-\-stream\-fd=FILE_DESCRIPTOR
出力ファイルディスクリプタを指定します。XMLストリームバッ クエンドはFILE_DESCRIPTORに配信します。

このオプションはXMLストリームバックエンドを使用する場合だ け有効です。
.TP
.fi
.B
\-\-stream\-directory=DIRECTORY
出力ディレクトリを指定します。XMLストリームバックエンドは DIRECTORY以下にファイルを作成し、そのファイルに配信します。

このオプションはXMLストリームバックエンドを使用する場合だ け有効です。
.TP
.fi
.B
\-?, \-\-help
UIやテスト結果レポート機能に依存しないオプションを表示し ます。
.TP
.fi
.B
\-\-help\-stream
ストリーム関連のオプションを表示します。
.TP
.fi
.B
\-\-help\-report
レポート関連のオプションを表示します。
.TP
.fi
.B
\-\-help\-ui
UI関連のオプションを表示します。
.TP
.fi
.B
\-\-help\-all
すべてのオプションを表示します。
.SH ["終了ステータス"]
.PP
すべてのテストがパスすると0で、そうでない場合は0以外になりま す。テスト結果の「省略」と「通知」は失敗として扱いません。
.SH ["ファイル"]
.TP
.fi
.B
/usr/local/share/doc/cutter/ja/
リファレンスマニュアルやチュートリアルなどのCutterのドキュ メントがあります。
.SH ["例"]
.PP
以下の例では、cutterはtest/ディレクトリ以下のテストを実行し、 テストの進行状況を詳細に表示します。
.nf
\&    % cutter \-v v test/
.fi
.PP
以下の例では、テスト結果がlogs/ディレクトリ以下に保存されま す。
.nf
\&    % cutter \-\-stream=xml \-\-stream\-directory=logs/ test/
.fi
.SH ["関連項目"]
.PP
GLibのリファレンスマニュアル。

