From 204a0243ad080eb6432f3ff36d2137ba9006169b Mon Sep 17 00:00:00 2001 From: Andy Shevchenko Date: Sat, 28 Jul 2012 18:56:40 +0000 Subject: 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 git-svn-id: file:///svnroot/renrot/trunk@616 fe2816f4-e837-0410-b10a-f608c9d244a1 --- renrot | 398 +++++++++++++++++++++++++++++++++++------------------------------ 1 file changed, 217 insertions(+), 181 deletions(-) (limited to 'renrot') diff --git a/renrot b/renrot index 722d921..0b25b4c 100755 --- a/renrot +++ b/renrot @@ -371,29 +371,35 @@ sub getOptions { "keywords-file|k=s" => \$h_kw_opts{'file'}, "keywords-replace!" => \$h_kw_opts{'replace'}, - # OTHERS - "backup!" => \$backup, - "comment-file=s" => \$comfile, - "config-file|c=s" => \$configFile, + # RENAMIMG "counter-fixed-field!" => \$countFF, "counter-start=i" => \$countStart, "counter-step=i" => \$countStep, + "no-rename|norename" => \$noRename, + + # ROTATIMG + "no-rotate|norotate" => \$noRotation, + "only-orientation" => \$orientTag, + "rotate-angle|r=i" => \$rotateAngle, + "rotate-thumb=i" => \$rotateThumbnail, + + # TAG WRITER + "comment-file=s" => \$comfile, + "no-tags|notags" => \$noTags, + "tag|t=s" => \@tmpTags, + "user-comment=s" => \$userComment, + + # OTHERS + "backup!" => \$backup, + "config-file|c=s" => \$configFile, "dry-run" => \$dryRun, "exclude=s" => \@excludeList, "extension|e=s" => \$extToProcess, "generate-thumb|g" => \$gen_thm, "help|?" => sub { usage(0, 2) }, - "no-rename|norename" => \$noRename, - "no-rotate|norotate" => \$noRotation, - "no-tags|notags" => \$noTags, "no-renrot|nochg" => \$noRenRoTagMtm, - "only-orientation" => \$orientTag, "quiet|q" => \$quiet, - "rotate-angle|r=i" => \$rotateAngle, - "rotate-thumb=i" => \$rotateThumbnail, "sub-fileset=s" => \$subFileSet, - "tag|t=s" => \@tmpTags, - "user-comment=s" => \$userComment, "v+" => \$verbose, "version" => sub { usage(0, 0) }, "work-directory|d=s" => \$workDir, @@ -1946,148 +1952,53 @@ Process the files with given I (JPG, jpeg, CRW, crw, etc). Depending on the operating system, the extension search might or might not be case-sensitive. -=item B<-n> or B<--name-template> I section. - -Interpreted sequences are: - -=over - -B<%%> a literal % - -B<%#> a literal # - -B<%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 I). Such cameras generate file names starting with letters -and ended with digits. No other symbols are allowed in file names, except -C<->, C<.> and C<_>. - -B<%c> Ordinal number of file in the processed file set (see also -B<--counter-fixed-field> option). - -B<%d> Day of month (01-31). +=item B<--mtime>, B<--no-mtime> -B<%E> The value of ExposureTime tag, if defined. +Defines whether to set the file's mtime, using DateTimeOriginal tag value. +Use B<--no-mtime> to set it to current time stamp after processing. -B<%e> Old file extension +=item B<--no-renrot> or B<--nochg> -B<%F> The value of FNumber tag, if defined. +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. -B<%H> Hour (00-23). +=item B<--use-color>, B<--no-use-color> -B<%I> The value of ISO tag, if defined. +Colorize output. This does NOT work under Windows. -B<%i> FileNumber tag if exists (otherwise, it is replaced by string -C). +=item B<--dry-run> -B<%M> Minute (00-59). +Do not do anything, only print would have been done. -B<%m> Month (01-12). +=item B<-g> or B<--generate-thumb> -B<%n> Previous filename (the one before B started processing). +Generation and writing ThumbnailImage tag. The original value of the ThumbnailImage +tag remains intact. To rewrite it you need to delete it first (look exiftool examples). -B<%O> Base part of the original filename (see B<%o>). In other words, the -first part from the beginning to the last dot character. +=item B<--use-ipc>, B<--no-use-ipc> -B<%o> The name file had before it was processed by B for the first -time. If the file was processed only once, the tag RenRotFileNameOriginal is -set to the original file name. +Rotate thumbnails using pipe, rather than files. This does NOT work under +Windows. -B<%S> Second (00-59) +=item B<-v> -B<%W> The value of WhiteBalance tag, if defined. +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 B. -B<%Y> Year with the century (1900, 1901, and so on) +=item B<-?> or B<--help> -B<%y> Year without a century (00..99) +Display short usage summary and exit. -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 B<"#">, while building name template -(see L). +=item B<--version> -Be careful, since any binary EXIF (like ThumbnaiImage) can produce totally -unexpected results. +Output version information and exit. =back -=item B<--no-rename> - -Do not rename files (default is to rename them to YYYYmmddHHMMSS.ext) - -=item B<--counter-fixed-field>, B<--no-counter-fixed-field> - -Set fixed length for file counter, used in file name templates (see B<%c>). -It is enabled by default. Use B<--no-counter-fixed-field> to undo its effect. - -=item B<--counter-start> I - -Initial value for the file counter (default is I<1>) - -=item B<--counter-step> I - -Step to increment file counter with (default is I<1>) - -=item B<-r> or B<--rotate-angle> I - -Define the angle to rotate files and thumbnails. Allowed values for I -are 90, 180 or 270. It is useful for files not having Orientation tag. - -=item B<--rotate-thumb> I - -Rotate only thumbnails. Allowed values for I are 90, 180 or 270 degrees. -Use if the files which were already rotated, but their thumbnails were not. - -=item B<--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. - -=item B<--trim>, B<--no-trim> - -Pass the C<-trim> option to L, to trim if needed. By default, -trimming is enabled. Use B<--no-trim> to disable it. - -=item B<--no-rotate> - -Do not rotate images (default is to rotate according to EXIF data). - -=item B<--mtime>, B<--no-mtime> +=head1 B -Defines whether to set the file's mtime, using DateTimeOriginal tag value. -Use B<--no-mtime> to set it to current time stamp after processing. - -=item B<--no-renrot> or B<--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. - -=item B<--keywords>, B<--no-keywords> - -Whether to fill Keywords tag. Default is to not. Be careful, since with this option -enabled, the existing keywords are rewriten. The keywords are taken from -F<.keywords> file or file specified with option B<--keywords-file>. - -=item B<-k> or B<--keywords-file> F - -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 C< _Test_ CRLF> is -read as C<_Test_>. - -=item B<--keywords-replace>, B<--no-keywords-replace> - -Replace existing Keywords tag list rather than add new values to it. Default -is not to replace. +=over =item B<--aggr-mode> I @@ -2124,54 +2035,6 @@ B<--aggr-virtual> is that any files to be aggregated remain untouched in their places, and relative symbolic links pointing to them are stored in the directory tree created. Use B<--no-aggr-virtual> to prevent virtualization. -=item B<--comment-file> F - -File with commentaries. It is a low priority alias to I. - -=item B<--user-comment> I - -A low priority alias to I<--tag UserComment: STRING> - -=item B<-t> or B<--tag> I - -See the section L, for the detailed description - -=item B<--no-tags> - -No user's defined tags will be written. - -=item B<--use-color>, B<--no-use-color> - -Colorize output. This does NOT work under Windows. - -=item B<--dry-run> - -Do not do anything, only print would have been done. - -=item B<-g> or B<--generate-thumb> - -Generation and writing ThumbnailImage tag. The original value of the ThumbnailImage -tag remains intact. To rewrite it you need to delete it first (look exiftool examples). - -=item B<--use-ipc>, B<--no-use-ipc> - -Rotate thumbnails using pipe, rather than files. This does NOT work under -Windows. - -=item B<-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 B. - -=item B<-?> or B<--help> - -Display short usage summary and exit. - -=item B<--version> - -Output version information and exit. - =back =head1 B @@ -2298,6 +2161,179 @@ Only the files found in the file will be ranked. =back +=head1 B + +=over + +=item B<--keywords>, B<--no-keywords> + +Whether to fill Keywords tag. Default is to not. Be careful, since with this option +enabled, the existing keywords are rewriten. The keywords are taken from +F<.keywords> file or file specified with option B<--keywords-file>. + +=item B<-k> or B<--keywords-file> F + +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 C< _Test_ CRLF> is +read as C<_Test_>. + +=item B<--keywords-replace>, B<--no-keywords-replace> + +Replace existing Keywords tag list rather than add new values to it. Default +is not to replace. + +=back + +=head1 B + +=over + +=item B<-n> or B<--name-template> I section. + +Interpreted sequences are: + +=over + +B<%%> a literal % + +B<%#> a literal # + +B<%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 I). Such cameras generate file names starting with letters +and ended with digits. No other symbols are allowed in file names, except +C<->, C<.> and C<_>. + +B<%c> Ordinal number of file in the processed file set (see also +B<--counter-fixed-field> option). + +B<%d> Day of month (01-31). + +B<%E> The value of ExposureTime tag, if defined. + +B<%e> Old file extension + +B<%F> The value of FNumber tag, if defined. + +B<%H> Hour (00-23). + +B<%I> The value of ISO tag, if defined. + +B<%i> FileNumber tag if exists (otherwise, it is replaced by string +C). + +B<%M> Minute (00-59). + +B<%m> Month (01-12). + +B<%n> Previous filename (the one before B started processing). + +B<%O> Base part of the original filename (see B<%o>). In other words, the +first part from the beginning to the last dot character. + +B<%o> The name file had before it was processed by B for the first +time. If the file was processed only once, the tag RenRotFileNameOriginal is +set to the original file name. + +B<%S> Second (00-59) + +B<%W> The value of WhiteBalance tag, if defined. + +B<%Y> Year with the century (1900, 1901, and so on) + +B<%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 B<"#">, while building name template +(see L). + +Be careful, since any binary EXIF (like ThumbnaiImage) can produce totally +unexpected results. + +=back + +=item B<--no-rename> + +Do not rename files (default is to rename them to YYYYmmddHHMMSS.ext) + +=item B<--counter-fixed-field>, B<--no-counter-fixed-field> + +Set fixed length for file counter, used in file name templates (see B<%c>). +It is enabled by default. Use B<--no-counter-fixed-field> to undo its effect. + +=item B<--counter-start> I + +Initial value for the file counter (default is I<1>) + +=item B<--counter-step> I + +Step to increment file counter with (default is I<1>) + +=back + +=head1 B + +=over + +=item B<-r> or B<--rotate-angle> I + +Define the angle to rotate files and thumbnails. Allowed values for I +are 90, 180 or 270. It is useful for files not having Orientation tag. + +=item B<--rotate-thumb> I + +Rotate only thumbnails. Allowed values for I are 90, 180 or 270 degrees. +Use if the files which were already rotated, but their thumbnails were not. + +=item B<--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. + +=item B<--trim>, B<--no-trim> + +Pass the C<-trim> option to L, to trim if needed. By default, +trimming is enabled. Use B<--no-trim> to disable it. + +=item B<--no-rotate> + +Do not rotate images (default is to rotate according to EXIF data). + +=back + +=head1 B + +=over + +=item B<--comment-file> F + +File with commentaries. It is a low priority alias to I. + +=item B<--user-comment> I + +A low priority alias to I<--tag UserComment: STRING> + +=item B<-t> or B<--tag> I + +See the section L, for the detailed description + +=item B<--no-tags> + +No user's defined tags will be written. + +=back + =head1 B