
   ---------------------------------------------------------------------
    ORCA (OpenSubtitles Rusty Command-line Add-on)
      command-line tool for subtitle file download/uploads/checks, etc.
   ---------------------------------------------------------------------

  ---------------
   Introduction:
  ---------------
  	ORCA is a command-line tool for performing various operations
    (search, download, ...) on internet servers supporting the OSDb protocol.
    
    It can be used to quickly find and download subtitles to your favorite
    movies/videos.


  -------------------
   First-time setup:
  -------------------
     1) Open ORCA.INI in your favorite text editor to enter your settings.
     2) There are some comments to guide your through it.
     3) Pay special attention to proxy settings, make sure they are correct
     4) Head over to section [OSDB], notice the format of an OSDb
          configuration line:
            ServerN = description|url|username|password|langs|flags|
          Enter your OSDb username/password and desired languages, e.g.:
            Server1=OpenSubtitles|http://www.opensubtitles.org/xml-rpc|Subber|mypass|eng,slo,cze|10|
          "flags" is a string where:
            first position   "1" means this is your default OSDb server
            seconds position "1" means proxy settings should be used
          If you're not sure how to configure this and you're also using
            Oscar just copy your settings from OSCAR.INI
     5) If you don't feel like editing this file most of these settings
          can be also configured from the command-line.
          
  --------------
   Downloading:
  --------------
    Downloading is highly customizable but requires some computer knowledge.
    Here's the basic concept:
      - at the highest level you specify what languages you're interested in
          (this is done in ORCA.INI, section [OSDB])
      - then you can specify several download conditions that are evaluated
          against every subtitle file matching given video hash/language.
          (these conditions are specified in ORCA.INI, section [CONDITIONS])
      - conditions are numbered 1 .. 99 where condition with number 1 has the
          highest priority, meaning subtitle files that match this condition
          will be downloaded first.
      - the second parameter when downloading is the
          'maximum number of subtitle files per video/language'. This value
          specifies how many (max) subtitle files will be downloaded for
          a single video hash/language match.
          The best (subtitle files matching the condition with highest priority)
            are download first until the limit is reached or no more subtitle
            files are available for download.
          (this is configured in ORCA.INI, section [SYSTEM])  

	
  ---------------
   Requirements:
  ---------------
	  - Windows XP+
	  - internet connection

	  
  --------
   Links:
  --------
    OpenSubtitles.org         http://www.opensubtitles.org/
    Oscar                     http://trac.opensubtitles.org/projects/oscar/

	
  --------------------------
   Command-line parameters:
  --------------------------
		orca.exe <files> <command> <options> <settings> <switches>

		commands:
			d - Download (one, more, list of ...)
			
			v - Version  (display version number)
			h - Help     (display help)
			n - iNfo     (display server information)
			c - Clear    (clear previously loaded video lists, when using multiple commands at once)

		settings:
			/ph - set proxy host     (/ph:...)
      /pp -           port     (/pp:..)
      /pu -           user     (/pu:....)
      /ps -           password (/ps:...)
      /on - set OSDb server by its number in configuration file
      /ou -          username (/ou:...)
      /os -          password (/os:...)
			/t  - set subtitle file template (/t:...)
			/l  - set language for subtitle files (/l:...)
			/m  - max limit of subtitle files per video/language (/m:...)
			/c  - subtitle file download condition specifier (/c:...)
          (e.g. '(rating>9) or (uploader=Majky) or (added>01.01.2008)')
      /sm - subtitle file sort method (none, lang, added, rating, sumcd, downloads)
      /sd - subtitle file sort direction (asc, desc)
			
		switches (-/+):
			s - include subdirectories        (-s/+s)
			o - overwrite existing            (-o/+o)
      c - use cache                     (-c/+c)
			
		examples:
		  - orca.exe d c:\movies +s
          (recursively search/download subtitles to videos stored in c:\movies)


  --------          
   Hints:
  --------          
    - parameters are evaluated/executed in the order they were specified,
        multiple commands can be used in one run
    - download logic: 
    - when using download conditions keep in mind that when using and/or
        operators their operands must be enclosed in parenthesis, i.e.:
          (operand1) and (operand2)
    - see also 'orca.ini' for some more hints on configuration options
			

[Majky, Dungeon Research 2008]
