Differences

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

Link to this comparison view

Both sides previous revision Previous revision
vcs:docs:conf_files [2016/04/17 23:28]
Toni Corvera ↷ Page moved from dox:vcs:conf_files to vcs:docs:conf_files
vcs:docs:conf_files [2016/04/17 23:28] (current)
Toni Corvera ↷ Links adapted because of a move operation
Line 9: Line 9:
   * ''​./​vcs.conf'':​ (i.e. ''​vcs.conf''​ in the current directory) Per-dir configuration   * ''​./​vcs.conf'':​ (i.e. ''​vcs.conf''​ in the current directory) Per-dir configuration
  
-See also //[[dox:vcs:​profiles]]//​ for an alternative to auto-loading configuration files.+See also //[[vcs:docs:​profiles]]//​ for an alternative to auto-loading configuration files.
  
 They'​re loaded in this order, and when a configuration option is present in more than one file the last file takes precedence. They'​re loaded in this order, and when a configuration option is present in more than one file the last file takes precedence.
Line 26: Line 26:
 **Examples**\\ **Examples**\\
   * Setting background colour for the heading to blue: ''​bg_heading=blue''​. Added to a configuration file or from the command-line:​ ''​$ vcs -O '​bg_heading=blue'​ file.avi''​   * Setting background colour for the heading to blue: ''​bg_heading=blue''​. Added to a configuration file or from the command-line:​ ''​$ vcs -O '​bg_heading=blue'​ file.avi''​
