Tera Term のススメ

logpause

2024/09/01 15:35 Macro::TTL コマンドリファレンス

【Tera Term マクロ言語】コマンドリファレンス

logpause 機能

[通信コマンド]

Tera Term のログを一時中断します。

コマンドライン

logpause

<file name> は、ログを取得するファイル名を指定します。
省略できません。

ファイル <file name> に、受信した文字が書き込まれます。
ログ取得を開始したあとはバックグラウンドで動作し、次に記述したコマンドへ処理が移動します。

ファイル名に \ を含まない場合、Tera Termのカレントディレクトリに作成されます。
当該ディレクトリを変更するには 044 コマンドを使用してください。

また、バージョン 4.45以降は、ファイル名に strftime のフォーマットを利用できる機能の追加されました。
マクロでも、ログ名に strftime フォーマットが指定可能です。

書式	意味
&h	ホスト名。未接続の場合は空。
&p	TCP ポート番号。未接続の場合は空。TCP 接続でないときも空。
&u	ログオン中のユーザ名。
%a	曜日の省略形。
%A	曜日の正式名。
%b	月の省略形。
%B	月の正式名。
%c	ロケールに対応する日付と時刻の表現。
%d	10 進数で表す月の日付 (01 ～ 31)。
%H	24 時間表記の時間 (00 ～ 23)。
%I	12 時間表記の時間 (01 ～ 12)。
%j	10 進数で表す年初からの日数 (001 ～ 366)。
%m	10 進数で表す月 (01 ～ 12)。
%M	10 進数で表す分 (00 ～ 59)。
%p	現在のロケールの午前/午後。
%S	10 進数で表す秒 (00 ～ 59)。
%U	10 進数で表す週の通し番号。日曜日を週の最初の日とする (00 ～ 53)。
%w	10 進数で表す曜日 (0 ～ 6、日曜日が 0)。
%W	10 進数で表す週の通し番号。月曜日を週の最初の日とする (00 ～ 53)。
%x	現在のロケールの日付表現。
%X	現在のロケールの時刻表現。
%y	10 進数で表す西暦の下 2 桁 (00 ～ 99)。
%Y	10 進数で表す 4 桁の西暦。
%z, %Z	レジストリの設定に応じて、タイムゾーンの名前または省略形を指定します。タイムゾーンが不明な場合は指定しません。
%%	パーセント記号。

【注意】
バージョン 4.55 で、ログファイル名に strftime のフォーマットを指定したときに展開されない問題の修正が入っています。

<binary flag>

<binary flag> は、ログのタイプを指定します。
省略できません。

指定するパラメータは以下の通りです。

<binary flag>	モード	挙動の説明
0	Text	受信した漢字、改行文字は変換されてファイルに書き込まれ、エスケープシーケンスは書き込みません。
1	Binary	受信した文字をすべてそのままファイルに書き込みます。

バイナリログは、ログ再生に利用可能です。

<append flag>

<append flag> は、上書きか追記かを指定します。
省略できません。

指定するパラメータは以下の通りです。

<append flag>	ファイルの有無	挙動の説明
0	既存あり	そのファイルに対して上書きします。
0	既存なし	新規でファイルを作成します
1	既存あり	そのファイルに追加して書き込みます。
1	既存なし	新規でファイルを作成します

バージョン 4.61以降 (ログ再生可能なバイナリオプションの追加)

<binary flag> が 1 （0 以外）の場合、<plain text flag> および <timestamp flag> は両方とも無視されます。

<plain text flag>

指定するパラメータは以下の通りです。

<plain text flag>	挙動の説明
0	ASCII 制御文字を書き込みます。省略時は、こちらが指定されたものとして処理されます
1	ASCII 非表示文字をログに書き込みません。

これより後のパラメータを指定しない場合において、省略可能です。

<timestamp flag>

指定するパラメータは以下の通りです。

<timestamp flag>	挙動の説明
0	特に追加処理を行いません。省略時は、こちらが指定されたものとして処理されます
1	ログの行頭に時刻を追加します。

これより後のパラメータを指定しない場合において、省略可能です。

バージョン 4.62以降 (ログを開けたかどうか result を返す仕様の追加)

ログファイルを開けた場合、result に 0 が格納されます。
開けなかった場合は 1 が格納されます。

バージョン 4.80以降 (端末バッファをログへ含めるオプションの追加)

<hide dialog flag>

指定するパラメータは以下の通りです。

<hide dialog flag>	挙動の説明
0	ログ転送のダイアログを表示します。省略時は、こちらが指定されたものとして処理されます
1	ログ転送のダイアログを表示しません。

これより後のパラメータを指定しない場合において、省略可能です。

<include screen buffer flag>

指定するパラメータは以下の通りです。

<include screen buffer flag>	挙動の説明
0	特に追加処理を行いません。省略時は、こちらが指定されたものとして処理されます
1	現在の端末バッファすべてを先にファイルに書き込みます。

これより後のパラメータを指定しない場合において、省略可能です。

バージョン 4.97以降 (ログ行頭へタイムスタンプを追記するオプションの追加)

<timestamp type> は timestamp の形式を指定します。
以下の値が指定出来ます。

指定するパラメータは以下の通りです。

<timestamp type>	出力情報	挙動の説明
0	ローカルタイム	端末の現在時刻を、ロケーションに応じて利用します。日本なら JST です。省略時は、こちらが指定されたものとして処理されます
1	UTC	端末の現在時刻を UTC に変換して利用します。
2	経過時間(Logging)	ログ取得開始時点からの経過時間を利用します。
3	経過時間(Connection)	接続開始時点からの経過時間を利用します。

省略可能です。

パラメータの説明

指定するパラメータは以下の通りです。

パラメータ	型	パラメータ説明
<file name>	文字列	ログを書き込むファイル名を指定する。
<binary flag>	整数	ログのタイプ（バイナリかASCIIか）を指定する。
<append flag>	整数	既存ログの扱い（追記か上書きか）を指定する。
<plain text flag>	整数	ASCII 制御文字を書き込むかどうかを指定する。
<timestamp flag>	整数	タイムスタンプの有無（追記するか）を指定する。
<hide dialog flag>	整数	ログ転送のダイアログを表示するかどうかを指定する。
<include screen buffer flag>	整数	ログ取得時にバッファ内の情報も含むかどうかを指定する。
<timestamp type>	整数	タイムスタンプを追記する場合、その形式を指定する。