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.20 by root, Tue Jan 10 18:09:22 2006 UTC vs.
Revision 1.21 by root, Tue Jan 10 19:46:28 2006 UTC

… …
460.Sp 460.Sp
461subwindow. 461subwindow.
462.ie n .Sh "Variables in the ""urxvt"" Package" 462.ie n .Sh "Variables in the ""urxvt"" Package"
463.el .Sh "Variables in the \f(CWurxvt\fP Package" 463.el .Sh "Variables in the \f(CWurxvt\fP Package"
464.IX Subsection "Variables in the urxvt Package" 464.IX Subsection "Variables in the urxvt Package"
465.IP "$urxvt::LIBDIR" 4
466.IX Item "$urxvt::LIBDIR"
467The rxvt-unicode library directory, where, among other things, the perl
468modules and scripts are stored.
469.ie n .IP "$urxvt::RESCLASS, $urxvt::RESCLASS" 4
470.el .IP "$urxvt::RESCLASS, \f(CW$urxvt::RESCLASS\fR" 4
471.IX Item "$urxvt::RESCLASS, $urxvt::RESCLASS"
472The resource class and name rxvt-unicode uses to look up X resources.
473.IP "$urxvt::RXVTNAME" 4
474.IX Item "$urxvt::RXVTNAME"
475The basename of the installed binaries, usually \f(CW\*(C`urxvt\*(C'\fR.
465.IP "$urxvt::TERM" 4 476.IP "$urxvt::TERM" 4
466.IX Item "$urxvt::TERM" 477.IX Item "$urxvt::TERM"
467The current terminal. This variable stores the current \f(CW\*(C`urxvt::term\*(C'\fR 478The current terminal. This variable stores the current \f(CW\*(C`urxvt::term\*(C'\fR
468object, whenever a callback/hook is executing. 479object, whenever a callback/hook is executing.
480.IP "*" 4
469.ie n .Sh "Functions in the ""urxvt"" Package" 481.ie n .Sh "Functions in the ""urxvt"" Package"
470.el .Sh "Functions in the \f(CWurxvt\fP Package" 482.el .Sh "Functions in the \f(CWurxvt\fP Package"
471.IX Subsection "Functions in the urxvt Package" 483.IX Subsection "Functions in the urxvt Package"
484.PD 0
472.IP "$term = new urxvt [arg...]" 4 485.IP "$term = new urxvt [arg...]" 4
473.IX Item "$term = new urxvt [arg...]" 486.IX Item "$term = new urxvt [arg...]"
487.PD
474Creates a new terminal, very similar as if you had started it with 488Creates a new terminal, very similar as if you had started it with
475\&\f(CW\*(C`system $binfile, arg...\*(C'\fR. Croaks (and probably outputs an error message) 489\&\f(CW\*(C`system $binfile, arg...\*(C'\fR. Croaks (and probably outputs an error message)
476if the new instance couldn't be created. Returns \f(CW\*(C`undef\*(C'\fR if the new 490if the new instance couldn't be created. Returns \f(CW\*(C`undef\*(C'\fR if the new
477instance didn't initialise perl, and the terminal object otherwise. The 491instance didn't initialise perl, and the terminal object otherwise. The
478\&\f(CW\*(C`init\*(C'\fR and \f(CW\*(C`start\*(C'\fR hooks will be called during the call. 492\&\f(CW\*(C`init\*(C'\fR and \f(CW\*(C`start\*(C'\fR hooks will be called during the call.
… …
534.ie n .IP "$background = urxvt::GET_BASEBG $rend" 4 548.ie n .IP "$background = urxvt::GET_BASEBG $rend" 4
535.el .IP "$background = urxvt::GET_BASEBG \f(CW$rend\fR" 4 549.el .IP "$background = urxvt::GET_BASEBG \f(CW$rend\fR" 4
536.IX Item "$background = urxvt::GET_BASEBG $rend" 550.IX Item "$background = urxvt::GET_BASEBG $rend"
537.PD 551.PD
538Return the foreground/background colour index, respectively. 552Return the foreground/background colour index, respectively.
539.ie n .IP "$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)" 4 553.ie n .IP "$rend = urxvt::SET_FGCOLOR $rend\fR, \f(CW$new_colour" 4
540.el .IP "$rend = urxvt::SET_FGCOLOR ($rend, \f(CW$new_colour\fR)" 4 554.el .IP "$rend = urxvt::SET_FGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4
541.IX Item "$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)" 555.IX Item "$rend = urxvt::SET_FGCOLOR $rend, $new_colour"
542.PD 0 556.PD 0
543.ie n .IP "$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)" 4 557.ie n .IP "$rend = urxvt::SET_BGCOLOR $rend\fR, \f(CW$new_colour" 4
544.el .IP "$rend = urxvt::SET_BGCOLOR ($rend, \f(CW$new_colour\fR)" 4 558.el .IP "$rend = urxvt::SET_BGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4
545.IX Item "$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)" 559.IX Item "$rend = urxvt::SET_BGCOLOR $rend, $new_colour"
546.PD 560.PD
547Replace the foreground/background colour in the rendition mask with the 561Replace the foreground/background colour in the rendition mask with the
548specified one. 562specified one.
549.IP "$value = urxvt::GET_CUSTOM ($rend)" 4 563.ie n .IP "$value = urxvt::GET_CUSTOM $rend" 4
564.el .IP "$value = urxvt::GET_CUSTOM \f(CW$rend\fR" 4
550.IX Item "$value = urxvt::GET_CUSTOM ($rend)" 565.IX Item "$value = urxvt::GET_CUSTOM $rend"
551Return the \*(L"custom\*(R" value: Every rendition has 5 bits for use by 566Return the \*(L"custom\*(R" value: Every rendition has 5 bits for use by
552extensions. They can be set and changed as you like and are initially 567extensions. They can be set and changed as you like and are initially
553zero. 568zero.
554.ie n .IP "$rend = urxvt::SET_CUSTOM ($rend, $new_value)" 4 569.ie n .IP "$rend = urxvt::SET_CUSTOM $rend\fR, \f(CW$new_value" 4
555.el .IP "$rend = urxvt::SET_CUSTOM ($rend, \f(CW$new_value\fR)" 4 570.el .IP "$rend = urxvt::SET_CUSTOM \f(CW$rend\fR, \f(CW$new_value\fR" 4
556.IX Item "$rend = urxvt::SET_CUSTOM ($rend, $new_value)" 571.IX Item "$rend = urxvt::SET_CUSTOM $rend, $new_value"
557Change the custom value. 572Change the custom value.
558.ie n .Sh "The ""urxvt::anyevent"" Class" 573.ie n .Sh "The ""urxvt::anyevent"" Class"
559.el .Sh "The \f(CWurxvt::anyevent\fP Class" 574.el .Sh "The \f(CWurxvt::anyevent\fP Class"
560.IX Subsection "The urxvt::anyevent Class" 575.IX Subsection "The urxvt::anyevent Class"
561The sole purpose of this class is to deliver an interface to the 576The sole purpose of this class is to deliver an interface to the
562\&\f(CW\*(C`AnyEvent\*(C'\fR module \- any module using it will work inside urxvt without 577\&\f(CW\*(C`AnyEvent\*(C'\fR module \- any module using it will work inside urxvt without
563further work. The only exception is that you cannot wait on condition 578further programming. The only exception is that you cannot wait on
564variables, but non-blocking condvar use is ok. What this means is that you 579condition variables, but non-blocking condvar use is ok. What this means
565cannot use blocking APIs, but the non-blocking variant should work. 580is that you cannot use blocking APIs, but the non-blocking variant should
581work.
566.ie n .Sh "The ""urxvt::term"" Class" 582.ie n .Sh "The ""urxvt::term"" Class"
567.el .Sh "The \f(CWurxvt::term\fP Class" 583.el .Sh "The \f(CWurxvt::term\fP Class"
568.IX Subsection "The urxvt::term Class" 584.IX Subsection "The urxvt::term Class"
569.IP "$term\->destroy" 4 585.IP "$term\->destroy" 4
570.IX Item "$term->destroy" 586.IX Item "$term->destroy"
571Destroy the terminal object (close the window, free resources etc.). 587Destroy the terminal object (close the window, free resources
588etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
589watchers (timers, io watchers) are still active.
572.ie n .IP "$isset = $term\fR\->option ($optval[, \f(CW$set])" 4 590.ie n .IP "$isset = $term\fR\->option ($optval[, \f(CW$set])" 4
573.el .IP "$isset = \f(CW$term\fR\->option ($optval[, \f(CW$set\fR])" 4 591.el .IP "$isset = \f(CW$term\fR\->option ($optval[, \f(CW$set\fR])" 4
574.IX Item "$isset = $term->option ($optval[, $set])" 592.IX Item "$isset = $term->option ($optval[, $set])"
575Returns true if the option specified by \f(CW$optval\fR is enabled, and 593Returns true if the option specified by \f(CW$optval\fR is enabled, and
576optionally change it. All option values are stored by name in the hash 594optionally change it. All option values are stored by name in the hash
… …
965evaluation errors, as it is better to lose the grab in the error case as 983evaluation errors, as it is better to lose the grab in the error case as
966the session. 984the session.
967.ie n .Sh "The ""urxvt::popup"" Class" 985.ie n .Sh "The ""urxvt::popup"" Class"
968.el .Sh "The \f(CWurxvt::popup\fP Class" 986.el .Sh "The \f(CWurxvt::popup\fP Class"
969.IX Subsection "The urxvt::popup Class" 987.IX Subsection "The urxvt::popup Class"
988.IP "$popup\->add_title ($title)" 4
989.IX Item "$popup->add_title ($title)"
990Adds a non-clickable title to the popup.
991.IP "$popup\->add_separator ([$sepchr])" 4
992.IX Item "$popup->add_separator ([$sepchr])"
993Creates a separator, optionally using the character given as \f(CW$sepchr\fR.
994.ie n .IP "$popup\->add_button ($text, $cb)" 4
995.el .IP "$popup\->add_button ($text, \f(CW$cb\fR)" 4
996.IX Item "$popup->add_button ($text, $cb)"
997Adds a clickable button to the popup. \f(CW$cb\fR is called whenever it is
998selected.
999.ie n .IP "$popup\->add_toggle ($text, $cb\fR, \f(CW$initial_value)" 4
1000.el .IP "$popup\->add_toggle ($text, \f(CW$cb\fR, \f(CW$initial_value\fR)" 4
1001.IX Item "$popup->add_toggle ($text, $cb, $initial_value)"
1002Adds a toggle/checkbox item to the popup. Teh callback gets called
1003whenever it gets toggled, with a boolean indicating its value as its first
1004argument.
1005.IP "$popup\->show" 4
1006.IX Item "$popup->show"
1007Displays the popup (which is initially hidden).
970.ie n .Sh "The ""urxvt::timer"" Class" 1008.ie n .Sh "The ""urxvt::timer"" Class"
971.el .Sh "The \f(CWurxvt::timer\fP Class" 1009.el .Sh "The \f(CWurxvt::timer\fP Class"
972.IX Subsection "The urxvt::timer Class" 1010.IX Subsection "The urxvt::timer Class"
973.RS 4
974This class implements timer watchers/events. Time is represented as a 1011This class implements timer watchers/events. Time is represented as a
975fractional number of seconds since the epoch. Example: 1012fractional number of seconds since the epoch. Example:
976.Sp 1013.Sp
977.Vb 8 1014.Vb 8
978\& $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); 1015\& $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
… …
982\& ->cb (sub { 1019\& ->cb (sub {
983\& $term->{overlay}->set (0, 0, 1020\& $term->{overlay}->set (0, 0,
984\& sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1021\& sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
985\& }); 1022\& });
986.Ve 1023.Ve
1024.RS 4
987.IP "$timer = new urxvt::timer" 4 1025.IP "$timer = new urxvt::timer" 4
988.IX Item "$timer = new urxvt::timer" 1026.IX Item "$timer = new urxvt::timer"
989Create a new timer object in started state. It is scheduled to fire 1027Create a new timer object in started state. It is scheduled to fire
990immediately. 1028immediately.
991.ie n .IP "$timer = $timer\fR\->cb (sub { my ($timer) = \f(CW@_; ... })" 4 1029.ie n .IP "$timer = $timer\fR\->cb (sub { my ($timer) = \f(CW@_; ... })" 4

Diff Legend

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