-  * Output to JPEG by default: ''​format=jpg''​. Added to a configuration file (the command-line option ''​[[dox:vcs:​cli_options#​jpeg|-j]]''​ does the same for a single run).+  * Output to JPEG by default: ''​format=jpg''​. Added to a configuration file (the command-line option ''​[[vcs:docs:​cli_options#​jpeg|-j]]''​ does the same for a single run).
  
 **Example configuration file**\\ **Example configuration file**\\
Line 50: Line 50:
 ^ Option ​              ^ Default ^ Description ^ Additional details ^ ^ Option ​              ^ Default ^ Description ^ Additional details ^
 ^ Main behaviour options ^^^^ ^ Main behaviour options ^^^^
-| ''​interval''​ | ''​300''​ | Default capture interval ​          | [[dox:vcs:​time_syntax|Time]] |+| ''​interval''​ | ''​300''​ | Default capture interval ​          | [[vcs:docs:​time_syntax|Time]] |
 | ''​numcaps'' ​ | ''​16'' ​ | Default number of captures ​        | Integer | | ''​numcaps'' ​ | ''​16'' ​ | Default number of captures ​        | Integer |
 | ''​columns'' ​    | ''​2'' ​  | Default number of columns ​         | Integer | | ''​columns'' ​    | ''​2'' ​  | Default number of columns ​         | Integer |
Line 56: Line 56:
 | ''​height'' ​       |     | Height | Can be a fixed value or a percentage. By default same as input | | ''​height'' ​       |     | Height | Can be a fixed value or a percentage. By default same as input |
 | ''​signature'' ​  | "​Preview created by" | Text before the user name in the signature | | | ''​signature'' ​  | "​Preview created by" | Text before the user name in the signature | |
-| ''​user'' ​            | ''​$(id -un)''​ ((i.e. your username)) | User name for signature. | See ''​[[dox:vcs:​cli_options#​user|-u]]'' ​ (''​[[dox:vcs:​cli_options#​user|--user]]''​) and ''​[[dox:vcs:​cli_options#​fullname|-U]]''​ (''​[[dox:vcs:​cli_options#​fullname|--fullname]]''​) |+| ''​user'' ​            | ''​$(id -un)''​ ((i.e. your username)) | User name for signature. | See ''​[[vcs:docs:​cli_options#​user|-u]]'' ​ (''​[[vcs:docs:​cli_options#​user|--user]]''​) and ''​[[vcs:docs:​cli_options#​fullname|-U]]''​ (''​[[vcs:docs:​cli_options#​fullname|--fullname]]''​) |
 | ''​format'' ​   | png | Sets the output format | Should match the extension of a format known by ImageMagick | | ''​format'' ​   | png | Sets the output format | Should match the extension of a format known by ImageMagick |
 | ''​quality'' ​  | 92  | Image quality for output in lossy formats | Integer, Only affects the final image | | ''​quality'' ​  | 92  | Image quality for output in lossy formats | Integer, Only affects the final image |
 | ''​decoder'' ​         | ''​$DEC_FFMPEG''​ | Controls which capturer to use by default | Symbolic: ''​$DEC_FFMPEG''​ => FFmpeg, ''​$DEC_MPLAYER''​ => MPlayer | | ''​decoder'' ​         | ''​$DEC_FFMPEG''​ | Controls which capturer to use by default | Symbolic: ''​$DEC_FFMPEG''​ => FFmpeg, ''​$DEC_MPLAYER''​ => MPlayer |
-| ''​timecode_from'' ​   | ''​$TC_INTERVAL''​ | Selects between [[dox:vcs:​usage#​capture_count_modes|number of captures or interval mode]] | Symbolic: ''​$TC_INTERVAL''​ => interval mode, ''​$TC_NUMCAPS''​ => number of captures mode | +| ''​timecode_from'' ​   | ''​$TC_INTERVAL''​ | Selects between [[vcs:docs:​usage#​capture_count_modes|number of captures or interval mode]] | Symbolic: ''​$TC_INTERVAL''​ => interval mode, ''​$TC_NUMCAPS''​ => number of captures mode | 
-| ''​extended_factor'' ​ | ''​0'' ​ | Set the extended factor. | ''​0''​ disables extended mode.\\ See [[dox:vcs:​extended_mode]] |+| ''​extended_factor'' ​ | ''​0'' ​ | Set the extended factor. | ''​0''​ disables extended mode.\\ See [[vcs:docs:​extended_mode]] |
 | ''​disable_shadows'' ​ | ''​0'' ​ | Disables drop shadows when ''​1''​. | Equivalent command-line argument ''​-ds''​. | | ''​disable_shadows'' ​ | ''​0'' ​ | Disables drop shadows when ''​1''​. | Equivalent command-line argument ''​-ds''​. |
 | ''​disable_timestamps'' ​ | ''​0'' ​ | Disables timestamps on captures when ''​1''​. | Equivalent command-line argument ''​-dt''​. | | ''​disable_timestamps'' ​ | ''​0'' ​ | Disables timestamps on captures when ''​1''​. | Equivalent command-line argument ''​-dt''​. |
Line 95: Line 95:
 | ''​end_offset''​ | ''​5%''​ | Default value for end offset. See ''​-E''​ | | | ''​end_offset''​ | ''​5%''​ | Default value for end offset. See ''​-E''​ | |
 | ''​safe_rename_pattern''​ | ''​%b-%N.%e''​ | Pattern used for output files to avoid overwriting existing files. | ''​%b'':​ Basename \\ ''​%N'':​ Incremental number \\ ''​%e'':​ extension \\ Scheduled for removal in 1.13 | | ''​safe_rename_pattern''​ | ''​%b-%N.%e''​ | Pattern used for output files to avoid overwriting existing files. | ''​%b'':​ Basename \\ ''​%N'':​ Incremental number \\ ''​%e'':​ extension \\ Scheduled for removal in 1.13 |
-| ''​verbosity'' ​       | ''​$V_ALL''​ | Verbosity level | Available: ''​$V_ALL'',​ ''​$V_NONE'',​ ''​$V_ERROR'',​ ''​$V_WARN'',​ ''​$V_INFO''​ \\ See also ''​[[dox:vcs:​cli_options#​quiet|--quiet]]''​ |+| ''​verbosity'' ​       | ''​$V_ALL''​ | Verbosity level | Available: ''​$V_ALL'',​ ''​$V_NONE'',​ ''​$V_ERROR'',​ ''​$V_WARN'',​ ''​$V_INFO''​ \\ See also ''​[[vcs:docs:​cli_options#​quiet|--quiet]]''​ |
 | ''​simple_feedback''​ | ''​0''​ | Controls colour output ((**From 1.11**: Also the alternative prefixes when no colour is available)) to console. | Set to ''​1''​ to disable colour | | ''​simple_feedback''​ | ''​0''​ | Controls colour output ((**From 1.11**: Also the alternative prefixes when no colour is available)) to console. | Set to ''​1''​ to disable colour |
 | ''​stdout'' ​ | ''/​dev/​null''​ | Standard output of decoder is sent here | | | ''​stdout'' ​ | ''/​dev/​null''​ | Standard output of decoder is sent here | |
 | ''​stderr'' ​ | ''/​dev/​null''​ | Standard error of decoder is sent here | | | ''​stderr'' ​ | ''/​dev/​null''​ | Standard error of decoder is sent here | |
  
All dates/times in this page are UTC.