Man page review for v0.26

v0.27.3
Robin Mills 9 years ago
parent 88ad60e2ec
commit e46907cb1b

@ -3,7 +3,7 @@
.\" First parameter, NAME, should be all caps .\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1) .\" other parameters are allowed: see man(7), man(1)
.TH EXIV2 1 "Aug 24, 2016" .TH EXIV2 1 "Sep 23, 2016"
.\" Please adjust this date whenever revising the manpage. .\" Please adjust this date whenever revising the manpage.
.\" .\"
.\" Some roff macros, for reference: .\" Some roff macros, for reference:
@ -177,7 +177,7 @@ lvl d | i | i | w | e
debug, info, warning, error debug, info, warning, error
mod s | a | t | v | h | i | x | c | p | i | C | R | S | X mod s | a | t | v | h | i | x | c | p | i | C | R | S | X
summary, all, translated, vanilla, hex iptc, xmp, comment, preview, summary, all, translated, vanilla, hex, iptc, xmp, comment, preview,
ICC Profile, Recursive Structure, Simple Structure, raw XMP ICC Profile, Recursive Structure, Simple Structure, raw XMP
tgt a | c | e | i | p | t | x | C | X | XX | - tgt a | c | e | i | p | t | x | C | X | XX | -
@ -316,11 +316,11 @@ c : JPEG comment
.br .br
p : list available image previews, sorted by preview image size in pixels p : list available image previews, sorted by preview image size in pixels
.br .br
C : print image ICC Profile (jpg, png, tiff, cr2 only) C : print image ICC Profile (jpg, png, tiff, webp, cr2 only)
.br .br
R : print image structure recursively (jpg, png, tiff, cr2 only) R : print image structure recursively (jpg, png, tiff, webp, cr2 only)
.br .br
S : print image structure information (jpg, png, tiff, cr2 only) S : print image structure information (jpg, png, tiff, webp, cr2 only)
.br .br
X : print "raw" XMP (jpg, png, tiff, cr2, webp only) X : print "raw" XMP (jpg, png, tiff, cr2, webp only)
.TP .TP
@ -351,11 +351,11 @@ c : number of components (count)
.br .br
s : size in bytes s : size in bytes
.br .br
v : plain data value v : plain data value (vanilla values)
.br .br
V : plain data value AND the word 'set ' at the start of line (for use with exiv2 -m-) V : plain data value AND the word 'set ' (for use with exiv2 -m-)
.br .br
t : interpreted (translated) data t : interpreted (translated) human readable data
.br .br
h : hexdump of the data h : hexdump of the data
.TP .TP
@ -375,6 +375,8 @@ x : XMP packet
c : JPEG comment c : JPEG comment
.br .br
C : ICC Profile C : ICC Profile
.br
I : All IPTC data
.TP .TP
.B \-i \fItgt\fP .B \-i \fItgt\fP
Insert target(s) for the 'insert' action. Possible targets are the Insert target(s) for the 'insert' action. Possible targets are the
@ -531,85 +533,65 @@ is used by default if the value doesn't start with a charset
definition. definition.
.sp 1 .sp 1
The format for an IPTC \fBDate\fP value is: The format for an IPTC \fBDate\fP value is:
.RS .sp 1
YYYY\-MM\-DD (year, month, day) YYYY\-MM\-DD (year, month, day)
.RE .sp 1
The format for an IPTC \fBTime\fP value is: The format for an IPTC \fBTime\fP value is:
.RS .sp 1
HH:MM:SS (hours, minutes, seconds) HH:MM:SS (hours, minutes, seconds)
.RE .sp
and may optionally be followed by: and may optionally be followed by:
.RS .sp 1
\-HH:MM or +HH:MM (hours, minutes ahead/behind UTC) \-HH:MM or +HH:MM (hours, minutes ahead/behind UTC)
.RE .sp 1
The format of \fBRational\fP (and \fBSRational\fP) is one of: The format of \fBRational\fP (and \fBSRational\fP) is one of:
.RS .sp 1
.IP integer | integer/integer | Fnumber | number
integer .sp 1
.IP
integer-numerator/integer-denominator
.IP
Fnumber
.IP
fnumber
.RE
Rational Examples: Rational Examples:
.RS .sp 1
.nf .nf
exiv2 "-Mset Exif.Photo.MaxApertureValue 557429/62500" X.jpg $ exiv2 "-Mset Exif.Photo.MaxApertureValue 557429/62500" X.jpg
exiv2 "-Mset Exif.Photo.MaxApertureValue F5.6" X.jpg $ exiv2 "-Mset Exif.Photo.MaxApertureValue F5.6" X.jpg
.fi .fi
.RE
.sp 1 .sp 1
The Rational format Fnumber (or fnumber) is for the convenience of setting aperture values. Aperture values The Rational format Fnumber is for the convenience of setting aperture values. Aperture values
are stored in Exif is an \fBAPEX\fP value which can be evaluated by the expression: are stored in Exif is an \fBAPEX\fP value which can be evaluated by the expression:
.sp 1 .sp 1
.RS
.nf .nf
apex-value = log(Fnumber) * 2.0 / log(2.0) apex-value = log(Fnumber) * 2.0 / log(2.0)
Fnumber = exp(apex-value * log(2.0) / 2.0) number = exp(apex-value * log(2.0) / 2.0)
.fi .fi
.RE
.sp 1 .sp 1
The Rational format Fnumber is valid for any \fBRational\fP, even when the key is not an Aperture. The Rational format Fnumber is valid for any \fBRational\fP, even when the key is not an Aperture.
More information about \fBAPEX\fP value is available from: http://en.wikipedia.org/wiki/APEX_system More information about \fBAPEX\fP value is available from: http://en.wikipedia.org/wiki/APEX_system
.sp 1 .sp 1
The format of XMP \fBLangAlt\fP values includes an optional language qualifier: The format of XMP \fBLangAlt\fP values includes an optional language qualifier:
.RS
.nf .nf
.B lang="\fIlanguage-code\fP\fI" text\fP .B lang="\fIlanguage-code\fP\fI" text\fP
.fi .fi
.RE
.sp .sp
lang="x-default" is used if the value doesn't start with a language qualifier. lang="x-default" is used if the value doesn't start with a language qualifier.
.sp 1 .sp 1
.RS
.nf .nf
exiv2 -M'set Xmp.dc.title lang="de-DE" Euros' X.jpg $ exiv2 -M'set Xmp.dc.title lang="de-DE" Euros' X.jpg
exiv2 -M'set Xmp.dc.title lang="en-GB" Pounds' X.jpg $ exiv2 -M'set Xmp.dc.title lang="en-GB" Pounds' X.jpg
exiv2 -M'set Xmp.dc.title lang="en-US" In God We Trust' X.jpg $ exiv2 -M'set Xmp.dc.title lang="en-US" In God We Trust' X.jpg
exiv2 -M'set Xmp.dc.title All others pay cash' X.jpg $ exiv2 -M'set Xmp.dc.title All others pay cash' X.jpg
.fi .fi
.RE
.sp 1 .sp 1
To remove a language specification, set the value to '' (empty string) To remove a language specification, set the value to '' (empty string)
.RS
.nf .nf
exiv2 -M'set Xmp.dc.title lang="en-US"' X.jpg exiv2 -M'set Xmp.dc.title lang="en-US"' X.jpg
.fi .fi
.RE
To remove all language specifications, delete the key: To remove all language specifications, delete the key:
.RS
.nf .nf
exiv2 -M'del Xmp.dc.title' X.jpg $ exiv2 -M'del Xmp.dc.title' X.jpg
.fi .fi
.RE
To register additional XMP namespaces, combine the command with: To register additional XMP namespaces, combine the command with:
.RS
.nf .nf
\fBreg\fP \fIprefix\fP \fInamespace\fP \fBreg\fP \fIprefix\fP \fInamespace\fP
.fi .fi
.RE
.SS Command file format .SS Command file format
Empty lines and lines starting with \fB#\fP in a command file are Empty lines and lines starting with \fB#\fP in a command file are
ignored (comments). Remaining lines are commands as described above. ignored (comments). Remaining lines are commands as described above.
@ -668,9 +650,6 @@ requirements of the target format. Some tags copied like this may not
make sense in the target image. make sense in the target image.
.SH SEE ALSO .SH SEE ALSO
.TP .TP
.I man exiv2samples
Information about the sample applications included in the exiv2 code distribution
.TP
.I http://www.exiv2.org/sample.html#modify .I http://www.exiv2.org/sample.html#modify
Sample command files. Sample command files.
.TP .TP

Loading…
Cancel
Save