aboutsummaryrefslogtreecommitdiff
path: root/wikiget.1.md
diff options
context:
space:
mode:
authorCody Logan <clpo13@gmail.com>2023-10-02 10:30:53 -0700
committerCody Logan <clpo13@gmail.com>2023-10-02 10:30:53 -0700
commit32bceeefb667b1966956b49981d256359afe0177 (patch)
tree4ce0676814cdf1cc028daeb205e40ccff73af033 /wikiget.1.md
parent62b815f0fa083b8336f8ac36225fe0ba9838d202 (diff)
downloadwikiget-32bceeefb667b1966956b49981d256359afe0177.tar.gz
wikiget-32bceeefb667b1966956b49981d256359afe0177.zip
Update man page with alternate invocations
Diffstat (limited to 'wikiget.1.md')
-rw-r--r--wikiget.1.md19
1 files changed, 11 insertions, 8 deletions
diff --git a/wikiget.1.md b/wikiget.1.md
index 01dcd5e..11ab708 100644
--- a/wikiget.1.md
+++ b/wikiget.1.md
@@ -8,11 +8,10 @@ wikiget - download files from MediaWiki sites
# SYNOPSIS
-**wikiget**
-[\-**h**] [\-**V**] [\-**q**|\-**v**] [\-**f**] [\-**s** *SITE*] [\-**p** *PATH*]
-[\-\-**username** *USERNAME*] [\-\-**password** *PASSWORD*]
-[\-**o** *OUTPUT* | \-**a**] [\-**l** *LOGFILE*]
-*FILE*
+| **wikiget** \[*options*] *FILE*
+| **wikiget** \[*options*] \[\-**a**|\-\-**batch**] *BATCHFILE*
+| **wikiget** \[\-**V**|\-\-**version**]
+| **wikiget** \[\-**h**|\-\-**help**]
# DESCRIPTION
@@ -28,6 +27,12 @@ using only the file name or the URL of its description page.
description page, like *https://en.wikipedia.org/wiki/File:Example.jpg*, the file is fetched from the site
in the URL, in this case "en.wikipedia.org".
+*BATCHFILE*
+
+: In batch download mode (activated with \-**a** or \-\-**batch**), this is a text file containing multiple
+ file names or URLs to be downloaded, one per line. If an error is encountered during download, execution
+ stops immediately and the offending filename is printed.
+
\-**s**, \-\-**site** *SITE*
: MediaWiki site to download from. Will not have any effect if the full URL is given in the *FILE* parameter.
@@ -61,9 +66,7 @@ using only the file name or the URL of its description page.
\-**a**, \-\-**batch**
-: If this flag is set, *FILE* will be treated as an input text file containing multiple files to be downloaded,
- one filename or URL per line. If an error is encountered during download, execution stops immediately and the
- offending filename is printed.
+: If this flag is set, **wikiget** will run in batch download mode (see *BATCHFILE*).
\-**v**, \-\-**verbose**