diff --git a/man/man1/exiv2.md b/man/man1/exiv2.md index d427923c..50aa46f0 100644 --- a/man/man1/exiv2.md +++ b/man/man1/exiv2.md @@ -9,12 +9,12 @@ exiv2 - Image metadata manipulation tool
-# SYNOPSIS -**exiv2** [ *option* [ *arg* ] ]+ [ *action* ] *file* ... +# 1 SYNOPSIS +**exiv2** [ **option** [ *arg* ] ]+ [ *action* ] *file* ...
-# DESCRIPTION +# 2 DESCRIPTION **exiv2** is a program to read and write image metadata, including Exif, IPTC, XMP, image comments, ICC Profile, thumbnails, image previews and many vendor makernote tags. The program optionally @@ -27,58 +27,62 @@ guidelines. ### TABLE OF CONTENTS 1. [SYNOPSIS](#synopsis) 2. [DESCRIPTION](#description) -1. [FILE TYPES](#file_types) -2. [ACTIONS](#actions) -3. [COMMAND SUMMARY](#cmd_summary) -4. [OPTIONS](#options) -5. ['MODIFY' COMMANDS](#modify_cmds) - 1. [Quotations with 'modify' commands](#quotes_modify) - 2. ['Modify' command format](#mod_cmd_format) - 3. ['Modify' examples](#mod_examples) - 3. ['Modify' command file](#modify_cmd_file) -6. [EXIV2 GROUPS, TYPES AND VALUES](#groups_types_values) - 1. [Exiv2 tags](#exiv2_tags) - 2. [Exif/IPTC/XMP types](#exiv2_types) - 3. [Exiv2 key syntax](#exiv2_key_syntax) +3. [FILE TYPES](#file_types) +4. [ACTIONS](#actions) +5. [COMMAND SUMMARY](#cmd_summary) +6. [OPTIONS](#options) +7. [EXIV2 GROUPS, TYPES AND VALUES](#groups_types_values) + 1. [Exiv2 key syntax](#exiv2_key_syntax) + 2. [Exiv2 tags](#exiv2_tags) + 3. [Exif/IPTC/XMP types](#exiv2_types) 4. [Multiple elements](#multi_elements) - 5. [Duplicate Exif tags](#multi_exif_tags) + 5. [Duplicate tags](#multi_tags) 6. [Date/Time formats](#date_time_fmts) 7. [Exif 'Comment' values](#exif_comment_values) 8. [XMP namespaces](#xmp_namespaces) 9. [XMP LangAlt values](#langalt_values) 10. [XMP structs](#xmp_structs) -7. [CONFIGURATION FILE](#config_file) -8. [EXAMPLES](#examples) -9. [ENVIRONMENT](#environment) -10. [NOTES](#notes) -11. [BUGS](#bugs) -12. [COPYRIGHT](#copyright) -13. [SEE ALSO](#see_also) -14. [AUTHORS](#authors) +8. [PREVIEW IMAGES AND THUMBNAILS](#preview_images) +9. [ICC PROFILES](#icc_profiles) +10. [IMAGE COMMENTS](#image_comments) +11. ['MODIFY' COMMANDS](#modify_cmds) + 1. [Quotations with 'modify' commands](#quotes_modify) + 2. ['Modify' command format](#mod_cmd_format) + 3. [Modifying a value](#mod_value) + 4. ['Modify' examples](#mod_examples) + 5. ['Modify' command file](#mod_cmd_file) +12. [CONFIGURATION FILE](#config_file) +13. [EXAMPLES](#examples) +14. [ENVIRONMENT](#environment) +15. [NOTES](#notes) +16. [BUGS](#bugs) +17. [COPYRIGHT](#copyright) +18. [AUTHORS](#authors) +19. [SEE ALSO](#see_also)
-# FILE TYPES +# 3 FILE TYPES The following image formats and metadata categories are supported:
Type | Exif | IPTC | XMP | Image Comments | ICC Profile | Thumbnail |:---|:---- |:---- |:---- |:---- |:---- |:---- -ARW | Read | Read | Read | - | - | Read +ARW | Read/Write | Read/Write | Read/Write | - | Read/Write | Read/Write AVIF | Read | Read | Read | - | - | Read BMP | - | - | - | - | - | - CR2 | Read/Write | Read/Write | Read/Write | - | Read/Write | Read/Write -CR3 | Read | Read | Read | - | - | - +CR3 | Read | Read | Read | - | - | Read CRW | Read/Write | - | - | Read/Write | - | Read/Write DNG | Read/Write | Read/Write | Read/Write | - | Read/Write | Read/Write EPS | - | - | Read/Write | | - | - EXV | Read/Write | Read/Write | Read/Write | Read/Write | Read/Write | Read/Write GIF | - | - | - | - | - | - -HEIC | Read | Read | Read | - | - | - -HEIF | Read | Read | Read | - | - | - +HEIC | Read | Read | Read | - | - | Read +HEIF | Read | Read | Read | - | - | Read JP2 | Read/Write | Read/Write | Read/Write | - | Read/Write | Read/Write JPEG | Read/Write | Read/Write | Read/Write | Read/Write | Read/Write | Read/Write -JXL | Read | Read | Read | - | - | - +JXL | Read | Read | Read | - | - | Read MRW | Read | Read | Read | - | - | Read NEF | Read/Write | Read/Write | Read/Write | - | Read/Write | Read/Write ORF | Read/Write | Read/Write | Read/Write | - | - | Read/Write @@ -105,49 +109,49 @@ the table, may also work. + Some image formats allow an extra interal type of metadata. Only partial support exists for the RAF format. -+ Support for BMFF types such as CR3, HEIF and HEIC is a build option. To -check if enabled, use `exiv2 --version --verbose --grep bmff` and see if -`enable_bmff=1`. ++ Support for BMFF types such as AVIF, CR3, HEIF and HEIC is a build +option. To check if this is enabled, use `exiv2 --version --verbose --grep bmff` +and see if `enable_bmff=1`. + Naked codestream JXL files do not contain Exif, IPTC or XMP metadata. -+ The thumbnail, if available, is included in the list of image previews. - + [TOC](#TOC)
-# ACTIONS +# 4 ACTIONS The *action* argument is only required if it is not clear from the *options* which action is implied.
### pr | print -Print image metadata. This is the default action, i.e., the command -`exiv2 image.jpg` will print a summary of the image Exif metadata. +Print image metadata, the default is [--print s](#print_mod). This is also +the default action (i.e., `exiv2 image.jpg`).
### ex | extract -Extract metadata to \*.exv, XMP sidecar (\*.xmp), preview image, -thumbnail or ICC profile file. Modification commands can be applied -on-the-fly. +Extract metadata to "raw" metadata (\*.exv), XMP sidecar (\*.xmp), +preview image, thumbnail or ICC profile file. The default is [--extract XXei](#extract_tgt3). +Use [--location dir](#location_dir) to direct the output to a different +directory. Modification commands can be applied on-the-fly.
### in | insert -Insert metadata from corresponding \*.exv, XMP sidecar (\*.xmp), -thumbnail or ICC profile files. Use option [--suffix suf](#suffix_suf) -to change the suffix of the input files. Since files of any supported -format can be used as input files, this command can be used to copy -the metadata between files of different formats. Modification commands -can be applied on-the-fly. +Insert metadata from corresponding "raw" metadata (\*.exv), XMP sidecar (\*.xmp), +thumbnail or ICC profile files, the default is [--insert XXeix](#insert_tgt2). +Use [--location dir](#location_dir) to direct the input from a different +directory and [--suffix suf](#suffix_suf) for the output extension. Since +files of any supported format can be used as input files, this command +can be used to copy the metadata between files of different formats.
### rm | delete -Delete image metadata from the files. +Delete image metadata from the files, the default is [--delete a](#delete_tgt1).
@@ -167,9 +171,10 @@ or [--Modify cmd](#Modify_cmd). ### mv | rename Rename files and/or set file timestamps according to the Exif create -timestamp. Uses the value of [Exif.Photo.DateTimeOriginal](https://www.exiv2.org/tags.html) -tag or, if not present, [Exif.Image.DateTime](https://www.exiv2.org/tags.html) -to determine the timestamp. The filename format can be set with [--rename fmt](#rename_fmt), +timestamp. The default filename format is in [--rename fmt](#rename_fmt). +Uses the value of [Exif.Photo.DateTimeOriginal](https://www.exiv2.org/tags.html) +or, [Exif.Image.DateTime](https://www.exiv2.org/tags.html) to determine +the timestamp. The filename format can be set with [--rename fmt](#rename_fmt), timestamp options are [--timestamp](#timestamp) and [--Timestamp](#Timestamp). See [TZ environment variable](#TZ). @@ -193,16 +198,16 @@ specify the current encoding of the comment if necessary.
-# COMMAND SUMMARY +# 5 COMMAND SUMMARY -**exiv2** [ *option* [ *arg* ] ]+ [ *action* ] *file* ...
+**exiv2** [ **option** [ *arg* ] ]+ [ *action* ] *file* ...
Where *file* is one or more files containing image metadata. These can optionally be specified using a URL (http, https, ftp, sftp, data -and file supported) or a wildcard pattern (e.g., `image1.tiff image2.jpg`, -`https://clanmills.com/Stonehenge.jpg` or `*.jpg`) +and file supported) or a wildcard pattern (e.g., *image1.tiff image2.jpg*, +*https://clanmills.com/Stonehenge.jpg* or *\*.jpg*) -| Option | Long option | Description | +| **Option** *arg* | **Long option** *arg* | Description | |:------ |:---- |:---- | | **-a** *time* | **--adjust** *time* | Automatically modify metadata time stamps. For the [adjust](#ad_adjust) action [[...]](#adjust_time) | | **-b** | **--binary** | Obsolete and should not be used. Reserved for use with the test suite | @@ -239,21 +244,21 @@ and file supported) or a wildcard pattern (e.g., `image1.tiff image2.jpg`, The arguments for those options are: -| Argument | Description | +| *arg* | Description | |:------ |:---- | | *action* | pr \| ex \| in \| rm \| ad \| mo \| mv \| fi \| fc
(print, extract, insert, delete, adjust, modify, rename, fixiso, fixcom) | | *cmd* | (**set** \| **add**) *key* [[*type*] *value*] \| **del** *key* [*type*] \| **reg** *prefix* *namespace*
(see ['Modify' command format](#mod_cmd_format)) | | *enc* | Values defined in [iconv_open(3)](https://linux.die.net/man/3/iconv_open) (e.g., UTF-8) | | *flg* | E \| I \| X \| x \| g \| k \| l \| n \| y \| c \| s \| v \| t \| h
(Exif, IPTC, XMP, num, grp, key, label, name, type, count, size, vanilla, translated, hex) | | *fmt* | Default format: %Y%m%d_%H%M%S | -| *key* | See [Exiv2 key syntax](#exiv2_key_syntax)) | +| *key* | See [Exiv2 key syntax](#exiv2_key_syntax) | | *lvl* | d \| i \| w \| e \| m
(debug, info, warning, error, mute) | | *mod* | s \| a \| e \| t \| v \| h \| i \| x \| c \| p \| C \| R \| S \| X
(summary, all, Exif, translated, vanilla, hex, IPTC, XMP, comment, preview, ICC Profile, Recursive Structure, Simple Structure, raw XMP) | | *suf* | '.' then the file's extension (e.g., '.txt') | -| *time* | [ +\|-]HH[:MM[:SS[.mmm]]]
(Default is **+** when **+**/**-** are missing) | +| *time* | [+\|-]HH[:MM[:SS]]
(Default is **+** when **+**/**-** are missing) | | *tgt1* | a \| c \| e \| i \| I \| t \| x \| C \| -
(all, comment, Exif, IPTC, IPTC all, thumbnail, XMP, ICC Profile, stdin/out) | -| *tgt2* | a \| c \| e \| i \| t \| x \| C \| X \| XX \| -
(all, comment, Exif, IPTC, thumbnail, XMP, ICC Profile, SideCar, Raw XMP, stdin/out) | -| *tgt3* | a \| e \| i \| p \| t \| x \| C \| X \| XX \| -
(all, Exif, IPTC, preview, thumbnail, XMP, ICC Profile, SideCar, Raw XMP, stdin/out) | +| *tgt2* | a \| c \| e \| i \| t \| x \| C \| X \| XX \| -
(all, comment, Exif, IPTC, thumbnail, XMP, ICC Profile, SideCar, Raw metadata, stdin/out) | +| *tgt3* | a \| e \| i \| p \| t \| x \| C \| X \| XX \| -
(all, Exif, IPTC, preview, thumbnail, XMP, ICC Profile, SideCar, Raw metadata, stdin/out) | | *type* | An Exif, IPTC or XMP tag type (e.g., xmpText). See [Exif/IPTC/XMP types](#exiv2_types) | | *+-n* | The amount to change in the date (e.g., -3). Default is **+** when **+**/**-** are missing | @@ -261,7 +266,7 @@ The arguments for those options are:
-# OPTIONS +# 6 OPTIONS
@@ -298,7 +303,7 @@ time. ### **-Q** *lvl*, **--log** *lvl* Set the log-level to 'd'(ebug), 'i'(nfo), 'w'(arning), 'e'(rror) or 'm'(ute), with the *lvl* chosen including those below it -('d' <- 'i' <- 'w' <- 'e'). The default log-level is 'w'. **--log** *m* +('d' \<- 'i' \<- 'w' \<- 'e'). The default log-level is 'w'. **--log** *m* is equivalent to [--quiet](#quiet). All log messages are written to standard error. @@ -483,9 +488,9 @@ Renaming file to ./Stonehenge_16_Jul_2015_1.jpg
### **-a** *time*, **--adjust** *time* -Time adjustment, where *time* is in the format [-]HH[:MM[:SS]]. This -option is only used with the [adjust](#ad_adjust) action. See [TZ](#TZ) -environment variable. +Adjusts the times in standard Exif tags, where *time* is in the format: +[+\|-]HH[:MM[:SS]]. This option is only used with the [adjust](#ad_adjust) +action. See [TZ](#TZ) environment variable. Examples of *time* are: @@ -530,9 +535,9 @@ Possible modes are: | h | Hex dump of the Exif data (shortcut for [--Print Exgnycsh](#Print_flgs)) | | i | IPTC tags (shortcut for [--Print Ikyct](#Print_flgs)) | | x | XMP tags (shortcut for [--Print Xkyct](#Print_flgs)) | -| c | JPEG comment | -| p | List available image previews, sorted by size in pixels (e.g., see [--extract tgt3](#extract_tgt3)) | -| C | Image ICC Profile | +| c | JPEG comment (see [IMAGE COMMENTS](#image_comments)) | +| p | List available image previews, sorted by size in pixels (see [PREVIEW IMAGES AND THUMBNAILS](#preview_images)) | +| C | Image ICC Profile (see [ICC PROFILES](#icc_profiles)) | | R | Print image structure recursively (only for the 'debug' build with jpg, png, tiff, webp, cr2 and jp2 types) | | S | Image structure information (jpg, png, tiff, webp, cr2 and jp2 types only) | | X | "raw" XMP | @@ -559,14 +564,14 @@ as well as data columns included in the print output. Valid flags are: | x | Tag number for Exif or IPTC tags (in hexadecimal) | | g | Group name (e.g., for Exif.Photo.UserComment, outputs Photo) | | k | Key (e.g., Exif.Photo.UserComment) | -| l | Tag label (human readable tagname, e.g., for Exif.Photo.UserComment, outputs 'User comment') | +| l | Tag label (human-readable tagname, e.g., for Exif.Photo.UserComment, outputs 'User comment') | | n | Tagname (e.g., for Exif.Photo.UserComment, outputs UserComment) | -| y | Type (for available types, see [Exif/IPTC/XMP types](#exiv2_types) | +| y | Type (for available types, see [Exif/IPTC/XMP types](#exiv2_types)) | | c | Number of components (for single entry types, the number of **sizeof('type')** in 'size'. For multi-entry types, the number of entries. See [Exif/IPTC/XMP types](#exiv2_types)) | -| s | Size in bytes | +| s | Size in bytes of vanilla output (see note in [Exif 'Comment' values](#exif_comment_values)). Some types include a *NULL* character in the size (see [Exif/IPTC/XMP types](#exiv2_types)) | | v | Plain data value (vanilla values, i.e., untranslated) | -| V | Plain data value AND the word 'set ' (see ['MODIFY' COMMANDS](#modify_cmds) | -| t | Interpreted (translated) human readable data values | +| V | Plain data value and the word 'set ' (see ['MODIFY' COMMANDS](#modify_cmds))| +| t | Interpreted (translated) human-readable data values | | h | Hex dump of the data |