Skip to content

Commit 96cf38d

Browse files
committed
マニュアルを修正した(ドロップ箇所の説明の外だし) #894
1 parent 028696b commit 96cf38d

File tree

10 files changed

+341
-191
lines changed

10 files changed

+341
-191
lines changed

doc/en/html/menu/file-receivefile.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ <h2>"Receiving file" dialog box</h2>
7575
<h3 id="drop">Drop of received data</h3>
7676
<p style="padding-left: 1em;">
7777
When receiving data at a high bit rate from the serial port, there may be instances where received data is dropped.<br>
78-
This is likely to occur when the PC is under high load and Tera Term's processing (reading data from the UART chip) cannot keep up.<br>
79-
If this occurs, reduce the communication speed (baud rate).
78+
This is likely to occur when the PC is under high load and Tera Term's processing cannot keep up.<br>
79+
Refer to the <a href="../usage/tips/data_drop.html#solution">Solution</a> section.
8080
</p>
8181

8282
</body>

doc/en/html/menu/file-sendfile.html

Lines changed: 20 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@ <h1>Send file ([File] menu)</h1>
1616

1717
<p>
1818
Selecting this menu brings up the "Send file" dialog.<br>
19-
Selecting this menu while holding down CTRL key skips "Send file" dialog
20-
and you can send file by only selecting file.<br>
21-
At this time, same sending options are used as before.
19+
If you select this menu while holding down the CTRL key, it skips the "Send File" dialogand proceed to file selection.<br>
20+
In that case, the same sending options as before will be used.
2221
<p>
2322

2423
<p>
25-
This behavior can be changed with <a href="#SpecialOption">Special Option</a>.
24+
This behavior can be changed in the configuration file.
25+
See "<a href="../setup/teraterm-trans.html#SendfileSkipOptionDialog">Skip Send file dialog</a>" for details.
2626
</p>
2727

28-
<h2 id="dialog">"Send file" dialog box (to input the file name)</h2>
28+
<h2 id="dialog">"Send file" dialog box</h2>
2929
<dl>
3030
<dt>File Name</dt>
3131
<dd>
@@ -71,9 +71,9 @@ <h2 id="dialog">"Send file" dialog box (to input the file name)</h2>
7171

7272
<dt id="Binary">Binary</dt>
7373
<dd>
74-
If you select this option, received characters are sent without any
75-
modifications. Otherwise, new-line codes are converted and control
76-
characters (except TAB, LF and CR) are stripped out.
74+
If you select this option, received characters are sent without any
75+
modifications. Otherwise, new-line codes are converted and control
76+
characters (except TAB, LF and CR) are stripped out.
7777
</dd>
7878

7979
<dt>Delay setting</dt>
@@ -119,92 +119,26 @@ <h2 id="dialog">"Send file" dialog box (to input the file name)</h2>
119119
</dd>
120120
</dl>
121121

