From: Kushal Das Date: Thu, 21 Apr 2022 15:05:36 +0000 (+0200) Subject: docs: updates spellings with full words X-Git-Tag: curl-7_83_0~25 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=94ac2ca7754f6ee13c378fed2e731aee61045bb1;p=thirdparty%2Fcurl.git docs: updates spellings with full words Closes #8730 --- diff --git a/docs/BUGS.md b/docs/BUGS.md index 4707a27717..584c67f0cb 100644 --- a/docs/BUGS.md +++ b/docs/BUGS.md @@ -65,7 +65,7 @@ debug dump with your bug report. The output you get by using the `-v` or `--trace` options. - If curl crashed, causing a core dump (in unix), there is hardly any use to + If curl crashed, causing a core dump (in Unix), there is hardly any use to send that huge file to anyone of us. Unless we have the same system setup as you, we cannot do much with it. Instead, we ask you to get a stack trace and send that (much smaller) output to us instead. diff --git a/docs/FAQ b/docs/FAQ index 0a4fe4384f..b92f1bbb19 100644 --- a/docs/FAQ +++ b/docs/FAQ @@ -42,10 +42,10 @@ FAQ 3.11 How do I POST with a different Content-Type? 3.12 Why do FTP-specific features over HTTP proxy fail? 3.13 Why do my single/double quotes fail? - 3.14 Does curl support Javascript or PAC (automated proxy config)? + 3.14 Does curl support JavaScript or PAC (automated proxy config)? 3.15 Can I do recursive fetches with curl? 3.16 What certificates do I need when I use SSL? - 3.17 How do I list the root dir of an FTP server? + 3.17 How do I list the root directory of an FTP server? 3.18 Can I use curl to send a POST/PUT and not wait for a response? 3.19 How do I get HTTP from a host using a specific IP address? 3.20 How to SFTP from my user's home directory? @@ -225,7 +225,7 @@ FAQ implement it for you, that is not a friendly attitude. We spend a considerable time already on maintaining and developing curl. In order to get more out of us, you should consider trading in some of your time and - effort in return. Simply go to the GitHub repo which resides at + effort in return. Simply go to the GitHub repository which resides at https://github.com/curl/curl, fork the project, and create pull requests with your proposed changes. @@ -327,7 +327,7 @@ FAQ In the cURL project we have decided not to attempt to keep this file updated (or even present) since deciding what to add to a ca cert bundle is an undertaking we have not been ready to accept, and the one we can get from - Mozilla is perfectly fine so there's no need to duplicate that work. + Mozilla is perfectly fine so there is no need to duplicate that work. Today, with many services performed over HTTPS, every operating system should come with a default ca cert bundle that can be deemed somewhat @@ -341,7 +341,7 @@ FAQ 1.12 I have a problem who, can I chat with? - There's a bunch of friendly people hanging out in the #curl channel on the + There is a bunch of friendly people hanging out in the #curl channel on the IRC network libera.chat. If you are polite and nice, chances are good that you can get -- or provide -- help instantly. @@ -493,10 +493,10 @@ FAQ To curl, all contents are alike. It does not matter how the page was generated. It may be ASP, PHP, Perl, shell-script, SSI or plain HTML - files. There's no difference to curl and it does not even know what kind of + files. There is no difference to curl and it does not even know what kind of language that generated the page. - See also item 3.14 regarding javascript. + See also item 3.14 regarding JavaScript. 3.7 Can I use curl to delete/rename a file through FTP? @@ -597,27 +597,27 @@ FAQ Remember that curl works and runs on more operating systems than most single individuals have ever tried. - 3.14 Does curl support Javascript or PAC (automated proxy config)? + 3.14 Does curl support JavaScript or PAC (automated proxy config)? - Many web pages do magic stuff using embedded Javascript. curl and libcurl + Many web pages do magic stuff using embedded JavaScript. curl and libcurl have no built-in support for that, so it will be treated just like any other contents. .pac files are a Netscape invention and are sometimes used by organizations to allow them to differentiate which proxies to use. The .pac contents is - just a Javascript program that gets invoked by the browser and that returns - the name of the proxy to connect to. Since curl does not support Javascript, + just a JavaScript program that gets invoked by the browser and that returns + the name of the proxy to connect to. Since curl does not support JavaScript, it cannot support .pac proxy configuration either. - Some workarounds usually suggested to overcome this Javascript dependency: + Some workarounds usually suggested to overcome this JavaScript dependency: - Depending on the Javascript complexity, write up a script that translates it + Depending on the JavaScript complexity, write up a script that translates it to another language and execute that. - Read the Javascript code and rewrite the same logic in another language. + Read the JavaScript code and rewrite the same logic in another language. - Implement a Javascript interpreter, people have successfully used the - Mozilla Javascript engine in the past. + Implement a JavaScript interpreter, people have successfully used the + Mozilla JavaScript engine in the past. Ask your admins to stop this, for a static proxy setup or similar. @@ -668,10 +668,10 @@ FAQ refused access. You then need to explicitly disable the verification to connect to the server. - 3.17 How do I list the root dir of an FTP server? + 3.17 How do I list the root directory of an FTP server? There are two ways. The way defined in the RFC is to use an encoded slash - in the first path part. List the "/tmp" dir like this: + in the first path part. List the "/tmp" directory like this: curl ftp://ftp.sunet.se/%2ftmp/ @@ -765,7 +765,7 @@ FAQ 4.2 Why do I get problems when I use & or % in the URL? - In general unix shells, the & symbol is treated specially and when used, it + In general Unix shells, the & symbol is treated specially and when used, it runs the specified command in the background. To safely send the & as a part of a URL, you should quote the entire URL by using single (') or double (") quotes around it. Similar problems can also occur on some shells with other @@ -962,7 +962,7 @@ FAQ Meta tags. You can write an HTML tag that will cause the browser to redirect to another given URL after a certain time. - Javascript. You can write a Javascript program embedded in an HTML page that + JavaScript. You can write a JavaScript program embedded in an HTML page that redirects the browser to another given URL. There is no way to make curl follow these redirects. You must either @@ -1227,7 +1227,7 @@ FAQ should check for libs * Adjust the system's config to check for libs in the directory where you have - put the dir (like Linux's /etc/ld.so.conf) + put the library (like Linux's /etc/ld.so.conf) 'man ld.so' and 'man ld' will tell you more details @@ -1325,15 +1325,16 @@ FAQ to list the files. The follow-up question tends to be how is a program supposed to parse the - directory listing. How does it know what's a file and what's a dir and what's - a symlink etc. If the FTP server supports the MLSD command then it will - return data in a machine-readable format that can be parsed for type. The - types are specified by RFC3659 section 7.5.1. If MLSD is not supported then - you have to work with what you are given. The LIST output format is entirely - at the server's own liking and the NLST output does not reveal any types and - in many cases does not even include all the directory entries. Also, both LIST - and NLST tend to hide unix-style hidden files (those that start with a dot) - by default so you need to do "LIST -a" or similar to see them. + directory listing. How does it know what's a file and what's a directory and + what's a symlink etc. If the FTP server supports the MLSD command then it + will return data in a machine-readable format that can be parsed for type. + The types are specified by RFC3659 section 7.5.1. If MLSD is not supported + then you have to work with what you are given. The LIST output format is + entirely at the server's own liking and the NLST output does not reveal any + types and in many cases does not even include all the directory entries. + Also, both LIST and NLST tend to hide unix-style hidden files (those that + start with a dot) by default so you need to do "LIST -a" or similar to see + them. Example - List only directories. ftp.funet.fi supports MLSD and ftp.kernel.org does not: @@ -1372,7 +1373,7 @@ FAQ libraries, you need to continue your search elsewhere but there exist many good open source ones out there for most protocols you could want a server for. There are also really good stand-alone servers that have been tested - and proven for many years. There's no need for you to reinvent them. + and proven for many years. There is no need for you to reinvent them. 5.18 Does libcurl use threads? @@ -1505,7 +1506,7 @@ FAQ 8.1 Why does curl use C89? - As with everything in curl, there's a history and we keep using what we have + As with everything in curl, there is a history and we keep using what we have used before until someone brings up the subject and argues for and works on changing it. diff --git a/docs/FEATURES.md b/docs/FEATURES.md index 31631284ae..1a03489f7e 100644 --- a/docs/FEATURES.md +++ b/docs/FEATURES.md @@ -22,7 +22,7 @@ - "standard" proxy environment variables support - compiles on win32 (reported builds on 70+ operating systems) - selectable network interface for outgoing traffic - - IPv6 support on unix and Windows + - IPv6 support on Unix and Windows - happy eyeballs dual-stack connects - persistent connections - SOCKS 4 + 5 support, with or without local name resolving diff --git a/docs/HTTP-COOKIES.md b/docs/HTTP-COOKIES.md index 4c9a9bae49..8610d73ba6 100644 --- a/docs/HTTP-COOKIES.md +++ b/docs/HTTP-COOKIES.md @@ -120,14 +120,14 @@ Extract cookie information from the internal cookie storage as a linked list. -## Cookies with javascript +## Cookies with JavaScript - These days a lot of the web is built up by javascript. The webbrowser loads - complete programs that render the page you see. These javascript programs + These days a lot of the web is built up by JavaScript. The webbrowser loads + complete programs that render the page you see. These JavaScript programs can also set and access cookies. Since curl and libcurl are plain HTTP clients without any knowledge of or - capability to handle javascript, such cookies will not be detected or used. + capability to handle JavaScript, such cookies will not be detected or used. Often, if you want to mimic what a browser does on such websites, you can record web browser HTTP traffic when using such a site and then repeat the diff --git a/docs/HTTP3.md b/docs/HTTP3.md index caf09cd835..6cdadf312f 100644 --- a/docs/HTTP3.md +++ b/docs/HTTP3.md @@ -213,7 +213,7 @@ Check out the [list of known HTTP3 bugs](https://curl.se/docs/knownbugs.html#HTT This is not advice on how to run anything in production. This is for development and experimenting. -## Prereqs +## Prerequisite(s) An existing local HTTP/1.1 server that hosts files. Preferably also a few huge ones. You can easily create huge local files like `truncate -s=8G 8GB` - they diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 40a64a9e47..03d73843ac 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -149,7 +149,7 @@ debug multithreaded dynamic C runtime. ## MingW32 -Make sure that MinGW32's bin dir is in the search path, for example: +Make sure that MinGW32's bin directory is in the search path, for example: ```cmd set PATH=c:\mingw32\bin;%PATH% @@ -194,7 +194,7 @@ If you want to enable LDAPS support then set LDAPS=1. ## Cygwin -Almost identical to the unix installation. Run the configure script in the +Almost identical to the Unix installation. Run the configure script in the curl source tree root with `sh configure`. Make sure you have the `sh` executable in `/bin/` or you will see the configure fail toward the end. @@ -523,7 +523,7 @@ the `--disable` statements suggested above. Use will cause tests relying on those features to fail. The test harness can be manually forced to skip the relevant tests by specifying certain key words on the `runtests.pl` command line. Following is a list of appropriate key words for those configure options -that aren't automatically detected: +that are not automatically detected: - `--disable-cookies` !cookies - `--disable-dateparse` !RETRY-AFTER !CURLOPT_TIMECONDITION !CURLINFO_FILETIME !If-Modified-Since !getdate !-z diff --git a/docs/MANUAL.md b/docs/MANUAL.md index abc8ff154c..6b8acd6726 100644 --- a/docs/MANUAL.md +++ b/docs/MANUAL.md @@ -292,7 +292,7 @@ How to post a form with curl, lesson #1: Dig out all the `` tags in the form that you want to fill in. -If there's a "normal" post, you use `-d` to post. `-d` takes a full "post +If there is a "normal" post, you use `-d` to post. `-d` takes a full "post string", which is in the format =&=&... @@ -832,7 +832,7 @@ Unix introduced the `.netrc` concept a long time ago. It is a way for a user to specify name and password for commonly visited FTP sites in a file so that you do not have to type them in each time you visit those sites. You realize this is a big security risk if someone else gets hold of your passwords, so -therefore most unix programs will not read this file unless it is only readable +therefore most Unix programs will not read this file unless it is only readable by yourself (curl does not care though). Curl supports `.netrc` files if told to (using the `-n`/`--netrc` and @@ -864,7 +864,7 @@ Then use curl in way similar to: curl --krb private ftp://krb4site.com -u username:fakepwd -There's no use for a password on the `-u` switch, but a blank one will make +There is no use for a password on the `-u` switch, but a blank one will make curl ask for one and you already entered the real password to kinit/kauth. ## TELNET diff --git a/docs/TheArtOfHttpScripting.md b/docs/TheArtOfHttpScripting.md index 838314e46a..78dbd7a8f7 100644 --- a/docs/TheArtOfHttpScripting.md +++ b/docs/TheArtOfHttpScripting.md @@ -435,7 +435,7 @@ applications use this information to decide how to display pages. Silly web programmers try to make different pages for users of different browsers to make them look the best possible for their particular browsers. They usually - also do different kinds of javascript, vbscript etc. + also do different kinds of JavaScript, VBScript etc. At times, you will see that getting a page with curl will not return the same page that you see when getting the page with your browser. Then you know it @@ -479,7 +479,7 @@ Browsers typically support at least two other ways of redirects that curl does not: first the html may contain a meta refresh tag that asks the browser to load a specific URL after a set number of seconds, or it may use - javascript to do it. + JavaScript to do it. # Cookies @@ -648,13 +648,13 @@ make sure you got there through their login page) so you should make a habit of first getting the login-form page to capture the cookies set there. - Some web-based login systems feature various amounts of javascript, and + Some web-based login systems feature various amounts of JavaScript, and sometimes they use such code to set or modify cookie contents. Possibly they do that to prevent programmed logins, like this manual describes how to... Anyway, if reading the code is not enough to let you repeat the behavior manually, capturing the HTTP requests done by your browsers and analyzing the sent cookies is usually a working method to work out how to shortcut the - javascript need. + JavaScript need. In the actual `
` tag for the login, lots of sites fill-in random/session or otherwise secretly generated hidden tags and you may need diff --git a/docs/libcurl/libcurl-tutorial.3 b/docs/libcurl/libcurl-tutorial.3 index 0690088485..801aea0261 100644 --- a/docs/libcurl/libcurl-tutorial.3 +++ b/docs/libcurl/libcurl-tutorial.3 @@ -891,24 +891,24 @@ stand in the way for such innovative actions either! .IP "Proxy Auto-Config" Netscape first came up with this. It is basically a web page (usually using a -\&.pac extension) with a Javascript that when executed by the browser with the +\&.pac extension) with a JavaScript that when executed by the browser with the requested URL as input, returns information to the browser on how to connect to the URL. The returned information might be "DIRECT" (which means no proxy should be used), "PROXY host:port" (to tell the browser where the proxy for this particular URL is) or "SOCKS host:port" (to direct the browser to a SOCKS proxy). -libcurl has no means to interpret or evaluate Javascript and thus it does not +libcurl has no means to interpret or evaluate JavaScript and thus it does not support this. If you get yourself in a position where you face this nasty invention, the following advice have been mentioned and used in the past: -- Depending on the Javascript complexity, write up a script that translates it +- Depending on the JavaScript complexity, write up a script that translates it to another language and execute that. -- Read the Javascript code and rewrite the same logic in another language. +- Read the JavaScript code and rewrite the same logic in another language. -- Implement a Javascript interpreter; people have successfully used the -Mozilla Javascript engine in the past. +- Implement a JavaScript interpreter; people have successfully used the +Mozilla JavaScript engine in the past. - Ask your admins to stop this, for a static proxy setup or similar.