Calendar Server の実行ユーザーおよびグループ、または root としてログインしている状態でコマンド行ユーティリティーを実行します。これはインストール時に指定し、デフォルトは icsuser と icsgroup です。
たとえば、Calendar Server のベースディレクトリが cal_svr_base の場合、cscal ユーティリティーの list コマンドを実行するには、ログイン後に次のようにします。
cd cal_svr_base/SUNWics5/cal/sbin ./cscal list
Calendar Server のコマンド行ユーティリティーの構文は次のとおりです。
utility [ -option [value]] command [target]
それぞれの意味は次のとおりです。
utility は、cscal や csuser など、実行可能なユーティリティーの名前を表します。
option には、コマンドが実行する処理を指定します。オプションは、-d のように、ハイフン (-) に続けて小文字で指定します。角カッコ ([]) で囲まれているオプションは省略可能です。そのように明記されている場合は、複数のオプションを同時に指定できます。
value は、option によって指定される動作をさらに修飾します。 たとえば、-d オプションで使用する説明などがこれに該当します。角カッコ ([]) で囲まれている値は省略可能です。空白文字を含む値は、引用符 (" ") で囲む必要があります。複数の値を指定するときは全体を引用符 (" ") で囲み、各値を空白文字で区切ります。 ただし、セミコロンで区切ったリストを使用する場合など、特に明記されている場合を除きます。
command は、たとえば list や create のように、ユーティリティーが実行する処理を指定します。縦棒 (|) で区切られているコマンドは、一度に実行できるコマンドがいずれか (両方ではない) であることを示します。
target は、コマンドの実行対象となるカレンダ ID やユーザー ID などのオブジェクトです。
コマンド行ユーティリティーの使用には、一般に次の規則が適用されます。
ユーティリティー名だけを指定した場合は、すべてのコマンド、オプション、いくつかの例が表示されます。
必要なパスワードを指定しない場合、ユーティリティーにより要求されます。
各ユーティリティーでは、-v (verbose、詳細) オプションと -q (quiet、非出力) オプションを利用できます。
危険なコマンド (データを喪失する可能性があるコマンド) では、コマンドの実行前にユーティリティーにより確認を促されます。危険なコマンドには、カレンダを削除する cscal、ユーザーを削除する csuser などがあります。ただし、-q (quiet、非出力) オプションを指定した場合は確認は行われません。
各ユーティリティーには version コマンドが用意されています。
スクリプトからコマンド行ユーティリティーを実行する場合、ユーティリティーの実行に成功した場合はリターンコード “0” が返され、失敗した場合は “-1” が返されます。