From b6d9bd05e69b2c1fa75cd1295c4e30f7b413bf47 Mon Sep 17 00:00:00 2001 From: root Date: Wed, 11 Jan 2006 00:59:58 +0000 Subject: [PATCH] *** empty log message *** --- doc/rxvtperl.3.html | 12 ++-- doc/rxvtperl.3.man.in | 25 +++++-- doc/rxvtperl.3.txt | 151 +++++++++++++++++++++--------------------- src/urxvt.pm | 10 +-- 4 files changed, 107 insertions(+), 91 deletions(-) diff --git a/doc/rxvtperl.3.html b/doc/rxvtperl.3.html index 4fb3dff4..ec9d00b1 100644 --- a/doc/rxvtperl.3.html +++ b/doc/rxvtperl.3.html @@ -185,7 +185,7 @@ hints on what they mean:

Rxvt-unicodes special way of encoding text, where one ``unicode'' character -always represents one screen cell. See ROW_t for a discussion of this format. +always represents one screen cell. See row_t for a discussion of this format.

$string
@@ -478,7 +478,9 @@ The basename of the installed binaries, usually urxvt. The current terminal. This variable stores the current urxvt::term object, whenever a callback/hook is executing. -

+

+
+

Functions in the urxvt Package

@@ -609,11 +611,11 @@ work.

Creates a new terminal, very similar as if you had started it with system -$rxvtname, arg.... $envhashref must be a reference to a %ENV-like -hash which defines the environment of the new terminal. +$rxvtname, arg.... $envhashref must be a reference to a %ENV>-like +hash which defines the environment of the new terminal.
-

Croaks (and probably outputs an error message) if the new instance +

>Croaks (and probably outputs an error message) if the new instance couldn't be created. Returns undef if the new instance didn't initialise perl, and the terminal object otherwise. The init and start hooks will be called during this call.

