aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCody Logan <clpo13@gmail.com>2020-07-22 16:29:06 -0700
committerCody Logan <clpo13@gmail.com>2020-07-22 16:29:06 -0700
commitd847c2c02c7c93413f56432f13ae513104186ebd (patch)
tree2aa45016a865efb4551da106d169f0441e43e39b
parent49743541f1450431fbf968a16096462250cca3e8 (diff)
downloadwikiget-d847c2c02c7c93413f56432f13ae513104186ebd.tar.gz
wikiget-d847c2c02c7c93413f56432f13ae513104186ebd.zip
Update README
Remove mention of filename without File: or Image: prefix. Clarify use of --path flag when a fully-qualified URL is used.
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index a423ee0..1d9de8b 100644
--- a/README.md
+++ b/README.md
@@ -14,14 +14,15 @@ Requires Python 3.5+. Get it with `pip install --user wikiget`.
`wikiget [-h] [-V] [-q | -v] [-f] [-s SITE] [-p PATH] [--username USERNAME]
[--password PASSWORD] [-o OUTPUT | -a] FILE`
-If `FILE` is in the form `File:Example.jpg` or `Example.jpg`, it will be fetched
-from the default site, which is "commons.wikimedia.org". If it's the
+If `FILE` is in the form `File:Example.jpg` or `Image:Example.jpg`, it will be
+fetched from the default site, which is "commons.wikimedia.org". If it's the
fully-qualified URL of a file description page, like
`https://en.wikipedia.org/wiki/File:Example.jpg`, the file is fetched from the
specified site, in this case "en.wikipedia.org". Full URLs may contain
characters your shell interprets differently, so you can either escape those
characters with a backslash `\` or surround the entire URL with single `'` or
-double `"` quotes.
+double `"` quotes. Use of a fully-qualified URL like this may require setting
+the `--path` flag (see next paragraph).
The site can also be specified with the `--site` flag, though this will not have
any effect if the full URL is given. Non-Wikimedia sites should work, but you