improve documentation - webdump - HTML to plain-text converter for webpages | |
git clone git://git.codemadness.org/webdump | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit 20fb149d1183220e2fee0cbfb6d3ac4f288bc67e | |
parent ce2a730d81823f9fc5f1d607296bb4529e9aeef0 | |
Author: Hiltjo Posthuma <[email protected]> | |
Date: Thu, 7 Sep 2023 18:33:52 +0200 | |
improve documentation | |
Diffstat: | |
M README | 21 +++++++-------------- | |
M webdump.1 | 10 +++++++--- | |
2 files changed, 14 insertions(+), 17 deletions(-) | |
--- | |
diff --git a/README b/README | |
@@ -1,14 +1,3 @@ | |
-!!! | |
- | |
-NOTE! work-in-progress (very slowly) and experimental. | |
- | |
-This code has many dirty hacks and ugliness. Intended for my personal use only. | |
-Knowing this: of course feel free to use it in any way you like, see the | |
-LICENSE. | |
- | |
-!!! | |
- | |
- | |
webdump | |
------- | |
@@ -34,11 +23,15 @@ Dependencies | |
Usage | |
----- | |
-webdump < file.html | less -R | |
+Example: | |
+ | |
+ url='https://codemadness.org/sfeed.html' | |
+ | |
+ curl -s "$url" | webdump -r -b "$url" | less | |
-hurl 'https://codemadness.org/' | webdump | less -R | |
+ curl -s "$url" | webdump -8 -a -i -l -r -b "$url" | less -R | |
-webdump -a -i -l -r -w $(tput cols) < file.html | less -R | |
+ curl -s "$url" | webdump -s 'main' -8 -a -i -l -r -b "$url" | less -R | |
Goals / scope | |
diff --git a/webdump.1 b/webdump.1 | |
@@ -53,9 +53,13 @@ Write resources as TAB-separated lines to file descriptor 3. | |
.Ex -std | |
.Sh EXAMPLES | |
.Bd -literal | |
-curl -s 'https://codemadness.org/' | \\ | |
- webdump -b 'https://codemadness.org' -l -r | \\ | |
- less | |
+url='https://codemadness.org/sfeed.html' | |
+ | |
+curl -s "$url" | webdump -r -b "$url" | less | |
+ | |
+curl -s "$url" | webdump -8 -a -i -l -r -b "$url" | less -R | |
+ | |
+curl -s "$url" | webdump -s 'main' -8 -a -i -l -r -b "$url" | less -R | |
.Ed | |
.Sh SEE ALSO | |
.Xr curl 1 , |