summaryrefslogtreecommitdiffabout
authorAndy Shevchenko <andy@smile.org.ua>2012-07-28 18:56:40 (GMT)
committer Andy Shevchenko <andy@smile.org.ua>2012-07-28 18:56:40 (GMT)
commit204a0243ad080eb6432f3ff36d2137ba9006169b (patch) (unidiff)
tree4a17153452749f14263af6a74cfcad422e1df5e6
parent219ea9d30fcfbdf8ca73c395ca3517a63270ed5f (diff)
downloadrenrot-204a0243ad080eb6432f3ff36d2137ba9006169b.tar.gz
renrot-204a0243ad080eb6432f3ff36d2137ba9006169b.tar.bz2
doc: split long option list by frameworks
The options for the Aggregation, Keywordizer, Renaming, Rotating, and Tag Writer are moved to the separate sections. Signed-off-by: Andy Shevchenko <andy.shevchenko@gmail.com> git-svn-id: file:///svnroot/renrot/trunk@616 fe2816f4-e837-0410-b10a-f608c9d244a1
Diffstat (more/less context) (ignore whitespace changes)
-rwxr-xr-xrenrot398
1 files changed, 217 insertions, 181 deletions
diff --git a/renrot b/renrot
index 722d921..0b25b4c 100755
--- a/renrot
+++ b/renrot
@@ -371,29 +371,35 @@ sub getOptions {
371 "keywords-file|k=s" => \$h_kw_opts{'file'}, 371 "keywords-file|k=s" => \$h_kw_opts{'file'},
372 "keywords-replace!" => \$h_kw_opts{'replace'}, 372 "keywords-replace!" => \$h_kw_opts{'replace'},
373 373
374 # OTHERS 374 # RENAMIMG
375 "backup!" => \$backup,
376 "comment-file=s" => \$comfile,
377 "config-file|c=s" => \$configFile,
378 "counter-fixed-field!" => \$countFF, 375 "counter-fixed-field!" => \$countFF,
379 "counter-start=i" => \$countStart, 376 "counter-start=i" => \$countStart,
380 "counter-step=i" => \$countStep, 377 "counter-step=i" => \$countStep,
378 "no-rename|norename" => \$noRename,
379
380 # ROTATIMG
381 "no-rotate|norotate" => \$noRotation,
382 "only-orientation" => \$orientTag,
383 "rotate-angle|r=i" => \$rotateAngle,
384 "rotate-thumb=i" => \$rotateThumbnail,
385
386 # TAG WRITER
387 "comment-file=s" => \$comfile,
388 "no-tags|notags" => \$noTags,
389 "tag|t=s" => \@tmpTags,
390 "user-comment=s" => \$userComment,
391
392 # OTHERS
393 "backup!" => \$backup,
394 "config-file|c=s" => \$configFile,
381 "dry-run" => \$dryRun, 395 "dry-run" => \$dryRun,
382 "exclude=s" => \@excludeList, 396 "exclude=s" => \@excludeList,
383 "extension|e=s" => \$extToProcess, 397 "extension|e=s" => \$extToProcess,
384 "generate-thumb|g" => \$gen_thm, 398 "generate-thumb|g" => \$gen_thm,
385 "help|?" => sub { usage(0, 2) }, 399 "help|?" => sub { usage(0, 2) },
386 "no-rename|norename" => \$noRename,
387 "no-rotate|norotate" => \$noRotation,
388 "no-tags|notags" => \$noTags,
389 "no-renrot|nochg" => \$noRenRoTagMtm, 400 "no-renrot|nochg" => \$noRenRoTagMtm,
390 "only-orientation" => \$orientTag,
391 "quiet|q" => \$quiet, 401 "quiet|q" => \$quiet,
392 "rotate-angle|r=i" => \$rotateAngle,
393 "rotate-thumb=i" => \$rotateThumbnail,
394 "sub-fileset=s" => \$subFileSet, 402 "sub-fileset=s" => \$subFileSet,
395 "tag|t=s" => \@tmpTags,
396 "user-comment=s" => \$userComment,
397 "v+" => \$verbose, 403 "v+" => \$verbose,
398 "version" => sub { usage(0, 0) }, 404 "version" => sub { usage(0, 0) },
399 "work-directory|d=s" => \$workDir, 405 "work-directory|d=s" => \$workDir,
@@ -1946,148 +1952,53 @@ Process the files with given I<EXTENSION> (JPG, jpeg, CRW, crw, etc).
1946Depending on the operating system, the extension search might or might not be 1952Depending on the operating system, the extension search might or might not be
1947case-sensitive. 1953case-sensitive.
1948 1954
1949=item B<-n> or B<--name-template> I<TEMPLATE> 1955=item B<--mtime>, B<--no-mtime>
1950
1951A template to use for creating new file names while renaming. It can also be
1952defined in the configuration file (variable Name Template). The default is
1953I<%Y%m%d%H%M%S>. For practical uses, see L</TEMPLATE EXAMPLES> section.
1954
1955Interpreted sequences are:
1956
1957=over
1958
1959 B<%%>a literal %
1960
1961 B<%#>a literal #
1962
1963 B<%C>Numeric part of the original file name. Implemented for the sake
1964of cameras, that do not supply FileNumber EXIF tag (currently all makes,
1965except I<Canon>). Such cameras generate file names starting with letters
1966and ended with digits. No other symbols are allowed in file names, except
1967C<->, C<.> and C<_>.
1968
1969 B<%c>Ordinal number of file in the processed file set (see also
1970B<--counter-fixed-field> option).
1971
1972 B<%d>Day of month (01-31).
1973 1956
1974 B<%E>The value of ExposureTime tag, if defined. 1957Defines whether to set the file's mtime, using DateTimeOriginal tag value.
1958Use B<--no-mtime> to set it to current time stamp after processing.
1975 1959
1976 B<%e>Old file extension 1960=item B<--no-renrot> or B<--nochg>
1977 1961
1978 B<%F>The value of FNumber tag, if defined. 1962Do not rename, rotate, tag and mtime images. It saves files from any changes
1963while allows to do aggregation, contact sheet generation e.t.c.
1979 1964
1980 B<%H>Hour (00-23). 1965=item B<--use-color>, B<--no-use-color>
1981 1966
1982 B<%I>The value of ISO tag, if defined. 1967Colorize output. This does NOT work under Windows.
1983 1968
1984 B<%i>FileNumber tag if exists (otherwise, it is replaced by string 1969=item B<--dry-run>
1985C<NA>).
1986 1970
1987 B<%M>Minute (00-59). 1971Do not do anything, only print would have been done.
1988 1972
1989 B<%m>Month (01-12). 1973=item B<-g> or B<--generate-thumb>
1990 1974
1991 B<%n>Previous filename (the one before B<renrot> started processing). 1975Generation and writing ThumbnailImage tag. The original value of the ThumbnailImage
1976tag remains intact. To rewrite it you need to delete it first (look exiftool examples).
1992 1977
1993 B<%O>Base part of the original filename (see B<%o>). In other words, the 1978=item B<--use-ipc>, B<--no-use-ipc>
1994first part from the beginning to the last dot character.
1995 1979
1996 B<%o>The name file had before it was processed by B<renrot> for the first 1980Rotate thumbnails using pipe, rather than files. This does NOT work under
1997time. If the file was processed only once, the tag RenRotFileNameOriginal is 1981Windows.
1998set to the original file name.
1999 1982
2000 B<%S>Second (00-59) 1983=item B<-v>
2001 1984
2002 B<%W>The value of WhiteBalance tag, if defined. 1985Increase debugging level by 1. Debugging levels from 1 to 4 are internal
1986levels, the levels from 5 till 9 are equivalent to levels 1-5 levels ExifTool
1987with the maximum verbosity for B<renrot>.
2003 1988
2004 B<%Y>Year with the century (1900, 1901, and so on) 1989=item B<-?> or B<--help>
2005 1990
2006 B<%y>Year without a century (00..99) 1991Display short usage summary and exit.
2007 1992
2008You can use value of any EXIF tag to be included as name part. To do that you 1993=item B<--version>
2009need to embrace tag name with sign B<"#">, while building name template
2010(see L</TEMPLATE EXAMPLES>).
2011 1994
2012Be careful, since any binary EXIF (like ThumbnaiImage) can produce totally 1995Output version information and exit.
2013unexpected results.
2014 1996
2015=back 1997=back
2016 1998
2017=item B<--no-rename> 1999=head1 B<AGGREGATION>
2018
2019Do not rename files (default is to rename them to YYYYmmddHHMMSS.ext)
2020
2021=item B<--counter-fixed-field>, B<--no-counter-fixed-field>
2022
2023Set fixed length for file counter, used in file name templates (see B<%c>).
2024It is enabled by default. Use B<--no-counter-fixed-field> to undo its effect.
2025
2026=item B<--counter-start> I<NUMBER>
2027
2028Initial value for the file counter (default is I<1>)
2029
2030=item B<--counter-step> I<NUMBER>
2031
2032Step to increment file counter with (default is I<1>)
2033
2034=item B<-r> or B<--rotate-angle> I<ANGLE>
2035
2036Define the angle to rotate files and thumbnails. Allowed values for I<ANGLE>
2037are 90, 180 or 270. It is useful for files not having Orientation tag.
2038
2039=item B<--rotate-thumb> I<ANGLE>
2040
2041Rotate only thumbnails. Allowed values for I<ANGLE> are 90, 180 or 270 degrees.
2042Use if the files which were already rotated, but their thumbnails were not.
2043
2044=item B<--only-orientation>
2045
2046Rotate by changing the value of Orientation tag, no real rotation will be
2047made. The sequence of values to rotate an image from normal (0 degrees) by
204890 degrees clockwise is: 0 -> 90 -> 180 -> 270 -> 0. It means. set Orientation
2049tag to 90cw after the first rotation, and increase that value by 90 each time
2050the rotation is applied. For 270cw the rotation algorithm uses the reverted
2051sequence. Rotation by 180cw triggers values in two pairs: 0 <-> 180
2052and 90 <-> 270. This option cannot be applied to mirror values of Orientation
2053tag.
2054
2055=item B<--trim>, B<--no-trim>
2056
2057Pass the C<-trim> option to L<jpegtran(1)>, to trim if needed. By default,
2058trimming is enabled. Use B<--no-trim> to disable it.
2059
2060=item B<--no-rotate>
2061
2062Do not rotate images (default is to rotate according to EXIF data).
2063
2064=item B<--mtime>, B<--no-mtime>
2065 2000
2066Defines whether to set the file's mtime, using DateTimeOriginal tag value. 2001=over
2067Use B<--no-mtime> to set it to current time stamp after processing.
2068
2069=item B<--no-renrot> or B<--nochg>
2070
2071Do not rename, rotate, tag and mtime images. It saves files from any changes
2072while allows to do aggregation, contact sheet generation e.t.c.
2073
2074=item B<--keywords>, B<--no-keywords>
2075
2076Whether to fill Keywords tag. Default is to not. Be careful, since with this option
2077enabled, the existing keywords are rewriten. The keywords are taken from
2078F<.keywords> file or file specified with option B<--keywords-file>.
2079
2080=item B<-k> or B<--keywords-file> F<FILE>
2081
2082Path to the file with keywords. Its format is a keyword per line. The CR and
2083LF symbols are removed. Empty (only whitespace) lines are ignored. Any leading
2084and trailing whitespace is removed. For example, the line C< _Test_ CRLF> is
2085read as C<_Test_>.
2086
2087=item B<--keywords-replace>, B<--no-keywords-replace>
2088
2089Replace existing Keywords tag list rather than add new values to it. Default
2090is not to replace.
2091 2002
2092=item B<--aggr-mode> I<MODE> 2003=item B<--aggr-mode> I<MODE>
2093 2004
@@ -2124,54 +2035,6 @@ B<--aggr-virtual> is that any files to be aggregated remain untouched in their
2124places, and relative symbolic links pointing to them are stored in the 2035places, and relative symbolic links pointing to them are stored in the
2125directory tree created. Use B<--no-aggr-virtual> to prevent virtualization. 2036directory tree created. Use B<--no-aggr-virtual> to prevent virtualization.
2126 2037
2127=item B<--comment-file> F<FILE>
2128
2129File with commentaries. It is a low priority alias to I<TagFile = Comment: FILE>.
2130
2131=item B<--user-comment> I<STRING>
2132
2133A low priority alias to I<--tag UserComment: STRING>
2134
2135=item B<-t> or B<--tag> I<TAG>
2136
2137See the section L</TAGS>, for the detailed description
2138
2139=item B<--no-tags>
2140
2141No user's defined tags will be written.
2142
2143=item B<--use-color>, B<--no-use-color>
2144
2145Colorize output. This does NOT work under Windows.
2146
2147=item B<--dry-run>
2148
2149Do not do anything, only print would have been done.
2150
2151=item B<-g> or B<--generate-thumb>
2152
2153Generation and writing ThumbnailImage tag. The original value of the ThumbnailImage
2154tag remains intact. To rewrite it you need to delete it first (look exiftool examples).
2155
2156=item B<--use-ipc>, B<--no-use-ipc>
2157
2158Rotate thumbnails using pipe, rather than files. This does NOT work under
2159Windows.
2160
2161=item B<-v>
2162
2163Increase debugging level by 1. Debugging levels from 1 to 4 are internal
2164levels, the levels from 5 till 9 are equivalent to levels 1-5 levels ExifTool
2165with the maximum verbosity for B<renrot>.
2166
2167=item B<-?> or B<--help>
2168
2169Display short usage summary and exit.
2170
2171=item B<--version>
2172
2173Output version information and exit.
2174
2175=back 2038=back
2176 2039
2177=head1 B<CONTACT SHEET GENERATOR> 2040=head1 B<CONTACT SHEET GENERATOR>
@@ -2298,6 +2161,179 @@ Only the files found in the file will be ranked.
2298 2161
2299=back 2162=back
2300 2163
2164=head1 B<KEYWORDIZER>
2165
2166=over
2167
2168=item B<--keywords>, B<--no-keywords>
2169
2170Whether to fill Keywords tag. Default is to not. Be careful, since with this option
2171enabled, the existing keywords are rewriten. The keywords are taken from
2172F<.keywords> file or file specified with option B<--keywords-file>.
2173
2174=item B<-k> or B<--keywords-file> F<FILE>
2175
2176Path to the file with keywords. Its format is a keyword per line. The CR and
2177LF symbols are removed. Empty (only whitespace) lines are ignored. Any leading
2178and trailing whitespace is removed. For example, the line C< _Test_ CRLF> is
2179read as C<_Test_>.
2180
2181=item B<--keywords-replace>, B<--no-keywords-replace>
2182
2183Replace existing Keywords tag list rather than add new values to it. Default
2184is not to replace.
2185
2186=back
2187
2188=head1 B<RENAMING>
2189
2190=over
2191
2192=item B<-n> or B<--name-template> I<TEMPLATE>
2193
2194A template to use for creating new file names while renaming. It can also be
2195defined in the configuration file (variable Name Template). The default is
2196I<%Y%m%d%H%M%S>. For practical uses, see L</TEMPLATE EXAMPLES> section.
2197
2198Interpreted sequences are:
2199
2200=over
2201
2202 B<%%>a literal %
2203
2204 B<%#>a literal #
2205
2206 B<%C>Numeric part of the original file name. Implemented for the sake
2207of cameras, that do not supply FileNumber EXIF tag (currently all makes,
2208except I<Canon>). Such cameras generate file names starting with letters
2209and ended with digits. No other symbols are allowed in file names, except
2210C<->, C<.> and C<_>.
2211
2212 B<%c>Ordinal number of file in the processed file set (see also
2213B<--counter-fixed-field> option).
2214
2215 B<%d>Day of month (01-31).
2216
2217 B<%E>The value of ExposureTime tag, if defined.
2218
2219 B<%e>Old file extension
2220
2221 B<%F>The value of FNumber tag, if defined.
2222
2223 B<%H>Hour (00-23).
2224
2225 B<%I>The value of ISO tag, if defined.
2226
2227 B<%i>FileNumber tag if exists (otherwise, it is replaced by string
2228C<NA>).
2229
2230 B<%M>Minute (00-59).
2231
2232 B<%m>Month (01-12).
2233
2234 B<%n>Previous filename (the one before B<renrot> started processing).
2235
2236 B<%O>Base part of the original filename (see B<%o>). In other words, the
2237first part from the beginning to the last dot character.
2238
2239 B<%o>The name file had before it was processed by B<renrot> for the first
2240time. If the file was processed only once, the tag RenRotFileNameOriginal is
2241set to the original file name.
2242
2243 B<%S>Second (00-59)
2244
2245 B<%W>The value of WhiteBalance tag, if defined.
2246
2247 B<%Y>Year with the century (1900, 1901, and so on)
2248
2249 B<%y>Year without a century (00..99)
2250
2251You can use value of any EXIF tag to be included as name part. To do that you
2252need to embrace tag name with sign B<"#">, while building name template
2253(see L</TEMPLATE EXAMPLES>).
2254
2255Be careful, since any binary EXIF (like ThumbnaiImage) can produce totally
2256unexpected results.
2257
2258=back
2259
2260=item B<--no-rename>
2261
2262Do not rename files (default is to rename them to YYYYmmddHHMMSS.ext)
2263
2264=item B<--counter-fixed-field>, B<--no-counter-fixed-field>
2265
2266Set fixed length for file counter, used in file name templates (see B<%c>).
2267It is enabled by default. Use B<--no-counter-fixed-field> to undo its effect.
2268
2269=item B<--counter-start> I<NUMBER>
2270
2271Initial value for the file counter (default is I<1>)
2272
2273=item B<--counter-step> I<NUMBER>
2274
2275Step to increment file counter with (default is I<1>)
2276
2277=back
2278
2279=head1 B<ROTATING>
2280
2281=over
2282
2283=item B<-r> or B<--rotate-angle> I<ANGLE>
2284
2285Define the angle to rotate files and thumbnails. Allowed values for I<ANGLE>
2286are 90, 180 or 270. It is useful for files not having Orientation tag.
2287
2288=item B<--rotate-thumb> I<ANGLE>
2289
2290Rotate only thumbnails. Allowed values for I<ANGLE> are 90, 180 or 270 degrees.
2291Use if the files which were already rotated, but their thumbnails were not.
2292
2293=item B<--only-orientation>
2294
2295Rotate by changing the value of Orientation tag, no real rotation will be
2296made. The sequence of values to rotate an image from normal (0 degrees) by
229790 degrees clockwise is: 0 -> 90 -> 180 -> 270 -> 0. It means. set Orientation
2298tag to 90cw after the first rotation, and increase that value by 90 each time
2299the rotation is applied. For 270cw the rotation algorithm uses the reverted
2300sequence. Rotation by 180cw triggers values in two pairs: 0 <-> 180
2301and 90 <-> 270. This option cannot be applied to mirror values of Orientation
2302tag.
2303
2304=item B<--trim>, B<--no-trim>
2305
2306Pass the C<-trim> option to L<jpegtran(1)>, to trim if needed. By default,
2307trimming is enabled. Use B<--no-trim> to disable it.
2308
2309=item B<--no-rotate>
2310
2311Do not rotate images (default is to rotate according to EXIF data).
2312
2313=back
2314
2315=head1 B<TAG WRITER>
2316
2317=over
2318
2319=item B<--comment-file> F<FILE>
2320
2321File with commentaries. It is a low priority alias to I<TagFile = Comment: FILE>.
2322
2323=item B<--user-comment> I<STRING>
2324
2325A low priority alias to I<--tag UserComment: STRING>
2326
2327=item B<-t> or B<--tag> I<TAG>
2328
2329See the section L</TAGS>, for the detailed description
2330
2331=item B<--no-tags>
2332
2333No user's defined tags will be written.
2334
2335=back
2336
2301=head1 B<TEMPLATE EXAMPLES> 2337=head1 B<TEMPLATE EXAMPLES>
2302 2338
2303The name template C<01.%c.%Y%m%d%H%M%S.%i.shtr-%E.f-%F.wb-%W.iso-%I> (where 2339The name template C<01.%c.%Y%m%d%H%M%S.%i.shtr-%E.f-%F.wb-%W.iso-%I> (where

Return to:

Send suggestions and report system problems to the System administrator.