From f984a474ce933ecf8fc5bbdccbe7f79c68e0c6d6 Mon Sep 17 00:00:00 2001 From: Rnhmjoj Date: Thu, 26 Mar 2015 00:14:22 +0100 Subject: [PATCH] Update for the new default options --- README.md | 35 ++++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0d65a9b..89f95a1 100644 --- a/README.md +++ b/README.md @@ -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. 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 Make sure you have python 3 installed. @@ -18,19 +20,34 @@ Watch [this](http://showterm.io/d6f7a0c2a5de1da9ea317) for an example usage. ## Configuration file 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 -**Currently this is the only way to save magnet urls to a file** - -A config file would look something like: +### Default config file +These are the default options: ```INI -[SaveToFile] -enabled = true -directory = ~/downloads/pirate-get/ +[Save] +directory = ~/downloads/pirate-get ; directory where to save files +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 If you want to use a local copy of the Pirate Bay database download a copy here (or wherever the latest version is currently):