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.68 by root, Tue Mar 16 00:54:46 2010 UTC vs.
Revision 1.69 by sf-exg, Sat Jul 24 14:20:48 2010 UTC

… …
122.\} 122.\}
123.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
124.\" ======================================================================== 124.\" ========================================================================
125.\" 125.\"
126.IX Title "@@RXVT_NAME@@ 3" 126.IX Title "@@RXVT_NAME@@ 3"
127.TH @@RXVT_NAME@@ 3 "2010-02-06" "@@RXVT_VERSION@@" "RXVT-UNICODE" 127.TH @@RXVT_NAME@@ 3 "2010-07-24" "@@RXVT_VERSION@@" "RXVT-UNICODE"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes 128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents. 129.\" way too many mistakes in technical documents.
130.if n .ad l 130.if n .ad l
131.nh 131.nh
132.SH "NAME" 132.SH "NAME"
… …
484\& URxvt.remote\-selection.store: rsh ruth \*(Aqcat >/tmp/distributed\-selection\*(Aq 484\& URxvt.remote\-selection.store: rsh ruth \*(Aqcat >/tmp/distributed\-selection\*(Aq
485\& URxvt.remote\-selection.fetch: rsh ruth \*(Aqcat /tmp/distributed\-selection\*(Aq 485\& URxvt.remote\-selection.fetch: rsh ruth \*(Aqcat /tmp/distributed\-selection\*(Aq
486.Ve 486.Ve
487.IP "selection-pastebin" 4 487.IP "selection-pastebin" 4
488.IX Item "selection-pastebin" 488.IX Item "selection-pastebin"
489This is a little rarely useful extension that Uploads the selection as 489This is a little rarely useful extension that uploads the selection as
490textfile to a remote site (or does other things). (The implementation is 490textfile to a remote site (or does other things). (The implementation is
491not currently secure for use in a multiuser environment as it writes to 491not currently secure for use in a multiuser environment as it writes to
492\&\fI/tmp\fR directly.). 492\&\fI/tmp\fR directly.).
493.Sp 493.Sp
494It listens to the \f(CW\*(C`selection\-pastebin:remote\-pastebin\*(C'\fR keyboard command, 494It listens to the \f(CW\*(C`selection\-pastebin:remote\-pastebin\*(C'\fR keyboard command,
… …
519\& URxvt.selection\-pastebin.url: http://www.ta\-sa.org/files/txt/% 519\& URxvt.selection\-pastebin.url: http://www.ta\-sa.org/files/txt/%
520.Ve 520.Ve
521.Sp 521.Sp
522\&\fINote to xrdb users:\fR xrdb uses the C preprocessor, which might interpret 522\&\fINote to xrdb users:\fR xrdb uses the C preprocessor, which might interpret
523the double \f(CW\*(C`/\*(C'\fR characters as comment start. Use \f(CW\*(C`\e057\e057\*(C'\fR instead, 523the double \f(CW\*(C`/\*(C'\fR characters as comment start. Use \f(CW\*(C`\e057\e057\*(C'\fR instead,
524which works regardless of wether xrdb is used to parse the resource file 524which works regardless of whether xrdb is used to parse the resource file
525or not. 525or not.
526.IP "macosx-pastebin and macosx-pastebin-native" 4 526.IP "macosx-clipboard and macosx-clipboard-native" 4
527.IX Item "macosx-pastebin and macosx-pastebin-native" 527.IX Item "macosx-clipboard and macosx-clipboard-native"
528These two modules implement an extended clipboard for Mac \s-1OS\s0 X. They are 528These two modules implement an extended clipboard for Mac \s-1OS\s0 X. They are
529used like this: 529used like this:
530.Sp 530.Sp
531.Vb 3 531.Vb 3
532\& URxvt.perl\-ext\-common: default,macosx\-clipboard 532\& URxvt.perl\-ext\-common: default,macosx\-clipboard
533\& URxvt.keysym.M\-c: perl:macosx\-clipboard:copy 533\& URxvt.keysym.M\-c: perl:macosx\-clipboard:copy
534\& URxvt.keysym.M\-v: perl:macosx\-clipboard:paste 534\& URxvt.keysym.M\-v: perl:macosx\-clipboard:paste
535.Ve 535.Ve
536.Sp 536.Sp
537The difference between them is that the native variant requires a 537The difference between them is that the native variant requires a
538perl from apple's devkit or so, and \f(CW\*(C`maxosx\-pastebin\*(C'\fR requires the 538perl from apple's devkit or so, and \f(CW\*(C`macosx\-clipboard\*(C'\fR requires the
539\&\f(CW\*(C`Mac::Pasteboard\*(C'\fR module, works with other perls, has fewer bugs, is 539\&\f(CW\*(C`Mac::Pasteboard\*(C'\fR module, works with other perls, has fewer bugs, is
540simpler etc. etc. 540simpler etc. etc.
541.IP "example-refresh-hooks" 4 541.IP "example-refresh-hooks" 4
542.IX Item "example-refresh-hooks" 542.IX Item "example-refresh-hooks"
543Displays a very simple digital clock in the upper right corner of the 543Displays a very simple digital clock in the upper right corner of the
544window. Illustrates overwriting the refresh callbacks to create your own 544window. Illustrates overwriting the refresh callbacks to create your own
545overlays or changes. 545overlays or changes.
546.IP "confirm-paste" 4
547.IX Item "confirm-paste"
548Displays a confirmation dialog when a paste containing at least a full
549line is detected.
546.SH "API DOCUMENTATION" 550.SH "API DOCUMENTATION"
547.IX Header "API DOCUMENTATION" 551.IX Header "API DOCUMENTATION"
548.SS "General \s-1API\s0 Considerations" 552.SS "General \s-1API\s0 Considerations"
549.IX Subsection "General API Considerations" 553.IX Subsection "General API Considerations"
550All objects (such as terminals, time watchers etc.) are typical 554All objects (such as terminals, time watchers etc.) are typical
… …
561Argument names also often indicate the type of a parameter. Here are some 565Argument names also often indicate the type of a parameter. Here are some
562hints on what they mean: 566hints on what they mean:
563.ie n .IP "$text" 4 567.ie n .IP "$text" 4
564.el .IP "\f(CW$text\fR" 4 568.el .IP "\f(CW$text\fR" 4
565.IX Item "$text" 569.IX Item "$text"
566Rxvt-unicodes special way of encoding text, where one \*(L"unicode\*(R" character 570Rxvt-unicode's special way of encoding text, where one \*(L"unicode\*(R" character
567always represents one screen cell. See ROW_t for a discussion of this format. 571always represents one screen cell. See ROW_t for a discussion of this format.
568.ie n .IP "$string" 4 572.ie n .IP "$string" 4
569.el .IP "\f(CW$string\fR" 4 573.el .IP "\f(CW$string\fR" 4
570.IX Item "$string" 574.IX Item "$string"
571A perl text string, with an emphasis on \fItext\fR. It can store all unicode 575A perl text string, with an emphasis on \fItext\fR. It can store all unicode
… …
745.ie n .IP "on_tt_write $term, $octets" 4 749.ie n .IP "on_tt_write $term, $octets" 4
746.el .IP "on_tt_write \f(CW$term\fR, \f(CW$octets\fR" 4 750.el .IP "on_tt_write \f(CW$term\fR, \f(CW$octets\fR" 4
747.IX Item "on_tt_write $term, $octets" 751.IX Item "on_tt_write $term, $octets"
748Called whenever some data is written to the tty/pty and can be used to 752Called whenever some data is written to the tty/pty and can be used to
749suppress or filter tty input. 753suppress or filter tty input.
754.ie n .IP "on_tt_paste $term, $octets" 4
755.el .IP "on_tt_paste \f(CW$term\fR, \f(CW$octets\fR" 4
756.IX Item "on_tt_paste $term, $octets"
757Called whenever text is about to be pasted, with the text as argument. You
758can filter/change and paste the text yourself by returning a true value
759and calling \f(CW\*(C`$term\->tt_paste\*(C'\fR yourself. \f(CW$octets\fR is
760locale-encoded.
750.ie n .IP "on_line_update $term, $row" 4 761.ie n .IP "on_line_update $term, $row" 4
751.el .IP "on_line_update \f(CW$term\fR, \f(CW$row\fR" 4 762.el .IP "on_line_update \f(CW$term\fR, \f(CW$row\fR" 4
752.IX Item "on_line_update $term, $row" 763.IX Item "on_line_update $term, $row"
753Called whenever a line was updated or changed. Can be used to filter 764Called whenever a line was updated or changed. Can be used to filter
754screen output (e.g. underline urls or other useless stuff). Only lines 765screen output (e.g. underline urls or other useless stuff). Only lines
… …
779a \f(CW\*(C`perl:string\*(C'\fR action bound to a key, see description of the \fBkeysym\fR 790a \f(CW\*(C`perl:string\*(C'\fR action bound to a key, see description of the \fBkeysym\fR
780resource in the @@RXVT_NAME@@(1) manpage). 791resource in the @@RXVT_NAME@@(1) manpage).
781.Sp 792.Sp
782The event is simply the action string. This interface is assumed to change 793The event is simply the action string. This interface is assumed to change
783slightly in the future. 794slightly in the future.
784.ie n .IP "on_resize_all_windows $tern, $new_width, $new_height" 4 795.ie n .IP "on_resize_all_windows $term, $new_width, $new_height" 4
785.el .IP "on_resize_all_windows \f(CW$tern\fR, \f(CW$new_width\fR, \f(CW$new_height\fR" 4 796.el .IP "on_resize_all_windows \f(CW$term\fR, \f(CW$new_width\fR, \f(CW$new_height\fR" 4
786.IX Item "on_resize_all_windows $tern, $new_width, $new_height" 797.IX Item "on_resize_all_windows $term, $new_width, $new_height"
787Called just after the new window size has been calculated, but before 798Called just after the new window size has been calculated, but before
788windows are actually being resized or hints are being set. If this hook 799windows are actually being resized or hints are being set. If this hook
789returns \s-1TRUE\s0, setting of the window hints is being skipped. 800returns \s-1TRUE\s0, setting of the window hints is being skipped.
790.ie n .IP "on_x_event $term, $event" 4 801.ie n .IP "on_x_event $term, $event" 4
791.el .IP "on_x_event \f(CW$term\fR, \f(CW$event\fR" 4 802.el .IP "on_x_event \f(CW$term\fR, \f(CW$event\fR" 4
… …
834.IX Item "on_map_notify $term, $event" 845.IX Item "on_map_notify $term, $event"
835.ie n .IP "on_unmap_notify $term, $event" 4 846.ie n .IP "on_unmap_notify $term, $event" 4
836.el .IP "on_unmap_notify \f(CW$term\fR, \f(CW$event\fR" 4 847.el .IP "on_unmap_notify \f(CW$term\fR, \f(CW$event\fR" 4
837.IX Item "on_unmap_notify $term, $event" 848.IX Item "on_unmap_notify $term, $event"
838.PD 849.PD
839Called whenever the corresponding X event is received for the terminal If 850Called whenever the corresponding X event is received for the terminal. If
840the hook returns true, then the even will be ignored by rxvt-unicode. 851the hook returns true, then the event will be ignored by rxvt-unicode.
841.Sp 852.Sp
842The event is a hash with most values as named by Xlib (see the XEvent 853The event is a hash with most values as named by Xlib (see the XEvent
843manpage), with the additional members \f(CW\*(C`row\*(C'\fR and \f(CW\*(C`col\*(C'\fR, which are the 854manpage), with the additional members \f(CW\*(C`row\*(C'\fR and \f(CW\*(C`col\*(C'\fR, which are the
844(real, not screen-based) row and column under the mouse cursor. 855(real, not screen-based) row and column under the mouse cursor.
845.Sp 856.Sp
… …
1142.ie n .IP "$term\->selection_make ($eventtime[, $rectangular])" 4 1153.ie n .IP "$term\->selection_make ($eventtime[, $rectangular])" 4
1143.el .IP "\f(CW$term\fR\->selection_make ($eventtime[, \f(CW$rectangular\fR])" 4 1154.el .IP "\f(CW$term\fR\->selection_make ($eventtime[, \f(CW$rectangular\fR])" 4
1144.IX Item "$term->selection_make ($eventtime[, $rectangular])" 1155.IX Item "$term->selection_make ($eventtime[, $rectangular])"
1145Tries to make a selection as set by \f(CW\*(C`selection_beg\*(C'\fR and 1156Tries to make a selection as set by \f(CW\*(C`selection_beg\*(C'\fR and
1146\&\f(CW\*(C`selection_end\*(C'\fR. If \f(CW$rectangular\fR is true (default: false), a 1157\&\f(CW\*(C`selection_end\*(C'\fR. If \f(CW$rectangular\fR is true (default: false), a
1147rectangular selection will be made. This is the prefered function to make 1158rectangular selection will be made. This is the preferred function to make
1148a selection. 1159a selection.
1149.ie n .IP "$success = $term\->selection_grab ($eventtime)" 4 1160.ie n .IP "$success = $term\->selection_grab ($eventtime[, $clipboard])" 4
1150.el .IP "\f(CW$success\fR = \f(CW$term\fR\->selection_grab ($eventtime)" 4 1161.el .IP "\f(CW$success\fR = \f(CW$term\fR\->selection_grab ($eventtime[, \f(CW$clipboard\fR])" 4
1151.IX Item "$success = $term->selection_grab ($eventtime)" 1162.IX Item "$success = $term->selection_grab ($eventtime[, $clipboard])"
1152Try to request the primary selection text from the server (for example, as 1163Try to acquire ownership of the primary (clipboard if \f(CW$clipboard\fR is
1164true) selection from the server. The corresponding text can be set
1153set by the next method). No visual feedback will be given. This function 1165with the next method. No visual feedback will be given. This function
1154is mostly useful from within \f(CW\*(C`on_sel_grab\*(C'\fR hooks. 1166is mostly useful from within \f(CW\*(C`on_sel_grab\*(C'\fR hooks.
1155.ie n .IP "$oldtext = $term\->selection ([$newtext])" 4 1167.ie n .IP "$oldtext = $term\->selection ([$newtext, $clipboard])" 4
1156.el .IP "\f(CW$oldtext\fR = \f(CW$term\fR\->selection ([$newtext])" 4 1168.el .IP "\f(CW$oldtext\fR = \f(CW$term\fR\->selection ([$newtext, \f(CW$clipboard\fR])" 4
1157.IX Item "$oldtext = $term->selection ([$newtext])" 1169.IX Item "$oldtext = $term->selection ([$newtext, $clipboard])"
1158Return the current selection text and optionally replace it by \f(CW$newtext\fR. 1170Return the current selection (clipboard if \f(CW$clipboard\fR is true) text
1171and optionally replace it by \f(CW$newtext\fR.
1172.ie n .IP "$term\->selection_clear ([$clipboard])" 4
1173.el .IP "\f(CW$term\fR\->selection_clear ([$clipboard])" 4
1174.IX Item "$term->selection_clear ([$clipboard])"
1175Revoke ownership of the primary (clipboard if \f(CW$clipboard\fR is true) selection.
1159.ie n .IP "$term\->overlay_simple ($x, $y, $text)" 4 1176.ie n .IP "$term\->overlay_simple ($x, $y, $text)" 4
1160.el .IP "\f(CW$term\fR\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text\fR)" 4 1177.el .IP "\f(CW$term\fR\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text\fR)" 4
1161.IX Item "$term->overlay_simple ($x, $y, $text)" 1178.IX Item "$term->overlay_simple ($x, $y, $text)"
1162Create a simple multi-line overlay box. See the next method for details. 1179Create a simple multi-line overlay box. See the next method for details.
1163.ie n .IP "$term\->overlay ($x, $y, $width, $height[, $rstyle[, $border]])" 4 1180.ie n .IP "$term\->overlay ($x, $y, $width, $height[, $rstyle[, $border]])" 4
… …
1255locale-specific encoding of the terminal and can contain command sequences 1272locale-specific encoding of the terminal and can contain command sequences
1256(escape codes) that will be interpreted. 1273(escape codes) that will be interpreted.
1257.ie n .IP "$term\->tt_write ($octets)" 4 1274.ie n .IP "$term\->tt_write ($octets)" 4
1258.el .IP "\f(CW$term\fR\->tt_write ($octets)" 4 1275.el .IP "\f(CW$term\fR\->tt_write ($octets)" 4
1259.IX Item "$term->tt_write ($octets)" 1276.IX Item "$term->tt_write ($octets)"
1260Write the octets given in \f(CW$data\fR to the tty (i.e. as program input). To 1277Write the octets given in \f(CW$octets\fR to the tty (i.e. as program input). To
1261pass characters instead of octets, you should convert your strings first 1278pass characters instead of octets, you should convert your strings first
1262to the locale-specific encoding using \f(CW\*(C`$term\->locale_encode\*(C'\fR. 1279to the locale-specific encoding using \f(CW\*(C`$term\->locale_encode\*(C'\fR.
1280.ie n .IP "$term\->tt_paste ($octets)" 4
1281.el .IP "\f(CW$term\fR\->tt_paste ($octets)" 4
1282.IX Item "$term->tt_paste ($octets)"
1283Write the octets given in \f(CW$octets\fR to the tty as a paste, converting \s-1NL\s0 to
1284\&\s-1CR\s0 and bracketing the data with control sequences if bracketed paste mode
1285is set.
1263.ie n .IP "$old_events = $term\->pty_ev_events ([$new_events])" 4 1286.ie n .IP "$old_events = $term\->pty_ev_events ([$new_events])" 4
1264.el .IP "\f(CW$old_events\fR = \f(CW$term\fR\->pty_ev_events ([$new_events])" 4 1287.el .IP "\f(CW$old_events\fR = \f(CW$term\fR\->pty_ev_events ([$new_events])" 4
1265.IX Item "$old_events = $term->pty_ev_events ([$new_events])" 1288.IX Item "$old_events = $term->pty_ev_events ([$new_events])"
1266Replaces the event mask of the pty watcher by the given event mask. Can 1289Replaces the event mask of the pty watcher by the given event mask. Can
1267be used to suppress input and output handling to the pty/tty. See the 1290be used to suppress input and output handling to the pty/tty. See the
… …
1529Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1552Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1530recent grab. 1553recent grab.
1531.ie n .IP "$term\->ungrab" 4 1554.ie n .IP "$term\->ungrab" 4
1532.el .IP "\f(CW$term\fR\->ungrab" 4 1555.el .IP "\f(CW$term\fR\->ungrab" 4
1533.IX Item "$term->ungrab" 1556.IX Item "$term->ungrab"
1534Calls XUngrab for the most recent grab. Is called automatically on 1557Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1535evaluation errors, as it is better to lose the grab in the error case as 1558evaluation errors, as it is better to lose the grab in the error case as
1536the session. 1559the session.
1537.ie n .IP "$atom = $term\->XInternAtom ($atom_name[, $only_if_exists])" 4 1560.ie n .IP "$atom = $term\->XInternAtom ($atom_name[, $only_if_exists])" 4
1538.el .IP "\f(CW$atom\fR = \f(CW$term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists\fR])" 4 1561.el .IP "\f(CW$atom\fR = \f(CW$term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists\fR])" 4
1539.IX Item "$atom = $term->XInternAtom ($atom_name[, $only_if_exists])" 1562.IX Item "$atom = $term->XInternAtom ($atom_name[, $only_if_exists])"
… …
1575.el .IP "\f(CW$term\fR\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events\fR])" 4 1598.el .IP "\f(CW$term\fR\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events\fR])" 4
1576.IX Item "$term->XChangeInput ($window, $add_events[, $del_events])" 1599.IX Item "$term->XChangeInput ($window, $add_events[, $del_events])"
1577.PD 1600.PD
1578Various X or X\-related functions. The \f(CW$term\fR object only serves as 1601Various X or X\-related functions. The \f(CW$term\fR object only serves as
1579the source of the display, otherwise those functions map more-or-less 1602the source of the display, otherwise those functions map more-or-less
1580directory onto the X functions of the same name. 1603directly onto the X functions of the same name.
1581.ie n .SS "The ""urxvt::popup"" Class" 1604.ie n .SS "The ""urxvt::popup"" Class"
1582.el .SS "The \f(CWurxvt::popup\fP Class" 1605.el .SS "The \f(CWurxvt::popup\fP Class"
1583.IX Subsection "The urxvt::popup Class" 1606.IX Subsection "The urxvt::popup Class"
1584.ie n .IP "$popup\->add_title ($title)" 4 1607.ie n .IP "$popup\->add_title ($title)" 4
1585.el .IP "\f(CW$popup\fR\->add_title ($title)" 4 1608.el .IP "\f(CW$popup\fR\->add_title ($title)" 4

Diff Legend

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