日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
NEWSYSLOG.CONF(5) FreeBSD ファイルフォーマットマニュアル NEWSYSLOG.CONF(5)
名称
newsyslog.conf -- newsyslog(8) の設定ファイル
解説
newsyslog.conf ファイルは、newsyslog(8) ユーティリティのためのログファイ
ルのローテイション (rotation) を設定をするために使用されます。設定は、ロ
グが、サイズ、最後のローテイション時間または時刻に基づいてローテートされ
ることを指定します。また、ローテート時にログファイルへの安全なパーミッ
ションを指定するために newsyslog.conf ファイルを使用することができます。
初期化の間に、newsyslog(8) は、どのログが潜在的にローテートされ、アーカイ
ブされるかを決定するために設定ファイル、通常 /etc/newsyslog.conf を読み込
みます。各行は、空白類で区切られた、5 つの必須のフィールドと 4 つのオプ
ションのフィールドがあります。空行または `#' で始まる行は、無視されます。
`#' が行の途中に置かれるなら、`#' 文字とその後の行の残りは、無視されま
す。特別な意味を防止するために、`#' 文字は、`\' でエスケープされます。こ
の場合に、先行する `\' は、削除され、`#' は、通常の文字として扱われます。
設定ファイルのフィールドは、次の通りです:
logfile_name
アーカイブされるシステムログファイルの名前、またはリテラル文字列
``<default>'' または ``<include>'' の 1 つ。特別なデフォルトエン
トリは、ログファイル名が newsyslog(8) にコマンド行の引数として与
えられ、そのログファイル名が設定ファイルのあらゆる他の行と一致し
ない場合のみ、使用されます。include エントリは、他の設定ファイル
をインクルードするように使用され、グロブ (ファイル名置換) をサ
ポートします。
owner:group
このオプションのフィールドは、アーカイブファイルのための所有者と
グループを指定します。`:' は、owner または group フィールドが、空
白のままであるか、または値を含んでいる場合にかかわらず、必須で
す。フィールドは、数値または /etc/passwd または /etc/group に存在
する名前です。
mode ログファイルとアーカイブのファイルモードを指定します。有効なモー
ドビットは、0666 です。(すなわち、ローテートされたログのための読
み込み、書き込みパーミッションは、所有者、グループと他のために指
定されます。) すべての他のモードビットは、無視されます。
count 存在するアーカイブファイルの最大の数を指定します。これは、現在の
ログファイルを考慮しません。
size ログファイルのサイズがキロバイト単位の size に到達するとき、ログ
ファイルは、上で説明されるように調整されます。このフィールドがア
スタリスク (`*') を含んでいるなら、ログファイルは、サイズに基づい
て調整されません。
when when フィールドは、間隔、特有な時間、または両方から成ります。when
フィールドがアスタリスク (`*') を含んでいるなら、ログのローテー
ション (rotation) は、size フィールドの内容だけに依存します。そう
でなければ、when フィールドは、通常、`@' 符号と ISO 8601 制限され
た ISO 8601 形式に時間が続いている、時間単位のオプションの間隔か
ら成ります。さらに、形式は、また、1 日あたり 1 回、1 週あたり 1
回、または 1 ヵ月あたり 1 回のローテーション (rotation) 時間指定
とともに `$' 符号で構成されます。
newsyslog(8) が指定された時刻の 1 時間以内に実行される場合のみ、
時間に基づいたトリミング (調整) が起こります。間隔が指定されるな
ら、最後のローテーション (rotation) 以来その多くの時間が経過する
なら、ログファイルは、調整されます。時間と間隔の両方が指定される
とき、両方の条件は、ローテーション (rotation) が起こることを満た
さなければなりません。
タイムゾーンの指定のための用意はありません。唯一の比較は、
``within the hour'' (1 時間以内) であるので、現在の実装で明示的な
分または秒の要素を指定することに少しも意味がありません。
ISO 8601 の制限された時間の形式:
制限された ISO 8601 の時間のための先導文字は、`@' 符号です。制限
された ISO 8601 の時間の特定の形式は、次の通りです:
[[[[[cc]yy]mm]dd][T[hh[mm[ss]]]]]。オプションの日付フィールドは、
現在の日付の適切な要素をデフォルトとします。オプションの時間
フィールドは、真夜中をデフォルトとします。したがって、今日が 1999
年 1 月 22 日であるなら、次の日付指定は、すべて同等です:
`19990122T000000'
`990122T000000'
`0122T000000'
`22T000000'
`T000000'
`T0000'
`T00'
`22T'
`T'
`'
日, 週と月の時間の形式:
日、週と月の指定のための先導文字は、`$' 符号です。日、週と月の指
定の特定の形式は、次の通りです: それぞれ、[Dhh], [Ww[Dhh]], と
[Mdd[Dhh]]。オプションの時間フィールドは、真夜中をデフォルトとし
ます。日と時間の指定の範囲は、次の通りです:
hh 時間、範囲 0..23。
w 週の日、範囲 0..6、0 = 日曜日。
dd 月の日、範囲 1..31、または最後の月の日を指定する文
字 `L' または `l' の 1 つ。
いくつかの例は、次の通りです:
$D0 毎晩真夜中にローテート (rotate) します (@T00 と同じ
です)。
$D23 毎日 23 時 00 分にローテート (rotate) します (@T23
と同じです)。
$W0D23 毎週日曜日の 23 時 00 分にローテート (rotate) しま
す。
$W5D16 毎週金曜日の 16 時 00 分にローテート (rotate) しま
す。
$M1D0 毎月最初の日の真夜中にローテート (rotate) します
(すなわち、日の最初です; @01T00 と同じです)。
$M5D6 毎月の 5 日ごとの 6 時 00 分にローテート (rotate)
します (@05T06 と同じです)。
flags このオプションのフィールドは、この行が一致しているログファイルに
対して行われるあらゆる特別な処理を指定する 1 以上文字で構成されて
います。次は、有効なフラグです:
B ログファイルがバイナリファイルであるか、またはある特別な
形式があることを示します。通常、newsyslog(8) は、ローテー
ト (rotation) の間に ASCII メッセージをログファイルに挿入
します。このメッセージは、いつ、そして時々、なぜログファ
イルがローテート (rotation) されたかを示すために使用され
ます。B が指定されるなら、その情報メッセージは、ログファ
イルに挿入されません。
C ログファイルが、まだ存在せず、また、-C オプションがコマン
ド行で指定されたなら、ログファイルが作成されるべきことを
示します。
D newsyslog(8) が、このログファイルの新しいバージョンを作成
するとき、UF_NODUMP フラグを設定するべきであることを示し
ます。このオプションは、ファイルシステムのバックアップを
行うとき、どのように、dump(8) コマンドがログファイルを扱
うかに影響します。
G 指定された logfile_name がシェルパターンであり、
newsyslog(8) が、この行の他のオプションを使用してそのパ
ターンと一致しているすべてのファイル名をアーカイブするべ
きですことを示します。構文とマッチング規則の詳細について
は、glob(3) を参照してください。
J newsyslog(8) が bzip2(1) を使用してローテートされたログ
ファイルを圧縮することによってディスク空間を節約すること
を試みるべきであることを示します。
N このログファイルがローテートされるとき、シグナルを送られ
る必要があるプロセスがないことを示します。
p 0 番目のローテッド (rotated) ファイルは、圧縮されるべきで
はないことを示します。
R このフラグが設定されるなら、newsyslog(8) は、ファイルに格
納されたプロセス ID にシグナルを送る試みの代わりにローテ
イションの後に path_to_pid_cmd_file で定義されたシェルコ
マンドを実行します。
T このフラグが、設定されているなら、ログファイルに書き込ま
れる情報のローテイションメッセージは、RFC5424 によって指
定された形式です。通常、ローテイションメッセージは、伝統
的な (RFC3164) syslog 形式で書き込まれます。
U path_to_pid_cmd_file によって指定されたファイルがプロセス
の代わりにプロセスグループのための ID を含むことを示しま
す。また、このオプションは、そのファイルの最初の行がプロ
セス ID からそれを区別する負な値であることを必要としま
す。
X newsyslog(8) が、xz(1) を使用してローテートされたログファ
イルを圧縮することによってディスク空間を節約することを試
みるべきであることを示します。
Y newsyslog(8) が、zstd(1) を使用して、ロウテート (rotated)
されるログファイルを圧縮することによってディスク空間を節
約することを試みるべきであることを示します。
Z newsyslog(8) が、gzip(1) を使用してローテートされたログ
ファイルを圧縮することによってディスク空間を節約すること
を試みるべきであることを示します。
- マイナス記号は、あらゆる特別な処理を起こしませんが、利用
者が次のフィールドのいずれかを指定する必要があるとき、
flags フィールドを作成するために、プレースホールダ
(placeholder; 代替物) として使用することができます。
path_to_pid_cmd_file
このオプションのフィールドは、デーモンのプロセス ID を含んでいる
ファイル名を指定するか、または U フラグが指定されたなら、グループ
プロセス ID を見つけるために指定します。このフィールドが存在する
なら、signal は、このファイルに含まれているプロセス ID に送られま
す。このフィールドが存在していなくて、N フラグが指定されていない
なら、SIGHUP シグナルが、syslogd(8) または newsyslog(8) の -S ス
イッチによって指定されたファイルにあるプロセス ID に送られます。
正しく認識するために、このフィールドは、`/' から開始する必要があ
ります。R フラグで使用されるとき、ファイルは、シグナルを送信する
代わりにローテイションの後に newsyslog(8) によって実行されるバイ
ナリへのパスとして扱われます。
signal このオプションのフィールドは、デーモンプロセス (または U フラグが
指定されたなら、プロセスグループのすべてのプロセス) に送られるシ
グナルを指定します。このフィールドが存在しないなら、SIGHUP シグナ
ルが送られます。シグナルの名前は、``SIG'' で始まらなければなら
ず、シグナルの名前、例えば、SIGUSR1 です。代わりに、signal は、シ
グナル番号を指定することができます、例えば、SIGUSR1 のための 30。
使用例
次は、``<include>'' エントリの例です:
<include> /etc/newsyslog-local.conf
関連項目
bzip2(1), gzip(1), xz(1), syslog(3), chown(8), newsyslog(8), syslogd(8)
C. Lonvick, The BSD syslog Protocol, RFC3164.
R. Gerhards, The Syslog Protocol, RFC5424.
歴史
このマニュアルページは、FreeBSD 4.10 ではじめて登場しました。
FreeBSD 12.2 August 21, 2018 FreeBSD 12.2