logstart

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

logstart 機能

[通信コマンド]

中断していた Tera Term のログを再開します。

コマンドライン

logstart

機能説明

logpause コマンドで中断していた Tera Term のログを再開します。

パラメータの説明

指定するパラメータはありません。

続きを読む

logrotate

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

logrotate 機能

[通信コマンド]

ログをローテートします。

コマンドライン

logrotate 'size' '<size>'
logrotate 'rotate' <count>
logrotate 'halt'

機能説明

取得中のログファイルに対するローテーション設定を行います。
設定は即時反映されますが、即時ローテートするわけではありません。
size
ログのサイズが <size> バイトを超えていれば、ローテーションするよう設定します。

第1パラメータに、文字列で 'size' を指定することで、第2パラメータがローテーションサイズであることを指定します。

第2パラメータに、文字列でサイズを指定します。
<size> は 128 バイト以上で指定してください。
末尾に"K"があるとキロバイト単位、"M"があるとメガバイト単位になります。
rotate
ローテーションした際、何世代まで保存するか(何世代先を削除するか)設定します。

第1パラメータに、文字列で 'rotate' を指定することで、第2パラメータが世代数であることを指定します。

第2パラメータに、整数で世代数を指定します。
<count> は 1 以上を指定してください。
halt
第1パラメータに、文字列で 'halt' を指定することで、ローテーション設定を破棄することを指定します。
以後、ローテーションされなくなります。

パラメータの説明

指定するパラメータは以下の通りです。
パラメータパラメータ説明
(第1パラメータ)文字列'size'、'rotate'、'halt'のいずれかを指定します。
(第2パラメータ)文字列'size' を指定した場合に、ローテーションするログサイズを指定します。
整数'rotate' を指定した場合に、世代数を指定します。

続きを読む

logpause

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

logpause 機能

[通信コマンド]

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

コマンドライン

logpause

機能説明

中断している間に受信された文字は、ログファイルに書き込まれなくなります。

パラメータの説明

指定するパラメータはありません。

続きを読む

logopen

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

logopen 機能

[通信コマンド]

Tera Term のログを開始します。

コマンドライン

logopen <file name> <binary flag> <append flag> [<plain text flag> [<timestamp flag> [<hide dialog flag> [<include screen buffer flag> [<timestamp type>]]]]]

機能説明

指定されたパラメータに応じて Tera Term のログを開始します。
すべてのバージョンで対応部分
<file name>
<file name> は、ログを取得するファイル名を指定します。
省略できません。

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

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

また、バージョン 4.45以降は、ファイル名に strftime のフォーマットを利用できる機能の追加されました。
マクロでも、ログ名に strftime フォーマットが指定可能です。
書式意味
&hホスト名。未接続の場合は空。
&pTCP ポート番号。未接続の場合は空。TCP 接続でないときも空。
&uログオン中のユーザ名。
%a曜日の省略形。
%A曜日の正式名。
%b月の省略形。
%B月の正式名。
%cロケールに対応する日付と時刻の表現。
%d10 進数で表す月の日付 (01 ~ 31)。
%H24 時間表記の時間 (00 ~ 23)。
%I12 時間表記の時間 (01 ~ 12)。
%j10 進数で表す年初からの日数 (001 ~ 366)。
%m10 進数で表す月 (01 ~ 12)。
%M10 進数で表す分 (00 ~ 59)。
%p現在のロケールの午前/午後。
%S10 進数で表す秒 (00 ~ 59)。
%U10 進数で表す週の通し番号。日曜日を週の最初の日とする (00 ~ 53)。
%w10 進数で表す曜日 (0 ~ 6、日曜日が 0)。
%W10 進数で表す週の通し番号。月曜日を週の最初の日とする (00 ~ 53)。
%x現在のロケールの日付表現。
%X現在のロケールの時刻表現。
%y10 進数で表す西暦の下 2 桁 (00 ~ 99)。
%Y10 進数で表す 4 桁の西暦。
%z, %Zレジストリの設定に応じて、タイム ゾーンの名前または省略形を指定します。
タイム ゾーンが不明な場合は指定しません。
%%パーセント記号。
【注意】
バージョン 4.55 で、ログファイル名に strftime のフォーマットを指定したときに展開されない問題の修正が入っています。
<binary flag>
<binary flag> は、ログのタイプを指定します。
省略できません。

指定するパラメータは以下の通りです。
<binary flag>モード挙動の説明
0Text受信した漢字、改行文字は変換されてファイルに書き込まれ、エスケープシーケンスは書き込みません。
1Binary受信した文字をすべてそのままファイルに書き込みます。
バイナリログは、ログ再生に利用可能です。
<append flag>
<append flag> は、上書きか追記かを指定します。
省略できません。

指定するパラメータは以下の通りです。
<append flag>ファイルの有無挙動の説明
0既存ありそのファイルに対して上書きします。
既存なし新規でファイルを作成します
1既存ありそのファイルに追加して書き込みます。
既存なし新規でファイルを作成します
バージョン 4.61以降 (ログ再生可能なバイナリオプションの追加)
<binary flag> が 1 (0 以外)の場合、<plain text flag> および <timestamp flag> は両方とも無視されます。
<plain text flag>
指定するパラメータは以下の通りです。
<plain text flag>挙動の説明
0ASCII 制御文字を書き込みます。
省略時は、こちらが指定されたものとして処理されます
1ASCII 非表示文字をログに書き込みません。
これより後のパラメータを指定しない場合において、省略可能です。
<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 です。
省略時は、こちらが指定されたものとして処理されます
1UTC端末の現在時刻を 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>整数タイムスタンプを追記する場合、その形式を指定する。

続きを読む

loginfo

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

loginfo 機能

[通信コマンド]
Tera Term のログ取得状態を得ます。

コマンドライン

loginfo <strvar>

機能説明

Tera Term のログ取得状態を得ます。
<strvar>
ログ取得中であれば、指定した変数に取得中のログファイル名が格納されます。

ログを取得している場合、<strvar> にログファイル名が格納され、ログ取得時のフラグの状態が <result> に格納されます。
ログを取得していない場合は <result> に -1 が格納されます。

パラメータの説明

指定するパラメータは以下の通りです。
パラメータパラメータ説明
<strvar>文字列変数名を指定します。

続きを読む