                                                     -*- text -*-
WP-MIRROR
=========
                   Current Web home: http://www.nongnu.org/wp-mirror/


                        WP-MIRROR USER'S MANUAL
                              Version 0.7


COPYRIGHT, DISCLAIMER, AND LICENSE

Copyright (C) 2011-2014 Dr. Kent L. Miller.  All rights reserved.

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.

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.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>

PURPOSE

The Wikimedia Foundation offers wikipedias in nearly 300 languages.
In addition, the WMF has several other projects (e.g. wikibooks,
wiktionary, etc.)  for a total of around 1000 wikis.
 
Wp-mirror is a free utility for mirroring any desired set of these
wikis. That is, it builds a wiki farm that the user can browse
locally.  Many users need such off-line access, often for reasons of
mobility, availability, and privacy.  Wp-mirror builds a complete
mirror with original size media files. Wp-mirror is robust and uses
check-pointing to resume after interruption.

Wp-mirror by default mirrors the `simple wikipedia' and `simple
wiktionary' (Simple English means shorter sentences).  The default
should work `out-of-the-box' with no user configuration.  It should
build in 200ks (two days), occupy 90G of disk space, be served locally
by virtual hosts <http://simple.wikipedia.site/> and
<http://simple.wiktionary.site/>, and update automatically every week.
The default should be suitable for anyone who learned English as a
second language (ESL).
 
The top ten wikipedias are: en, de, nl, fr, it, ru, es, sv, pl, and
ja. Because wp-mirror uses original size media files, the top ten are
too large to fit on a laptop with a single 500G disk, unless the user
does not need the media files (and this is configurable).  The `en
wikipedia' is the most demanding case.  It should build in 1Ms (twelve
days), occupy 3T of disk space, be served locally by virtual host
<http://en.wikipedia.site/>, and update automatically every month.

Most features are configurable, either through command-line options,
or via a configuration file (/etc/wp-mirror/local.conf).

If WP-MIRROR fails or hangs, please take a look at the log files
(/var/log/wp-mirror.log).  Alternatively, try running

     shell# wp-mirror --debug
     shell# tail -n 1000 /var/log/wp-mirror.log

The last few lines should provide a clue.

WP-MIRROR was written and is maintained by Dr. Kent L. Miller.  Please
see the file THANKS for a list of contributors.

Please report bugs in WP-MIRROR to <wp-mirror-list@nongnu.org>.

INSTALLATION

Please refer to the WP-MIRROR Reference Manual.  The Reference Manual
should be regarded as required reading.  It is usually found under
/usr/share/doc/wp-mirror/doc/.
