17時00分
概要をスキップして本文へ
CacheUpIt の設定ファイルの種類と読み込み順序、書式について述べます。

設定ファイルの種類

CacheUpIt には四つの設定ファイルがあります。

それぞれについて説明します。

/etc/CacheUpIt.conf

もし存在すれば、そのシステムで CacheUpIt が起動するときに必ず読み込まれる設定ファイルです。全てのユーザに共通な設定を記述するときに使用します。

例えば curl コマンドのパスはデフォルトでは /usr/bin/curl ですがこれを /usr/local/bin/curl に設定し直すときなどに使用します。

$HOME/.CacheUpIt.conf

もし存在すれば、カレントユーザが実行する CacheUpIt が起動するときに読み込まれる設定ファイルです。

通常はこのファイルで同期させる項目やアップロード先を記述します。

./.CacheUpIt.conf

CacheUpIt 起動時のカレントディレクトリの .CacheUpIt.conf です。もし存在すれば、CacheUpIt が起動するときに読み込まれます。

プロジェクトごとに設定を管理する場合に使用します。ただし CacheUpIt 起動時のカレントディレクトリなので、複数のディレクトリに設定ファイルが散らばっているときはそれぞれのディレクトリで CacheUpIt を起動しなければなりません。システムの資源を無駄に消費してしまうので濫用は避けましょう。

-f オプションで指定したファイル

起動時に CacheUpIt の -f オプションで指定したファイルです。このファイルが指定されてなおかつ存在した場合に起動時に読み込まれます。このファイルは /etc/CacheUpIt.conf の代替として指定します。つまりこのファイルが指定されると /etc/CacheUpIt.conf は読み込まれません

例えば /etc/CacheUpIt.conf を変更するときにこれのコピーを編集し、-f オプションでそのコピーを指定して起動して動作を確認するときなどに使用するとよいでしょう。

設定ファイルの読み込み順序

四つの設定ファイルは次の順序で読み込まれます。存在しなければスキップされます。

  1. /etc/CacheUpIt.conf または -f オプションで指定したファイル
  2. $HOME/.CacheUpIt.conf
  3. ./.CacheUpIt.conf

-f オプションで指定したファイルは /etc/CacheUpIt.conf の代替なので、異なるファイルであればそのファイルが指定されると /etc/CacheUpIt.conf は読み込まれません。

設定ファイルの書式

全ての設定ファイルは Perl スクリプトとして CacheUpIt が読み込みます。Perl をご存知でしたら require でロードされると言えば通じるかと思います。したがってその書式は Perl の書式になります。

とはいえ、全てのユーザが Perl の書式を理解する必要はありません。順次このサイトを通して必要なことは設定例を提示してゆきます。逆に Perl をご存知の方は、設定ファイル中でサブルーチンを定義したりそのサブルーチンに必要な Perl モジュールをロードしたり、あるいは CacheUpIt 起動時に一緒に実行させたい処理を記述することができます。

注意としては最後に実行された内容が返す値がそのファイルの実行結果となり、これが偽を意味する undef や空文字列あるいは 0 のときは読み込みが失敗したと見なされることです。確実にこれを防ぐために次のような行を最後に入れておくとよいでしょう。

1;