コマンドラインインターフェイス
コマンドラインインターフェイスは単独の実行形式ファイルとして提供されます。 Windows のバッチファイルや Linux / Macintosh のシェルスクリプトなどから呼び出すことができます。
Antenna House Formatter V7.4 のコマンドラインインターフェイスは、FO(XSL Formatting Objects)ファイルなどを指定して動作させることもできますが、標準入力から FOを読み、標準出力へ PDF を書くフィルタとして動作させることができます。また、XMLとXSL を指定して、自動的にXSLT変換してから組版することも可能です。
実行形式ファイル名
実行形式ファイル名は以下のとおりです。
Windows | AHFCmd.exe |
---|---|
Linux / | AHFCmd |
これらを実行させるためには、いくつかの 環境変数 の設定が必要です。Windows版では、インストール時にそれらが設定されていますが、非Windows版ではご自身で実行前にそれらを設定する必要があります。
Windows版での実行
Antenna House Formatter V7.4 Windows版のコマンドラインプログラムを実行するには、次のようにします。
Antenna House Formatter V7.4 Windows版が正しくインストールされていれば、以下のメッセージが表示されて \tmp ディレクトリに sample.pdf が作成されます。
シェルスクリプトによる実行
Antenna House Formatter V7.4 非Windows版では、run.sh というシェルスクリプトが [Install directory] にインストールされています。これはコマンドラインプログラム AHFCmd を実行するためのサンプルスクリプトです。このスクリプトは必要な環境変数の設定を行ってから AHFCmd を実行します。このスクリプトを使って Antenna House Formatter V7.4 非Windows版のコマンドラインプログラムを実行するには、以下のようにしてください。
Antenna House Formatter V7.4 非Windows版が正しくインストールされていれば、以下のメッセージが表示されて /tmp ディレクトリに sample.pdf が作成されます。
run.sh には、AHFCmd に指定できるパラメータと同じパラメータを同じ形式で指定します。
パラメータ
コマンドラインインターフェイスでは以下のパラメータが指定できます。 表中 * 印の付いたパラメータは、no を先行させると否定の意味になります。 例えば、-nomultivol は、分冊出力を解除します。
パラメータ名とその値の間には半角空白を入れてください。 また、パス名を指定する場合など内容に空白が含まれるときはダブルクォートで囲んでください。 同一のパラメータ、あるいは背反するパラメータが指定された場合は、後から指定したものが有効です。
デフォルトのパラメータを環境変数で指定しておくことができます。環境変数での指定は、ここで指定したパラメータの前に補われて評価されます。
パラメータ | 既定値 | 機能 | ||
---|---|---|---|---|
-d ドキュメント |
組版対象のXML/FO/HTMLドキュメントの URIを指定します。
| |||
-s スタイルシート |
組版で使用するXSL/CSSスタイルシートのURIを指定します。
指定されているXMLドキュメントがFOの場合や、XMLファイルが <?xml-stylesheet ...?> の処理命令を含んでいてスタイルシートが指定されている場合、指定されているドキュメントがHTMLの場合などは、スタイルシートの指定は必要ありません。
XSLスタイルシートを利用するには、XSLTプロセッサが使用できるようになっていなければなりません。 Windows版では、特に設定していない場合は MSXML を標準のXSLTプロセッサとして使用しますが、別のXSLTプロセッサを使用する場合や、非Windows版では、使用するXSLTプロセッサの設定を行ってください。 XSLTプロセッサの設定は、「環境変数」または「オプション設定ファイル」で行います。 スタイルシートが CSS の場合は、最後のユーザスタイルシートとなります。 これは、-css によって追加するスタイルシートや、-i によって指定されたオプション設定ファイル中の指定よりも後に適用されます。 | |||
-f 組版種別 | AUTO |
組版種別を指定します。次のいずれかを指定できます。
| ||
-css ユーザスタイルシート | 追加するCSSユーザスタイルシートを指定します。-css はいくつでも指定できます。 -s で指定されるスタイルシートよりも先に、指定された順に適用されます。 | |||
-htmlcs デフォルトHTML文字セット | UTF-8 | HTMLのデフォルトのエンコーディングを指定します。 ここでの指定は、エンコーディングが不明なHTMLに対して適用されます。 省略された場合はUTF-8とみなされます。 | ||
-o 出力ファイル名 | @STDOUT |
組版結果の出力ファイルを指定します。
| ||
-i オプション設定ファイル | Antenna House Formatter V7.4 のオプションを記述したXML形式のオプション設定ファイルのパスを指定します。 このパラメータはいくつでも指定することができます。後から指定された設定内容は、前の内容を上書きします。オプション設定ファイルは記述されている内容だけが評価されるので、変更したい部分だけを記述したファイルを追加することで、一部の設定だけを変更することができます。オプション設定ファイルの内容と、同じ意味のコマンドラインパラメータでは、最後に指定された内容が、前の内容を上書きします。 | |||
-ix | 環境変数APPDATAで示されるアプリケーションデータディレクトリにある AHFSettings.xml(Windows x86版ではAHFSettings(x86).xml) をオプション設定ファイルとして読み込みます。 このパラメータは、 または と等価です。 Windows版でのみ有効です。 | |||
-p プリンタ名 |
組版結果を出力するプリンタ名を指定します。
省略された場合は -p @PDF が指定されたとみなされます。
| |||
-start 開始ページ | 1 | 出力の開始ページと終了ページを指定します。 開始ページが省略された場合や 0の場合は、先頭ページからとみなされます。 終了ページが省略された場合や 0の場合、あるいは実際のページ数より大きい場合は最終ページまでとみなされます。矛盾する指定、例えば -start 5 -end 3 のような場合はエラーです。 -multivol パラメータが指定されているとき、これらのパラメータはページ位置ではなく、分冊単位の指定となります。例えば、-start 3 は、3分冊目を出力します。 | ||
-end 終了ページ | 0 | |||
-page 文字列 |
出力するページを次のように指定します。
| |||
-addbp [ページ数] * |
出力の最後にブランクページを出力します。
ブランクページは最後に出力されたページと同じ大きさになります。
-addbp 2 のようにして何ページ出力するのか指定することもできます。
分冊出力のときは無効です。
| |||
-2pass * | 解決しない<fo:page-number-citation>を大量に持つ巨大な文書の組版では、ページ情報の破棄が不可能なためメモリを大量に消費します。そのため、組版できるページ数に限界が生じてしまいます。 このパラメータは、組版を2パスにすることでその問題を解決します。組版に要する時間は増えますが、消費するメモリは解決すべきページ番号情報だけとなり、ごくわずかとなります。 大規模文書の組版を参照してください。 CSS組版では無効です。 | |||
-dpw 長さ | 210mm | デフォルトのページ幅を単位付きの数値で指定します。 | ||
-dph 長さ | 297mm | デフォルトのページ高さを単位付きの数値で指定します。 | ||
-base ベースURI | デフォルトのベースURIを指定します。 | |||
-hypdic ディレクトリ名 | ハイフネーション辞書の存在するディレクトリを指定します。 | |||
-msxmlver バージョン | 6 | 内部的に利用するMSXMLの最大バージョンを指定します。6~3 のいずれかを指定できます。例えば、5 を指定すると、MSXML5→MSXML4→MSXML3 と探して、最初に見つかったMSXMLを採用します。指定がないときや範囲外の値のときは、6 とみなされます。 Windows版のみで有効です。 | ||
-param 名前=値 | XSLT変換で使う xsl:param のパラメータ名と値を指定します。値が空白を含む場合は、"名前=値" と指定してください。-param は複数指定できます。 | |||
-fontalias 名前=別名 | フォントファミリ名の置き換えを指定します。-fontalias A=B と指定した場合、FO 中の A というフォントファミリ名が B に置き換わります。複数の置換を指定したいときは、-fontalias パラメータをその分指定します。フォントファミリ名の置換は、「オプション設定ファイル」でも指定することができます。置き換えが、再起的に繰り返されることはありません。 | |||
-afc * | <axf:formatter-config> の使用を許可するかどうか指定します。デフォルトでは許可されています。-noafc を指定すると、<axf:formatter-config> は無視されます。 | |||
-x エラーレベル | 2 |
組版でエラーが発生した場合の処理の中止条件を指定します。
-x の指定値はエラーレベルです。
| ||
-silent | 組版でエラーが発生した場合、エラーメッセージを標準出力または標準エラー出力へ書き出しますが、-silent を指定すると出力を行いません。 | |||
-stdout | -stdout を指定すると、エラーメッセージを標準出力へ書き出します。既定では標準エラー出力へ出力します。 | |||
-stderr | -stderr を指定すると、エラーメッセージを標準エラー出力へ書き出します。既定では標準エラー出力へ出力します。 | |||
-xmlerr * | エラー出力をXML形式で行います。出力されるXMLは次のように単純なものです。名前空間は http://www.antennahouse.com/names/Error です。 | |||
-analyze * | 同じ単語で終わる連続する行など、体裁上の問題についてエリアツリーを分析します。-p @AreaTreeと指定してください。エリアツリーの自動分析に関する設定は、「オプション設定ファイル」で行います。動作の詳細については、「組版結果の自動分析」を参照してください。 | |||
-pgbar * | 簡単なページ作成の進捗状況をコンソールに出力します。"." は組版の、"-" は出力の1ページごとの進捗を示します。 | |||
-v | コマンドラインインターフェイスのバージョンや著作権を表示します。 このパラメータが指定されている場合は実際の組版処理は行いません。 | |||
-h -? | コマンドラインインターフェイスのパラメータの簡単な解説を表示します。 このパラメータが指定されている場合は実際の組版処理は行いません。 |
プリンタに関するパラメータ
パラメータ | 既定値 | 機能 |
---|---|---|
-ps プリンタ設定ファイル | プリンタ設定ファイルのパス名を指定します。 このファイルの作成方法は「プリンタ設定ファイル」を参照してください。 | |
-copies 出力部数 | 1 | 印刷する部数を指定します。 省略された場合は 1とみなされます。 |
-collate * | 出力部数が複数のときにのみ有効です。 -collate が指定されたときは、指定開始ページから終了ページまでの印刷を繰り返します。 -nocollate が指定されたときは、同一ページを続けて複数部印刷します。 | |
-gdismooth 値 | 0 | 印刷でアンチエイリアス処理を行うかどうかを指定します。以下の値の和を指定します。
|
PDF出力に関するパラメータ
パラメータ | 既定値 | 機能 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
-pdfver バージョン | PDF1.5 |
作成するPDFのバージョンを指定します。
バージョンは次のいずれかを指定してください。
| ||||||||||
-tpdf * | タグ付きPDFを生成します。 PDFのバージョンによって、タグ付きにできないときは無視されます。 | |||||||||||
-lpdf * | Web表示用に最適化されたリニアライズドPDFを生成します。 | |||||||||||
-prevp * | ページを逆順に出力します。 | |||||||||||
-multivol * | PDFを分冊出力するときに指定します。FO中に <axf:output-volume-info> 拡張要素が含まれていないときは無効です。 このパラメータにより、-start/-end パラメータの意味は、分冊単位の指定となります。 | |||||||||||
-encrypt キー長 | 128rc4 |
作成するPDFの暗号化時のキー長を指定します。
| ||||||||||
-nemd * | 作成するPDFを暗号化するとき、メタデータの暗号化を行わないようにします。 | |||||||||||
-userpwd パスワード | PDFに設定するユーザパスワードを指定します。PDF1.3~1.7では32文字までの、PDF2.0以降では127文字までのASCII文字を指定してください。 | |||||||||||
-ownerpwd パスワード | PDFに設定するオーナパスワードを指定します。PDF1.3~1.7では32文字までの、PDF2.0以降では127文字までのASCII文字を指定してください。 | |||||||||||
-npt * |
作成するPDFを印刷不可にします。
PDF1.4以降で、-encrypt 40rc4 以外の場合は、-ppa を利用してください。
このパラメータは、-ownerpwd の指定が必要です。 | |||||||||||
-ncg * |
作成するPDFを変更不可にします。
このパラメータは、-ownerpwd の指定が必要です。 | |||||||||||
-ncc * |
作成するPDFの内容をコピー不可にします。
このパラメータは、-ownerpwd の指定が必要です。 | |||||||||||
-nca * |
作成するPDFの注釈やフォーム追加不可にします。
このパラメータは、-ownerpwd の指定が必要です。 | |||||||||||
-nff * | 作成するPDFのフォームフィールドの入力と署名を不可にします。 PDF1.3 または -encrypt 40rc4 の場合は無視されます。 このパラメータを有効にするには、他のパラメータの設定が必要な場合があります。詳しくはISO 32000-1 または ISO 32000-2を参照してください。 | |||||||||||
-nab * | 作成するPDFのスクリーンリーダデバイスのテキストアクセスを不可にします。
PDF1.3 または -encrypt 40rc4 の場合は無視されます。 このパラメータは、-ncg の指定が必要です。 | |||||||||||
-nad * | 作成するPDFのページの挿入、削除、回転を不可にします。
PDF1.3 または -encrypt 40rc4 の場合は無視されます。 このパラメータは、-ncg の指定が必要です。 | |||||||||||
-ppa 値 | 2 |
作成するPDFの印刷を許可するかどうかを以下のいずれかで指定します。
| ||||||||||
-peb 値 | 1 |
作成するPDFにフォントを埋め込むかどうかを以下のいずれかで指定します。
| ||||||||||
-pee フォント名 | 作成するPDFに指定したフォントを埋め込みます。フォントを複数指定する場合はカンマ区切りで指定します。 | |||||||||||
-pesub パーセント値 | 100% | 作成するPDFに指定したフォントを埋め込むとき、指定した値(パーセンテージ)以上の使用率のときフォントすべてを埋め込み、値未満のとき使用している文字のみの部分的な埋め込みを行います。パーセント値には、単位なしの値または%値が指定できます(1.0 = 100%)。 指定しなかったときは100%とみなされるので、常に部分的な埋め込みが行われます。 | ||||||||||
-pef * | フォント埋め込みに失敗したときにエラーを発行しないようにします。 | |||||||||||
-peg * | フォントにグリフがなかったときにエラーを発行しないようにします。 | |||||||||||
-pex * | PDF/XまたはPDF/A、PDF/UA出力のときエラーがあっても、処理を中止しないようにします。 | |||||||||||
-pt 値 | all |
PDFへ画像を埋め込むとき、そのまま埋め込めるものはそのまま埋め込む(パススルー)かを指定します。パススルーとダウンサンプリングが同時に指定されているときは、ダウンサンプリングの指定が優先されます。ただし、そのまま埋め込めない事情があるときは無視されます。以下の文字列を空白区切りで列挙、画像の種類で指定することもできます。
| ||||||||||
-picc 値 | 0 |
作成するPDFに格納するカラー画像の圧縮方法を以下から選択します。
| ||||||||||
-picg 値 | 0 |
作成するPDFに格納するグレイスケール画像の圧縮方法を以下から選択します。
| ||||||||||
-picm 値 | 1 |
作成するPDFに格納する白黒画像の圧縮方法を以下から選択します。
| ||||||||||
-pidc 値 | 0 |
作成するPDFに格納するラスタのカラー画像のダウンサンプリングの方法を以下から選択します。
| ||||||||||
-pidca dpi値 | 450 | |||||||||||
-pidct dpi値 | 300 | |||||||||||
-pidg 値 | 0 |
作成するPDFに格納するラスタのグレイスケール画像のダウンサンプリングの方法を以下から選択します。
| ||||||||||
-pidga dpi値 | 450 | |||||||||||
-pidgt dpi値 | 300 | |||||||||||
-pidm 値 | 0 |
作成するPDFに格納するラスタの白黒画像のダウンサンプリングの方法を以下から選択します。
| ||||||||||
-pidma dpi値 | 1800 | |||||||||||
-pidmt dpi値 | 1200 | |||||||||||
-pjq パーセント値 | 80 | PDFに直接格納できない画像形式のとき、-picc または -picg にJPEG形式が指定されたときの画質を 1~100(%)の範囲の数値で指定します。数字が大きいほど画質はよくなりますが、ファイルサイズは大きくなります。初期値は 80 です。 | ||||||||||
-pcs * | 作成するPDF中のテキストとラインアートを圧縮しないようにします。 | |||||||||||
-pos * | 作成するPDF中のオブジェクトを圧縮します。-pcs が指定されているときは無効です。 | |||||||||||
-plr * | ローカルファイルで指定された外部へのリンクをPDFのリンクプロパティにどのように変換するかを指定します。-plr が指定されたときは、"World Wide Web リンク" に変換され、-noplr が指定されたときは、"ファイルから開く" に変換されます。 | |||||||||||
-prc 値 | 0 |
作成するPDFのRGBカラースペース(DeviceRGB)をDeviceGrayに変換する方法を以下のいずれかで指定します。
| ||||||||||
-pcics * | PDF/X、PDF/Aの出力のとき、含まれるRGB画像を自動的にCMYKに変換します。 | |||||||||||
-prr dpi値 | 108 | ベクタ画像がラスタ画像に変換されてPDFに格納されるときのラスタ画像の解像度を 70~500(dpi)の値で指定します。 このパラメータはWindows版でのみ有効です。 | ||||||||||
-p3da * | 3Dオブジェクトのインポートを有効にします。 | |||||||||||
-psbkm * | しおりの出力を抑制します。 | |||||||||||
-pdfscale スケール | 100% | 出力PDFの拡大縮小率を指定します。 スケールには、単位なしの値または%値が指定できます(1.0 = 100%)。 -pdfscale の後に -pdfwidth を指定した場合、高さについては -pdfscale の設定が有効です。 -pdfheight の場合も同様です。 | ||||||||||
-pdfheight 長さ | 100% | 出力PDFの高さを拡大縮小します。長さには単位付きの値または%値が指定できます。 | ||||||||||
-pdfwidth 長さ | 100% | 出力PDFの幅を拡大縮小します。長さには単位付きの値または%値が指定できます。 | ||||||||||
-createdate 日付 | PDFの /CreationDate, /ModDate を指定します。デフォルトや指定できる日付については、<axf:document-info> の createdate, modifydate を参照してください。 この指定は、<axf:document-info> の指定を上書きします。 | |||||||||||
-modifydate 日付 |
SVG出力に関するパラメータ
パラメータ | 既定値 | 機能 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
-svgver プロファイル | SVG2.0 |
作成するSVGのプロファイルを指定します。
プロファイル名は次のいずれかを指定してください。
| ||||||||
-svgip 処理方法 | 0 |
作成するSVGに含まれる画像の処理方法を以下のいずれかで指定します。
| ||||||||
-svgicp ディレクトリ名 | -svgip に 1 や 3 を指定したときの複写先を指定します。 相対パスでディレクトリ名を指定すると、-o で指定した出力パスからの相対パスに出力されます。 -o が標準出力のときは、相対パスを指定するとエラーになります。絶対パスで指定してください。 | |||||||||
-svgcicp * | 画像を -svgicp で指定したディレクトリに複写して処理するとき、指定した複写先ディレクトリが存在しない場合にそのディレクトリを作成します。 V7.4 | |||||||||
-svgiren * | 画像を -svgicp で指定したディレクトリに複写して処理するとき、そのファイル名をすべて -svgiprfx で指定したプレフィクスで命名し直すか、元のファイル名を利用するかを指定します。ファイル名が重複するときは、連番が補われます。 -svgiren を指定すると、すべて命名し直します。 | |||||||||
-svgiprfx プレフィクス | 画像を -svgicp で指定したディレクトリに複写して処理するとき、そのファイル名のプレフィクスを指定します。ファイル名は、プレフィクス+連番 となります。指定されないときは連番のみとなります。 | |||||||||
-svggzip * | gzip 圧縮された SVG を出力します。 | |||||||||
-svgsingle * | 複数ページで構成されるドキュメントを、単一のSVGファイルとして出力します。 | |||||||||
-svgfmt フォーマット | 1 | 元文書が複数ページで -svgsingle を指定していないときに複数のSVGファイルがファイル名末尾に連番を付けて出力されますが、連番のフォーマットを変更できます。 例えば、出力ファイル名に document.svg が与えられているとき、-svgfmt に "-01" を与えたならば、document-01.svg、document-02.svg、… となります。 このパラメータが省略されたときは "1" が指定されたものとみなされます。 | ||||||||
-svgspn * | -svgsingle が指定されていないとき、出力されるSVGが1ページしかないときには -svgfmt による連番を付けません。 | |||||||||
-svgic 値 | 0 |
SVGに直接格納できないラスタ画像形式のとき、JPEG に変換するか PNG に変換するかを指定します。
| ||||||||
-svgjq パーセント値 | 80 | -svgic に JPEG形式が指定されたときの画質を 1~100(%)の範囲の数値で指定します。数字が大きいほど画質はよくなりますが、ファイルサイズは大きくなります。初期値は 80 です。 | ||||||||
-svgrr dpi値 | 108 | ベクタ画像がラスタ画像に変換されてSVGに格納されるときのラスタ画像の解像度を 70~500(dpi)の値で指定します。 このパラメータはWindows版でのみ有効です。 |
テキスト出力に関するパラメータ
パラメータ | 既定値 | 機能 |
---|---|---|
-tenc エンコーディング | UTF-8 | テキスト出力時のエンコーディングを指定します。このパラメータが省略された場合はUTF-8が適用されます。 詳しくは、「テキスト出力の設定」を参照してください。 |
-teol 改行コード | CRLF または LF | テキスト出力時の改行コードを指定します。このパラメータが省略された場合、Windows版ではCRLFが、非Windows版ではLFが適用されます。 詳しくは、「テキスト出力の設定」を参照してください。 |
値に付加する単位には、次のいずれかが指定できます。
表記 | 意味 |
---|---|
cm | センチメートル |
mm | ミリメートル。 1mm = 0.1cm |
in | インチ。 1in = 2.54cm |
pt | ポイント。 1pt = 1in/72 |
pc | パイカ。 1pc = 12pt |
jpt | 1jpt = 0.3514mm |
q | 1q = 0.25mm |
次の例は、sample.xml にスタイルシート sample.xsl を適用して組版し、sample.pdf に出力します。
非Windows版でスタイルシートを利用するには、外部XSLTプロセッサの指定を オプション設定ファイル で行い、-i パラメータでそれを指定する必要があります。
次の例は、オプション設定ファイル options.xml を読み込み、sample.fo を組版して、プリンタに出力します。
戻り値
コマンドラインインターフェイスで組版を実行したとき、組版が成功した場合は 0 を、失敗した場合は 1 を戻り値として処理を終えます。-v などで組版を行わなかった場合の戻り値は 0 です。
プリンタ名
以下は Windows版でのみ有効です。
プリンタ名は、Windows のスタートメニューの [設定]-[プリンタ] や、コントロールパネルの [プリンタとFAX] で表示される名前を指定します。
プリンタ設定ファイル
以下は Windows版でのみ有効です。
Windowsでは、一般にプリンタに関する設定情報をやり取りする場合、DEVMODEという構造体を使用します。プリンタドライバはこのDEVMODE構造体の情報に基づいて動作します。 DEVMODE構造体をファイルに保存するユーティリティとして、Antenna House Formatter V7.4 は、AHFDev.exe を用意しています。
このプログラムを起動すると、「プリンタの設定」ダイアログが表示されます。プリンタのプロパティ設定を行い [設定の保存] を押すと、出力先ファイル名の指定ダイアログが開きます。ここで出力するファイル名を入力してください。これによってDEVMODE構造体が「プリンタの設定を記録したデータファイル」として記録されます。このファイル名を、.NET/COMインターフェイスの PrinterSetting や、コマンドラインインターフェイスの -psパラメータに指定してください。プログラムを終了するには [設定の終了] ボタンを押します。
プリンタ設定ファイルを指定した場合、-p オプションの指定がなくても印刷が行われます。次のように動作します。
- AHFCmd -p printer-name -ps setting-file -d ...
setting-file で指定されたDEVMODEを、プリンタ printer-name に適用して印刷します。
- AHFCmd -p @PDF -ps setting-file -d ...
-ps オプションを無視してPDFへ出力します。
- AHFCmd -ps setting-file -d ...
setting-file で指定されたDEVMODEで印刷します。DEVMODE中にプリンタ名が指定されていなければデフォルトプリンタで印刷します。
-collate や -copies などが指定されているときは、指定されたDEVMODEの内容を上書きします。
制限事項
印刷に関する制限は、グラフィカルユーザインターフェイスの制限事項を参照してください。