periodic(8)

periodic − 定期的なシステム機能を実行する

periodic directory ...

解説

periodic ユーティリティは指定されたディレクトリにあるシェルスクリプトを実 行するために、 cron(8) に呼び出されることを意図しています。

以下の引数から一つ以上を指定しなければいけません :

標準的な 1 日周期の実行ファイルを実行します。これはよく (その地 域の時刻で) 朝早くに行なわれます。

weekly
標準的な 1 週間周期の実行ファイルを実行します。これはよく日曜日 の朝に行なわれます。

monthly
標準的な 1 ヶ月周期の実行ファイルを実行します。これはよく月の 1 日目に行なわれます。

security
標準的な 1 日周期でのセキュリティチェックを実行します。通常、 daily の実行から起動されます。

path
実行すべき一連の実行ファイルがある任意のディレクトリを指定しま す。

引数が絶対パスのディレクトリ名の場合はそれがそのまま使われます。それ以外 の場合は /etc/periodic の下と periodic.conf(5) (以下を参照) の中の local_periodic で指定されたディレクトリが検索されます。

periodic ユーティリティは指定されたディレクトリ (複数指定可) にある各実行 可能ファイルを実行します。もし実行可能ビットがセットされていないファイル があっても、無視するだけでそれに関するメッセージも表示しません。

各スクリプトは以下のいずれかの値とともに終了することが要求されます。

0
スクリプトの出力に注目すべき点はありません。変数 ⟨
basedir⟩_show_success で出力のマスクを制御します。

1
スクリプトから注意すべき情報が出力されています。変数 ⟨
basedir⟩_show_info でこの出力をマスクするかどうかを制御します。

2
スクリプトは無効な設定による警告を発しました。変数 ⟨
basedir⟩_show_badconfig でこの出力をマスクするかどうかを制御しま す。

>2
スクリプトからマスクされない出力が出されています。

もし、 periodic.conf 中の関連のある変数 ( ⟨basedir⟩ はスクリプトが置かれ た基準となるディレクトリ) が ‘‘NO’’ に設定されているなら、スクリプトの出 力はマスクされます。その変数が ‘‘YES’’ か ‘‘NO’’ のどちらにも設定されてい なければ、 periodic.conf(5) に記述されたデフォルトの値が採用されます。

残った出力は ⟨
basedir⟩_output に設定された値に基づいて送られます。

もし、これにパス名 ( ‘/’ で始まります) が設定されているなら、出力は単純に そのファイルに記録されます。 newsyslog(8) は /var/log/daily.log, /var/log/weekly.log, /var/log/monthly.log というファイルを知っており、こ れらのファイルが存在するなら、適当な回数でローテートされます。したがっ て、 periodic の出力を記録しようとするなら、これらを設定するのが適切で す。

⟨
basedir⟩_output の値が ‘/’ で始まっておらず、空でもない場合には、メー ルのアドレスのリストが含まれているとみなされ、出力はメールで送られます。

⟨
basedir⟩_output が設定されていないか、空である場合には出力は標準出力に 送られます。

環境変数

periodic ユーティリティは環境変数 PATH をすべての標準的なシステムディレク トリを含むように設定します。ただし、 /usr/local/bin のような追加的なディ レクトリは含めません。もし他のパスに依存するような実行ファイルを加えるな ら、それぞれの実行ファイルが自己の環境変数を適切に設定する責任を負う必要 があります。

典型的な periodic ユーティリティの呼び出しは システムのデフォルト cron(8) テーブル内のエ ントリから行なわれます。

/etc/periodic
サブディレクトリとして daily, weekly, monthly を含む上層のディレクトリです。これら のサブディレクトリにはシステムの標準的な定期 的実行ファイルが置かれます。

/etc/defaults/periodic.conf
periodic.conf システムレジストリは periodic と標準の daily, weekly, monthly スクリプトの 振舞を制御する変数を保持します。

/etc/periodic.conf
このファイルはデフォルトの periodic の設定の 一部を置き換えるものです。

使用例

システム crontab には下の例のような periodic のエントリが記述されているは ずです :

      # do daily/weekly/monthly maintenance
      0      2       *       *       *       root    periodic daily
      0      3       *       *       6       root    periodic weekly
      0      5       1       *       *       root    periodic monthly

典型的なシステムレジストリ /etc/defaults/periodic.conf には変数 local_periodic について次のように記述してあるでしょう :

local_periodic="/usr/local/etc/periodic /usr/X11R6/etc/periodic"

periodic の出力をメールで受け取る代わりにログにとるには以下のような行を /etc/periodic.conf に追加します :

      daily_output=/var/log/daily.log
      weekly_output=/var/log/weekly.log
      monthly_output=/var/log/monthly.log

毎日実行される periodic のジョブから重要な情報のみを見るためには、以下の 行を /etc/periodic.conf に追加します :

      daily_show_success=NO
      daily_show_info=NO
      daily_show_badconfig=NO

sh(1), crontab(5), periodic.conf(5), cron(8), newsyslog(8)

終了状態は成功時には 0 です。もし以下のいずれかの理由でコマンドが失敗すれ ば、終了状態は 1 になります :

usage: periodic <directory of files to execute> スクリプトフラグメントが どこにあるかを指定するディレクトリパス引数が periodic に渡されませんでし た。

<directory> not found 説明するまでもありません。(訳注: 指定したディレク トリが見つかりません。)

periodic ユーティリティは FreeBSD 3.0 に初めて登場しました。

ディレクトリの情報を、文字列を含むシェル変数 ⟨basedir⟩ で指定するので、 ⟨basedir⟩ は sh(1) において有効な名前である必要があります。すなわち、アル ファベット、数値、アンダスコアであることが必要であり、最初の文字は数値で あってはなりません。

Paul Traina ⟨pst@FreeBSD.org⟩
Brian Somers ⟨brian@Awfulhak.org⟩

FreeBSD 10.0 November 28, 2001 FreeBSD 10.0