Explain how the only flag works

This commit is contained in:
hartator 2015-11-17 14:52:22 -06:00
parent 4f26d3249c
commit fb4b5a9bd3

View File

@ -1,14 +1,14 @@
# Wayback Machine Downloader # Wayback Machine Downloader
Download any website from the Internet Archive Wayback Machine. Download any website from the Internet Archive Wayback Machine.
## Installation ## Installation
You need to install Ruby on your system (>= 1.9.2) - if you don't already have it. You need to install Ruby on your system (>= 1.9.2) - if you don't already have it.
Then run: Then run:
gem install wayback_machine_downloader gem install wayback_machine_downloader
**Tip:** If you run into permission errors, you might have to add `sudo` in front of this command. **Tip:** If you run into permission errors, you might have to add `sudo` in front of this command.
## Basic Usage ## Basic Usage
@ -23,11 +23,17 @@ It will download the last version of every file present on Wayback Machine to `w
## Optional Timestamp ## Optional Timestamp
You may want to supply a specific timestamp to lock your backup to an older version of the website, which can be found inside the urls of the regular Wayback Machine website (e.g., http://web.archive.org/web/20060716231334/http://example.com). You may want to supply a specific timestamp to lock your backup to an older version of the website, which can be found inside the urls of the regular Wayback Machine website (e.g., http://web.archive.org/web/20060716231334/http://example.com).
Wayback Machine Downloader will then fetch only file versions on or prior to the timestamp specified: Wayback Machine Downloader will then fetch only file versions on or prior to the timestamp specified:
wayback_machine_downloader http://example.com --timestamp 20060716231334 wayback_machine_downloader http://example.com --timestamp 20060716231334
## Optional Only URL Filter
You may want to retrieve files that are of certain type (e.g., .pdf, .jpg, .wrd...) or are in a specific directory. To do so, you can supply the `--only` flag with a string or a Regex to limit what Wayback Machine Downloader will download.
wayback_machine_downloader http://example.com --only \.pdf
## Contributing ## Contributing
Contributions are welcome! Just submit a pull request via GitHub. Contributions are welcome! Just submit a pull request via GitHub.