rnhmjoj/pirate-get
1
0
Fork 0
mirror of https://github.com/vikstrous/pirate-get synced 2025-01-24 12:14:20 +01:00
Code Issues Releases Wiki Activity

Update for the new default options

Browse Source
This commit is contained in:
Rnhmjoj 2015-03-26 00:14:22 +01:00
parent 3ef1c89a56
commit f984a474ce
1 changed files with 26 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -2,7 +2,9 @@
pirate-get is a convenient command line tool (inspired by APT) to speed up your trip to the Pirate Bay and get your completely legal torrents more quickly. pirate-get is a convenient command line tool (inspired by APT) to speed up your trip to the Pirate Bay and get your completely legal torrents more quickly.
Tested on Arch Linux mostly. It should work on any other Linux too. Let me know if it doesn't. Tested on Arch Linux mostly. It should work on any other Linux too. Let me know if it doesn't.
Also tested on OSX (works fine on yosemite) `--local` option hasn't been tested recently. Also tested on OSX (works fine on yosemite)
`--local` option hasn't been tested recently.
## Installation ## Installation
Make sure you have python 3 installed. Make sure you have python 3 installed.
@ -18,19 +20,34 @@ Watch [this](http://showterm.io/d6f7a0c2a5de1da9ea317) for an example usage.
## Configuration file ## Configuration file
You can use a file to override pirate-get's default settings. You can use a file to override pirate-get's default settings.
Default is `$XDG_CONFIG_HOME/pirate-get`. If it does not exist then `$HOME/.config/pirate-get`. Default is `$XDG_CONFIG_HOME/pirate-get`.
If it does not exist then `$HOME/.config/pirate-get`.
### SaveToFile ### Default config file
**Currently this is the only way to save magnet urls to a file** These are the default options:
A config file would look something like:
```INI ```INI
[SaveToFile] [Save]
enabled = true directory = ~/downloads/pirate-get ; directory where to save files
directory = ~/downloads/pirate-get/ magnets = false ; save every selected torrent as a magnet in a single file
torrents = false ; save each selected torrent in a .torrent file
[LocalDB]
enabled = false ; use a local copy of the pirate bay database
path = ~/downloads/pirate-get/db ; path of the database
[Misc]
openCommand = ; specify a custom command for opening the magnet
; ex. myprogram --open %s
; %s represent the magnet uri
transmission = false ; open magnets with transmission-remote client
colors = true ; use colored output
``` ```
Note:
Any command line option will override its respective setting in the config file.
## Notes ## Notes
If you want to use a local copy of the Pirate Bay database download a copy here (or wherever the latest version is currently): If you want to use a local copy of the Pirate Bay database download a copy here (or wherever the latest version is currently):