ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.man.in (file contents):
Revision 1.24 by root, Wed Jan 11 02:13:56 2006 UTC vs.
Revision 1.25 by root, Thu Jan 12 05:37:34 2006 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 3" 131.IX Title "rxvt 3"
132.TH rxvt 3 "2006-01-11" "6.3" "RXVT-UNICODE" 132.TH rxvt 3 "2006-01-12" "7.0" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134@@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter 134@@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 1 137.Vb 1
… …
173\& @@RXVT_NAME@@ -pe <extensionname> 173\& @@RXVT_NAME@@ -pe <extensionname>
174.Ve 174.Ve
175.IP "selection (enabled by default)" 4 175.IP "selection (enabled by default)" 4
176.IX Item "selection (enabled by default)" 176.IX Item "selection (enabled by default)"
177(More) intelligent selection. This extension tries to be more intelligent 177(More) intelligent selection. This extension tries to be more intelligent
178when the user extends selections (double\-click). Right now, it tries to 178when the user extends selections (double\-click and further clicks). Right
179select urls and complete shell-quoted arguments, which is very convenient, 179now, it tries to select words, urls and complete shell-quoted
180too, if your \fIls\fR supports \f(CW\*(C`\-\-quoting\-style=shell\*(C'\fR. 180arguments, which is very convenient, too, if your \fIls\fR supports
181\&\f(CW\*(C`\-\-quoting\-style=shell\*(C'\fR.
182.Sp
183A double-click usually selects the word under the cursor, further clicks
184will enlarge the selection.
181.Sp 185.Sp
182It also offers the following bindable keyboard command: 186It also offers the following bindable keyboard command:
183.RS 4 187.RS 4
184.IP "rot13" 4 188.IP "rot13" 4
185.IX Item "rot13" 189.IX Item "rot13"
… …
201text into various other formats/action (such as uri unescaping, perl 205text into various other formats/action (such as uri unescaping, perl
202evalution, web-browser starting etc.), depending on content. 206evalution, web-browser starting etc.), depending on content.
203.IP "searchable\-scrollback<hotkey> (enabled by default)" 4 207.IP "searchable\-scrollback<hotkey> (enabled by default)" 4
204.IX Item "searchable-scrollback<hotkey> (enabled by default)" 208.IX Item "searchable-scrollback<hotkey> (enabled by default)"
205Adds regex search functionality to the scrollback buffer, triggered 209Adds regex search functionality to the scrollback buffer, triggered
206by a hotkey (default: \f(CW\*(C`M\-s\*(C'\fR). When in search mode, normal terminal 210by a hotkey (default: \f(CW\*(C`M\-s\*(C'\fR). While in search mode, normal terminal
207input/output is suspended. 211input/output is suspended and a regex is displayed at the bottom of the
212screen.
208.Sp 213.Sp
209\&\f(CW\*(C`/\*(C'\fR starts an incremental regex search, \f(CW\*(C`n\*(C'\fR searches further, \f(CW\*(C`p\*(C'\fR or 214Inputting characters appends them to the regex and continues incremental
210\&\f(CW\*(C`N\*(C'\fR jump to the previous match, \f(CW\*(C`G\*(C'\fR jumps to the bottom and clears the 215search. \f(CW\*(C`BackSpace\*(C'\fR removes a character from the regex, \f(CW\*(C`Up\*(C'\fR and \f(CW\*(C`Down\*(C'\fR
211history, \f(CW\*(C`enter\*(C'\fR leaves search mode at the current position and \f(CW\*(C`escape\*(C'\fR 216search upwards/downwards in the scrollback buffer, \f(CW\*(C`End\*(C'\fR jumps to the
212returns to the original position. 217bottom. \f(CW\*(C`Escape\*(C'\fR leaves search mode and returns to the point where search
218was started, while \f(CW\*(C`Enter\*(C'\fR or \f(CW\*(C`Return\*(C'\fR stay at the current position and
219additionally stores the first match in the current line into the primary
220selection.
213.IP "digital-clock" 4 221.IP "digital-clock" 4
214.IX Item "digital-clock" 222.IX Item "digital-clock"
215Displays a digital clock using the built-in overlay. 223Displays a digital clock using the built-in overlay.
216.IP "mark-urls" 4 224.IP "mark-urls" 4
217.IX Item "mark-urls" 225.IX Item "mark-urls"
218Uses per-line display filtering (\f(CW\*(C`on_line_update\*(C'\fR) to underline urls and 226Uses per-line display filtering (\f(CW\*(C`on_line_update\*(C'\fR) to underline urls and
219make them clickable. When clicked, the program specified in the resource 227make them clickable. When middle\-clicked, the program specified in the
220\&\f(CW\*(C`urlLauncher\*(C'\fR (default \f(CW\*(C`x\-www\-browser\*(C'\fR) will be started. 228resource \f(CW\*(C`urlLauncher\*(C'\fR (default \f(CW\*(C`x\-www\-browser\*(C'\fR) will be started with
229the \s-1URL\s0 as first argument.
221.IP "block-graphics-to-ascii" 4 230.IP "block-graphics-to-ascii" 4
222.IX Item "block-graphics-to-ascii" 231.IX Item "block-graphics-to-ascii"
223A not very useful example of filtering all text output to the terminal, 232A not very useful example of filtering all text output to the terminal,
224by replacing all line-drawing characters (U+2500 .. U+259F) by a 233by replacing all line-drawing characters (U+2500 .. U+259F) by a
225similar-looking ascii character. 234similar-looking ascii character.
… …
339.el .IP "on_sel_extend \f(CW$term\fR" 4 348.el .IP "on_sel_extend \f(CW$term\fR" 4
340.IX Item "on_sel_extend $term" 349.IX Item "on_sel_extend $term"
341Called whenever the user tries to extend the selection (e.g. with a double 350Called whenever the user tries to extend the selection (e.g. with a double
342click) and is either supposed to return false (normal operation), or 351click) and is either supposed to return false (normal operation), or
343should extend the selection itelf and return true to suppress the built-in 352should extend the selection itelf and return true to suppress the built-in
344processing. 353processing. This can happen multiple times, as long as the callback
354returns true, it will be called on every further click by the user and is
355supposed to enlarge the selection more and more, if possible.
345.Sp 356.Sp
346See the \fIselection\fR example extension. 357See the \fIselection\fR example extension.
347.ie n .IP "on_view_change $term\fR, \f(CW$offset" 4 358.ie n .IP "on_view_change $term\fR, \f(CW$offset" 4
348.el .IP "on_view_change \f(CW$term\fR, \f(CW$offset\fR" 4 359.el .IP "on_view_change \f(CW$term\fR, \f(CW$offset\fR" 4
349.IX Item "on_view_change $term, $offset" 360.IX Item "on_view_change $term, $offset"
… …
683.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col\fR])" 4 694.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col\fR])" 4
684.IX Item "($row, $col) = $term->selection_end ([$row, $col])" 695.IX Item "($row, $col) = $term->selection_end ([$row, $col])"
685.PD 696.PD
686Return the current values of the selection mark, begin or end positions, 697Return the current values of the selection mark, begin or end positions,
687and optionally set them to new values. 698and optionally set them to new values.
699.ie n .IP "$term\->selection_make ($eventtime[, $rectangular])" 4
700.el .IP "$term\->selection_make ($eventtime[, \f(CW$rectangular\fR])" 4
701.IX Item "$term->selection_make ($eventtime[, $rectangular])"
702Tries to make a selection as set by \f(CW\*(C`selection_beg\*(C'\fR and
703\&\f(CW\*(C`selection_end\*(C'\fR. If \f(CW$rectangular\fR is true (default: false), a
704rectangular selection will be made. This is the prefered function to make
705a selection.
688.ie n .IP "$success = $term\->selection_grab ($eventtime)" 4 706.ie n .IP "$success = $term\->selection_grab ($eventtime)" 4
689.el .IP "$success = \f(CW$term\fR\->selection_grab ($eventtime)" 4 707.el .IP "$success = \f(CW$term\fR\->selection_grab ($eventtime)" 4
690.IX Item "$success = $term->selection_grab ($eventtime)" 708.IX Item "$success = $term->selection_grab ($eventtime)"
691Try to request the primary selection from the server (for example, as set 709Try to request the primary selection text from the server (for example, as
692by the next method). 710set by the next method). No visual feedback will be given. This function
711is mostly useful from within \f(CW\*(C`on_sel_grab\*(C'\fR hooks.
693.ie n .IP "$oldtext = $term\->selection ([$newtext])" 4 712.ie n .IP "$oldtext = $term\->selection ([$newtext])" 4
694.el .IP "$oldtext = \f(CW$term\fR\->selection ([$newtext])" 4 713.el .IP "$oldtext = \f(CW$term\fR\->selection ([$newtext])" 4
695.IX Item "$oldtext = $term->selection ([$newtext])" 714.IX Item "$oldtext = $term->selection ([$newtext])"
696Return the current selection text and optionally replace it by \f(CW$newtext\fR. 715Return the current selection text and optionally replace it by \f(CW$newtext\fR.
697.ie n .IP "$term\->overlay_simple ($x, $y\fR, \f(CW$text)" 4 716.ie n .IP "$term\->overlay_simple ($x, $y\fR, \f(CW$text)" 4
… …
752Convert the given locale-encoded octets into a perl string. 771Convert the given locale-encoded octets into a perl string.
753.ie n .IP "$term\->scr_xor_span ($beg_row, $beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle])" 4 772.ie n .IP "$term\->scr_xor_span ($beg_row, $beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle])" 4
754.el .IP "$term\->scr_xor_span ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle\fR])" 4 773.el .IP "$term\->scr_xor_span ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle\fR])" 4
755.IX Item "$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])" 774.IX Item "$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])"
756XORs the rendition values in the given span with the provided value 775XORs the rendition values in the given span with the provided value
757(default: \f(CW\*(C`RS_RVid\*(C'\fR). Useful in refresh hooks to provide effects similar 776(default: \f(CW\*(C`RS_RVid\*(C'\fR), which \fI\s-1MUST\s0 \s-1NOT\s0\fR contain font styles. Useful in
758to the selection. 777refresh hooks to provide effects similar to the selection.
759.ie n .IP "$term\->scr_xor_rect ($beg_row, $beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2]])" 4 778.ie n .IP "$term\->scr_xor_rect ($beg_row, $beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2]])" 4
760.el .IP "$term\->scr_xor_rect ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2\fR]])" 4 779.el .IP "$term\->scr_xor_rect ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2\fR]])" 4
761.IX Item "$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])" 780.IX Item "$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])"
762Similar to \f(CW\*(C`scr_xor_span\*(C'\fR, but xors a rectangle instead. Trailing 781Similar to \f(CW\*(C`scr_xor_span\*(C'\fR, but xors a rectangle instead. Trailing
763whitespace will additionally be xored with the \f(CW$rstyle2\fR, which defaults 782whitespace will additionally be xored with the \f(CW$rstyle2\fR, which defaults
764to \f(CW\*(C`RS_RVid | RS_Uline\*(C'\fR, which removes reverse video again and underlines 783to \f(CW\*(C`RS_RVid | RS_Uline\*(C'\fR, which removes reverse video again and underlines
765it instead. 784it instead. Both styles \fI\s-1MUST\s0 \s-1NOT\s0\fR contain font styles.
766.IP "$term\->scr_bell" 4 785.IP "$term\->scr_bell" 4
767.IX Item "$term->scr_bell" 786.IX Item "$term->scr_bell"
768Ring the bell! 787Ring the bell!
769.IP "$term\->scr_add_lines ($string)" 4 788.IP "$term\->scr_add_lines ($string)" 4
770.IX Item "$term->scr_add_lines ($string)" 789.IX Item "$term->scr_add_lines ($string)"
… …
958Return the row number of the first/last row of the line, respectively. 977Return the row number of the first/last row of the line, respectively.
959.ie n .IP "$offset = $line\fR\->offset_of ($row, \f(CW$col)" 4 978.ie n .IP "$offset = $line\fR\->offset_of ($row, \f(CW$col)" 4
960.el .IP "$offset = \f(CW$line\fR\->offset_of ($row, \f(CW$col\fR)" 4 979.el .IP "$offset = \f(CW$line\fR\->offset_of ($row, \f(CW$col\fR)" 4
961.IX Item "$offset = $line->offset_of ($row, $col)" 980.IX Item "$offset = $line->offset_of ($row, $col)"
962Returns the character offset of the given row|col pair within the logical 981Returns the character offset of the given row|col pair within the logical
963line. 982line. Works for rows outside the line, too, and returns corresponding
983offsets outside the string.
964.ie n .IP "($row, $col\fR) = \f(CW$line\->coord_of ($offset)" 4 984.ie n .IP "($row, $col\fR) = \f(CW$line\->coord_of ($offset)" 4
965.el .IP "($row, \f(CW$col\fR) = \f(CW$line\fR\->coord_of ($offset)" 4 985.el .IP "($row, \f(CW$col\fR) = \f(CW$line\fR\->coord_of ($offset)" 4
966.IX Item "($row, $col) = $line->coord_of ($offset)" 986.IX Item "($row, $col) = $line->coord_of ($offset)"
967Translates a string offset into terminal coordinates again. 987Translates a string offset into terminal coordinates again.
968.RE 988.RE
… …
1130.IP "== 0 \- fatal messages" 4 1150.IP "== 0 \- fatal messages" 4
1131.IX Item "== 0 - fatal messages" 1151.IX Item "== 0 - fatal messages"
1132.PD 0 1152.PD 0
1133.IP ">= 3 \- script loading and management" 4 1153.IP ">= 3 \- script loading and management" 4
1134.IX Item ">= 3 - script loading and management" 1154.IX Item ">= 3 - script loading and management"
1135.IP ">=10 \- all events received" 4 1155.IP ">=10 \- all called hooks" 4
1136.IX Item ">=10 - all events received" 1156.IX Item ">=10 - all called hooks"
1157.IP ">=11 \- hook reutrn values" 4
1158.IX Item ">=11 - hook reutrn values"
1137.PD 1159.PD
1138.SH "AUTHOR" 1160.SH "AUTHOR"
1139.IX Header "AUTHOR" 1161.IX Header "AUTHOR"
1140.Vb 2 1162.Vb 2
1141\& Marc Lehmann <pcg@goof.com> 1163\& Marc Lehmann <pcg@goof.com>

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines