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

Improve section about configuration

Browse Source
This commit is contained in:
Michele Guerini Rocco 2015-07-16 01:00:16 +02:00
parent b165eb1265
commit ef8fddea6f
1 changed files with 27 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -24,30 +24,44 @@ Default is `$XDG_CONFIG_HOME/pirate-get`.
If it does not exist then `$HOME/.config/pirate-get`. If it does not exist then `$HOME/.config/pirate-get`.
### Default config file ### Default config file
These are the default options: If not existing a new config file will be created when you start
pirate-get. Here the available options and their behaviors are when unset:
```INI ```INI
[Save] [Save]
directory = $PWD ; directory where to save files ; directory where to save files
magnets = false ; save each selected magnet link in a .magnet file directory = $PWD
torrents = false ; save each selected torrent in a .torrent file
; save each selected magnet link in a .magnet file
magnets = false
; save each selected torrent in a .torrent file
torrents = false
[LocalDB] [LocalDB]
enabled = false ; use a local copy of the pirate bay database ; use a local copy of the pirate bay database
path = ~/downloads/pirate-get/db ; path of the database enabled = false
; path of the database
path = ~/downloads/pirate-get/db
[Misc] [Misc]
openCommand = ; specify a custom command for opening the magnet ; specify a custom command for opening the magnet
; ex. myprogram --open %s ; ex. myprogram --open %s
; %s represent the magnet uri ; %s represent the magnet uri
openCommand =
transmission = false ; open magnets with transmission-remote client ; open magnets with transmission-remote client
colors = true ; use colored output transmission = false
; use colored output
colors = true
``` ```
Note: Note:
Any command line option will override its respective setting in the config file. 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):