Skip to content

Commit 800c41c

Browse files
authored
Merge pull request #57 from XhmikosR/patch-1
README.md" minor Markdown tweaks
2 parents fec0da4 + 8d0b207 commit 800c41c

File tree

1 file changed

+27
-16
lines changed

1 file changed

+27
-16
lines changed

README.md

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,15 @@ If they do not ship it, consider making a request for it.
1717

1818
You can always install wcurl by simply downloading the script:
1919

20-
```console
20+
```sh
2121
curl -fLO https://github.com/curl/wcurl/releases/latest/download/wcurl
2222
chmod +x wcurl
2323
sudo mv wcurl /usr/local/bin/wcurl
2424
```
2525

2626
# Install wcurl's manpage
27-
```console
27+
28+
```sh
2829
curl -fLO https://github.com/curl/wcurl/releases/latest/download/wcurl.1
2930
sudo mkdir -p /usr/local/share/man/man1/
3031
sudo mv wcurl.1 /usr/local/share/man/man1/wcurl.1
@@ -34,15 +35,18 @@ sudo mandb
3435
# wcurl(1)
3536

3637
**wcurl**
37-
- a simple wrapper around curl to easily download files.
38+
39+
* a simple wrapper around curl to easily download files.
3840

3941
# Synopsis
4042

41-
wcurl <URL>...
42-
wcurl [--curl-options <CURL_OPTIONS>]... [--no-decode-filename] [-o|-O|--output <PATH>] [--dry-run] [--] <URL>...
43-
wcurl [--curl-options=<CURL_OPTIONS>]... [--no-decode-filename] [--output=<PATH>] [--dry-run] [--] <URL>...
44-
wcurl -V|--version
45-
wcurl -h|--help
43+
```text
44+
wcurl <URL>...
45+
wcurl [--curl-options <CURL_OPTIONS>]... [--no-decode-filename] [-o|-O|--output <PATH>] [--dry-run] [--] <URL>...
46+
wcurl [--curl-options=<CURL_OPTIONS>]... [--no-decode-filename] [--output=<PATH>] [--dry-run] [--] <URL>...
47+
wcurl -V|--version
48+
wcurl -h|--help
49+
```
4650

4751
# Description
4852

@@ -56,7 +60,6 @@ If you need anything more complex, you can provide any of curl's supported
5660
parameters via the `--curl-options` option. Just beware that you likely
5761
should be using curl directly if your use case is not covered.
5862

59-
6063
* By default, **wcurl** does:
6164
* Percent-encode whitespaces in URLs;
6265
* Download multiple URLs in parallel if the installed curl's version is >= 7.66.0 (`--parallel`);
@@ -114,19 +117,27 @@ then performs the parsing. May be specified more than once.
114117

115118
* Download a single file:
116119

117-
`wcurl example.com/filename.txt`
120+
```sh
121+
wcurl example.com/filename.txt
122+
```
118123

119124
* Download two files in parallel:
120125

121-
`wcurl example.com/filename1.txt example.com/filename2.txt`
126+
```sh
127+
wcurl example.com/filename1.txt example.com/filename2.txt
128+
```
122129

123-
* Download a file passing the _--progress-bar_ and _--http2_ flags to curl:
130+
* Download a file passing the `--progress-bar` and `--http2` flags to curl:
124131

125-
`wcurl --curl-options="--progress-bar --http2" example.com/filename.txt`
132+
```sh
133+
wcurl --curl-options="--progress-bar --http2" example.com/filename.txt
134+
```
126135

127136
* Resume from an interrupted download (if more options are used, this needs to be the last one in the list):
128137

129-
`wcurl --curl-options="--continue-at -" example.com/filename.txt`
138+
```sh
139+
wcurl --curl-options="--continue-at -" example.com/filename.txt
140+
```
130141

131142
# Running the testsuite
132143

@@ -145,8 +156,8 @@ script:
145156

146157
To lint the shell scripts, you need to install `shellcheck` and `checkbashisms`. These tools check the scripts for issues and ensure they follow best practices.
147158

148-
- On Debian-like systems: `apt install shellcheck devscripts`
149-
- On Fedora-like systems: `dnf install shellcheck devscripts`
159+
* On Debian-like systems: `apt install shellcheck devscripts`
160+
* On Fedora-like systems: `dnf install shellcheck devscripts`
150161

151162
After installation, you can run `shellcheck` and `checkbashisms` by executing the following commands:
152163

0 commit comments

Comments
 (0)