122-
<h3 id="SpecialOption">Special options in the Tera Term setup file</h3>
123-
See also the following settings
124-
<ul>
125-
<li><a href="../setup/teraterm-trans.html#FileSendHighSpeedMode">High Speed File Transfer on Serial Connection (When sequential read)</a>
126-
<li><a href="../setup/teraterm-trans.html#SendfileSkipOptionDialog">Skip Send file dialog</a>
127-
</ul>
128-
129-
130-
<h3 id="drop">Send size</h3>
131-
132-
<p>
133-
Considering receiver's receive buffer size and processing speed,
134-
by inserting a delay for each specified send size,
135-
file send can be performed more efficiently than by inserting a delay for each character or each line.
136-
</p>
137-
138-
<p>
139-
Dropping of transmitted data may occur at following part.
140-
</p>
141-
142-
<pre>
143-
s1 s2 s3 s4 program
144-
Tera Term ---&gt; Send buffer ---&gt; Windows ---&gt; (sshd,telnet,pipe) ---&gt; OS,driver ---&gt; pty + shell, other program
145-
in Tera Term (serial ) UART chip,ext Embedded programs, etc.
146-
147-
receive buffer &lt;-- &lt;--- &lt;--- &lt;---
148-
r1 r2 r3 r4
149-
</pre>
150-
151-
<dl>
152-
<dt>s1 Sned buffer in Tera Term</dt>
153-
<dd>
154-
It is unlikely to drop.<br>
155-
Data is sended while watching free size of send buffer.
156-
</dd>
157-
<dt>s2 Windows</dt>
158-
<dd>
159-
It is unlikely to drop.<br>
160-
Depending on hardware and driver version, various problems may occur, including BSoD.<br>
161-
You can see details of driver in Tera Term serial port settings.
162-
</dd>
163-
<dt>s3 transmission path</dt>
164-
<dd>
165-
In serial, there is no resend process with error. If error occurs in data, data is dropped.<br>
166-
For TCP/IP, pipe, it is unlikely to drop.
167-
</dd>
168-
<dt>s4 OS,UART chip(receiver)</dt>
169-
<dd>
170-
Receiving data beyond processing capacity of PC (CPU) (when PROGRAM does not pick up received data from OS or chip) or other causes,
171-
Receive buffer of OS (driver) or UART chip are overflows and data is dropped.<br>
172-
OS (driver) or program handles flow control depends on implementation.<br>
173-
In TCP/IP, flow control and resend on error are performed, and in most cases,
174-
protocol stack in OS handles these processes.<br>
175-
In serial, user can decide whether flow control is used or not, and resend are not automatically performed in case of overflow or other errors.
176-
</dd>
177-
<dt>program</dt>
178-
<dd>
179-
Dropped due to receive buffer overflow, etc. in program.<br>
180-
When receive buffer is about to overflow in pseudo terminal(pty), 0x07(BEL) is sent and Tera Term will ring bell.
181-
</dd>
182-
</dl>
183-
184-
Receive buffer size of main UART chips and drivers
185-
<pre>
186-
8250 UART no FIFO
187-
16550 UART 16 Byte FIFO
188-
FT232R 256 Byte receive buffer
189-
TTY drive(Linux 2.6.26) 4KB (<a href="../reference/sourcecode.html#ttssh">SSH Design and Implementation in TTSSH</a>)
190-
</pre>
191-
192-
<p>
193-
If echo of sent data is not returned, it is possible that received data has been dropped somewhere.
194-
</p>
195-
196-
<h2>"Send file" dialog box (displayed while sending)</h2>
122+
<h2>"Sending file" dialog box</h2>
197123
<dl>
198124
<dt>Close</dt>
199125
<dd>
200-
The Close button quits sending.
126+
The Close button quits sending.
201127
</dd>
202128

203129
<dt>Pause/Start</dt>
204130
<dd>
205-
The Pause button pauses sending. The Start button restarts sending.
206-
These buttons function as toggles.
131+
The Pause button pauses sending. The Start button restarts sending.
132+
These buttons function as toggles.
207133
</dd>
208134
</dl>
135+
136+
<h2 id="drop">Drop of transmitted data</h2>
137+
<p style="padding-left: 1em;">
138+
When sending data at a high bit rate over the serial port, transmitted data may be dropped.<br>
139+
This may be caused by insufficient performance of the connected device.<br>
140+
Refer to the <a href="../usage/tips/data_drop.html#solution">Solution</a> section.
141+
</p>
142+
209143
</body>
210144
</html>

doc/en/html/menu/setup-additional-serialport.html

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -104,16 +104,22 @@ <h1><a href="setup-additional.html">Additional settings</a> / "Serial port" tab
104104

105105
<dt id="Delay">Transmit delay</dt>
106106
<dd>
107-
Time intervals between characters (lines) being sent, in milliseconds.
108-
The unit is milliseconds. You can set the wait time per character (line).
109-
If the modem or host drops characters when Tera Term sends a large number of characters, try setting an appropriate delay time.
107+
Time intervals between characters (lines) being sent, in milliseconds.
108+
The unit is milliseconds. You can set the wait time per character (line).
109+
If the modem or host drops characters when Tera Term sends a large number of characters, try setting an appropriate delay time.
110110
</dd>
111111

112112
<dt id="Information">Detail information of COM port</dt>
113113
<dd>
114-
The detail information of selected port is shown in the text box. <br>
115-
You can select all data by using CTRL+A.
116-
You can scroll horizontally by using CTRL/SHIFT + wheel.
114+
The detail information of selected port is shown in the text box. <br>
115+
You can select all data by using CTRL+A.
116+
You can scroll horizontally by using CTRL/SHIFT + wheel.
117+
</dd>
118+
119+
<dt id="drop">If the transmitted or received data is dropped</dt>
120+
<dd>
121+
Data sent or received may be lost for various reasons.<br>
122+
See the <a href="../usage/tips/data_drop.html">Dropping sent and received data</a> section for information on the locations of drops and recommended countermeasures.
117123
</dd>
118124

