Skip to content

Commit eae83b4

Browse files
Update docs concerning BMFF-based files (#2404)
* Update docs concerning BMFF-based files * Fix minor issues in documentation
1 parent cbf549b commit eae83b4

File tree

2 files changed

+22
-8
lines changed

2 files changed

+22
-8
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The file ReadMe.txt in a build bundle describes how to install the library on th
4949
16. [Cross Platform Build and Test on Linux for MinGW](#2-16)
5050
17. [Building with C++11 and other compilers](#2-17)
5151
18. [Static and Shared Libraries](#2-18)
52-
19. [Support for bmff files (CR3, HEIF, HEIC, and AVIF)](#2-19)
52+
19. [Support for BMFF files (e.g., CR3, HEIF, HEIC, AVIF, and JPEG XL)](#2-19)
5353
3. [License and Support](#3)
5454
1. [License](#3-1)
5555
2. [Support](#3-2)
@@ -620,7 +620,7 @@ int main(int argc, const char* argv[])
620620
...
621621
}
622622
```
623-
The use of the _**thread unsafe function**_ Exiv2::enableBMFF(true) is discussed in [2.19 Support for bmff files](#2-19)
623+
The use of the _**thread unsafe function**_ Exiv2::enableBMFF(true) is discussed in [2.19 Support for BMFF files (e.g., CR3, HEIF, HEIC, AVIF, and JPEG XL)](#2-19)
624624
625625
[TOC](#TOC)
626626
<div id="2-15">
@@ -806,19 +806,19 @@ This is discussed: [https://github.com/Exiv2/exiv2/issues/1230](https://github.c
806806
[TOC](#TOC)
807807
<div id="2-19">
808808
809-
### 2.19 Support for bmff files (CR3, HEIF, HEIC, and AVIF)
809+
### 2.19 Support for BMFF files (e.g., CR3, HEIF, HEIC, AVIF, and JPEG XL)
810810
811-
**Attention is drawn to the possibility that bmff support may be the subject of patent rights. _Exiv2 shall not be held responsible for identifying any or all such patent rights. Exiv2 shall not be held responsible for the legal consequences of the use of this code_.**
811+
**Attention is drawn to the possibility that BMFF support may be the subject of patent rights. _Exiv2 shall not be held responsible for identifying any or all such patent rights. Exiv2 shall not be held responsible for the legal consequences of the use of this code_.**
812812
813-
Access to the bmff code is guarded in two ways. Firstly, you have to build the library with the cmake option: `-DEXIV2_ENABLE_BMFF=On`. Secondly, the application must enable bmff support at run-time by calling the following function.
813+
Access to the BMFF code is guarded in two ways. Firstly, you have to build the library with the cmake option: `-DEXIV2_ENABLE_BMFF=On`. Secondly, the application must enable BMFF support at run-time by calling the following function.
814814
815815
```cpp
816816
EXIV2API bool enableBMFF(bool enable);
817817
```
818818
819-
The return value from `enableBMFF()` is true if the library has been build with bmff support (cmake option -DEXIV2_ANABLE_BMFF=On).
819+
The return value from `enableBMFF()` is true if the library has been build with BMFF support (cmake option -DEXIV2_ANABLE_BMFF=On).
820820
821-
Applications may wish to provide a preference setting to enable bmff support and thereby place the responsibility for the use of this code with the user of the application.
821+
Applications may wish to provide a preference setting to enable BMFF support and thereby place the responsibility for the use of this code with the user of the application.
822822
823823
[TOC](#TOC)
824824
<div id="3">

man/man1/exiv2.1

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.\" First parameter, NAME, should be all caps
33
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
44
.\" other parameters are allowed: see man(7), man(1)
5-
.TH EXIV2 1 "August 10, 2021"
5+
.TH EXIV2 1 "November 02, 2022"
66
.\" Please adjust this date whenever revising the manpage.
77
.\"
88
.\" Some roff macros, for reference:
@@ -53,6 +53,7 @@ HEIC Read Read Read - -
5353
HEIF Read Read Read - -
5454
JP2 Read/Write Read/Write Read/Write - Read/Write
5555
JPEG Read/Write Read/Write Read/Write Read/Write Read/Write
56+
JPEG XL Read Read Read - -
5657
MRW Read Read Read - -
5758
NEF Read/Write Read/Write Read/Write - Read/Write
5859
ORF Read/Write Read/Write Read/Write - -
@@ -76,6 +77,19 @@ image are determined.
7677
.IP \(bu 2
7778
Reading other TIFF-like RAW image formats, which are not listed in the
7879
table, may also work.
80+
.IP \(bu 2
81+
Support for BMFF file types such as CR3, HEIF, HEIC, AVIF, and
82+
JPEG XL is a build option. To check if this is enabled, use:
83+
.PP
84+
.in +4n
85+
.EX
86+
$ exiv2 --version --verbose | grep bmff
87+
enable_bmff=1
88+
.EE
89+
.in
90+
.PP
91+
.IP \(bu 2
92+
Naked codestream JPEG XL files do not contain Exif, IPTC, or XMP metadata.
7993
.SH ACTIONS
8094
The \fIaction\fP argument is only required if it is not clear from the
8195
\fIoptions\fP which action is implied.

0 commit comments

Comments
 (0)