.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "ODFHIGHLIGHT 1p" .TH ODFHIGHLIGHT 1p "2022-06-16" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" odfhighlight \- search, replace and highlight text in a document .SH "SYNOPSIS" .IX Header "SYNOPSIS" odfhighlight \*(L"source.odt\*(R" \*(L"search string\*(R" \-r \*(L"replacement\*(R" \-o \*(L"target.odt\*(R" .PP replaces \*(L"search string\*(R" by \*(L"replacement\*(R" in the file \*(L"source.odt\*(R", highlights each replacement with a yellow (default) backgound, then writes the resulting document as \*(L"target.odt\*(R" .PP odfhighlight \*(L"myfile.odt\*(R" \*(L"search string\*(R" \-color \*(L"green\*(R" .PP highlights each occurrence of \*(L"search string\*(R" in \*(L"myfile.odt\*(R" with a green background color, without changing the text (without \*(L"\-o\*(R" option, the changes apply to \*(L"myfile.odt\*(R" .SH "ARGUMENTS AND OPTIONS" .IX Header "ARGUMENTS AND OPTIONS" .SS "Default behaviour" .IX Subsection "Default behaviour" With the \*(L"minimal\*(R" command line, with only a filename and a string as arguments, each matching string is highlighted with a yellow background and represented with the \*(L"Standard\*(R" style. .SS "Options" .IX Subsection "Options" .Vb 1 \& \-e \-\-encoding "xxxxxx" \& \& character set to use, if different from the default \& \& \-r \-\-replacement "new string" \& \& "new string" is used as a replacement for "search string" \& \& \-c \-\-color "code" \& \& an RGB color code, expressed either as the concatenation of \& 3 comma\-separated decimal values (each one in the range \& 0..255, ex: "72,61,139" for a dark slate blue), or a 6\-digit \& hexadecimal number, preceded by a "#" (ex: #00ff00 for green) \& or, if a colormap is available and known in your \& OpenOffice::OODoc installation, a symbolic color name (ex: \& "sky blue") \& \& \-s \-\-stylename "name" \& \& the name of the color style (default: "MyHighlight"); the \& user must provide a style name that is not already in use \& in the document \& \& \-p \-\-property "property=value" \& \& This option can be repeated; each occurrence gives an \& additional property for the highlight style (font name, size, \& foreground color, ...). For example, with the combination of \& \-p \*(Aqfo:color=#ff0000\*(Aq and \-p \*(Aqfo:font\-size=18pt\*(Aq, the \& highlighted text will be made of 18pt\-sized, red characters. \& In order to master these options, you should have some \& knowledge of the Form Objects (FO) vocabulary that is used \& in the OpenDocument specification. \& \& \-o \-\-output "filename" \& \-t \-\-target "filename" \& \& an alternative filename to save the modified document, when \& the source document must remain unchanged .Ve