119125
</dl>
Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2+
"http://www.w3.org/TR/html4/strict.dtd">
3+
<HTML>
4+
<HEAD>
5+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
6+
<TITLE>Dropping sent and received data</TITLE>
7+
<META http-equiv="Content-Style-Type" content="text/css">
8+
<link rel="stylesheet" href="../../style.css" type="text/css">
9+
</HEAD>
10+
<BODY>
11+
12+
<h1>Dropping sent and received data</h1>
13+
14+
Data sent or received may be lost for various reasons.<br>
15+
The locations where drops occur and the solutions are as follows:
16+
17+
<h2 id="send">1. Sending Data</h2>
18+
19+
<pre>
20+
s1 s2 s3 s4 program
21+
Tera Term ---> Send buffer ---> OS,driver ---> (sshd,telnet,pipe) ---> UART chip ---> pty + shell, other program
22+
in Tera Term UART chip (serial ) driver,OS Embedded programs, etc.
23+
</pre>
24+
25+
<dl>
26+
<dt>s1. Sned buffer in Tera Term</dt>
27+
<dd>
28+
It is unlikely to drop.<br>
29+
Data is sended while watching free size of send buffer OutBuff[](16KB).
30+
</dd>
31+
<dt>s2. OS,UART chip(sender)</dt>
32+
<dd>
33+
It is unlikely to drop.<br>
34+
Depending on hardware and driver version, various problems may occur, including BSoD.<br>
35+
You can see details of driver in Tera Term serial port settings.<br>
36+
Tera Term will suggest 4KB as the recommended size of the send buffer to the communication device in <a href="https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-setupcomm">SetupComm()</a>.
37+
</dd>
38+
<dt>s3. transmission path</dt>
39+
<dd>
40+
Cable quality, cable length, crosstalk, signal interference, etc. can cause errors and drops.<br>
41+
In serial, there is no resend process with error. If error occurs in data, data is dropped.<br>
42+
For TCP/IP, pipe, it is unlikely to drop.
43+
</dd>
44+
<dt>s4. UART chip,OS(receiver)</dt>
45+
<dd>
46+
Receiving data beyond processing capacity of PC (CPU) (when PROGRAM does not pick up received data from OS or chip) or other causes,
47+
Receive buffer of OS (driver) or UART chip are overflows and data is dropped.<br>
48+
OS (driver) or program handles flow control depends on implementation.<br>
49+
In TCP/IP, flow control and resend on error are performed, and in most cases,
50+
protocol stack in OS handles these processes.<br>
51+
In serial, user can decide whether flow control is used or not, and resend are not automatically performed in case of overflow or other errors.
52+
</dd>
53+
<dt>program</dt>
54+
<dd>
55+
Dropped due to receive buffer overflow, etc. in program.<br>
56+
When receive buffer is about to overflow in pseudo terminal(pty), 0x07(BEL) is sent and Tera Term will ring bell.
57+
</dd>
58+
</dl>
59+
60+
<h2 id="send">2. Receiving Data</h2>
61+
62+
<pre>
63+
r1 r2 r3 r4 program
64+
Tera Term ---> Receiving buffer ---> UART chip ---> (sshd,telnet,pipe) ---> OS,driver ---> pty + shell, other program
65+
in Tera Term driver,OS (serial ) UART chip Embedded programs, etc.
66+
</pre>
67+
68+
<dl>
69+
<dt>program</dt>
70+
<dd>
71+
It is unlikely to drop.<br>
72+
Drop due to send buffer overflow, etc. in program.<br>
73+
</dd>
74+
<dt>r4. OS,UART chip(sender)</dt>
75+
<dd>
76+
It is unlikely to drop.<br>
77+
Depending on hardware and driver version, various problems may occur.<br>
78+
</dd>
79+
<dt>r3. transmission path</dt>
80+
<dd>
81+
Cable quality, cable length, crosstalk, signal interference, etc. can cause errors and drops.<br>
82+
In serial, there is no resend process with error. If error occurs in data, data is dropped.<br>
83+
For TCP/IP, pipe, it is unlikely to drop.
84+
</dd>
85+
<dt>r2. UART chip,OS(receiver)</dt>
86+
<dd>
87+
Tera Term will suggest 16KB as the recommended receive buffer size for the communication device in <a href="https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-setupcomm">SetupComm()</a>.<br>
88+
If reading from the UART chip or OS is delayed due to high load, the receive buffer of the communication device will overflow and data will be dropped.<br>
89+
In TCP/IP, flow control and resend on error are performed, and in most cases,
90+
protocol stack in OS handles these processes.<br>
91+
In serial, user can decide whether flow control is used or not, and resend are not automatically performed in case of overflow or other errors.
92+
<p>
93+
Receive buffer size of main UART chips and drivers
94+
<pre>
95+
8250 UART no FIFO
96+
16550 UART 16 Byte FIFO
97+
FT232R 256 Byte receive buffer
98+
TTY drive(Linux 2.6.26) 4KB (<a href="../reference/sourcecode.html#ttssh">SSH Design and Implementation in TTSSH</a>)
99+
</pre>
100+
</dd>
101+
<dt>r1. Receiving buffer in Tera Term</dt>
102+
<dd>
103+
The received data read from the OS is stored in Tera Term's receive buffer InBuff[] (16KB), where it is used for screen drawing, log output, macro processing, etc.<br>
104+
If Tera Term processing (screen drawing, log output, macro processing, etc.) is delayed, the receive buffer will overflow and data will be dropped.
105+
</dd>
106+
</dl>
107+
108+
<h2 id="solution">3. Solution</h2>
109+
110+
<ol>
111+
<li>Checking the Connection Method</li>
112+
For serial connections, make sure the <a href="../../menu/setup-additional-serialport.html#Speed">Serial parameters (baud rate, bit length, etc.)</a> match between the sender and receiver.<br>
113+
Setting flow control can help prevent receive buffer overflow.<br>
114+
Hardware flow control (RTS/CTS, DSR/DTR) is recommended.<br>
115+
<br>
116+
<li>If the transmitted data is dropped</li>
117+
This is thought to be due to insufficient processing performance of the opposing device "s4. UART chip,OS(receiver)" and "program".<br>
118+
The solution is to slow down the communication speed and reduce the amount sent per unit time.<br>
119+
For serial connections, lower the baud rate.<br>
120+
If the baud rate cannot be changed, such as in embedded devices, set a send delay to prevent the receive buffer from overflowing.<br>
121+
A send delay is also effective in cases where line feeds or screen clearing take time, such as with LCD controllers,
122+
and sending the next command before the processing is complete causes problems.<br>
123+
<br>
124+
<li>If received data is dropped</li>
125+
This is probably due to insufficient processing performance in "r2. UART chip,OS(receiver)" and "r1. Receiving buffer in Tera Term"<br>
126+
When launching a resource-intensive app such as Visual Studio or video/image editing software, the app may temporarily run out of resources and drop.<br>
127+
The solution is to slow down the communication speed and reduce the amount sent per unit time.<br>
128+
For serial connections, lower the baud rate.<br>
129+
<br>
130+
<li>Others</li>
131+
If data errors occur, the problem may be resolved by using a higher quality cable or by moving the cable away from noise sources (power adapter, power cable, etc.).
132+
</ol>
133+
134+
</BODY>
135+
</HTML>

