File subliminal_mansource.rst of Package python-subliminal

==========
subliminal
==========

-------------------
subtitle downloader
-------------------

:Author: Antoine Bertin <diaoulael@gmail.com>
:Date:   2016-03-31
:Copyright: Copyright © 2016 Antoine Bertin, MIT licensed.
:Version: 2.0rc1
:Manual section: 1
:Manual group: User Commands

SYNOPSIS
========

**subliminal** [OPTIONS] COMMAND [ARGS]...

DESCRIPTION
===========
Subtitles, faster than your thoughts.

OPTIONS
=======

--addic7ed USERNAME PASSWORD
  Addic7ed configuration.
--opensubtitles USERNAME PASSWORD
  OpenSubtitles configuration.
--subscenter USERNAME PASSWORD
  SubsCenter configuration.

--cache-dir DIRECTORY
  Path to the cache directory.  [default: ~/.config/subliminal]

--debug
  Print useful information for debugging subliminal and for reporting bugs.
--version                     Show the version and exit.
--help                        Show this message and exit.

DOWNLOAD
========

**subliminal** download [OPTIONS] PATH...

PATH can be a directory containing videos, a video file path or a video file name. It can be used multiple times.

If an existing subtitle is detected (external or embedded) in the correct language, the download is skipped for the associated video.

options
-------

-l, --language LANGUAGE
   Language as IETF code, e.g. en, pt-BR (can be used multiple times).
   [required]

-p, --provider [addic7ed|napiprojekt|opensubtitles|podnapisi|subscenter|thesubdb|tvsubtitles]
   Provider to use (can be used multiple times).

-a, --age AGE                   Filter videos newer than AGE, e.g. 12h, 1w2d.
-d, --directory DIR             Directory where to save subtitles, default is next to the video file.
-e, --encoding ENC              Subtitle file encoding, default is to preserve original encoding.
-s, --single                    Save subtitle without language code in the file name, i.e. use .srt extension.
-f, --force                     Force download even if a subtitle already exist.
-hi, --hearing-impaired
  Prefer hearing impaired subtitles.

-m, --min-score INTEGER RANGE
  Minimum score for a subtitle to be downloaded (0 to 100).

-v, --verbose                   Increase verbosity.
--help                          Show this message and exit.


CACHE
=====

**subliminal** cache [OPTIONS]

options
-------
--clear-subliminal
  Clear subliminal's cache. Use this ONLY if your cache is corrupted or if you experience issues.
--help              Show this message and exit.