Blame gtkmm-osx/jpeg-6b/wrjpgcom.1

Carlos Lopez a09598
.TH WRJPGCOM 1 "15 June 1995"
Carlos Lopez a09598
.SH NAME
Carlos Lopez a09598
wrjpgcom \- insert text comments into a JPEG file
Carlos Lopez a09598
.SH SYNOPSIS
Carlos Lopez a09598
.B wrjpgcom
Carlos Lopez a09598
[
Carlos Lopez a09598
.B \-replace
Carlos Lopez a09598
]
Carlos Lopez a09598
[
Carlos Lopez a09598
.BI \-comment " text"
Carlos Lopez a09598
]
Carlos Lopez a09598
[
Carlos Lopez a09598
.BI \-cfile " name"
Carlos Lopez a09598
]
Carlos Lopez a09598
[
Carlos Lopez a09598
.I filename
Carlos Lopez a09598
]
Carlos Lopez a09598
.LP
Carlos Lopez a09598
.SH DESCRIPTION
Carlos Lopez a09598
.LP
Carlos Lopez a09598
.B wrjpgcom
Carlos Lopez a09598
reads the named JPEG/JFIF file, or the standard input if no file is named,
Carlos Lopez a09598
and generates a new JPEG/JFIF file on standard output.  A comment block is
Carlos Lopez a09598
added to the file.
Carlos Lopez a09598
.PP
Carlos Lopez a09598
The JPEG standard allows "comment" (COM) blocks to occur within a JPEG file.
Carlos Lopez a09598
Although the standard doesn't actually define what COM blocks are for, they
Carlos Lopez a09598
are widely used to hold user-supplied text strings.  This lets you add
Carlos Lopez a09598
annotations, titles, index terms, etc to your JPEG files, and later retrieve
Carlos Lopez a09598
them as text.  COM blocks do not interfere with the image stored in the JPEG
Carlos Lopez a09598
file.  The maximum size of a COM block is 64K, but you can have as many of
Carlos Lopez a09598
them as you like in one JPEG file.
Carlos Lopez a09598
.PP
Carlos Lopez a09598
.B wrjpgcom
Carlos Lopez a09598
adds a COM block, containing text you provide, to a JPEG file.
Carlos Lopez a09598
Ordinarily, the COM block is added after any existing COM blocks; but you
Carlos Lopez a09598
can delete the old COM blocks if you wish.
Carlos Lopez a09598
.SH OPTIONS
Carlos Lopez a09598
Switch names may be abbreviated, and are not case sensitive.
Carlos Lopez a09598
.TP
Carlos Lopez a09598
.B \-replace
Carlos Lopez a09598
Delete any existing COM blocks from the file.
Carlos Lopez a09598
.TP
Carlos Lopez a09598
.BI \-comment " text"
Carlos Lopez a09598
Supply text for new COM block on command line.
Carlos Lopez a09598
.TP
Carlos Lopez a09598
.BI \-cfile " name"
Carlos Lopez a09598
Read text for new COM block from named file.
Carlos Lopez a09598
.PP
Carlos Lopez a09598
If you have only one line of comment text to add, you can provide it on the
Carlos Lopez a09598
command line with
Carlos Lopez a09598
.BR \-comment .
Carlos Lopez a09598
The comment text must be surrounded with quotes so that it is treated as a
Carlos Lopez a09598
single argument.  Longer comments can be read from a text file.
Carlos Lopez a09598
.PP
Carlos Lopez a09598
If you give neither
Carlos Lopez a09598
.B \-comment
Carlos Lopez a09598
nor
Carlos Lopez a09598
.BR \-cfile ,
Carlos Lopez a09598
then
Carlos Lopez a09598
.B wrjpgcom
Carlos Lopez a09598
will read the comment text from standard input.  (In this case an input image
Carlos Lopez a09598
file name MUST be supplied, so that the source JPEG file comes from somewhere
Carlos Lopez a09598
else.)  You can enter multiple lines, up to 64KB worth.  Type an end-of-file
Carlos Lopez a09598
indicator (usually control-D) to terminate the comment text entry.
Carlos Lopez a09598
.PP
Carlos Lopez a09598
.B wrjpgcom
Carlos Lopez a09598
will not add a COM block if the provided comment string is empty.  Therefore
Carlos Lopez a09598
\fB\-replace \-comment ""\fR can be used to delete all COM blocks from a file.
Carlos Lopez a09598
.SH EXAMPLES
Carlos Lopez a09598
.LP
Carlos Lopez a09598
Add a short comment to in.jpg, producing out.jpg:
Carlos Lopez a09598
.IP
Carlos Lopez a09598
.B wrjpgcom \-c
Carlos Lopez a09598
\fI"View of my back yard" in.jpg
Carlos Lopez a09598
.B >
Carlos Lopez a09598
.I out.jpg
Carlos Lopez a09598
.PP
Carlos Lopez a09598
Attach a long comment previously stored in comment.txt:
Carlos Lopez a09598
.IP
Carlos Lopez a09598
.B wrjpgcom
Carlos Lopez a09598
.I in.jpg
Carlos Lopez a09598
.B <
Carlos Lopez a09598
.I comment.txt
Carlos Lopez a09598
.B >
Carlos Lopez a09598
.I out.jpg
Carlos Lopez a09598
.PP
Carlos Lopez a09598
or equivalently
Carlos Lopez a09598
.IP
Carlos Lopez a09598
.B wrjpgcom
Carlos Lopez a09598
.B -cfile
Carlos Lopez a09598
.I comment.txt
Carlos Lopez a09598
.B <
Carlos Lopez a09598
.I in.jpg
Carlos Lopez a09598
.B >
Carlos Lopez a09598
.I out.jpg
Carlos Lopez a09598
.SH SEE ALSO
Carlos Lopez a09598
.BR cjpeg (1),
Carlos Lopez a09598
.BR djpeg (1),
Carlos Lopez a09598
.BR jpegtran (1),
Carlos Lopez a09598
.BR rdjpgcom (1)
Carlos Lopez a09598
.SH AUTHOR
Carlos Lopez a09598
Independent JPEG Group