[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

2. Configuring Renrot

In the simplest case you will be able to startup renrot without any additional command line options except ‘-e


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

2.1 Command Line Options.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

2.1.1 General Command Line Options.

-c ‘filename
--config-file ‘filename

Path to the configuration file.

-d directory
--work-directory directory

Define the working directory.

--exclude ‘filename

Specify files to exclude. Wildcards are not allowed. If a set of files is given, there must be as many occurrences of this option as there are files in the set.

--sub-fileset ‘filename

Get names of files to operate upon from FILE. The file must contain a file name per line. This option is useful when you need to process only a set of X from Y files in the directory. If specified, the rest of files given in the command line is ignored.

-e extention
--extension extention

Process the files with given extention (JPG, jpeg, CRW, crw, etc). Depending on the operating system, the extension search might or might not be case-sensitive.

-n template
--name-template template

A template to use for creating new file names while renaming. It can also be defined in the configuration file (variable Name Template). The default is ‘%Y%m%d%H%M%S’. For practical uses, see “TEMPLATE EXAMPLES” section.

Interpreted sequences are:

%%

a literal %

%#

a literal #

%C

Numeric part of the original file name. Implemented for the sake of cameras, that do not supply FileNumber EXIF tag (currently all makes, except *Canon*). Such cameras generate file names starting with letters and ended with digits. No other symbols are allowed in file names, except “-”, “.” and “_”.

%c

Ordinal number of file in the processed file set (see also ‘--counter-fixed-field’ option).

%d

Day of month (01-31).

%E

The value of ExposureTime tag, if defined.

%e

Old file extension

%F

The value of FNumber tag, if defined.

%H

Hour (00-23).

%I

The value of ISO tag, if defined.

%i

FileNumber tag if exists (otherwise, it is replaced by string “NA”).

%M

Minute (00-59).

%m

Month (01-12).

%n

Previous filename (the one before renrot started processing).

%O

Base part of the original filename (see ‘%o’). In other words, the first part from the beginning to the last dot character.

%o

The name file had before it was processed by renrot for the first time. If the file was processed only once, the tag RenRotFileNameOriginal is set to the original file name.

%S

Second (00-59)

%W

The value of WhiteBalance tag, if defined.

%Y

Year with the century (1900, 1901, and so on)

%y

Year without a century (00..99)

You can use value of any EXIF tag to be included as name part. To do that you need to embrace tag name with sign "#", while building name template (see "TEMPLATE EXAMPLES").

Be careful, since any binary EXIF (like ThumbnaiImage) can produce totally unexpected results.

--no-rename

Do not rename files (default is to rename them to YYYYmmddHHMMSS.ext)

--counter-fixed-field
--no-counter-fixed-field

Set fixed length for file counter, used in file name templates (see ‘%c’). It is enabled by default. Use –no-counter-fixed-field to undo its effect.

--counter-start number

Initial value for the file counter (default is 1)

--counter-step number

Step to increment file counter with (default is 1)

-r angle
--rotate-angle angle

Define the angle to rotate files and thumbnails. Allowed values for angle are 90, 180 or 270. It is useful for files not having Orientation tag.

--rotate-thumb angle

Rotate only thumbnails. Allowed values for *ANGLE* are 90, 180 or 270 degrees. Use if the files which were already rotated, but their thumbnails were not.

--only-orientation

Rotate by changing the value of Orientation tag, no real rotation will be made. The sequence of values to rotate an image from normal (0 degrees) by 90 degrees clockwise is: 0 -> 90 -> 180 -> 270 -> 0. It means. set Orientation tag to 90cw after the first rotation, and increase that value by 90 each time the rotation is applied. For 270cw the rotation algorithm uses the reverted sequence. Rotation by 180cw triggers values in two pairs: 0 <-> 180 and 90 <-> 270. This option cannot be applied to mirror values of Orientation tag.

--trim
--no-trim

Pass the "-trim" option to jpegtran(1), to trim if needed. By default, trimming is enabled. Use –no-trim to disable it.

--no-rotate

Do not rotate images (default is to rotate according to EXIF data).

--mtime
--no-mtime

Defines whether to set the file's mtime, using DateTimeOriginal tag value. Use ‘--no-mtime’ to set it to current time stamp after processing.

--no-ren-rot-tag-mtm
--nochg

Do not rename, rotate, tag and mtime images. It saves files from any changes while allows to do aggregation, contact sheet generation e.t.c.

--keywordize
--no-keywordize

Whether to keywordize. Default is to not. Be careful, since with this option enabled, the existing keywords are rewriten. The keywords are taken from .keywords file or file specified with option ‘--keywords-file’.

-k ‘filename
--keywords-file ‘filename

Path to the file with keywords. Its format is a keyword per line. The CR and LF symbols are removed. Empty (only whitespace) lines are ignored. Any leading and trailing whitespace is removed. For example, the line " _Test_ CRLF" is read as "_Test_".

--keywords-replace
--no-keywords-replace

Replace existing Keywords tag list rather than add new values to it. Default is not to replace.

--comment-file ‘filename

File with commentaries. It is a low priority alias to TagFile = Comment: ‘filename.

--user-comment string

A low priority alias to ‘--tag UserComment: string

-t tag
--tag tag

See the section "TAGS", for the detailed description

--no-tags

No tags will be written. This is the default.

--use-color
--no-use-color

Colorize output. This does NOT work under Win32.

--dry-run

Do not do anything, only print would have been done.

--use-ipc
--no-use-ipc

Rotate thumbnails using pipe, rather than files. This does NOT work under Win32.

-v

Increase debugging level by 1. Debugging levels from 1 to 4 are internal levels, the levels from 5 till 9 are equivalent to levels 1-5 levels ExifTool with the maximum verbosity for renrot.

-?
--help

Display short usage summary and exit.

--version

Output version information and exit.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

2.1.2 Aggregation Options.

--aggr-mode mode

Run aggregation process in given mode. Possible values are: none, delta or template.

--aggr-delta number

Aggregation time delta, in seconds. Files with DateTimeOriginal and ones of the previous file delta, greater than ‘--aggr-delta’ are placed in the directory, with the name constructed by concatenating the value of the ‘--aggr-directory’ option and the directory name counter.

--aggr-directory directory

Aggregation directory name prefix (default is “Images”)

-a template
--aggr-template template

File name template to use for file aggregation. Images are aggregated by date/time patterns. You may use combination of ‘%d’, ‘%H’, ‘%M’, ‘%m’, ‘%S’, ‘%Y’, and ‘%y’ meta-characters. The template can also be defined in the configuration file (see Aggregation Template variable). The default is ‘%Y%m%d’. For the detailed description, refer to ‘--name-template’ option. For practical uses, see see section Template examples. section.

--aggr-virtual
--no-aggr-virtual

Defines virtualization for existent aggregation modes. If set, resulting files are placed into the directory given by the command line option ‘--aggr-virtual-directory’ or configuration file option aggregation virtual directory then any changes required by the current aggregation mode are applied. The main effect of ‘--aggr-virtual’ is that any files to be aggregated remain untouched in their places, and symlinks pointing to them are stored in the directory tree created. Use ‘--no-aggr-virtual’ to prevent virtualization.

--aggr-virtual-directory directory

Store virtual aggregation files in directory


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

2.1.3 Contact Sheet Options.

--cs
--contact-sheet

Create the contact sheet. Currently it works with ThumbnailImage EXIFs and the files defined as thumbnails (see the option ‘--cs-thm’, below)

--cs-file ‘filename
--contact-sheet-file ‘filename

Base file name for montage files.

--cs-dir directory
--contact-sheet-dir directory

Temporary directory for montage (created in the begining and deleted at the end of the process)

--cs-thm
--contact-sheet-thm

Files for the montage are already thumbnails

Options bellow are native ImageMagic montage options look ImageMagick documentation for montage options: montage --help and http://www.imagemagick.org/

Note please, for color(2) use RGB triplets only like ‘000’ for the ‘black’ or ‘F00’ for the ‘red’.

--cs-tile geometry
--contact-sheet-tile geometry

Tile MxN(3).

--cs-title string
--contact-sheet-title string

Set the title of the contact sheet(4).

--cs-bg color
--contact-sheet-bg color

Background color(5).

--cs-bd color
--contact-sheet-bd color

Border color(6).

--contact-sheet-mt color

Frame color(7).

--contact-sheet-fn string

Render text with this font(8).

--cs-fl color
--contact-sheet-fl color

Color to fill the text(9).

--cs-lb string
--contact-sheet-lb string

Assign a label to an image(10).

--cs-fr geometry
--contact-sheet-fr geometry

Surround image with an ornamental border in N pixels(11).

--cs-pntsz number
--contact-sheet-pntsz number

Font point size (IM: ‘-pointsize’).

--cs-shadow
--contact-sheet-shadow

Set the shadow beneath a tile to simulate depth(12).

--cs-thm-fl color
--contact-sheet-thm-fl color

Color to fill the text in generated thumbnail.

--cs-thm-fn string
--contact-sheet-thm-fn string

Render the generated thumbnail text with this font(13).

--cs-thm-grfr color
--contact-sheet-thm-grfr color

Generated thumbnail background gradient color-from

--cs-thm-grto color
--contact-sheet-thm-grto color

Generated thumbnail background gradient color-to

--cs-thm-text string
--contact-sheet-thm-text string

Generated thumbnail text

--cs-rank
--contact-sheet-rank

Run ranking process according the ranks defined with ‘--cs-rank-file

The result is the colored frames of the thumbnails of contact sheets.

--cs-rank-file ‘filename
--contact-sheet-rank-file ‘filename

Path to the file with ranks. Its format is a "file rankcolor" per line. Filename separated from the color by space or tabulation.

 
01.file.jpg red
04.file.JPG green

Only the files found in the file will be ranked.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

2.2 Configuration File

A configuration file can be used to set some variables. Renrot looks for its configuration file, named ‘renrot.conf’, in system configuration directories /etc/renrot and </usr/local/etc/renrot>, and in subdirectory .renrot. of the current user home directory. An alternate configuration file can also be explicitly given using the ‘--config-file option’.

The configuration file consists of a set of case-insensive keywords and their values separated by equal sign. Each such keyword/value pair occupies a separate line. Boolean variables can have one of the following values: ‘0’, ‘No’, ‘False’, ‘Off’ for ‘false’, and ‘1’, ‘Yes’, ‘True’, ‘On’ for ‘true’.

The variables defined for use in configuration file are:

use IPC

Use IPC for execution external command

use color

Use colorized output (not works under MS Windows) Default color setup for different facilities:

 
color = debug: 'green'
color = error: 'magenta'
color = fatal: 'red'
color = info: 'bold'
color = process: 'white'
color = warning: 'cyan'
mtime

Set to ‘Yes’ for synchronize mtime with tags, otherwise set it to ‘No’.

name template

File name template (see ‘--name-template’, for the description).

trim

Set to ‘Yes’ to trim rotated images when using jpegtran(1).

aggregation mode

Aggregation mode, possible values are: none, delta or template.

aggregation template

Aggregation template, which defines the file aggregation (see ‘--aggr-template’, for the description).

aggregation virtual

Defines virtualization for the existing aggregation modes (see the ‘--aggr-virtual’ option).

aggregation virtual directory

Defines a directory for virtual aggregation (see ‘--aggr-virtual-directory’ option).

Tag
TagFile

Refer to the section "TAGS", for the detailed description

include

Include the named file.


[ << ] [ >> ]           [Top] [Contents] [Index] [ ? ]

This document was generated by Zeus V Panchenko on October, 30 2009 using texi2html 1.78.