Skip to content

Commit

Permalink
Merge pull request #326 from cyian-1756/docs
Browse files Browse the repository at this point in the history
Added basic docs for some of ripmes options
  • Loading branch information
cyian-1756 authored Dec 9, 2017
2 parents f3a79b0 + 436cb7b commit 94f66d3
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/options.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
file.overwrite | bool | If true ripme will overwrite existing files rather than skip them

clipboard.autorip | bool | If true ripme will try to download any links in the clip board

error.skip404 | bool | Don't retry on 404 errors

download.save_order| bool | If true ripme will prefix each downloaded file with a number in the order the file was download

auto.update | bool | If true ripme will auto-update every time it's started

play.sound | bool | If true ripme will play a sound every time a rip finishes

download.show_popup| bool | TODO figure out what this is for

log.save | bool | If true ripme will save it's logs

urls_only.save | bool | If true ripme will save all urls to a text file and download no files

album_titles.save | bool | Currently does nothing

prefer.mp4 | bool | Prefer mp4 when downloading a video that has more than 1 format

download.timeout | int | File download timeout (in milliseconds)

page.timeout | int | Page download timeout (in milliseconds)

download.max_size | int | Maximum size of downloaded files in bytes

threads.size | int | The number of threads to use

twitter.auth | String | Twitter API key (Base64'd)

tumblr.auth | String | Tumblr API key

log.level | String | The debug log level (Example: Log level: Debug)

gw.api | String | TODO figure out what this is for

twitter.max_requests | int | TODO figure out what this is for

0 comments on commit 94f66d3

Please sign in to comment.