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 [2016/04/16 17:25]
Toni Corvera ↷ Links adapted because of a move operation
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.12.2+Documentation updated for version ​1.12.2
  
 ===== Intro ===== ===== Intro =====
Line 19: Line 19:
 FIXME Note this documentation is a work in progress 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 [[dox: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.
Line 27: Line 27:
 ===== Documentation ===== ===== Documentation =====
  
-  * [[dox:vcs:​sections|Contact sheet sections]] +  * [[vcs:docs:​sections|Contact sheet sections]] 
-  * [[dox:vcs:​usage|Usage]]\\ Contents: +  * [[vcs:docs:​usage|Usage]]\\ Contents: 
-    * [[dox:vcs:​usage#​Default behaviour]] +    * [[vcs:docs:​usage#​Default behaviour]] 
-    * [[dox:vcs:​usage#​Capture count modes]] +    * [[vcs:docs:​usage#​Capture count modes]] 
-    * [[dox:vcs:​usage#​Number of columns]] +    * [[vcs:docs:​usage#​Number of columns]] 
-    * [[dox:vcs:​usage#​Capture size and aspect ratio]] +    * [[vcs:docs:​usage#​Capture size and aspect ratio]] 
-    * [[dox:vcs:​usage#​Adding a title]] +    * [[vcs:docs:​usage#​Adding a title]] 
-    * [[dox:vcs:​usage#​Output filename]] +    * [[vcs:docs:​usage#​Output filename]] 
-  * [[dox:vcs:​time_syntax]] +  * [[vcs:docs:​time_syntax]] 
-  * [[dox: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) 
-  * [[dox:vcs:​extended_mode|Extended mode]] +  * [[vcs:docs:​extended_mode|Extended mode]] 
-  * [[dox:vcs:​manual_modes|Manual modes]]\\ Contents: +  * [[vcs:docs:​manual_modes|Manual modes]]\\ Contents: 
-    * [[dox:vcs:​manual_modes#​Manually added captures]] +    * [[vcs:docs:​manual_modes#​Manually added captures]] 
-    * [[dox:vcs:​manual_modes#​Highlights]] +    * [[vcs:docs:​manual_modes#​Highlights]] 
-    * [[dox:vcs:​manual_modes#​Manual-only mode]] +    * [[vcs:docs:​manual_modes#​Manual-only mode]] 
-  * [[dox: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//"​)
-  * [[dox:vcs:​conf_files|Configuration files]] (overriding default options) +  * [[vcs:docs:​conf_files|Configuration files]] (overriding default options) 
-    * [[dox:vcs:​example_configs]] +    * [[vcs:docs:​example_configs]] 
-  * [[dox:vcs:​profiles]]+  * [[vcs:docs:profiles]]
   * Other   * Other
     * [[vcs:​nonlatin|Non-latin scripts in file names]]     * [[vcs:​nonlatin|Non-latin scripts in file names]]
-  * [[dox:vcs:​troubleshooting|Troubleshooting]]+  * [[vcs:docs:​troubleshooting|Troubleshooting]]
  
-  * List main of options (see [[dox: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): 
-    * ''​[[dox:vcs:​usage#​capture_count_modes|-n,​ --numcaps]]'':​ Number of captures +    * ''​[[vcs:docs:​usage#​capture_count_modes|-n,​ --numcaps]]'':​ Number of captures 
-    * ''​[[dox:vcs:​usage#​capture_count_modes|-i,​ --interval]]'':​ Interval of captures +    * ''​[[vcs:docs:​usage#​capture_count_modes|-i,​ --interval]]'':​ Interval of captures 
-    * ''​[[dox:vcs:​usage#​number_of_columns|-c,​ --columns]]'':​ Number of columns +    * ''​[[vcs:docs:​usage#​number_of_columns|-c,​ --columns]]'':​ Number of columns 
-    * ''​[[dox:vcs:​usage#​capture_size_and_aspect_ratio|-H,​ --height]]'':​ Capture height +    * ''​[[vcs:docs:​usage#​capture_size_and_aspect_ratio|-H,​ --height]]'':​ Capture height 
-    * ''​[[dox: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 =====
  
-  * [[dox:vcs:​tips|Tips]] +  * [[vcs:docs:​tips|Tips]] 
-  * [[dox:vcs:​changelog|History]] +  * [[vcs:docs:​changelog|History]] 
-  * [[dox:​vcs:​bugs|Open and fixed bugs and feature requests]] +  * [[bts>|Open and fixed bugs and feature requests]] 
-  * [[dox:vcs:roadmap|Roadmap]]+  * [[bts>​roadmap/​vcs|Roadmap]]
   * Indexes   * Indexes
-    * [[dox:vcs:​samples|All samples]] +    * [[vcs:docs:​samples|All samples]] 
-    * [[dox:vcs:​devel:​testfiles]] +    * [[vcs:docs:​devel:​testfiles]] 
-  * [[dox:vcs:​alternatives|Similar tools]]+  * [[vcs:docs:​alternatives|Similar tools]]
  
 ===== Development documentation ===== ===== Development documentation =====
  
-  * [[dox:vcs:​devel:​references]]+  * [[vcs:docs:​devel:​references]]
  
 The following pages detail drafts for future developments:​ The following pages detail drafts for future developments:​
  
-  * [[dox: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]]
-  * [[dox:vcs:​devel:​posix|POSIX compatibility]] +  * [[vcs:docs:​devel:​posix|POSIX compatibility]] 
-  * [[dox:vcs:​devel:​bash_support]] +  * [[vcs:docs:​devel:​bash_support]] 
-  * [[dox:vcs:​devel:​transcode]] +  * [[vcs:docs:​devel:​transcode]] 
-  * [[dox:vcs:​devel:​renumbering]] +  * [[vcs:docs:​devel:​renumbering]] 
-  * [[dox:vcs:​devel:​brainstorming]]+  * [[vcs:docs:​devel:​brainstorming]]
All dates/times in this page are UTC.