doc/en/html/usage/tips/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ <h1>Tips</h1>
1616
<LI><A HREF="loging_howto.html">Log and replay functions</A></LI>
1717
<LI><A HREF="user-shortcutkey.html">User shortcut keys</A></LI>
1818
<LI><A HREF="about_tenkey.html">Numeric keypad</A></LI>
19-
<LI><A HREF="appkeypad.html">Keypad mode</A></LI>
19+
<LI><A HREF="appkeypad.html">Keypad mode</A></LI>
2020
<LI><A HREF="pf1-pf4key_vt100.html">PF1-PF4 keys of VT100</A></LI>
2121
<!-- <LI><A HREF="pc-communication.html">How to use online service</A></LI> -->
2222
<!-- <LI><A HREF="nifty-serve.html">NIFTY-Serve hint</A></LI> -->
@@ -35,6 +35,7 @@ <h1>Tips</h1>
3535
<!-- <LI><A HREF="ime.html">IME hint</A></LI> -->
3636
<LI><A HREF="virtual_store.html">Virtual Store</A></LI>
3737
<LI><A HREF="vt100_wrap.html">VT100 Wrap process</A></LI>
38+
<LI><A HREF="data_drop.html">Dropping sent and received data</A></LI>
3839
</UL>
3940

4041
</BODY>

doc/ja/html/menu/file-receivefile.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,11 @@
7373
</dd>
7474
</dl>
7575

76-
<h3 id="drop">受信データのドロップ</h3>
76+
<h2 id="drop">受信データのドロップ</h2>
7777
<p style="padding-left: 1em;">
7878
シリアルポートから高ビットレートでデータを受信する場合、受信データをドロップする場合があります。<br>
79-
PCが高負荷で Tera Term の処理(UART チップからのデータ読み出し)が追い付かない場合に発生しがちです<br>
80-
その場合は、通信速度を遅くして下さい
79+
PCが高負荷で Tera Term の処理が追い付かない場合に発生しがちです<br>
80+
<a href="../usage/tips/data_drop.html#solution">対処方法</a>を参照下さい
8181
</p>
8282

8383
</body>

0 commit comments

Comments
 (0)