7-1 実行方法

7-1-1 コマンドラインアプリケーションのコマンド表記に関して

本マニュアルにおいて、コマンドラインアプリケーションのコマンド表記には以下の記法を用います。

表記

説明

無地のテキスト
(角かっこ([ ])または波かっこ({ })がないもの)

表記の文字列をそのまま入力することが必要な項目

<山かっこで囲われたテキスト>

値の指定が必要な項目。テキスト部分は項目名

[角かっこで囲われたテキスト]

省略可能な項目。テキスト部分は項目名

{波かっこで囲われたテキスト}

必須の項目セット。項目の中から1つを選択する必要がある

縦棒(|)

項目セットに対する区切り記号。1つを選択する必要があり、同時に複数指定できない

7-1-2 実行方法の基礎

『PDF Tool API』のコマンドラインアプリケーションは、次のような構成で引数を指定して実行します。

<コマンドラインアプリケーション名> <コマンド> [パラメータ] -d {入力ファイル|フォルダパス} -o {出力ファイル|フォルダパス}

引数などの各項目の解説は以下の通りです。

例:-changeDocInfo

例:-title Val

例:-d C:\test\test.pdf

例:-o C:\sav\out.pdf

7-1-3 Windows版の実行方法

Windows版のコマンドラインアプリケーションでは、次のように引数を指定して実行します。

AHPDFToolCmd80.exe <コマンド> [パラメータ] -d {入力ファイル|フォルダパス} -o {出力ファイル|フォルダパス}

補足事項 [Windows版]:

  • パラメータを必要とするコマンドの場合、コマンド指定後に必ずパラメータを指定してください。パラメータを指定しない場合はエラーになります。
  • 環境変数[ERRORLEVEL]で取得する戻り値で実行の成否とエラーコードを取得可能です。詳細は『10-3-1 コマンドラインアプリケーションの戻り値[Windows]』を参照してください。
  • コマンドラインアプリケーションの実行中にエラーが発生した場合は、標準出力にエラー内容を示すメッセージ文字列が出力されます。エラー出力やエラー内容の詳細は『10-3 エラー処理について』を参照してください。
  • 入出力におけるファイル指定またはフォルダ指定についての詳細は「7-2 入出力ファイル・フォルダの指定」を参照してください。

7-1-4 Linux版の実行方法

Linux版のコマンドラインアプリケーションは、次のように引数を指定して実行します。

AHPDFToolCmd80 <コマンド> [パラメータ] -d {入力ファイル|フォルダパス} -o {出力ファイル|フォルダパス}

シェルスクリプト[run.sh]について

Linux版ではインストーラによってシェルスクリプト[run.sh]が配置されます。[run.sh]はコマンドラインアプリケーションやライセンスファイルの配置情報を環境変数に設定して実行できるシェルスクリプトです。

Linux版ではWindows版とは異なりインストーラが環境変数の設定を行うオプションがありません。インストール先情報が設定された[run.sh]はその代わりとして同梱されるファイルです。
(より正確には、[run.sh]はインストーラにより配置フォルダなどの情報を記入してインストール時に生成されるファイルです)

シェルスクリプトを通じて『PDF Tool API』を使用する場合、次のように引数を指定して実行します。

sh run.sh <コマンド> [パラメータ] -d {入力ファイル|フォルダパス} -o {出力ファイル|フォルダパス}

シェルスクリプト[run.sh]を一旦実行した後はターミナルを閉じるまで、環境変数の設定なしで「AHPDFToolCmd80」をコマンドラインアプリケーション上で実行することが可能になります。

補足事項 [Linux版]:

  • パラメータを必要とするコマンドの場合、「コマンド」指定後に必ず「パラメータ」を指定してください。必要とする「パラメータ」を指定しない場合はエラーになります。
  • 変数「$?」で取得する戻り値で実行の成否を取得可能です。詳細は『10-3-1 コマンドラインの戻り値[Linux]』を参照してください。
  • コマンドラインアプリケーションの実行中にエラーが発生した場合は、標準出力にエラー内容を示すメッセージ文字列が出力されます。エラー出力やエラー内容の詳細は『10-3 エラー処理について』を参照してください。
  • シェルスクリプト[run.sh]による環境変数設定はターミナルを閉じるまでしか保持されません。Windowsのシステム環境変数のように、ログイン時に自動的に読み込まれる環境変数を設定したい場合は、[~/.profile]や[~.bashrc]、[~/.bash_profile]を用いた実行環境の環境変数の設定をお試しください。
  • 入出力におけるファイル指定またはフォルダ指定についての詳細は「7-2 入出力ファイル・フォルダの指定」を参照してください。

Please enter alt text.