コマンドラインインターフェイス
コマンドラインインターフェイス
コマンドラインインターフェイスは単独の実行形式ファイルとして提供されます。 Windows のバッチファイルや Solaris / Linux のシェルスクリプトなどから呼び出すことができます。
Server Based Converter V3.0 のコマンドラインインターフェイスは、 ファイル を指定して動作させることもできますが、標準入力からファイルを読み、 標準出力へ PDF / SVG を書くフィルタとして動作させることができます。
実行形式ファイル名は以下のとおりです。
| Windows | SBCCmd.exe |
|---|---|
| Solaris / Linux | SBCCmd |
これらを実行させるためには、いくつかの 環境変数 の設定が必要です。Windows版では、インストール時にそれらが設定されていますが、Solaris / Linux版ではご自身で実行前にそれらを設定する必要があります。
Server Based Converter V3.0 Windows版のコマンドラインプログラムを実行するには、次のようにします。
> cd [Install directory] > SBCCmd -d samples\sample.doc -o \tmp\sample.pdf
Server Based Converter V3.0 Windows版が正しくインストールされていれば、以下のメッセージが表示されて \tmp ディレクトリに sample.pdf が作成されます。
SBCCmd : Server Based Converter V3.0 Copyright (c) 1999-2010 Antenna House, Inc.SBCCmd : Formatting finished normally.
Server Based Converter V3.0 Solaris / Linux版では、 run.sh というシェルスクリプトが [Install directory] にインストールされています。これはコマンドラインプログラム SBCCmd を実行するためのサンプルスクリプトです。このスクリプトは必要な環境変数の設定を行ってから SBCCmd を実行します。このスクリプトを使って Server Based Converter V3.0 Solaris / Linux版のコマンドラインプログラムを実行するには、以下のようにしてください。
$ cd [Install directory] $ ./run.sh -d samples/sample.doc -o /tmp/sample.pdf
Server Based Converter V3.0 Solaris / Linux版が正しくインストールされていれば、以下のメッセージが表示されて /tmp ディレクトリに sample.pdf が作成されます。
Server Based Converter V3.0 Copyright (c) 1999-2010 Antenna House, Inc.SBCCmd : Formatting finished normally.
run.sh には、SBCCmd に指定できるパラメータと同じパラメータを同じ形式で指定します。
コマンドラインインターフェイスでは以下のパラメータが指定できます。 表中 * 印の付いたパラメータは、no を先行させると否定の意味になります。
パラメータの指定文字と内容の間は半角空白を入れてください。 また、パス名を指定する場合など内容に空白が含まれるときはダブルクォートで囲んでください。 同一のパラメータ、あるいは背反するパラメータが指定された場合は、後から指定したものが有効です。
| パラメータ | 機能 |
|---|---|
| -d 変換元ドキュメント |
変換対象ドキュメントの URIを指定します。
|
| -o 出力ファイル名 |
変換結果の出力ファイルを指定します。
|
| -i オプション設定ファイル | Server Based Converter V3.0 のオプションを記述したXML形式のオプション設定ファイルのパスを指定します。 このパラメータはいくつでも指定することができます。後から指定された設定内容は、前の内容を上書きします。オプション設定ファイルは記述されている内容だけが評価されるので、変更したい部分だけを記述したファイルを追加することで、一部の設定だけを変更することができます。オプション設定ファイルの内容と、同じ意味のコマンドラインパラメータでは、後者が優先します。 |
| -p 出力形式／プリンタ名 |
変換結果を出力する形式を指定します。
印刷する場合はプリンタ名を指定します。
省略された場合は -p @PDF が指定されたとみなされます。但し Standard Flash 出力版でのみ、省略された場合は -p @Flash が指定されたとみなされます。
PDF出力に関しては、「PDF出力」を参照してください。 SVG出力に関しては、「SVG出力」を参照してください。 INX出力に関しては、「INX出力」を参照してください。 XPS出力に関しては、「XPS出力」を参照してください。 Flash出力に関しては、「Flash出力」を参照してください。 JPEG 出力と PNG 出力、TIFF出力は Windows 版でのみ有効です。 |
| -start 開始ページ -end 終了ページ |
出力の開始ページと終了ページを指定します。 開始ページが省略された場合や 0以下の場合は、先頭ページからとみなされます。 終了ページが省略された場合や実際のページ数より大きい場合は最終ページまでとみなされます。 矛盾する指定、例えば -start 5 -end 3 のような場合はエラーです。 |
| -omitbp | 変換元ファイルが MS Word または MS Excel のときのみ有効で、文書先頭に空のページがあったとき、 それをスキップして最初に見つかった内容のある１ページ目のみを取得するときに -end 1 と組み合わせて指定します。 それ以外の動作は保証しません。 |
| -fontalias 名前=別名 | フォントファミリ名の置き換えを指定します。 -fontalias A=B と指定した場合、文書中の A というフォントファミリ名が B に置き換わります。複数の置換を指定したいときは、-fontalias パラメータをその分指定します。 フォントファミリ名の置換は、「オプション設定ファイル」でも指定することができます。 置き換えが、再起的に繰り返されることはありません。 |
| -extlevel エラーレベル |
エラーが発生した場合の処理の中止条件を指定します。
-extlevel の指定値はエラーレベルです。
|
| -silent | 変換でエラーが発生した場合、 エラー情報を標準出力または標準エラー出力へ書き出しますが、 -silent を指定すると出力を行いません。 |
| -stdout | -stdout を指定すると、エラー情報を標準出力へ書き出します。既定では標準エラー出力へ出力します。 |
| -stderr | -stderr を指定すると、エラー情報を標準エラー出力へ書き出します。既定では標準エラー出力へ出力します。 |
| -pgbar * | 簡単なページ作成の進捗状況をコンソールに出力します。 |
| -v | コマンドラインインターフェイスのバージョンや著作権を表示します。 このパラメータが指定されている場合は実際の変換処理は行いません。 |
| -h or -? | コマンドラインインターフェイスのパラメータの簡単な解説を表示します。 このパラメータが指定されている場合は実際の変換処理は行いません。 |
| パラメータ | 機能 |
|---|---|
| -gdismooth 値 |
印刷とイメージ出力時にスムージング処理を行います。 スムージング処理は、文字、線画、イメージを個別に指定できます。 1:文字 2:線画 4:イメージ 組み合わせて指定する場合は値を加算してください。 値が省略されたときは"7"(3つとも指定)とみなします。 このパラメータは Windows XP以上 / WindowsServer2003以降 でのみ有効です。 |
| パラメータ | 機能 |
|---|---|
| -wmarktext 文字列 | 各ページに、指定したすかし文字列を表示します。\n で区切ることによって複数行にすることができます。 評価版のときは無効です。 |
| -wmarkfont フォントファミリ | >watermark-text で指定した文字列に対するフォントファミリを指定します。 |
| -wmarkweight 値 | watermark-text で指定した文字列に対するフォントの太さを指定します。normal、bold または 100～900 の数値が指定できます。 |
| -wmarkstyle フォントスタイル | watermark-text で指定した文字列に対するフォントスタイルを指定します。 normal または italic が指定できます。 |
| -wmarkopacity 透明度 | wmarktext で指定した文字列に対する不透明度を指定します。 |
| パラメータ | 機能 |
|---|---|
| -copies 出力部数 | 印刷する部数を指定します。 省略された場合は 1とみなされます。 |
| -collate* | 出力部数が複数のときにのみ有効です。 -collate が指定されたときは、指定開始ページから終了ページまでの印刷を繰り返します。 -nocollate が指定されたときは、同一ページを続けて複数部印刷します。 |
| -fitpaper |
プリンタで設定された用紙サイズに収まるようにサイズを調整して印刷します。 ※ A4 の用紙に A4 の PDF を印刷する場合、余白の印字不可能領域分小さくなります。 |
| パラメータ | 機能 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| -pdfver バージョン |
作成するPDFのバージョンを指定します。
バージョンは次のいずれかを指定してください。
| ||||||||||
| -encrypt キー長 | 作成するPDFの暗号化時のキー長を指定します。 キー長は40、128（bit）のいずれかを指定してください。 128bitはPDF1.4以上で有効です。 | ||||||||||
| -userpwd パスワード | PDFに設定するユーザパスワードを指定します。 パスワードは32バイト以内でなければなりません。 | ||||||||||
| -ownerpwd パスワード | PDFに設定するオーナパスワードを指定します。 パスワードは32バイト以内でなければなりません。 | ||||||||||
| -npt * |
作成するPDFを印刷不可にします。
このパラメータは、-ownerpwd の指定が必要です。 | ||||||||||
| -ncg * |
作成するPDFを変更不可にします。
このパラメータは、-ownerpwd の指定が必要です。 | ||||||||||
| -ncc * |
作成するPDFの内容をコピー不可にします。
このパラメータは、-ownerpwd の指定が必要です。 | ||||||||||
| -nca * |
作成するPDFの注釈やフォーム追加不可にします。
このパラメータは、-ownerpwd の指定が必要です。 | ||||||||||
| -nff * | 作成するPDFのフォームフィールドの入力と署名を不可にします。 PDF1.3の場合は無視されます。 このパラメータを有効にするには、他のパラメータの設定が必要な場合があります。詳しくは「PDFリファレンスマニュアル」を参照してください。 | ||||||||||
| -nab * | 作成するPDFのスクリーンリーダデバイスのテキストアクセスを不可にします。
PDF1.3の場合は無視されます。 このパラメータは、-ncg の指定が必要です。 | ||||||||||
| -nad * | 作成するPDFのページの挿入、削除、回転を不可にします。
PDF1.3の場合は無視されます。 このパラメータは、-ncg の指定が必要です。 | ||||||||||
| -peb 値 |
作成するPDFに埋め込み可能なフォントを埋め込むかどうかを以下のいずれかで指定します。
| ||||||||||
| -pee フォント名 | 作成するPDFに指定したフォントを埋め込みます。フォントを複数指定する場合はカンマ区切りで指定します。 | ||||||||||
| -pef * | フォント埋め込みに失敗したときにエラーを発行しないようにします。 | ||||||||||
| -peg * | フォントにグリフがなかったときにエラーを発行しないようにします。 | ||||||||||
| -ppa 値 |
作成するPDFの印刷を許可するかどうかを以下のいずれかで指定します。このパラメータはPDFバージョンで1.4以降を指定しなければ有効になりません。
| ||||||||||
| -picc 値 |
作成するPDFに格納するカラー画像の圧縮方法を以下から選択します。
| ||||||||||
| -picg 値 |
作成するPDFに格納するグレイスケール画像の圧縮方法を以下から選択します。
| ||||||||||
| -picm 値 |
作成するPDFに格納する白黒画像の圧縮方法を以下から選択します。
| ||||||||||
| -pidc 値 |
作成するPDFに格納するラスタのカラー画像のダウンサンプリングの方法を以下から選択します。
| ||||||||||
| -pidct dpi値 | |||||||||||
| -pidca dpi値 | |||||||||||
| -pidg 値 |
作成するPDFに格納するラスタのグレイスケール画像のダウンサンプリングの方法を以下から選択します。
| ||||||||||
| -pidgt dpi値 | |||||||||||
| -pidga dpi値 | |||||||||||
| -pidm 値 |
作成するPDFに格納するラスタの白黒画像のダウンサンプリングの方法を以下から選択します。
| ||||||||||
| -pidmt dpi値 | |||||||||||
| -pidma dpi値 | |||||||||||
| -pjq パーセント値 | PDFに直接格納できない画像形式のとき、-picc または -picg にJPEG形式が指定されたときの画質を 1～100（%）の範囲の数値で指定します。数字が大きいほど画質は良くなりますが、ファイルサイズは大きくなります。初期値は 80 です。 | ||||||||||
| -pcs * | 作成するPDF中のテキストとラインアートを圧縮しないようにします。 | ||||||||||
| -plr * | 相対アドレスで指定された外部へのリンクをPDFのリンクプロパティにどのように変換するかを指定します。-plr が指定されたときは、 "World Wide Web リンク" に変換され、-noplr が指定されたときは、 "ファイルから開く" に変換されます。 | ||||||||||
| -prc 値 |
作成するPDFのRGB色空間（DeviceRGB）をDeviceGrayに変換する方法を以下のいずれかで指定します。
| ||||||||||
| -prr dpi値 | ベクタイメージがラスタイメージに変換されてPDFに格納されるときのラスタイメージの解像度を 70～500（dpi）の値で指定します。 このパラメータはWindows版でのみ有効です。 | ||||||||||
| -pdfscale スケール | 出力PDFの拡大縮小率を指定します。 スケールには、単位なしの値または%値が指定できます（1.0 = 100%）。 -pdfscale の後に -pdfwidth を指定した場合、高さについては -pdfscale の設定が有効です。 -pdfheight の場合も同様です。 | ||||||||||
| -pdfheight 長さ | 出力PDFの高さを拡大縮小します。長さには単位付きの値または%値が指定できます。 | ||||||||||
| -pdfwidth 長さ | 出力PDFの幅を拡大縮小します。長さには単位付きの値または%値が指定できます。 |
| パラメータ | 機能 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| -svgver プロファイル |
作成するSVGのプロファイルを指定します。
プロファイル名は次のいずれかを指定してください。
| |||||||||
| -svgip 処理方法 |
作成するSVGに含まれる画像の処理方法を以下のいずれかで指定します。
| |||||||||
| -svgicp ディレクトリ名 | -svgip に 1 を指定したときの複写先を指定します。 相対パスでディレクトリ名を指定すると、-o で指定した出力パスからの相対パスに出力されます。 -o が標準出力のときは、相対パスを指定するとエラーになります。絶対パスで指定してください。 | |||||||||
| -svgiren * | 画像を -svgicp で指定したディレクトリに複写して処理するとき、そのファイル名をすべて -svgiprfx で指定したプレフィクスで命名し直すか、元のファイル名を利用するかを指定します。ファイル名が重複するときは、連番が補われます。 -svgiren を指定すると、すべて命名し直します。 | |||||||||
| -svgiprfx プレフィクス | 画像を -svgicp で指定したディレクトリに複写して処理するとき、そのファイル名のプレフィクスを指定します。ファイル名は、プレフィクス+連番 となります。指定されないときは連番のみとなります。 | |||||||||
| -svggzip * | gzip 圧縮された SVG を出力します。 | |||||||||
| -svgsingle * | 複数ページで構成されるドキュメントを、単一のSVGファイルとして出力します。 | |||||||||
| -svgfmt フォーマット | 変換元文書が複数ページで -svgsingle を指定していないときに複数のSVGファイルがファイル名末尾に連番を 付けて出力されますが、連番のフォーマットを変更できます。 例えば、出力ファイル名に document.svg が与えられているとき、 -svgfmt に "-01" を与えたならば、document-01.svg、document-02.svg、… となります。 このパラメータが省略されたときは "1" が指定されたものとみなされます。 | |||||||||
| -svgspn * | -svgsingle が指定されていないとき、出力されるSVGが1ページしかないときには -svgfmt による連番を付けません。 | |||||||||
| -svgea * | 作成するSVGに埋め込み可能なすべてのフォントを埋め込みます。 | |||||||||
| -svgee フォント名 | 作成するSVGに指定したフォントを埋め込みます。フォントを複数指定する場合はカンマ区切りで指定します。 | |||||||||
| -svgef * | フォント埋め込みに失敗したときにエラーを発行しないようにします。 | |||||||||
| -svgic 値 |
SVGに直接格納できないラスタ画像形式のとき、JPEG に変換するか PNG に変換するかを指定します。
| |||||||||
| -svgjq パーセント値 | -svgic に JPEG形式が指定されたときの画質を 1～100（%）の範囲の数値で指定します。数字が大きいほど画質は良くなりますが、ファイルサイズは大きくなります。初期値は 80 です。 | |||||||||
| -svgrr dpi値 | ベクタイメージがラスタイメージに変換されてSVGに格納されるときのラスタイメージの解像度を 70～500（DPI）の値で指定します。 このパラメータはWindows版でのみ有効です。 | |||||||||
| -svgidpi dpi | イメージを埋め込むときのダウンサンプリングの解像度を１以上の整数で指定します。もとのイメージの解像度が指定より低い場合はそのままの解像度で埋め込みます。 | |||||||||
| -svgidm method |
ダウンサンプリング時の圧縮法を指定します。
| |||||||||
| -svgpmax 最大ページ数 |
-svgsingle を指定したとき出力する最大ページ数を指定します。このパラメータが省略されたときは "5000" が指定されたものとみなします。 -svgpmax , -svghmax のどちらかまたは両方を指定した場合は、最大サイズ（-svghmax）または最大ページ数（-svgpmax）のどちらかを超えたときエラーとして処理を中止します。 | |||||||||
| -svghmax 値 | -svgsingle を指定したとき、複数ページを単一ページに割り付けたときの高さの最大値を指定します。値には単位を付けなければなりません。 -svgpmax、-svghmax のどちらかまたは両方を指定した場合は、最大サイズ（-svghmax）または最大ページ数（-svgpmax）のどちらかを超えたときエラーとして処理を中止します。 このパラメータが省略されたときは高さを制限しません。 |
| パラメータ | 機能 | ||||||
|---|---|---|---|---|---|---|---|
| -inxomode 値 |
INX出力時の出力モードを指定します。
|
| パラメータ | 機能 |
|---|---|
| -flashpartial * | Flash出力で、エラーのときに途中までのFlashを作成します。 |
| -flashhidebutton | Flash出力で、ページ送りボタンを出力しません。 |
| パラメータ | 機能 |
|---|---|
| -rasdpi 値 |
イメージ出力時の画像サイズを 1～1,440(DPI) の範囲の整数値で指定します。このパラメータが範囲外であるか省略されたとき Windows では画面のフォントサイズで設定されている DPI値 が適用されます。 出力できる画像の最大サイズは、空きメモリ容量など Windows のシステムリソースに依存します。 |
| -rasscale 値 | イメージ出力時の縮小率を 0 より大きく 1 以下の範囲の数値で指定します。% 値または px（ピクセル）値で指定することもできます。このパラメータが範囲外であるか省略された場合 1 が適用されます。 |
| -rasheight 値 | rasscale で決まる出力イメージの最大高さを px（ピクセル）値で指定します。 |
| -rasfmt フォーマット | イメージ出力では、元文書が複数ページのとき複数のイメージファイルがファイル名末尾に連番を付けて出力されますが、連番のフォーマットを変更できます。例えば、出力ファイル名に document.png が与えられているとき、-rasfmt に "-01" を与えたならば、document-01.png、document-02.png、… となります。このパラメータが省略されたときは "1" が指定されたものとみなされます。 |
| -rasgdi+ | イメージへの変換に GdiPlus を使用します。この指定は Windows XP 以降 および WindowsServer2003以降 でのみ有効です。 |
| -rasjq 値 | JPEG への変換品質を 1～100（%）の値で指定します。このパラメータが省略されたときは 80 が指定されたものとみなします。 |
| -rasmono |
元のファイルがモノクロのときに指定します。 使用メモリを減らすことができます。 |
| パラメータ | 機能 |
|---|---|
|
-textwidth 値 -textheight 値 |
入力データにテキスト形式を指定した場合の用紙サイズを指定します。値には単位が指定できます。単位を指定しなかったときはptが指定されたものとみなされます。 |
|
-textmleft 値 -textmtop 値 -textmright 値 -textmbottom 値 |
入力データにテキスト形式を指定した場合の余白サイズを指定します。 |
| -textfname フォントファミリ名 | 入力データにテキスト形式を指定した場合の出力フォントファミリ名を指定します。 |
| -textfsize 値 | 入力データにテキスト形式を指定した場合の出力フォントサイズを指定します。 |
| -textpnum | 入力データにテキスト形式を指定したとき出力にページ番号を付加します。 |
| -textlnum | 入力データにテキスト形式を指定したとき出力に行番号を付加します。 |
| -textloset 値 | 入力データにテキスト形式を指定したとき出力に行番号を付加する場合の本文との距離を指定します。 |
| -textlfmt format | 入力データにテキスト形式を指定したとき出力に行番号を付加する場合の行番号フォーマットを指定します。 |
| ☞ | 変換元ファイルが小さいと、エンコーディングの判定ができず読み込みに失敗することがあります。 |
|---|
値に付加する単位には、次のいずれかが指定できます。
| 表記 | 意味 |
|---|---|
| cm | センチメートル |
| mm | ミリメートル。 1 mm = 1/10 cm |
| in | インチ。 1 in = 2.54 cm |
| pt | ポイント。 1 pt = 1/72 in |
| pc | パイカ。 1 pc = 12 pt |
| jpt | 1 jpt = 0.3514 mm |
| q | 1 q = 0.25 mm |
コマンドラインインターフェイスで変換を実行したとき、 変換が成功した場合は 0 を、失敗した場合は 1 を戻り値として処理を終えます。 -v などで変換を行わなかった場合の戻り値は 0 です。
以下は Windows版でのみ有効です。
プリンタ名は、Windows のスタートメニューの [設定]-[プリンタ] や、コントロールパネルの [プリンタとFAX] で表示される名前を指定します。
-p "Acrobat Distiller" -p "EPSON LP-2500"
![[プリンタとFAX]](img/prwxp.png)