Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
vcs:docs [2010/03/03 23:09]
Toni Corvera Added brainstorming
vcs:docs [2016/04/18 01:56] (current)
Toni Corvera [Information] Replace link to obsolte page
Line 1: Line 1:
-======VCS======+======vcs documentation======
  
 Homepage: http://​p.outlyer.net/​vcs/​ Homepage: http://​p.outlyer.net/​vcs/​
  
-Last release is 1.0.100a. +Documentation updated for version ​1.12.2
-\\ +
-Next release will be 1.11 ((See [[vcs:​devel:​renumbering]])),​ around the first week of march 2010.+
  
 ===== Intro ===== ===== Intro =====
Line 15: Line 13:
 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. 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 bigcomplexscript 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 ;)+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 ===== ===== Reading this documentation =====
  
-FIXME Note this documentation is a work in progress ​I've just started ;-)+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:​cli_options|full list of command-line options]] is available, with links to the appropriate sections.+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. 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 ''​$ ​vcs''​ means run ''​vcs''​ as any user.+The usual UNIX documentation conventions apply: ''#​ command''​ means run ''​command''​ as ''​root''​ user, while ''​$ ​command''​ means run ''​command''​ as any user.
  
 ===== Documentation ===== ===== Documentation =====
  
-  * [[vcs:​sections|Contact sheet sections]] +  * [[vcs:docs:​sections|Contact sheet sections]] 
-  * [[vcs:​usage|Usage]]\\ Contents: +  * [[vcs:docs:​usage|Usage]]\\ Contents: 
-    * [[vcs:​usage#​Default behaviour]] +    * [[vcs:docs:​usage#​Default behaviour]] 
-    * [[vcs:​usage#​Capture count modes]] +    * [[vcs:docs:​usage#​Capture count modes]] 
-    * [[vcs:​usage#​Number of columns]] +    * [[vcs:docs:​usage#​Number of columns]] 
-    * [[vcs:​usage#​Capture size and aspect ratio]] +    * [[vcs:docs:​usage#​Capture size and aspect ratio]] 
-    * [[vcs:​usage#​Adding a title]] +    * [[vcs:docs:​usage#​Adding a title]] 
-    * **next version**: ​[[vcs:​usage#​Output filename]] +    * [[vcs:docs:​usage#​Output filename]] 
-  * [[vcs:​time_syntax]] +  * [[vcs:docs:​time_syntax]] 
-  * [[vcs:​partial_capture|Partial captures]] (restrict to a section of the video) +  * [[vcs:docs:​partial_capture|Partial captures]] (restrict to a section of the video) 
-  * [[vcs:​extended_mode|Extended mode]] +  * [[vcs:docs:​extended_mode|Extended mode]] 
-  * [[vcs:​manual_modes|Manual modes]]\\ Contents: +  * [[vcs:docs:​manual_modes|Manual modes]]\\ Contents: 
-    * [[vcs:​manual_modes#​Manually added captures]] +    * [[vcs:docs:​manual_modes#​Manually added captures]] 
-    * [[vcs:​manual_modes#​Highlights]] +    * [[vcs:docs:​manual_modes#​Highlights]] 
-    * [[vcs:​manual_modes#​Manual-only mode]] +    * [[vcs:docs:​manual_modes#​Manual-only mode]] 
-  * [[vcs:​colours|Setting contact sheet colours]]+  * [[vcs:docs:​colours|Setting contact sheet colours]]
   * [[vcs:​other_modes|Other modes of operation]] ("//​funky modes//"​)   * [[vcs:​other_modes|Other modes of operation]] ("//​funky modes//"​)
-  * [[vcs:​conf_files|Configuration files]] (overriding default options)+  * [[vcs:docs:​conf_files|Configuration files]] (overriding default options) 
 +    * [[vcs:​docs:​example_configs]] 
 +  * [[vcs:​docs:​profiles]]
   * Other   * Other
     * [[vcs:​nonlatin|Non-latin scripts in file names]]     * [[vcs:​nonlatin|Non-latin scripts in file names]]
-  * [[vcs:​troubleshooting|Troubleshooting]]+  * [[vcs:docs:​troubleshooting|Troubleshooting]]
  
-  * List main of options (see [[vcs:​cli_options|Command-line options]] for the full list): +  * List main of options (see [[vcs:docs:​cli_options|Command-line options]] for the full list): 
-    * ''​[[vcs:​usage#​capture_count_modes|-n,​ --numcaps]]'':​ Number of captures +    * ''​[[vcs:docs:​usage#​capture_count_modes|-n,​ --numcaps]]'':​ Number of captures 
-    * ''​[[vcs:​usage#​capture_count_modes|-i,​ --interval]]'':​ Interval of captures +    * ''​[[vcs:docs:​usage#​capture_count_modes|-i,​ --interval]]'':​ Interval of captures 
-    * ''​[[vcs:​usage#​number_of_columns|-c,​ --columns]]'':​ Number of columns +    * ''​[[vcs:docs:​usage#​number_of_columns|-c,​ --columns]]'':​ Number of columns 
-    * ''​[[vcs:​usage#​capture_size_and_aspect_ratio|-H,​ --height]]'':​ Capture height +    * ''​[[vcs:docs:​usage#​capture_size_and_aspect_ratio|-H,​ --height]]'':​ Capture height 
-    * ''​[[vcs:​usage#​capture_size_and_aspect_ratio|-a,​ --aspect]]'':​ Aspect ratio of captures+    * ''​[[vcs:docs:​usage#​capture_size_and_aspect_ratio|-a,​ --aspect]]'':​ Aspect ratio of captures
  
 ===== Information ===== ===== Information =====
  
-  * [[vcs:​tips|Tips]] +  * [[vcs:docs:​tips|Tips]] 
-  * [[vcs:​changelog|History]] +  * [[vcs:docs:​changelog|History]] 
-  * [[vcs:bugs|Open and fixed bugs and feature requests]] +  * [[bts>|Open and fixed bugs and feature requests]] 
-  * [[vcs:roadmap|Roadmap]]+  * [[bts>​roadmap/​vcs|Roadmap]]
   * Indexes   * Indexes
-    * [[vcs:​samples|All samples]] +    * [[vcs:docs:​samples|All samples]] 
-    * [[vcs:​devel:​testfiles]] +    * [[vcs:docs:​devel:​testfiles]] 
-  * [[vcs:​alternatives|Similar tools]]+  * [[vcs:docs:​alternatives|Similar tools]]
  
 ===== Development documentation ===== ===== Development documentation =====
  
-  * [[vcs:​devel:​References]]+  * [[vcs:docs:devel:references]]
  
 The following pages detail drafts for future developments:​ The following pages detail drafts for future developments:​
  
-  * [[vcs:​devel:​conf:​new_syntax|Configuration files syntax revamp]]+  * [[vcs:docs:​devel:​conf:​new_syntax|Configuration files syntax revamp]]
   * [[vcs:​devel:​conf:​cleanup|Configuration options cleanup]]   * [[vcs:​devel:​conf:​cleanup|Configuration options cleanup]]
   * [[vcs:​devel:​Plugins]]   * [[vcs:​devel:​Plugins]]
-  * [[vcs:​devel:​posix|POSIX compatibility]] +  * [[vcs:docs:​devel:​posix|POSIX compatibility]] 
-  * [[vcs:​devel:​bash_support]] +  * [[vcs:docs:​devel:​bash_support]] 
-  * [[vcs:​devel:​transcode]] +  * [[vcs:docs:​devel:​transcode]] 
-  * [[vcs:​devel:​renumbering]] +  * [[vcs:docs:​devel:​renumbering]] 
-  * [[vcs:​devel:​brainstorming]]+  * [[vcs:docs:​devel:​brainstorming]]
All dates/times in this page are UTC.