Patch #700

exiv2 (0.19-1) 00_hyphens_used_as_minus.diff

Added by Mark Purcell over 7 years ago. Updated over 4 years ago.

Status:ClosedStart date:01 May 2010
Priority:NormalDue date:27 Apr 2013
Assignee:Niels Kristian Bech Jensen% Done:

100%

Category:documentation
Target version:0.24

Description

Andreas,

This manual page seems to contain a hyphen where a minus sign was intended. By default, "-" chars are interpreted as hyphens (U+2010) by groff, not as minus signs (U+002D). Since options to programs use minus signs (U+002D), this means for example in UTF-8 locales that you cannot cut and paste options, nor search for them easily. The Debian groff package currently forces "-" to be interpreted as a minus sign due to the number of manual pages with this problem, but this is a Debian-specific modification and hopefully eventually can be removed.
"-" must be escaped ("\-") to be interpreted as minus. If you really intend a hyphen (normally you don't), write it as "\(hy" to emphasise that fact. See groff(7) and especially groff_char(7) for details, and also the thread starting with http://lists.debian.org/debian-devel/2003/debian-devel-200303/msg01481.html
If you use some tool that converts your documentation to groff format, this tag may indicate a bug in the tool. Some tools convert dashes of any kind to hyphens. The safe way of converting dashes is to convert them to "\-".
Because this error can occur very often, Lintian shows only the first 10 occurrences for each man page and give the number of suppressed occurrences. If you want to see all warnings, run Lintian with the -d/--debug option.
Refer to the groff_char(7) manual page for details.
Severity: wishlist, Certainty: possible

I am currently using the following patch in Debian, could I ask you to consider applying upstream:
http://patch-tracker.debian.org/patch/series/view/exiv2/0.19-1/00_hyphens_used_as_minus.diff

--- a/src/exiv2.1
+++ b/src/exiv2.1
@ -171,17 +171,17 @ Print mode for the 'print' action. Possi
.br
s : print a summary of the Exif metadata (the default)
.br
-a : print Exif, IPTC and XMP metadata (shortcut for -Pkyct)
+a : print Exif, IPTC and XMP metadata (shortcut for \-Pkyct)
.br
-t : interpreted (translated) Exif tags (-PEkyct)
+t : interpreted (translated) Exif tags (\-PEkyct)
.br
-v : plain Exif tag values (-PExgnycv)
+v : plain Exif tag values (\-PExgnycv)
.br
-h : hexdump of the Exif data (-PExgnycsh)
+h : hexdump of the Exif data (\-PExgnycsh)
.br
-i : IPTC datasets (-PIkyct)
+i : IPTC datasets (\-PIkyct)
.br
-x : XMP properties (-PXkyct)
+x : XMP properties (\-PXkyct)
.br
c : JPEG comment
.br
@ -256,7 +256,7 @ images and a modifier to generate an XMP
p[<n>[,<m> ...]] : Extract preview images. The optional comma separated
list of preview image numbers is used to determine which preview images
to extract. The available preview images and their numbers are displayed
-with the 'print' option -pp.
+with the 'print' option \-pp.
.br
X : Extract metadata to an XMP sidecar file <file>.xmp. The remaining
extract targets determine what metadata to extract to the sidecar
@ -393,13 +393,13 @ ignored (comments). Remaining lines are
exiv2 .jpg
Prints a summary of the Exif information for all JPEG files in the directory.
.TP
-exiv2 -pi image.jpg
+exiv2 \-pi image.jpg
Prints the IPTC metadata of the image.
.TP
exiv2 rename img_1234.jpg
Renames img_1234.jpg (taken on 13\-Nov\-05 at 22:58:31) to 20051113_225831.jpg
.TP
-exiv2 -r':basename:_%Y%m' rename img_1234.jpg
+exiv2 \-r':basename:_%Y%m' rename img_1234.jpg
Renames img_1234.jpg to img_1234_200511.jpg
.TP
exiv2 \-et img1.jpg img2.jpg
@ -441,7 +441,7 @ and GPSLatitudeRef contains either 'N' o
latitude respectively.
.TP
.nf
-exiv2 insert -l/tmp -S.CRW /data/
.JPG
+exiv2 insert \-l/tmp \-S.CRW /data/*.JPG
.fi
Copy all metadata from CRW files in the /tmp directory to JPG files
with corresponding basenames in the /data directory. Note that this

Associated revisions

Revision 3025
Added by Niels Kristian Bech Jensen over 4 years ago

Issue #700: Escape dashes used as option specifiers in the manual page to make copy and paste work. Based on patch by Mark Purcell.

History

#1 Updated by Niels Kristian Bech Jensen over 4 years ago

  • Category set to documentation
  • Status changed from New to Assigned
  • Assignee set to Niels Kristian Bech Jensen
  • Target version set to 0.24

#2 Updated by Niels Kristian Bech Jensen over 4 years ago

  • Due date set to 27 Apr 2013
  • Status changed from Assigned to Resolved
  • % Done changed from 0 to 100

Thanks for the patch. I have updated it and submitted it to the svn trunk.

Regards,
Niels Kristian

#3 Updated by Robin Mills over 4 years ago

  • Status changed from Resolved to Closed
  • Priority changed from Low to Normal

Fixed in 0.24.

Also available in: Atom PDF

Redmine Appliance - Powered by TurnKey Linux