ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.124 by root, Sun Jan 22 11:57:06 2006 UTC vs.
Revision 1.130 by root, Wed Jan 25 15:32:48 2006 UTC

66contain at least one pair of capturing parentheses, which will be used for 66contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything 67the match. For example, the followign adds a regex that matches everything
68between two vertical bars: 68between two vertical bars:
69 69
70 URxvt.selection.pattern-0: \\|([^|]+)\\| 70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72Another example: Programs I use often output "absolute path: " at the
73beginning of a line when they process multiple files. The following
74pattern matches the filename (note, there is a single space at the very
75end):
76
77 URxvt.selection.pattern-0: ^(/[^:]+):\
71 78
72You can look at the source of the selection extension to see more 79You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end. 80interesting uses, such as parsing a line from beginning to end.
74 81
75This extension also offers following bindable keyboard commands: 82This extension also offers following bindable keyboard commands:
139 146
140To avoid too many false positives, this is only done when: 147To avoid too many false positives, this is only done when:
141 148
142=over 4 149=over 4
143 150
151=item - the tty is in ICANON state.
152
153=item - the text cursor is visible.
154
155=item - the primary screen is currently being displayed.
156
144=item - the mouse is on the same (multi-row-) line as the text cursor. 157=item - the mouse is on the same (multi-row-) line as the text cursor.
145
146=item - the primary screen is currently being displayed.
147
148=item - the text cursor is visible.
149 158
150=back 159=back
151 160
152The normal selection mechanism isn't disabled, so quick successive clicks 161The normal selection mechanism isn't disabled, so quick successive clicks
153might interfere with selection creation in harmless ways. 162might interfere with selection creation in harmless ways.
203Uses per-line display filtering (C<on_line_update>) to underline urls and 212Uses per-line display filtering (C<on_line_update>) to underline urls and
204make them clickable. When middle-clicked, the program specified in the 213make them clickable. When middle-clicked, the program specified in the
205resource C<urlLauncher> (default C<x-www-browser>) will be started with 214resource C<urlLauncher> (default C<x-www-browser>) will be started with
206the URL as first argument. 215the URL as first argument.
207 216
217=item xim-onthespot
218
219This (experimental) perl extension implements OnTheSpot editing. It does
220not work perfectly, and some input methods don't seem to work well with
221OnTheSpot editing in general, but it seems to work at leats for SCIM and
222kinput2.
223
224You enable it by specifying this extension and a preedit style of
225C<OnTheSpot>, i.e.:
226
227 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
228
208=item automove-background 229=item automove-background
209 230
210This is basically a one-line extension that dynamically changes the background pixmap offset 231This is basically a one-line extension that dynamically changes the background pixmap offset
211to the window position, in effect creating the same effect as pseudo transparency with 232to the window position, in effect creating the same effect as pseudo transparency with
212a custom pixmap. No scaling is supported in this mode. Exmaple: 233a custom pixmap. No scaling is supported in this mode. Exmaple:
221 242
222=item digital-clock 243=item digital-clock
223 244
224Displays a digital clock using the built-in overlay. 245Displays a digital clock using the built-in overlay.
225 246
226=item example-refresh-hooks 247=item remote-clipboard
227 248
228Displays a very simple digital clock in the upper right corner of the 249Somewhat of a misnomer, this extension adds two menu entries to the
229window. Illustrates overwriting the refresh callbacks to create your own 250selection popup that allows one ti run external commands to store the
230overlays or changes. 251selection somewhere and fetch it again.
252
253We use it to implement a "distributed selection mechanism", which just
254means that one command uploads the file to a remote server, and another
255reads it.
256
257The commands can be set using the C<URxvt.remote-selection.store> and
258C<URxvt.remote-selection.fetch> resources. The first should read the
259selection to store from STDIN (always in UTF-8), the second should provide
260the selection data on STDOUT (also in UTF-8).
261
262The defaults (which are likely useless to you) use rsh and cat:
263
264 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
265 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
231 266
232=item selection-pastebin 267=item selection-pastebin
233 268
234This is a little rarely useful extension that Uploads the selection as 269This is a little rarely useful extension that Uploads the selection as
235textfile to a remote site (or does other things). (The implementation is 270textfile to a remote site (or does other things). (The implementation is
255After a successful upload the selection will be replaced by the text given 290After a successful upload the selection will be replaced by the text given
256in the C<selection-pastebin-url> resource (again, the % is the placeholder 291in the C<selection-pastebin-url> resource (again, the % is the placeholder
257for the filename): 292for the filename):
258 293
259 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 294 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
295
296=item example-refresh-hooks
297
298Displays a very simple digital clock in the upper right corner of the
299window. Illustrates overwriting the refresh callbacks to create your own
300overlays or changes.
260 301
261=back 302=back
262 303
263=head1 API DOCUMENTATION 304=head1 API DOCUMENTATION
264 305
361Called at the very end of initialisation of a new terminal, just before 402Called at the very end of initialisation of a new terminal, just before
362trying to map (display) the toplevel and returning to the mainloop. 403trying to map (display) the toplevel and returning to the mainloop.
363 404
364=item on_destroy $term 405=item on_destroy $term
365 406
366Called whenever something tries to destroy terminal, before doing anything 407Called whenever something tries to destroy terminal, when the terminal is
367yet. If this hook returns true, then destruction is skipped, but this is 408still fully functional (not for long, though).
368rarely a good idea.
369 409
370=item on_reset $term 410=item on_reset $term
371 411
372Called after the screen is "reset" for any reason, such as resizing or 412Called after the screen is "reset" for any reason, such as resizing or
373control sequences. Here is where you can react on changes to size-related 413control sequences. Here is where you can react on changes to size-related
475 515
476=item on_refresh_end $term 516=item on_refresh_end $term
477 517
478Called just after the screen gets redrawn. See C<on_refresh_begin>. 518Called just after the screen gets redrawn. See C<on_refresh_begin>.
479 519
480=item on_keyboard_command $term, $string 520=item on_user_command $term, $string
481 521
482Called whenever the user presses a key combination that has a 522Called whenever the a user-configured event is being activated (e.g. via
483C<perl:string> action bound to it (see description of the B<keysym> 523a C<perl:string> action bound to a key, see description of the B<keysym>
484resource in the @@RXVT_NAME@@(1) manpage). 524resource in the @@RXVT_NAME@@(1) manpage).
525
526The event is simply the action string. This interface is assumed to change
527slightly in the future.
485 528
486=item on_x_event $term, $event 529=item on_x_event $term, $event
487 530
488Called on every X event received on the vt window (and possibly other 531Called on every X event received on the vt window (and possibly other
489windows). Should only be used as a last resort. Most event structure 532windows). Should only be used as a last resort. Most event structure
1310Replaces the event mask of the pty watcher by the given event mask. Can 1353Replaces the event mask of the pty watcher by the given event mask. Can
1311be used to suppress input and output handling to the pty/tty. See the 1354be used to suppress input and output handling to the pty/tty. See the
1312description of C<< urxvt::timer->events >>. Make sure to always restore 1355description of C<< urxvt::timer->events >>. Make sure to always restore
1313the previous value. 1356the previous value.
1314 1357
1358=item $fd = $term->pty_fd
1359
1360Returns the master file descriptor for the pty in use, or C<-1> if no pty
1361is used.
1362
1315=item $windowid = $term->parent 1363=item $windowid = $term->parent
1316 1364
1317Return the window id of the toplevel window. 1365Return the window id of the toplevel window.
1318 1366
1319=item $windowid = $term->vt 1367=item $windowid = $term->vt

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines