From 6a6ef2ada28afef4e668154de17d7b107d9932a6 Mon Sep 17 00:00:00 2001
From: yggverse <yggverse@project>
Date: Mon, 24 Jun 2024 22:25:30 +0300
Subject: [PATCH] add CLI help

---
 help.gmi | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100755 help.gmi

diff --git a/help.gmi b/help.gmi
new file mode 100755
index 0000000..e642f5e
--- /dev/null
+++ b/help.gmi
@@ -0,0 +1,33 @@
+
+```
+┏┓     •  •┳┓┓
+┃┓┏┓┏┳┓┓┏┓┓┃┃┃
+┗┛┗ ┛┗┗┗┛┗┗┻┛┗┛ v 0.1
+```
+=> https://github.com/YGGverse/gemini-dl
+
+# Usage
+
+    gemini-dl.php --source gemini://.. --target /path/to/download
+
+## Required
+
+    -s, --source     - string, gemini protocol address
+    -t, --target     - string, absolute path to destination folder
+
+## Optional
+
+    -c, --crawl      - no value, crawl document links (entire capsule download), disabled by default
+    -d, --delay      - integer, pause between requests in seconds, 1 by default
+    -i, --index      - string, index filename for directory listing, index.gmi by default
+    -h, --help       - no value, show available commands
+    -k, --keep       - no value, keep original links (--crawl mode only), disabled by default
+    -m, --match      - string, collect links match regex rule, /.*/ by default
+    -r, --raw        - no value, include meta headers (--keep option ignored), disabled by default
+    -u, --unique     - no value, append snap version as folder timestamp, disabled by default
+
+## Experimental (in development)
+
+    -e, --external   - no value, follow external hosts, disabled by default
+    -f, --follow     - integer, follow redirects on --crawl, 0 by default
+    -l, --level      - integer, depth to --crawl, 0 by default