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.36 by root, Fri Jan 20 22:49:34 2006 UTC vs.
Revision 1.37 by root, Sat Jan 21 19:50:53 2006 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
… …
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-20" "7.1" "RXVT-UNICODE" 132.TH rxvt 3 "2006-01-21" "7.2" "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
… …
265search upwards/downwards in the scrollback buffer, \f(CW\*(C`End\*(C'\fR jumps to the 265search upwards/downwards in the scrollback buffer, \f(CW\*(C`End\*(C'\fR jumps to the
266bottom. \f(CW\*(C`Escape\*(C'\fR leaves search mode and returns to the point where search 266bottom. \f(CW\*(C`Escape\*(C'\fR leaves search mode and returns to the point where search
267was started, while \f(CW\*(C`Enter\*(C'\fR or \f(CW\*(C`Return\*(C'\fR stay at the current position and 267was started, while \f(CW\*(C`Enter\*(C'\fR or \f(CW\*(C`Return\*(C'\fR stay at the current position and
268additionally stores the first match in the current line into the primary 268additionally stores the first match in the current line into the primary
269selection. 269selection.
270.IP "selection-autotransform" 4 270.IP "readline (enabled by default)" 4
271.IX Item "selection-autotransform" 271.IX Item "readline (enabled by default)"
272This selection allows you to do automatic transforms on a selection
273whenever a selection is made.
274.Sp
275It works by specifying perl snippets (most useful is a single \f(CW\*(C`s///\*(C'\fR
276operator) that modify \f(CW$_\fR as resources:
277.Sp
278.Vb 3
279\& URxvt.selection-autotransform.0: transform
280\& URxvt.selection-autotransform.1: transform
281\& ...
282.Ve
283.Sp
284For example, the following will transform selections of the form
285\&\f(CW\*(C`filename:number\*(C'\fR, often seen in compiler messages, into \f(CW\*(C`vi +$filename
286$word\*(C'\fR:
287.Sp
288.Vb 1
289\& URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\e\ed+):?$/vi +$2 \e\eQ$1\e\eE\e\ex0d/
290.Ve
291.Sp
292And this example matches the same,but replaces it with vi-commands you can
293paste directly into your (vi :) editor:
294.Sp
295.Vb 1
296\& URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\e\ed+):?$/:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/
297.Ve
298.Sp
299Of course, this can be modified to suit your needs and your editor :)
300.Sp
301To expand the example above to typical perl error messages (\*(L"\s-1XXX\s0 at
302\&\s-1FILENAME\s0 line \s-1YYY\s0.\*(R"), you need a slightly more elaborate solution:
303.Sp
304.Vb 2
305\& URxvt.selection.pattern-0: ( at .*? line \e\ed+[,.])
306\& URxvt.selection-autotransform.0: s/^ at (.*?) line (\e\ed+)[,.]$/:e \e\eQ$1\eE\e\ex0d:$2\e\ex0d/
307.Ve
308.Sp
309The first line tells the selection code to treat the unchanging part of
310every error message as a selection pattern, and the second line transforms
311the message into vi commands to load the file.
312.IP "readline" 4
313.IX Item "readline"
314A support package that tries to make editing with readline easier. At the 272A support package that tries to make editing with readline easier. At the
315moment, it reacts to clicking with the left mouse button by trying to 273moment, it reacts to clicking with the left mouse button by trying to
316move the text cursor to this position. It does so by generating as many 274move the text cursor to this position. It does so by generating as many
317cursor-left or cursor-right keypresses as required (the this only works 275cursor-left or cursor-right keypresses as required (the this only works
318for programs that correctly support wide characters). 276for programs that correctly support wide characters).
319.Sp 277.Sp
320It only works when clicking into the same line (possibly extended over 278To avoid too many false positives, this is only done when:
321multiple rows) as the text cursor and on the primary screen, to reduce the 279.RS 4
322risk of misinterpreting. The normal selection isn't disabled, so quick 280.IP "\- the mouse is on the same (multi\-row\-) line as the text cursor." 4
281.IX Item "- the mouse is on the same (multi-row-) line as the text cursor."
282.PD 0
283.IP "\- the primary screen is currently being displayed." 4
284.IX Item "- the primary screen is currently being displayed."
285.IP "\- the text cursor is visible." 4
286.IX Item "- the text cursor is visible."
287.RE
288.RS 4
289.PD
290.Sp
291The normal selection mechanism isn't disabled, so quick successive clicks
323successive clicks might interfere with selection creation in harmless 292might interfere with selection creation in harmless ways.
324ways. 293.RE
294.IP "selection-autotransform" 4
295.IX Item "selection-autotransform"
296This selection allows you to do automatic transforms on a selection
297whenever a selection is made.
298.Sp
299It works by specifying perl snippets (most useful is a single \f(CW\*(C`s///\*(C'\fR
300operator) that modify \f(CW$_\fR as resources:
301.Sp
302.Vb 3
303\& URxvt.selection-autotransform.0: transform
304\& URxvt.selection-autotransform.1: transform
305\& ...
306.Ve
307.Sp
308For example, the following will transform selections of the form
309\&\f(CW\*(C`filename:number\*(C'\fR, often seen in compiler messages, into \f(CW\*(C`vi +$filename
310$word\*(C'\fR:
311.Sp
312.Vb 1
313\& URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\e\ed+):?$/vi +$2 \e\eQ$1\e\eE\e\ex0d/
314.Ve
315.Sp
316And this example matches the same,but replaces it with vi-commands you can
317paste directly into your (vi :) editor:
318.Sp
319.Vb 1
320\& URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\e\ed+):?$/:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/
321.Ve
322.Sp
323Of course, this can be modified to suit your needs and your editor :)
324.Sp
325To expand the example above to typical perl error messages (\*(L"\s-1XXX\s0 at
326\&\s-1FILENAME\s0 line \s-1YYY\s0.\*(R"), you need a slightly more elaborate solution:
327.Sp
328.Vb 2
329\& URxvt.selection.pattern-0: ( at .*? line \e\ed+[,.])
330\& URxvt.selection-autotransform.0: s/^ at (.*?) line (\e\ed+)[,.]$/:e \e\eQ$1\eE\e\ex0d:$2\e\ex0d/
331.Ve
332.Sp
333The first line tells the selection code to treat the unchanging part of
334every error message as a selection pattern, and the second line transforms
335the message into vi commands to load the file.
325.IP "tabbed" 4 336.IP "tabbed" 4
326.IX Item "tabbed" 337.IX Item "tabbed"
327This transforms the terminal into a tabbar with additional terminals, that 338This transforms the terminal into a tabbar with additional terminals, that
328is, it implements what is commonly refered to as \*(L"tabbed terminal\*(R". The topmost line 339is, it implements what is commonly refered to as \*(L"tabbed terminal\*(R". The topmost line
329displays a \*(L"[\s-1NEW\s0]\*(R" button, which, when clicked, will add a new tab, followed by one 340displays a \*(L"[\s-1NEW\s0]\*(R" button, which, when clicked, will add a new tab, followed by one
… …
1119AltGr), the meta key (often Alt) and the num lock key, if applicable. 1130AltGr), the meta key (often Alt) and the num lock key, if applicable.
1120.ie n .IP "$screen = $term\->current_screen" 4 1131.ie n .IP "$screen = $term\->current_screen" 4
1121.el .IP "$screen = \f(CW$term\fR\->current_screen" 4 1132.el .IP "$screen = \f(CW$term\fR\->current_screen" 4
1122.IX Item "$screen = $term->current_screen" 1133.IX Item "$screen = $term->current_screen"
1123Returns the currently displayed screen (0 primary, 1 secondary). 1134Returns the currently displayed screen (0 primary, 1 secondary).
1135.ie n .IP "$cursor_is_hidden = $term\->hidden_cursor" 4
1136.el .IP "$cursor_is_hidden = \f(CW$term\fR\->hidden_cursor" 4
1137.IX Item "$cursor_is_hidden = $term->hidden_cursor"
1138Returns wether the cursor is currently hidden or not.
1124.ie n .IP "$view_start = $term\->view_start ([$newvalue])" 4 1139.ie n .IP "$view_start = $term\->view_start ([$newvalue])" 4
1125.el .IP "$view_start = \f(CW$term\fR\->view_start ([$newvalue])" 4 1140.el .IP "$view_start = \f(CW$term\fR\->view_start ([$newvalue])" 4
1126.IX Item "$view_start = $term->view_start ([$newvalue])" 1141.IX Item "$view_start = $term->view_start ([$newvalue])"
1127Returns the row number of the topmost displayed line. Maximum value is 1142Returns the row number of the topmost displayed line. Maximum value is
1128\&\f(CW0\fR, which displays the normal terminal contents. Lower values scroll 1143\&\f(CW0\fR, which displays the normal terminal contents. Lower values scroll

Diff Legend

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