clerk Files

--------------------------------------------------------------------
Program Name:       clerk
Developed by:       Erick Tyndall and Emrys Maier
First release:      03 May 2010
Current release:    03 Sep 2014
Current version:    0.37.154
Website:            https://sourceforge.net/projects/tvclerk/


--------------------------------------------------------------------
Description

clerk is designed to simplify the organization of TV Series video
files. It does this by parsing file names looking for season and
episode patterns. Once a pattern is matched, clerk tries to match
the show name from an external list. The entire file name is then
properly capitalized and, if the option is selected, the file is
moved/copied to an organized folder structure or renamed in place.

There are 5 parts to each filename:
Showname S01E01 Title.avi
Showname  - User provided name of a show via 'showlist' file
S01       - Season number ( double digit )
E01       - Episode number ( double digit )
Title     - Titles are cleaned up per English language conventions,
            all major words (and first/last word) are capitalized.
            Words in the blacklist are removed.
Extension - Extensions are converted to lowercase, but are otherwise
            ignored.

Accepted season and episode patterns:
  S##E## (default output format)
  S## E##
  S# E##
  S#E##
  ##X##
  #X##
  ####
  ###

  -## (detected as multi-episode information)
  A/B (detected as partial-episode information)

Example Output:

Showname S01E01 Title.avi
Showname S01E01-02 Title.avi
Showname S01E01B Title.avi

--------------------------------------------------------------------
showlist

showlist is a text file that contains one show's information per
line. It is required for clerk to match show names to file names.

clerk will look for this file in the following locations:
--- on linux ---
./ or /etc/clerk/ or /usr/share/clerk/

--- on windows ---
.\ or C:\Program Files\clerk\ or C:\clerk\

The format for each line is:
User Selected Show Name(with proper capitalization)/additional names
to be matched(all lowercase);names are separated by semicolons
;*override directory

Two real examples:
CSI Miami/csi miami;crime scene investigation miami;*CSI/CSI Miami
House/house md;*

Comments are allowed, and must start the line with #


--------------------------------------------------------------------
blacklist

blacklist is a text file that contains common tags that you want
removed from file names. Each tag starts on a new line.

clerk will look for this file in the following locations:
--- on linux ---
./ or /etc/clerk/ or /usr/share/clerk/

--- on windows ---
.\ or C:\Program Files\clerk\ or C:\clerk\

Examples are:
  [LoL]
  XviD
  720p

Comments are allowed, and must start the line with #


--------------------------------------------------------------------
clerk.conf

clerk.conf is a text file containing many configuration options.

clerk will look for this file in the following locations:
--- on linux ---
./ or /etc/clerk/ or /usr/share/clerk/

--- on windows ---
.\ or C:\Program Files\clerk\ or C:\clerk\


--------------------------------------------------------------------
configuration file options

BLACKLIST   - Location of blacklist
SHOWLIST    - Location of showlist
RECURSE     - Recurse directories
INPUT       - Input directory/file
OUTPUT      - Output directory
SCRIPT      - Script file location and name
LOG         - Log file location and name
XML         - Xml file location and name
GAP         - Gap file location and name
MODE        - Default task (rename|move|copy)
EXEC        - Default mode (execute|test|script)
LEVEL       - Default output mode (quiet|summary|verbose)
SIZE        - max file size, in bytes
FILTER      - Filter out the following files
FILTERDELIM - Filter delimiter
SHOWDELIM   - Showlist delimiters
FILLER      - Space filler
SEPARATE    - Title separator: Name SxxExx Title.avi || Name SxxExx - Title.avi
SEASONDD    - Season Folder is a double digit: [01, 02, 03] vs [1, 2, 3]
NOCASE      - Words that should not be uppercased
NOCASEDELIM - Nocase delimiter


--------------------------------------------------------------------
command line options

  -i [INPUT]    Read from file or directory
  -o [OUTPUT]   Write to directory
  -B [BLIST]    Blacklist location
  -S [SLIST]    Showlist location
  -R            Recurse directories
  -e            Execute the tasks internally
  -t            Display the tasks without performing them
  -b [SCRIPT]   Write the tasks to a bash script
  -r            Rename the files
  -m            Move the files
  -c            Copy the files
  -D            Season folders use double digits
  -q            Output no information
  -s            Output summary information
  -v            Output summary and error information
  -l [LOG]      Write to log file
  -x [XML]      Write to xml file
  -g [GAP]      Write to gap file
  -h            Display this help and exit
  -V            Output version information and exit
  -F [DEST]     Rewrite showlist, blacklist, and config files to DEST