diff --git a/doc/rxvtperl.3.man.in b/doc/rxvtperl.3.man.in index e6cc2beb..7cec2735 100644 --- a/doc/rxvtperl.3.man.in +++ b/doc/rxvtperl.3.man.in @@ -246,7 +246,7 @@ hints on what they mean: .IP "$text" 4 .IX Item "$text" Rxvt-unicodes special way of encoding text, where one \*(L"unicode\*(R" character -always represents one screen cell. See ROW_t for a discussion of this format. +always represents one screen cell. See row_t for a discussion of this format. .IP "$string" 4 .IX Item "$string" A perl text string, with an emphasis on \fItext\fR. It can store all unicode @@ -477,12 +477,15 @@ The basename of the installed binaries, usually \f(CW\*(C`urxvt\*(C'\fR. .IX Item "$urxvt::TERM" The current terminal. This variable stores the current \f(CW\*(C`urxvt::term\*(C'\fR object, whenever a callback/hook is executing. +.IP "*" 4 .ie n .Sh "Functions in the ""urxvt"" Package" .el .Sh "Functions in the \f(CWurxvt\fP Package" .IX Subsection "Functions in the urxvt Package" +.PD 0 .ie n .IP "urxvt::fatal $errormessage" 4 .el .IP "urxvt::fatal \f(CW$errormessage\fR" 4 .IX Item "urxvt::fatal $errormessage" +.PD Fatally aborts execution with the given error message. Avoid at all costs! The only time this is acceptable is when the terminal process starts up. @@ -578,10 +581,11 @@ work. .el .IP "$term = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname\fR, [arg...]" 4 .IX Item "$term = new urxvt::term $envhashref, $rxvtname, [arg...]" Creates a new terminal, very similar as if you had started it with system -\&\f(CW\*(C`$rxvtname, arg...\*(C'\fR. \f(CW$envhashref\fR must be a reference to a \f(CW%ENV\fR\-like -hash which defines the environment of the new terminal. -.Sp -Croaks (and probably outputs an error message) if the new instance +\&\f(CW\*(C`$rxvtname, arg...\*(C'\fR. \f(CW$envhashref\fR must be a reference to a \f(CW%ENV\fR>\-like +\&\f(CW\*(C`hash which defines the environment of the new terminal. + +\&\*(C'\fR.Sp +>Croaks (and probably outputs an error message) if the new instance couldn't be created. Returns \f(CW\*(C`undef\*(C'\fR if the new instance didn't initialise perl, and the terminal object otherwise. The \f(CW\*(C`init\*(C'\fR and \&\f(CW\*(C`start\*(C'\fR hooks will be called during this call. @@ -1018,7 +1022,7 @@ Displays the popup (which is initially hidden). .IX Subsection "The urxvt::timer Class" This class implements timer watchers/events. Time is represented as a fractional number of seconds since the epoch. Example: -.PP +.Sp .Vb 8 \& $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); \& $term->{timer} = urxvt::timer @@ -1029,6 +1033,7 @@ fractional number of seconds since the epoch. Example: \& sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); \& }); .Ve +.RS 4 .IP "$timer = new urxvt::timer" 4 .IX Item "$timer = new urxvt::timer" Create a new timer object in started state. It is scheduled to fire @@ -1063,11 +1068,13 @@ Set the event trigger time to \f(CW$tstamp\fR and start the timer. .el .IP "$timer = \f(CW$timer\fR\->stop" 4 .IX Item "$timer = $timer->stop" Stop the timer. +.RE +.RS 4 .ie n .Sh "The ""urxvt::iow"" Class" .el .Sh "The \f(CWurxvt::iow\fP Class" .IX Subsection "The urxvt::iow Class" This class implements io watchers/events. Example: -.PP +.Sp .Vb 12 \& $term->{socket} = ... \& $term->{iow} = urxvt::iow @@ -1108,6 +1115,8 @@ Start watching for requested events on the given handle. .el .IP "$iow = \f(CW$iow\fR\->stop" 4 .IX Item "$iow = $iow->stop" Stop watching for events on the given filehandle. +.RE +.RS 4 .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" .Sh "\s-1URXVT_PERL_VERBOSITY\s0" @@ -1121,6 +1130,8 @@ numbers indicate more verbose output. .IX Item ">= 3 - script loading and management" .IP ">=10 \- all events received" 4 .IX Item ">=10 - all events received" +.RE +.RS 4 .PD .SH "AUTHOR" .IX Header "AUTHOR" diff --git a/doc/rxvtperl.3.txt b/doc/rxvtperl.3.txt index 9b8b83bc..1246f021 100644 --- a/doc/rxvtperl.3.txt +++ b/doc/rxvtperl.3.txt @@ -100,7 +100,7 @@ API DOCUMENTATION $text Rxvt-unicodes special way of encoding text, where one "unicode" - character always represents one screen cell. See ROW_t for a + character always represents one screen cell. See row_t for a discussion of this format. $string @@ -301,6 +301,8 @@ API DOCUMENTATION The current terminal. This variable stores the current "urxvt::term" object, whenever a callback/hook is executing. + * + Functions in the "urxvt" Package urxvt::fatal $errormessage Fatally aborts execution with the given error message. Avoid at all @@ -382,9 +384,10 @@ API DOCUMENTATION $term = new urxvt::term $envhashref, $rxvtname, [arg...] Creates a new terminal, very similar as if you had started it with system "$rxvtname, arg...". $envhashref must be a reference to a - %ENV-like hash which defines the environment of the new terminal. + %ENV>-like "hash which defines the environment of the new terminal. + " - Croaks (and probably outputs an error message) if the new instance + >Croaks (and probably outputs an error message) if the new instance couldn't be created. Returns "undef" if the new instance didn't initialise perl, and the terminal object otherwise. The "init" and "start" hooks will be called during this call. @@ -735,92 +738,92 @@ API DOCUMENTATION Displays the popup (which is initially hidden). The "urxvt::timer" Class - This class implements timer watchers/events. Time is represented as a - fractional number of seconds since the epoch. Example: + This class implements timer watchers/events. Time is represented as + a fractional number of seconds since the epoch. Example: - $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); - $term->{timer} = urxvt::timer - ->new - ->interval (1) - ->cb (sub { - $term->{overlay}->set (0, 0, - sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); - }); + $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); + $term->{timer} = urxvt::timer + ->new + ->interval (1) + ->cb (sub { + $term->{overlay}->set (0, 0, + sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); + }); - $timer = new urxvt::timer - Create a new timer object in started state. It is scheduled to fire - immediately. + $timer = new urxvt::timer + Create a new timer object in started state. It is scheduled to + fire immediately. - $timer = $timer->cb (sub { my ($timer) = @_; ... }) - Set the callback to be called when the timer triggers. + $timer = $timer->cb (sub { my ($timer) = @_; ... }) + Set the callback to be called when the timer triggers. - $tstamp = $timer->at - Return the time this watcher will fire next. + $tstamp = $timer->at + Return the time this watcher will fire next. - $timer = $timer->set ($tstamp) - Set the time the event is generated to $tstamp. + $timer = $timer->set ($tstamp) + Set the time the event is generated to $tstamp. - $timer = $timer->interval ($interval) - Normally (and when $interval is 0), the timer will automatically - stop after it has fired once. If $interval is non-zero, then the - timer is automatically rescheduled at the given intervals. + $timer = $timer->interval ($interval) + Normally (and when $interval is 0), the timer will automatically + stop after it has fired once. If $interval is non-zero, then the + timer is automatically rescheduled at the given intervals. - $timer = $timer->start - Start the timer. + $timer = $timer->start + Start the timer. - $timer = $timer->start ($tstamp) - Set the event trigger time to $tstamp and start the timer. + $timer = $timer->start ($tstamp) + Set the event trigger time to $tstamp and start the timer. - $timer = $timer->stop - Stop the timer. + $timer = $timer->stop + Stop the timer. The "urxvt::iow" Class - This class implements io watchers/events. Example: - - $term->{socket} = ... - $term->{iow} = urxvt::iow - ->new - ->fd (fileno $term->{socket}) - ->events (urxvt::EVENT_READ) - ->start - ->cb (sub { - my ($iow, $revents) = @_; - # $revents must be 1 here, no need to check - sysread $term->{socket}, my $buf, 8192 - or end-of-file; - }); - - $iow = new urxvt::iow - Create a new io watcher object in stopped state. - - $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) - Set the callback to be called when io events are triggered. - $reventmask is a bitset as described in the "events" method. - - $iow = $iow->fd ($fd) - Set the filedescriptor (not handle) to watch. - - $iow = $iow->events ($eventmask) - Set the event mask to watch. The only allowed values are - "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed - together, or "urxvt::EVENT_NONE". - - $iow = $iow->start - Start watching for requested events on the given handle. - - $iow = $iow->stop - Stop watching for events on the given filehandle. + This class implements io watchers/events. Example: + + $term->{socket} = ... + $term->{iow} = urxvt::iow + ->new + ->fd (fileno $term->{socket}) + ->events (urxvt::EVENT_READ) + ->start + ->cb (sub { + my ($iow, $revents) = @_; + # $revents must be 1 here, no need to check + sysread $term->{socket}, my $buf, 8192 + or end-of-file; + }); + + $iow = new urxvt::iow + Create a new io watcher object in stopped state. + + $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) + Set the callback to be called when io events are triggered. + $reventmask is a bitset as described in the "events" method. + + $iow = $iow->fd ($fd) + Set the filedescriptor (not handle) to watch. + + $iow = $iow->events ($eventmask) + Set the event mask to watch. The only allowed values are + "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be + ORed together, or "urxvt::EVENT_NONE". + + $iow = $iow->start + Start watching for requested events on the given handle. + + $iow = $iow->stop + Stop watching for events on the given filehandle. ENVIRONMENT URXVT_PERL_VERBOSITY - This variable controls the verbosity level of the perl extension. Higher - numbers indicate more verbose output. + This variable controls the verbosity level of the perl extension. + Higher numbers indicate more verbose output. - == 0 - fatal messages - >= 3 - script loading and management - >=10 - all events received + == 0 - fatal messages + >= 3 - script loading and management + >=10 - all events received AUTHOR - Marc Lehmann - http://software.schmorp.de/pkg/rxvt-unicode + Marc Lehmann + http://software.schmorp.de/pkg/rxvt-unicode diff --git a/src/urxvt.pm b/src/urxvt.pm index 44c7611c..46f3fa56 100644 --- a/src/urxvt.pm +++ b/src/urxvt.pm @@ -125,7 +125,7 @@ hints on what they mean: =item $text Rxvt-unicodes special way of encoding text, where one "unicode" character -always represents one screen cell. See L for a discussion of this format. +always represents one screen cell. See L for a discussion of this format. =item $string @@ -388,6 +388,8 @@ The basename of the installed binaries, usually C. The current terminal. This variable stores the current C object, whenever a callback/hook is executing. +=item + =back =head2 Functions in the C Package @@ -782,8 +784,8 @@ sub register_package { =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] Creates a new terminal, very similar as if you had started it with system -C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like -hash which defines the environment of the new terminal. +C<$rxvtname, arg...>. C<$envhashref> must be a reference to a %ENV>-like +C if the new instance didn't @@ -1442,8 +1444,6 @@ sub DESTROY { $self->{term}->ungrab; } -=back - =head2 The C Class This class implements timer watchers/events. Time is represented as a -- 2.34.1