| Both sides previous revision Previous revision | Next revisionBoth sides next revision |
| vcs:conf_files [2010/03/01 20:02] – Added example configuration file. Added note about spaces and quotes Toni Corvera | vcs:conf_files [2010/03/08 00:02] – Fixes Toni Corvera |
|---|
| ^ Option ^ Default ^ Description ^ Additional details ^ Deprecated? ^ | ^ Option ^ Default ^ Description ^ Additional details ^ Deprecated? ^ |
| ^ Main behaviour options ^^^^^ | ^ Main behaviour options ^^^^^ |
| | ''DEFAULT_INTERVAL'' | 300 | Default capture interval | Integer: Seconds FIXME Does it take symbolic values? | | | | ''DEFAULT_INTERVAL'' | ''300'' | Default capture interval | Integer: Seconds FIXME Does it take symbolic values? | Already. Use ''interval'' instead | |
| | ''DEFAULT_NUMCAPS'' | 16 | Default number of captures | Integer | | | | ''DEFAULT_NUMCAPS'' | ''16'' | Default number of captures | Integer | Already. Use ''numcaps'' instead | |
| | ''DEFAULT_COLS'' | 2 | Default number of columns | Integer | | | | ''DEFAULT_COLS'' | ''2'' | Default number of columns | Integer | Already. Use ''cols'' instead | |
| | | ''HPAD'' | ''2'' | Padding between captures | Integer. **Since 1.11** | | |
| | | ''th_height'' | | Height | Can be a fixed value or a percentage. By default same as input. **Since 1.11** | | |
| | ''user_signature'' | "Preview created by" | Text before the user name in the signature | | | | | ''user_signature'' | "Preview created by" | Text before the user name in the signature | | | |
| | ''user'' | ''$(id -un)'' ((i.e. your username)) | User name for signature. | See ''[[vcs:cli_options#user|-u]]'' (''[[vcs:cli_options#user|--user]]'') and ''[[vcs:cli_options#fullname|-U]]'' (''[[vcs:cli_options#fullname|--fullname]]'') | | | | ''user'' | ''$(id -un)'' ((i.e. your username)) | User name for signature. | See ''[[vcs:cli_options#user|-u]]'' (''[[vcs:cli_options#user|--user]]'') and ''[[vcs:cli_options#fullname|-U]]'' (''[[vcs:cli_options#fullname|--fullname]]'') | | |
| | ''DVD_FILE'' | | Default DVD device or ISO | | | | | ''DVD_FILE'' | | Default DVD device or ISO | | | |
| ^ Colours ((See ''$ convert -list color'')) ^^^^^ | ^ Colours ((See ''$ convert -list color'')) ^^^^^ |
| | ''bg_heading'' | ''YellowGreen'' ((**In 1.11 will change to ** RGB(175,205,122)=#afcd7a)) | Background for meta info (size, codec...) | | | | | ''bg_heading'' | ''#afcd7a'' ((#afcd7a=RGB(175,205,122) ))((Up to 1.11 was ''YellowGreen'')) | Background for meta info (size, codec...) | | | |
| | ''bg_sign'' | ''SlateGray'' | Background for signature | | | | | ''bg_sign'' | ''SlateGray'' | Background for signature | | | |
| | ''bg_title'' | ''White'' | Background for the title (see ''-T'') | | | | | ''bg_title'' | ''White'' | Background for the title (see ''-T'') | | | |
| | ''fg_title'' | ''Black'' | Font colour for the title | | | | | ''fg_title'' | ''Black'' | Font colour for the title | | | |
| ^ Fonts ((See ''$ convert -list font'')) ^^^^^ | ^ Fonts ((See ''$ convert -list font'')) ^^^^^ |
| | ''font_tstamps'' | ''courier'' | Used for timestamps over the thumbnails | | | | | ''font_tstamps'' | ''DejaVu-Sans-Book'' ((Up to 1.11 was picked by ImageMagick)) | Used for timestamps over the thumbnails | | | |
| | ''font_heading'' | ''helvetica'' | Used for the meta info heading | | | | | ''font_heading'' | ''DejaVu-Sans-Book'' ((Up to 1.11 was ''helvetica'')) | Used for the meta info heading | | | |
| | ''font_sign'' | ''helvetica'' | Used for the signature box | | | | | ''font_sign'' | ''DejaVu-Sans-Book'' ((Up to 1.11 was ''helvetica'')) | Used for the signature box | | | |
| | ''font_filename'' | ''$FF_DEFAULT'' | Font used for the file name | This variable only accepts the ''$FF_*'' constants | Yes ((Handling of non-latin filenames will change substantially)) | | | ''font_filename'' | ''$FF_DEFAULT'' | Picks filename font, set to ''$FF_MINCHO'' to use the alternate font | This variable only accepts the ''$FF_*'' constants | | |
| | ''font_title'' | ''helvetica'' | Used for the title (see ''-T'') | | | | | ''FONT_MINCHO'' | | Font used for non-latin filenames. | See ''$font_filename'' and ''-I''. Tries to pick automatically, can be set manually with -I | Partly ((Will be renamed)) | |
| | ''FONT_MINCHO'' | ''/usr/share/fonts/truetype/kochi/kochi-mincho.ttf'' | Font used for non-latin filenames. See ''$font_filename'' and ''-I'' | Yes ((Will be simplified in future versions)) | | | ''font_title'' | ''DejaVu-Sans-Book'' ((Up to 1.11 was ''helvetica'')) | Used for the title (see ''-T'') | | | |
| ^ Font sizes ((Specified in points)) ^^^^^ | ^ Font sizes ((Specified in points)) ^^^^^ |
| | ''pts_tstamps'' | ''18'' | Used for the timestamps | Integer | | | | ''pts_tstamps'' | ''14'' ((Up to 1.11 was ''18'')) | Used for the timestamps | Integer. This value is reduced for smaller captures | | |
| | ''pts_meta'' | ''16'' | Used for the meta info heading | Integer | | | | ''pts_meta'' | ''14'' ((Up to 1.11 was ''16'')) | Used for the meta info heading | Integer | | |
| | ''pts_sign'' | ''11'' | Used for the signature | Integer | | | | ''pts_sign'' | ''10'' ((Up to 1.11 was ''11'')) | Used for the signature | Integer | | |
| | ''pts_title'' | ''36'' | Used for the title (see ''-T'') | Integer | | | | ''pts_title'' | ''33'' ((Up to 1.11 was ''36'')) | Used for the title (see ''-T'') | Integer | | |
| ^ Low level options ^^^^^ | ^ Low level options ^^^^^ |
| | ''GETOPT'' | ''getopt'' | Getopt command | The getopt command must be set correctly or the script won't work. Must be a version accepting GNU syntax. Can only be set in configuration files (i.e. not from the command-line). | | | | ''GETOPT'' | ''getopt'' | Getopt command | The getopt command must be set correctly or the script won't work. Must be a version accepting GNU syntax. Can only be set in configuration files (i.e. not from the command-line). | | |
| | ''safe_rename_pattern'' | ''%b-%N.%e'' | Pattern used for output files to avoid overwriting existing files. | ''%b'': Basename \\ ''%N'': Incremental number \\ ''%e'': extension | | | | ''safe_rename_pattern'' | ''%b-%N.%e'' | Pattern used for output files to avoid overwriting existing files. | ''%b'': Basename \\ ''%N'': Incremental number \\ ''%e'': extension | | |
| | ''verbosity'' | ''$V_ALL'' | Verbosity level | Available: ''$V_ALL'', ''$V_NONE'', ''$V_ERROR'', ''$V_WARN'', ''$V_INFO'' \\ See also ''[[vcs:cli_options#quiet|--quiet]]'' | | | | ''verbosity'' | ''$V_ALL'' | Verbosity level | Available: ''$V_ALL'', ''$V_NONE'', ''$V_ERROR'', ''$V_WARN'', ''$V_INFO'' \\ See also ''[[vcs:cli_options#quiet|--quiet]]'' | | |
| | ''plain_messages'' | ''0'' | Controls colour output ((**From 1.11**: Also the alternative prefixes when no colour is available)) to console. | Set to ''1'' to disable colour | | | | | ''plain_messages'' | ''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 | | Maybe ((Might be moved to the ''%%--%%undocumented'' subset)) | | | ''stdout'' | ''/dev/null'' | Standard output of decoder is sent here | | Maybe ((Might be moved to the ''%%--%%undocumented'' subset)) | |
| | ''stderr'' | ''/dev/null'' | Standard error of decoder is sent here | | Maybe ((Might be moved to the ''%%--%%undocumented'' subset)) | | | ''stderr'' | ''/dev/null'' | Standard error of decoder is sent here | | Maybe ((Might be moved to the ''%%--%%undocumented'' subset)) | |
| |