README.md in saber-1.1.1 vs README.md in saber-1.2.0

- old
+ new

@@ -1,75 +1,78 @@ Saber, a complete solution for PT users. [![Build Status](https://secure.travis-ci.org/SaberSalv/saber.png)](http://travis-ci.org/SaberSalv/saber) ========================================== -| | | -|----------------|-----------------------------------------| +| | | +|----------------|-------------------------------------------| | Homepage: | https://github.com/SaberSalv/saber | -| Author: | Saber | -| License: | MIT-LICENSE | +| Author: | Saber | +| License: | MIT-LICENSE | | Documentation: | https://github.com/SaberSalv/saber/wiki | | Issue Tracker: | https://github.com/SaberSalv/saber/issues | +| Operation Systems: | Linux, Mac OS X | **Features:** -* Add Torrent: send a torrent file from website to rutorrent. -* Fetch: automatically/manually fetch files from seedbox to home-laptop. -* Upload: upload a torrent file from command line to the site. -* Other Tasks: - - Make: make a torrent file and copy it to local and remote watch directory. - - Send: send files from home-laptop to seedbox. - - Clean: remove files which are not seeded in rtorrent. +* **Add Torrent**: send a torrent file from website to rutorrent. +* **Upload**: upload a torrent file from command line to the site. +* **Fetch**: automatically/manually fetch files from seedbox to home-laptop. +* **Other Tasks**: + - **Make**: make a torrent file and copy it to local and remote watch directory. + - **Send**: send files from home-laptop to seedbox. + - **Clean**: remove files which are not seeded in rtorrent. you can find more tools at [here](https://github.com/SaberSalv/saber/wiki/Tools). Getting Started ---------------- -Create ~/.saberrc configuration file from [template](https://github.com/SaberSalv/saber/blob/master/templates/_saberrc). More detail will be explained below. +Create `~/.saberrc` configuration file from [template](https://github.com/SaberSalv/saber/blob/master/templates/_saberrc). ### Add Torrent See [saber-addtorrent](https://github.com/SaberSalv/saber-addtorrent) project. +### Upload -### Fetch +Because of lacking APIs in major PT sites, so I write this small script to help uploading a torrent from cmdline. Good news is BTN v2.0 will include API. And BTN already has an official autobot which grabs scene releases. :) -#### AutoFetch +> Support sites: BIB, bB, STP -Configure ~/.saberrc +> Support upload types: ebook, magazine - p: - fetcher_download = Pa("~/download") +Manual fill \<info-data>.yml file and upload it. - server: - ftp = "ftp://seedbox/bt" + $ saber.bib g magazine hello.pdf + > create hello.yml + $ edit hello.yml - xmpp: - jid = "x1@gmail.com" # need register a gtalk account. - password = "y1" - host = nil - port = nil + type: magazines + title: Hello + description: Hello World + ... - client: - xmpp: - jid = "x2@gmail.com" - password = "y2" - host = nil - port = nil + $ saber.bib upload pdf hello.yml + > it opens a firefox browser + > it fills data and submit it + > upload complete -Start saber-server at server side. +Auto fill \<info-data>.yml file from ISBN. - # ~/.rtorrent.rc + $ saber.bib g ebook hello.epub:1781100055 + > create hello.yml - method.set_key = event.download.finished, saber-fetch, "execute= saber-drb_add, (d.get_hash), (d.get_custom1)" +### Fetch +#### AutoFetch + +Start saber-server at server side. + $ saber server -V Start saber-client at client side. $ aria2c --enable-rpc --save-session session.lock -i session.lock - $ saber client -V Test if it works (server) $ saber drb_add <rtorrent_file_hash_id> saber -V @@ -79,119 +82,38 @@ Manually fetch: right click 'Saber Fetch' in rutorrent web ui, then it'll add to aria2. Or from command line, send a download file to client: `saber drb_add <hash_id> saber`, sometime the client need a long time(2 minutes) to recive the file list sent by server. -For ArchLinux, you can install `saber-server-daemon`, `user-saber-client-daemon`, `user-aria2-daemon` packages. - #### ManualFetch -Configure ~/.saberrc - - p: - fetcher_download = Pa("~/download") - remote_download = Pa("~/bt") - - server: - user = "x" - host = "seedbox" - ftp = "ftp://seedbox/bt" - Begin fetch a file from seedbox $ saber fetch foo > begin to download ftp://seedbox/bt/foo/a.epub via aria2 > begin to download ftp://seedbox/bt/foo/b.epub via aria2 -### Upload - -Because of lacking APIs in major PT sites, so I write this small script to help uploading a torrent from cmdline. Good news is BTN v2.0 will include API. And BTN already has an official autobot which grabs scene releases. :) - -> Support sites: BIB - -Configure ~/.saberrc - - p: - watch = Pa("~/bt/watch") - remote_watch = Pa("bt/watch") - - username = "foo" - bib: - username = "bar" - announce_url = "x" - - server: - user = "x" - host = "y" - -Fill \<info-data>.yml file and upload it. - - $ saber.bib g magazine hello.pdf - > create hello.pdf.yml - $ vim hello.pdf.yml - - type: magazines - Title: Hello - Description: Hello World - ... - - $ saber.bib upload hello.pdf.torrent - > Upload Complete - - $ saber.bib upload hello.pdf # short cut - > make hello.pdf.torrent - > Upload Complete - -Auto fill \<info-data>.yml file from isbn. - - $ saber.bib g ebook hello.epub 1781100055 - > create hello.epub.yml - ### Tasks #### Make -Configure ~/.saberrc - - p: - watch = Pa("~/bt/watch") - remote_watch = Pa("bt/watch") - - bib: - announce_url = "x" - - server: - user = "x" - host = "y" - Make a torrent - $ saber make hello.epub - > mktorrent -p -a x hello.epub + $ saber.bib make hello.epub + > mktorrent -p -a ANNOUNCE_URL hello.epub > cp hello.epub.torrent ~/bt/watch > rsync -Phr hello.epub.torrent user@host:bt/watch #### Send -Configure ~/.saberrc - - server: - user = "x" - host = "y" - Send files to seedbox $ saber send1 hello.epub bt - > rsync -Phr hello.epub user@host:bt + > rsync -ahP hello.epub user@host:bt #### Clean -Configure ~/.saberrc - - p: - download = Pa("~/bt") - Clean up unseeded files in rtorrent. $ saber clean use `saber help` to list all tasks. @@ -213,16 +135,9 @@ * Submit any bugs/features/ideas to github issue tracker. Please see [Contibution Documentation](https://github.com/SaberSalv/saber/blob/master/CONTRIBUTING.md). A list of [Contributors](https://github.com/SaberSalv/saber/contributors). - -Resources ---------- - -* [Archlinux](http://www.archlinux.org): A simple, lightweight linux distribution. -* [pacaur](https://github.com/Spyhawk/pacaur): An AUR helper for ArchLinux. -* [YAAW](https://github.com/binux/yaaw): Yet Another Aria2 Web Frontend in pure HTML/CSS/Javascirpt. Copyright --------- (the MIT License)