Doxygen はコマンドラインベースのユーティリティです。コマンドラインで doxygen を --help オプション付きで実行すると、プログラムの使い方の簡単な説明が表示されます。

すべてのオプションは、先頭の文字 -、それに続く1文字、およびオプションに応じて1つ以上の引数で構成されています。

プロジェクトのマニュアルを生成するには、通常、次の手順に従う必要があります。

特別なドキュメンテーションブロックを使用してソースコードをドキュメント化します（「特別なコメントブロック」のセクションを参照）。
Doxygen を -g オプション付きで呼び出すことにより、設定ファイル（「設定」のセクションを参照）を生成します。
```
doxygen -g <config_file>
```
設定ファイルがプロジェクトに合うように編集します。設定ファイルでは、入力ファイルと多くのオプション情報を指定できます。
設定ファイルの設定に基づいて、Doxygen にドキュメントを生成させます。
```
doxygen <config_file>
```

古いバージョンの Doxygen で生成された設定ファイルがある場合は、Doxygen を -u オプション付きで実行することにより、現在のバージョンにアップグレードできます。

doxygen -u <config_file>

元の設定ファイル内のすべての設定は、新しい設定ファイルにコピーされます。新しいオプションにはデフォルト値が設定されます。元の設定ファイルに追加した可能性のあるコメントは失われることに注意してください。

出力の微調整

出力の見栄えを微調整したい場合、Doxygen を使用すると、後で編集できるデフォルトのスタイルシート、ヘッダー、およびフッターファイルを生成できます。

HTML 出力の場合、次のコマンドを使用して、デフォルトのヘッダーファイル（「HTML_HEADER」を参照）、デフォルトのフッター（「HTML_FOOTER」を参照）、およびデフォルトのスタイルシート（「HTML_STYLESHEET」を参照）を生成できます。
```
doxygen -w html header.html footer.html stylesheet.css <config_file>
```
config_file はオプションです。省略した場合、Doxygen は Doxyfile という名前のファイルを検索して処理します。これも見つからない場合は、デフォルト設定が使用されます。
出力の場合、次のコマンドを使用して、refman.tex の最初と最後の部分（「LATEX_HEADER」と「LATEX_FOOTER」を参照）と、そのヘッダーに含まれるスタイルシート（通常は doxygen.sty）を生成できます。
```
doxygen -w latex header.tex footer.tex doxygen.sty <config_file>
```
デフォルト以外のオプション（たとえば、追加のパッケージを使用するなど）が必要な場合は、これらのオプションが正しく設定された設定ファイルを作成し、生成されたファイルの後にその設定ファイルを指定する必要があります（出力ファイルの1つを指定するのを忘れた場合に備えて、最初に設定ファイルのバックアップを作成してください）。
RTF 出力の場合、次のコマンドを使用して、デフォルトのスタイルシートファイル（「RTF_STYLESHEET_FILE」を参照）を生成できます。
```
doxygen -w rtf rtfstyle.cfg
```

警告: カスタムヘッダーを使用する場合、Doxygen が必要とするスクリプトとスタイルシートを適切に含める責任があります。これは構成オプションに依存し、新しい Doxygen リリースにアップグレードするときに変更される可能性があります。

注記

設定ファイル内の各項目のドキュメントが不要な場合は、オプションの -s オプションを使用できます。これは、-u オプションと組み合わせて、既存の設定ファイルからドキュメントを追加または削除するために使用できます。最小限の設定ファイルを取得するには、-x または -x_noenv オプションを使用して、デフォルトの Doxygen 設定ファイルとの違いのみを表示します。バグレポートの一部として設定ファイルを送信する場合、または GitHub で問題を投稿する場合は、-s または -x または -x_noenv オプションを使用してください！（「バグの報告方法」も参照してください）
Doxygen がファイルから/ファイルへではなく、標準入出力に対して読み取り/書き込みを行うようにするには、ファイル名に - を使用します。

次のセクションに進むか、インデックスに戻ります。