aboutsummaryrefslogtreecommitdiff
path: root/wikiget.1
diff options
context:
space:
mode:
authorCody Logan <cody@lokken.dev>2023-10-10 11:04:14 -0700
committerCody Logan <cody@lokken.dev>2023-10-10 11:04:14 -0700
commit878d4174248711906cfaf4e7bf10c0bf83af85f3 (patch)
tree5056f154df28386f543a18e045acfd695d58ec12 /wikiget.1
parent206f0fe0b97610fc371ad0acdd5146ac12eacfe7 (diff)
downloadwikiget-878d4174248711906cfaf4e7bf10c0bf83af85f3.tar.gz
wikiget-878d4174248711906cfaf4e7bf10c0bf83af85f3.zip
Move man-related files to docs directory
Diffstat (limited to 'wikiget.1')
-rw-r--r--wikiget.1122
1 files changed, 0 insertions, 122 deletions
diff --git a/wikiget.1 b/wikiget.1
deleted file mode 100644
index 03a0c41..0000000
--- a/wikiget.1
+++ /dev/null
@@ -1,122 +0,0 @@
-.\" Automatically generated by Pandoc 3.1.8
-.\"
-.TH "WIKIGET" "1" "October 5, 2023" "Version 0.5.1" "Wikiget User Manual"
-.SH NAME
-wikiget - download files from MediaWiki sites
-.SH SYNOPSIS
-.PP
-\f[B]wikiget\f[R] [\f[I]options\f[R]] \f[I]FILE\f[R]
-.PD 0
-.P
-.PD
-\f[B]wikiget\f[R] [\f[I]options\f[R]] [-\f[B]a\f[R]|--\f[B]batch\f[R]]
-\f[I]BATCHFILE\f[R]
-.PD 0
-.P
-.PD
-\f[B]wikiget\f[R] [-\f[B]V\f[R]|--\f[B]version\f[R]]
-.PD 0
-.P
-.PD
-\f[B]wikiget\f[R] [-\f[B]h\f[R]|--\f[B]help\f[R]]
-.SH DESCRIPTION
-Something like \f[B]wget\f[R](1) for downloading a file from MediaWiki
-sites (like Wikipedia or Wikimedia Commons) using only the file name or
-the URL of its description page.
-.SH OPTIONS
-.TP
-\f[I]FILE\f[R]
-The file to be downloaded.
-If \f[I]FILE\f[R] is in the form \f[I]File:Example.jpg\f[R] or
-\f[I]Image:Example.jpg\f[R], it will be fetched from the default site,
-which is \[lq]commons.wikimedia.org\[rq].
-If it\[cq]s the fully-qualified URL of a file description page, like
-\f[I]https://en.wikipedia.org/wiki/File:Example.jpg\f[R], the file is
-fetched from the site in the URL, in this case
-\[lq]en.wikipedia.org\[rq].
-.TP
-\f[I]BATCHFILE\f[R]
-In batch download mode (activated with -\f[B]a\f[R] or
---\f[B]batch\f[R]), 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.
-.TP
--\f[B]s\f[R], --\f[B]site\f[R] \f[I]SITE\f[R]
-MediaWiki site to download from.
-Will not have any effect if the full URL is given in the \f[I]FILE\f[R]
-parameter.
-.TP
--\f[B]P\f[R], --\f[B]path\f[R] \f[I]PATH\f[R]
-Script path for the wiki, where \[lq]index.php\[rq] and
-\[lq]api.php\[rq] live.
-On Wikimedia sites, it\[cq]s \[lq]/w/\[rq], the default, but other sites
-may use \[lq]/\[rq] or something else entirely.
-.TP
--\f[B]u\f[R], --\f[B]username\f[R] \f[I]USERNAME\f[R]
-Username for private wikis that require a login even for read access.
-.TP
--\f[B]p\f[R], --\f[B]password\f[R] \f[I]PASSWORD\f[R]
-Password for private wikis that require a login even for read access.
-.TP
--\f[B]o\f[R], --\f[B]output\f[R] \f[I]OUTPUT\f[R]
-By default, the output filename is the same as the remote filename
-(without the File: or Image: prefix), but this can be changed with this
-option.
-.TP
--\f[B]l\f[R], --\f[B]logfile\f[R] \f[I]LOGFILE\f[R]
-Specify a logfile, which will contain detailed information about the
-download process.
-If the logfile already exists, new log information is appended to it.
-.TP
--\f[B]f\f[R], --\f[B]force\f[R]
-Force existing files to be overwritten.
-.TP
--\f[B]a\f[R], --\f[B]batch\f[R]
-If this flag is set, \f[B]wikiget\f[R] will run in batch download mode
-(see \f[I]BATCHFILE\f[R]).
-.TP
--\f[B]j\f[R], --\f[B]threads\f[R]
-Number of parallel downloads to attempt in batch mode.
-This option has no effect if -\f[B]a\f[R] is not also set.
-.TP
--\f[B]v\f[R], --\f[B]verbose\f[R]
-Print additional information, such as the site used and the full URL of
-the file.
-Additional invocations will increase the level of detail.
-.TP
--\f[B]q\f[R], --\f[B]quiet\f[R]
-Silence warnings and minimize printed output.
-.TP
--\f[B]V\f[R], --\f[B]version\f[R]
-Print the version number of the program.
-.TP
--\f[B]h\f[R], --\f[B]help\f[R]
-Print a brief summary of these options.
-.SH EXAMPLES
-.IP
-.EX
-wikiget File:Example.jpg
-wikiget --site en.wikipedia.org File:Example.jpg
-wikiget https://en.wikipedia.org/wiki/File:Example.jpg -o test.jpg
-.EE
-.SH BUG REPORTS
-https://github.com/clpo13/wikiget/issues
-.SH LICENSE
-Copyright (C) 2018-2023 Cody Logan and contributors
-.PP
-This program is free software: you can redistribute it and/or modify it
-under the terms of the GNU General Public License as published by the
-Free Software Foundation, either version 3 of the License, or (at your
-option) any later version.
-.PP
-This program is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-See the GNU General Public License for more details.
-.PP
-You should have received a copy of the GNU General Public License along
-with this program.
-If not, see https://www.gnu.org/licenses/.
-.SH AUTHORS
-Cody Logan <clpo13@gmail.com>.