Skip to content

Commit 1701b5e

Browse files
committed
update documentation
1 parent a2455c4 commit 1701b5e

2 files changed

Lines changed: 6 additions & 79 deletions

File tree

Readme.MD

Lines changed: 3 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -48,82 +48,9 @@ Method ProgressCallback.4dm can be used as example how to create a progress bar
4848

4949
Copy this 2-4 files into your project, done.
5050

51-
# Full documentation
51+
# Documentation
5252

53-
54-
install curl for sftp
55-
to accept certificate, it needs to be in known_hosts
56-
to do so, on this computer, use terminal/console and enter once
57-
ssh name@host
58-
enter password
59-
-> added to local_host
60-
61-
from this moment, curl will accept this certificate
62-
63-
To do:
64-
65-
66-
67-
progress meter -> callback
68-
(delayed - on Mac there is a buffer, not useable to display progress)
69-
Example callback uses 4D progress
70-
71-
72-
test windows
53+
See Class documentation (in 4D use Explorer/Documentation)
54+
[Documentation](https://github.com/ThomasMaul/FileTransfer_Class/blob/main/Documentation/Classes/FileTransfer.md)
7355

74-
documentation
75-
76-
77-
Examples for setCurlPrefix
78-
79-
ssl cipers, certificate files
80-
81-
--limit-rate <speed>
82-
83-
Specify the maximum transfer rate you want curl to use. This feature is useful if you have a limited pipe and you'd like your transfer not use your entire bandwidth.
84-
85-
The given speed is measured in bytes/second, unless a suffix is appended. Appending 'k' or 'K' will count the number as kilobytes, 'm' or M' makes it megabytes while 'g' or 'G' makes it gigabytes. Examples: 200K, 3m and 1G.
86-
87-
If you are also using the -Y/--speed-limit option, that option will take precedence and might cripple the rate-limiting slightly, to help keeping the speed-limit logic working.
88-
89-
This option was introduced in curl 7.10.
90-
91-
If this option is used several times, the last one will be used.
92-
93-
-y/--speed-time <time>
94-
95-
96-
97-
98-
brew install curl
99-
/opt/homebrew/opt/curl/bin/curl --version
100-
curl 7.81.0 (arm-apple-darwin21.1.0) libcurl/7.81.0 (SecureTransport) OpenSSL/1.1.1m zlib/1.2.11 brotli/1.0.9 zstd/1.5.2 libidn2/2.3.2 libssh2/1.10.0 nghttp2/1.46.0 librtmp/2.3 OpenLDAP/2.6.1
101-
Release-Date: 2022-01-05
102-
Protocols: dict file ftp ftps gopher gophers http https imap imaps ldap ldaps mqtt pop3 pop3s rtmp rtsp scp sftp smb smbs smtp smtps telnet tftp
103-
Features: alt-svc AsynchDNS brotli GSS-API HSTS HTTP2 HTTPS-proxy IDN IPv6 Kerberos Largefile libz MultiSSL NTLM NTLM_WB SPNEGO SSL TLS-SRP UnixSockets zstd
104-
105-
106-
If a download is slower than speed-limit bytes per second during a speed-time period, the download gets aborted. If speed-time is used, the default speed-limit will be 1 unless set with -y.
107-
108-
This option controls transfers and thus will not affect slow connects etc. If this is a concern for you, try the --connect-timeout option.
109-
110-
If this option is used several times, the last one will be used.
111-
112-
-Y/--speed-limit <speed>
113-
114-
If a download is slower than this given speed, in bytes per second, for speed-time seconds it gets aborted. speed-time is set with -Y and is 30 if not set.
115-
116-
If this option is used several times, the last one will be used.
117-
118-
119-
--max-time 10 \
120-
--retry 5 \
121-
--retry-delay 0 \
122-
--retry-max-time 40 \
123-
124-
--max-time 10 (how long each retry will wait)
125-
--retry 5 (it will retry 5 times)
126-
--retry-delay 0 (an exponential backoff algorithm)
127-
--retry-max-time (total time before it's considered failed)
128-
12956

userPreferences.Thomas/workspace.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
{
22
"editors": [
3+
{
4+
"type": "explorer"
5+
},
36
{
47
"type": "method",
58
"id": 2147483645,
@@ -16,9 +19,6 @@
1619
"methodName": "test"
1720
}
1821
},
19-
{
20-
"type": "explorer"
21-
},
2222
{
2323
"type": "method",
2424
"id": 2147483639,

0 commit comments

Comments
 (0)