======vcs documentation======

Homepage: http://p.outlyer.net/vcs/

Documentation updated for version 1.12.2

===== Intro =====

VCS (Video Contact Sheet *NIX) is a script meant to generate contact sheets from videos, i.e. it creates an image composed of snapshots from the video.

It was written to run on Linux, and can run on other UNIX-like operating systems.

Two design decisions define the output: flexibility and //quality preview//. The contact sheet is configurable in many ways, even crazy ones in recent versions (flexibility); but it is also meant to provide as much information and represent the actual video quality as much as possible (//quality preview//), e.g. unlike most other video previewing software, the default snapshot size is not a thumbnail but the full video dimensions.

This is a one man project, a pretty big and complex (for a script) tool written in bash so it's bound to be buggy in one way or another, you're encouraged to submit any bug reports before ditching the script completely. I'm no native English speaker either so typos are also bound to appear in this docs ;)

===== Reading this documentation =====

FIXME Note this documentation is a work in progress

Throughout this documentation VCS will most often be referred to as ''vcs''. Options are referred often, usually in their short form, e.g. "use ''-i 30''" means "include  ''-i 30'' in the command line, as in ''$ vcs -i 30 file''". A [[vcs:docs:cli_options|full list of command-line options]] is available, with links to the appropriate sections.

Capture and snapshot refer to the same thing: the individual images captured from the video.

The usual UNIX documentation conventions apply: ''# command'' means run ''command'' as ''root'' user, while ''$ command'' means run ''command'' as any user.

===== Documentation =====

  * [[vcs:docs:sections|Contact sheet sections]]
  * [[vcs:docs:usage|Usage]]\\ Contents:
    * [[vcs:docs:usage#Default behaviour]]
    * [[vcs:docs:usage#Capture count modes]]
    * [[vcs:docs:usage#Number of columns]]
    * [[vcs:docs:usage#Capture size and aspect ratio]]
    * [[vcs:docs:usage#Adding a title]]
    * [[vcs:docs:usage#Output filename]]
  * [[vcs:docs:time_syntax]]
  * [[vcs:docs:partial_capture|Partial captures]] (restrict to a section of the video)
  * [[vcs:docs:extended_mode|Extended mode]]
  * [[vcs:docs:manual_modes|Manual modes]]\\ Contents:
    * [[vcs:docs:manual_modes#Manually added captures]]
    * [[vcs:docs:manual_modes#Highlights]]
    * [[vcs:docs:manual_modes#Manual-only mode]]
  * [[vcs:docs:colours|Setting contact sheet colours]]
  * [[vcs:other_modes|Other modes of operation]] ("//funky modes//")
  * [[vcs:docs:conf_files|Configuration files]] (overriding default options)
    * [[vcs:docs:example_configs]]
  * [[vcs:docs:profiles]]
  * Other
    * [[vcs:nonlatin|Non-latin scripts in file names]]
  * [[vcs:docs:troubleshooting|Troubleshooting]]

  * List main of options (see [[vcs:docs:cli_options|Command-line options]] for the full list):
    * ''[[vcs:docs:usage#capture_count_modes|-n, --numcaps]]'': Number of captures
    * ''[[vcs:docs:usage#capture_count_modes|-i, --interval]]'': Interval of captures
    * ''[[vcs:docs:usage#number_of_columns|-c, --columns]]'': Number of columns
    * ''[[vcs:docs:usage#capture_size_and_aspect_ratio|-H, --height]]'': Capture height
    * ''[[vcs:docs:usage#capture_size_and_aspect_ratio|-a, --aspect]]'': Aspect ratio of captures

===== Information =====

  * [[vcs:docs:tips|Tips]]
  * [[vcs:docs:changelog|History]]
  * [[bts>|Open and fixed bugs and feature requests]]
  * [[bts>roadmap/vcs|Roadmap]]
  * Indexes
    * [[vcs:docs:samples|All samples]]
    * [[vcs:docs:devel:testfiles]]
  * [[vcs:docs:alternatives|Similar tools]]

===== Development documentation =====

  * [[vcs:docs:devel:references]]

The following pages detail drafts for future developments:

  * [[vcs:docs:devel:conf:new_syntax|Configuration files syntax revamp]]
  * [[vcs:devel:conf:cleanup|Configuration options cleanup]]
  * [[vcs:devel:Plugins]]
  * [[vcs:docs:devel:posix|POSIX compatibility]]
  * [[vcs:docs:devel:bash_support]]
  * [[vcs:docs:devel:transcode]]
  * [[vcs:docs:devel:renumbering]]
  * [[vcs:docs:devel:brainstorming]]