~kklimonda/ubuntu/lucid/rxvt-unicode/lp-514821

Committer: Bazaar Package Importer
Author(s): Decklin Foster
Date: 2006-09-01 14:44:58 UTC
mfrom: (1.1.8 upstream) (3.1.1 etch)
Revision ID: james.westby@ubuntu.com-20060901144458-98hrz8zg01w8a3vy

Tags: 7.9-2

http://bugs.debian.org/385481

* Edit the comments in the app-defaults file, and disable all settings by
  default. If font autoselection fails, I would prefer to open a new bug
  specifically for that. (Closes: #385481)
* Reorganize and edit README.Debian, pushing as much as possible into FAQ
  format (with resource setting issues first).

files added:
debian/patches/select-quoted.patch

src/perl/kuake

files removed:
debian/patches/faq-section.patch

debian/patches/grammar.patch

debian/patches/make-doc.patch

debian/patches/man-title.patch

src/rxvtlib.h

files modified:
Changes

MANIFEST

README.FAQ

README.configure

debian/README.Debian

debian/app-defaults

debian/changelog

debian/control

debian/patches/app-defaults.patch

debian/patches/generate-docs.patch

debian/patches/old-debian-nonsense.patch

debian/patches/series

debian/urxvtcd

doc/Makefile.in

doc/rxvt-unicode.spec

doc/rxvt.1.html

doc/rxvt.1.man.in

doc/rxvt.1.pod

doc/rxvt.1.txt

doc/rxvt.7.html

doc/rxvt.7.man.in

doc/rxvt.7.pod

doc/rxvt.7.txt

doc/rxvtc.1.html

doc/rxvtc.1.man.in

doc/rxvtc.1.pod

doc/rxvtc.1.txt

doc/rxvtd.1.html

doc/rxvtd.1.man.in

doc/rxvtd.1.txt

doc/rxvtperl.3.html

doc/rxvtperl.3.man.in

doc/rxvtperl.3.txt

src/Makefile.in

src/callback.h

src/command.C

src/fdpass.C

src/feature.h

src/hookinc.h

src/init.C

src/iom.h

src/main.C

src/perl/automove-background

src/perl/mark-urls

src/perl/searchable-scrollback

src/perl/selection

src/perl/selection-pastebin

src/perl/selection-popup

src/rxvt.h

src/rxvtfont.C

src/rxvtlib.h.in

src/rxvtperl.xs

src/rxvttoolkit.C

src/rxvttoolkit.h

src/rxvtutil.h

src/screen.C

src/urxvt.pm

src/version.h

Show diffs side-by-side

added added

removed removed

doc/rxvtperl.3.html

<?xml version="1.0" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<head>

<title>rxvtperl - rxvt-unicode's embedded perl interpreter</title>

</head>

<hr />

<h1><a name="description">DESCRIPTION</a></h1>

Everytime a terminal object gets created, extension scripts specified via

Every time a terminal object gets created, extension scripts specified via

the <code>perl</code> resource are loaded and associated with it.

Scripts are compiled in a 'use strict' and 'use utf8' environment, and

thus must be encoded as UTF-8.

<pre>

URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre>

<dl>

<dt><a name="item_selection">selection (enabled by default)</a>

</dt>

<dt><a name="item_selection">selection (enabled by default)</a>

<dd>

(More) intelligent selection. This extension tries to be more intelligent

(More) intelligent selection. This extension tries to be more intelligent

when the user extends selections (double-click and further clicks). Right

now, it tries to select words, urls and complete shell-quoted

arguments, which is very convenient, too, if your ls supports

<code>--quoting-style=shell</code>.

100

<code>--quoting-style=shell</code>.

101

</dd>

100

102

<dd>

101

103

A double-click usually selects the word under the cursor, further clicks

115

117

<dd>

116

118

The index number (0, 1...) must not have any holes, and each regex must

117

119

contain at least one pair of capturing parentheses, which will be used for

118

the match. For example, the followign adds a regex that matches everything

120

the match. For example, the following adds a regex that matches everything

119

121

between two vertical bars:

120

122

</dd>

121

123

<dd>

140

142

This extension also offers following bindable keyboard commands:

141

143

</dd>

142

144

<dl>

143

144

</dt>

145

146

145

147

<dd>

146

Rot-13 the selection when activated. Used via keyboard trigger:

148

Rot-13 the selection when activated. Used via keyboard trigger:

147

149

</dd>

148

150

<dd>

149

151

<pre>

150

152

URxvt.keysym.C-M-r: perl:selection:rot13</pre>

151

153

</dd>

152

</dl>

153

<dt><a name="item_popup">option-popup (enabled by default)</a>

154

</dt>

154

</li>

155

</dl>

156

<dt><a name="item_popup">option-popup (enabled by default)</a>

157

155

158

<dd>

156

Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at

157

runtime.

159

Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at

160

runtime.

158

161

</dd>

159

162

<dd>

160

163

Other extensions can extend this popup menu by pushing a code reference

178

181

("my option" => $myoption, sub { $self->{myoption} = $_[0] })

179

182

};</pre>

180

183

</dd>

181

182

<dt>selection-popup (enabled by default)

183

</dt>

184

</li>

185

<dt>selection-popup (enabled by default)

186

184

187

<dd>

185

Binds a popup menu to Ctrl-Button3 that lets you convert the selection

188

Binds a popup menu to Ctrl-Button3 that lets you convert the selection

186

189

text into various other formats/action (such as uri unescaping, perl

187

evaluation, web-browser starting etc.), depending on content.

190

evaluation, web-browser starting etc.), depending on content.

188

191

</dd>

189

192

<dd>

190

193

Other extensions can extend this popup menu by pushing a code reference

193

196

</dd>

194

197

<dd>

195

198

It's sole argument is the popup menu, which can be modified. The selection

196

is in <code>$_</code>, which can be used to decide wether to add something or not.

199

is in <code>$_</code>, which can be used to decide whether to add something or not.

197

200

It should either return nothing or a string and a code reference. The

198

201

string will be used as button text and the code reference will be called

199

202

when the button gets activated and should transform <code>$_</code>.

210

213

: ()

211

214

};</pre>

212

215

</dd>

213

214

<dt><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a>

215

</dt>

216

</li>

217

<dt><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a>

218

216

219

<dd>

217

Adds regex search functionality to the scrollback buffer, triggered

220

Adds regex search functionality to the scrollback buffer, triggered

218

221

by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal

219

222

input/output is suspended and a regex is displayed at the bottom of the

220

screen.

223

screen.

221

224

</dd>

222

225

<dd>

223

226

Inputting characters appends them to the regex and continues incremental

228

231

additionally stores the first match in the current line into the primary

229

232

selection.

230

233

</dd>

231

232

<dt><a name="item_readline">readline (enabled by default)</a>

233

</dt>

234

<dd>

235

A support package that tries to make editing with readline easier. At

234

<dd>

235

The regex defaults to ``(?i)'', resulting in a case-insensitive search. To

236

get a case-sensitive search you can delete this prefix using <code>BackSpace</code>

237

or simply use an uppercase character which removes the ``(?i)'' prefix.

238

</dd>

239

<dd>

240

See perlre for more info about perl regular expression syntax.

241

</dd>

242

</li>

243

<dt><a name="item_readline">readline (enabled by default)</a>

244

245

<dd>

246

A support package that tries to make editing with readline easier. At

236

247

the moment, it reacts to clicking shift-left mouse button by trying to

237

248

move the text cursor to this position. It does so by generating as many

238

249

cursor-left or cursor-right keypresses as required (the this only works

239

for programs that correctly support wide characters).

250

for programs that correctly support wide characters).

240

251

</dd>

241

252

<dd>

242

253

To avoid too many false positives, this is only done when:

243

254

</dd>

244

255

<dl>

245

<dt><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a>

246

</dt>

247

<dt><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a>

248

</dt>

249

<dt><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a>

250

</dt>

251

<dt><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a>

252

</dt>

256

<dt><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a>

257

258

<dt><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a>

259

260

<dt><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a>

261

262

<dt><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a>

263

253

264

</dl>

254

265

The normal selection mechanism isn't disabled, so quick successive clicks

255

266

might interfere with selection creation in harmless ways.

256

<dt><a name="item_selection_2dautotransform">selection-autotransform</a>

257

</dt>

267

<dt><a name="item_selection_2dautotransform">selection-autotransform</a>

268

258

269

<dd>

259

This selection allows you to do automatic transforms on a selection

260

whenever a selection is made.

270

This selection allows you to do automatic transforms on a selection

271

whenever a selection is made.

261

272

</dd>

262

273

<dd>

263

274

It works by specifying perl snippets (most useful is a single <code>s///</code>

303

314

every error message as a selection pattern, and the second line transforms

304

315

the message into vi commands to load the file.

305

316

</dd>

306

307

<dt><a name="item_tabbed">tabbed</a>

308

</dt>

317

</li>

318

<dt><a name="item_tabbed">tabbed</a>

319

309

320

<dd>

310

This transforms the terminal into a tabbar with additional terminals, that

311

is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line

321

This transforms the terminal into a tabbar with additional terminals, that

322

is, it implements what is commonly referred to as ``tabbed terminal''. The topmost line

312

323

displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one

313

button per tab.

324

button per tab.

314

325

</dd>

315

326

<dd>

316

327

Clicking a button will activate that tab. Pressing Shift-Left and

333

344

See COLOR AND GRAPHICS in the <code>rxvt(1)</code> manpage for valid

334

345

indices.

335

346

</dd>

336

337

338

</dt>

347

</li>

348

349

339

350

<dd>

340

Uses per-line display filtering (<code>on_line_update</code>) to underline urls and

351

Uses per-line display filtering (<code>on_line_update</code>) to underline urls and

341

352

make them clickable. When middle-clicked, the program specified in the

342

353

resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with

343

the URL as first argument.

354

the URL as first argument.

344

355

</dd>

345

346

<dt><a name="item_xim_2donthespot">xim-onthespot</a>

347

</dt>

356

</li>

357

<dt><a name="item_xim_2donthespot">xim-onthespot</a>

358

348

359

<dd>

349

This (experimental) perl extension implements OnTheSpot editing. It does

360

This (experimental) perl extension implements OnTheSpot editing. It does

350

361

not work perfectly, and some input methods don't seem to work well with

351

362

OnTheSpot editing in general, but it seems to work at leats for SCIM and

352

kinput2.

363

kinput2.

353

364

</dd>

354

365

<dd>

355

366

You enable it by specifying this extension and a preedit style of

359

370

<pre>

360

371

rxvt -pt OnTheSpot -pe xim-onthespot</pre>

361

372

</dd>

362

363

<dt><a name="item_automove_2dbackground">automove-background</a>

364

</dt>

365

<dd>

366

This is basically a one-line extension that dynamically changes the background pixmap offset

367

to the window position, in effect creating the same effect as pseudo transparency with

368

a custom pixmap. No scaling is supported in this mode. Exmaple:

373

</li>

374

<dt><a name="item_kuake_3chotkey_3e">kuake<hotkey></a>

375

376

<dd>

377

A very primitive quake-console-like extension. It was inspired by a

378

description of how the programs <code>kuake</code> and <code>yakuake</code> work: Whenever the

379

user presses a global accelerator key (by default <code>F10</code>), the terminal

380

will show or hide itself. Another press of the accelerator key will hide

381

or show it again.

382

</dd>

383

<dd>

384

Initially, the window will not be shown when using this extension.

385

</dd>

386

<dd>

387

This is useful if you need a single terminal thats not using any desktop

388

space most of the time but is quickly available at the press of a key.

389

</dd>

390

<dd>

391

The accelerator key is grabbed regardless of any modifiers, so this

392

extension will actually grab a physical key just for this function.

393

</dd>

394

<dd>

395

If you want a quake-like animation, tell your window manager to do so

396

(fvwm can do it).

397

</dd>

398

</li>

399

<dt><a name="item_automove_2dbackground">automove-background</a>

400

401

<dd>

402

This is basically a very small extension that dynamically changes the

403

background pixmap offset to the window position, in effect creating the

404

same effect as pseudo transparency with a custom pixmap. No scaling is

405

supported in this mode. Example:

369

406

</dd>

370

407

<dd>

371

408

<pre>

372

409

rxvt -pixmap background.xpm -pe automove-background</pre>

373

410

</dd>

374

375

<dt><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a>

376

</dt>

411

</li>

412

<dt><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a>

413

377

414

<dd>

378

A not very useful example of filtering all text output to the terminal,

415

A not very useful example of filtering all text output to the terminal

379

416

by replacing all line-drawing characters (U+2500 .. U+259F) by a

380

similar-looking ascii character.

381

</dd>

382

383

<dt><a name="item_digital_2dclock">digital-clock</a>

384

</dt>

385

<dd>

386

Displays a digital clock using the built-in overlay.

387

</dd>

388

389

<dt><a name="item_remote_2dclipboard">remote-clipboard</a>

390

</dt>

391

<dd>

392

Somewhat of a misnomer, this extension adds two menu entries to the

417

similar-looking ascii character.

418

</dd>

419

</li>

420

<dt><a name="item_digital_2dclock">digital-clock</a>

421

422

<dd>

423

Displays a digital clock using the built-in overlay.

424

</dd>

425

</li>

426

<dt><a name="item_remote_2dclipboard">remote-clipboard</a>

427

428

<dd>

429

Somewhat of a misnomer, this extension adds two menu entries to the

393

430

selection popup that allows one ti run external commands to store the

394

selection somewhere and fetch it again.

431

selection somewhere and fetch it again.

395

432

</dd>

396

433

<dd>

397

434

We use it to implement a ``distributed selection mechanism'', which just

412

449

URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'

413

450

URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre>

414

451

</dd>

415

416

<dt><a name="item_selection_2dpastebin">selection-pastebin</a>

417

</dt>

452

</li>

453

<dt><a name="item_selection_2dpastebin">selection-pastebin</a>

454

418

455

<dd>

419

This is a little rarely useful extension that Uploads the selection as

456

This is a little rarely useful extension that Uploads the selection as

420

457

textfile to a remote site (or does other things). (The implementation is

421

458

not currently secure for use in a multiuser environment as it writes to

422

/tmp directly.).

459

/tmp directly.).

423

460

</dd>

424

461

<dd>

425

462

It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,

454

491

<pre>

455

492

URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>

456

493

</dd>

457

458

<dt><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a>

459

</dt>

494

</li>

495

<dt><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a>

496

460

497

<dd>

461

Displays a very simple digital clock in the upper right corner of the

498

Displays a very simple digital clock in the upper right corner of the

462

499

window. Illustrates overwriting the refresh callbacks to create your own

463

overlays or changes.

500

overlays or changes.

464

501

</dd>

465

</dl>

502

</li>

503

</dl>

466

504

467

505

468

506

<hr />

482

520

Argument names also often indicate the type of a parameter. Here are some

483

521

hints on what they mean:

484

522

<dl>

485

486

</dt>

523

524

487

525

<dd>

488

Rxvt-unicodes special way of encoding text, where one ``unicode'' character

489

always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.

526

Rxvt-unicodes special way of encoding text, where one ``unicode'' character

527

always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.

490

528

</dd>

491

492

<dt><a name="item__24string">$string</a>

493

</dt>

529

</li>

530

<dt><a name="item__string">$string</a>

531

494

532

<dd>

495

A perl text string, with an emphasis on text. It can store all unicode

533

A perl text string, with an emphasis on text. It can store all unicode

496

534

characters and is to be distinguished with text encoded in a specific

497

encoding (often locale-specific) and binary data.

535

encoding (often locale-specific) and binary data.

498

536

</dd>

499

500

<dt><a name="item__24octets">$octets</a>

501

</dt>

537

</li>

538

<dt><a name="item__octets">$octets</a>

539

502

540

<dd>

503

Either binary data or - more common - a text string encoded in a

504

locale-specific way.

541

Either binary data or - more common - a text string encoded in a

542

locale-specific way.

505

543

</dd>

506

</dl>

544

</li>

545

</dl>

507

546

508

547

509

548

<h2><a name="extension_objects">Extension Objects</a></h2>

510

Very perl extension is a perl class. A separate perl object is created

549

Every perl extension is a perl class. A separate perl object is created

511

550

for each terminal and each extension and passed as the first parameter to

512

551

hooks. So extensions can use their <code>$self</code> object without having to think

513

552

about other extensions, with the exception of methods and members that

517

556

<code>urxvt::term</code> class on this object.

518

557

It has the following methods and data members:

519

558

<dl>

520

<dt><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self->{term}</a>

521

</dt>

559

<dt><a name="item__urxvt_term">$urxvt_term = $self->{term}</a>

560

522

561

<dd>

523

Returns the <code>urxvt::term</code> object associated with this instance of the

524

extension. This member must not be changed in any way.

562

Returns the <code>urxvt::term</code> object associated with this instance of the

563

extension. This member must not be changed in any way.

525

564

</dd>

526

527

<dt><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a>

528

</dt>

565

</li>

566

<dt><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a>

567

529

568

<dd>

530

Dynamically enable the given hooks (named without the <code>on_</code> prefix) for

569

Dynamically enable the given hooks (named without the <code>on_</code> prefix) for

531

570

this extension, replacing any previous hook. This is useful when you want

532

to overwrite time-critical hooks only temporarily.

571

to overwrite time-critical hooks only temporarily.

533

572

</dd>

534

535

<dt><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a>

536

</dt>

573

</li>

574

<dt><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a>

575

537

576

<dd>

538

Dynamically disable the given hooks.

577

Dynamically disable the given hooks.

539

578

</dd>

540

</dl>

579

</li>

580

</dl>

541

581

542

582

543

583

<h2><a name="hooks">Hooks</a></h2>

544

584

The following subroutines can be declared in extension files, and will be

545

585

called whenever the relevant event happens.

546

The first argument passed to them is an extension oject as described in

586

The first argument passed to them is an extension object as described in

547

587

the in the <code>Extension Objects</code> section.

548

588

All of these hooks must return a boolean value. If any of the called

549

589

hooks returns true, then the event counts as being consumed, and the

550

590

relevant action might not be carried out by the C++ code.

551

591

When in doubt, return a false value (preferably <code>()</code>). >

552

592

<dl>

553

554

</dt>

593

594

555

595

<dd>

556

Called after a new terminal object has been initialized, but before

596

Called after a new terminal object has been initialized, but before

557

597

windows are created or the command gets run. Most methods are unsafe to

558

598

call or deliver senseless data, as terminal size and other characteristics

559

599

have not yet been determined. You can safely query and change resources

560

600

and options, though. For many purposes the <code>on_start</code> hook is a better

561

place.

562

</dd>

563

564

<dt><a name="item_on_start__24term">on_start $term</a>

565

</dt>

566

<dd>

567

Called at the very end of initialisation of a new terminal, just before

568

trying to map (display) the toplevel and returning to the mainloop.

569

</dd>

570

571

<dt><a name="item_on_destroy__24term">on_destroy $term</a>

572

</dt>

573

<dd>

574

Called whenever something tries to destroy terminal, when the terminal is

575

still fully functional (not for long, though).

576

</dd>

577

578

<dt><a name="item_on_reset__24term">on_reset $term</a>

579

</dt>

580

<dd>

581

Called after the screen is ``reset'' for any reason, such as resizing or

601

place.

602

</dd>

603

</li>

604

<dt><a name="item_on_start__24term">on_start $term</a>

605

606

<dd>

607

Called at the very end of initialisation of a new terminal, just before

608

trying to map (display) the toplevel and returning to the main loop.

609

</dd>

610

</li>

611

<dt><a name="item_on_destroy__24term">on_destroy $term</a>

612

613

<dd>

614

Called whenever something tries to destroy terminal, when the terminal is

615

still fully functional (not for long, though).

616

</dd>

617

</li>

618

<dt><a name="item_on_reset__24term">on_reset $term</a>

619

620

<dd>

621

Called after the screen is ``reset'' for any reason, such as resizing or

582

622

control sequences. Here is where you can react on changes to size-related

583

variables.

584

</dd>

585

586

<dt><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a>

587

</dt>

588

<dd>

589

Called just after the child process has been <code>fork</code>ed.

590

</dd>

591

592

<dt><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a>

593

</dt>

594

<dd>

595

Called just after the child process has exited. <code>$status</code> is the status

596

from <code>waitpid</code>.

597

</dd>

598

599

<dt><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a>

600

</dt>

601

<dd>

602

Called whenever a selection has been made by the user, but before the

623

variables.

624

</dd>

625

</li>

626

<dt><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a>

627

628

<dd>

629

Called just after the child process has been <code>fork</code>ed.

630

</dd>

631

</li>

632

<dt><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a>

633

634

<dd>

635

Called just after the child process has exited. <code>$status</code> is the status

636

from <code>waitpid</code>.

637

</dd>

638

</li>

639

<dt><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a>

640

641

<dd>

642

Called whenever a selection has been made by the user, but before the

603

643

selection text is copied, so changes to the beginning, end or type of the

604

selection will be honored.

644

selection will be honored.

605

645

</dd>

606

646

<dd>

607

647

Returning a true value aborts selection making by urxvt, in which case you

608

648

have to make a selection yourself by calling <a href="#item_selection_grab"><code>$term->selection_grab</code></a>.

609

649

</dd>

610

611

<dt><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a>

612

</dt>

650

</li>

651

<dt><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a>

652

613

653

<dd>

614

Called whenever a selection has been copied, but before the selection is

654

Called whenever a selection has been copied, but before the selection is

615

655

requested from the server. The selection text can be queried and changed

616

by calling <a href="#item_selection"><code>$term->selection</code></a>.

617

</dd>

618

<dd>

619

Returning a true value aborts selection grabbing. It will still be hilighted.

620

</dd>

621

622

<dt><a name="item_on_sel_extend__24term">on_sel_extend $term</a>

623

</dt>

624

<dd>

625

Called whenever the user tries to extend the selection (e.g. with a double

656

by calling <a href="#item_selection"><code>$term->selection</code></a>.

657

</dd>

658

<dd>

659

Returning a true value aborts selection grabbing. It will still be highlighted.

660

</dd>

661

</li>

662

<dt><a name="item_on_sel_extend__24term">on_sel_extend $term</a>

663

664

<dd>

665

Called whenever the user tries to extend the selection (e.g. with a double

626

666

click) and is either supposed to return false (normal operation), or

627

should extend the selection itelf and return true to suppress the built-in

667

should extend the selection itself and return true to suppress the built-in

628

668

processing. This can happen multiple times, as long as the callback

629

669

returns true, it will be called on every further click by the user and is

630

supposed to enlarge the selection more and more, if possible.

670

supposed to enlarge the selection more and more, if possible.

631

671

</dd>

632

672

<dd>

633

673

See the selection example extension.

634

674

</dd>

635

636

<dt><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a>

637

</dt>

675

</li>

676

<dt><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a>

677

638

678

<dd>

639

Called whenever the view offset changes, i..e the user or program

679

Called whenever the view offset changes, i.e. the user or program

640

680

scrolls. Offset <code>0</code> means display the normal terminal, positive values

641

show this many lines of scrollback.

681

show this many lines of scrollback.

642

682

</dd>

643

644

<dt><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a>

645

</dt>

683

</li>

684

<dt><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a>

685

646

686

<dd>

647

Called whenever lines scroll out of the terminal area into the scrollback

687

Called whenever lines scroll out of the terminal area into the scrollback

648

688

buffer. <code>$lines</code> is the number of lines scrolled out and may be larger

649

than the scroll back buffer or the terminal.

689

than the scroll back buffer or the terminal.

650

690

</dd>

651

691

<dd>

652

692

It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,

653

693

$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total

654

694

number of lines that will be in the scrollback buffer.

655

695

</dd>

656

657

<dt><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a>

658

</dt>

659

<dd>

660

Called whenever the ESC ] 777 ; string ST command sequence (OSC =

696

</li>

697

698

699

<dd>

700

Called on every OSC sequence and can be used to suppress it or modify its

701

behaviour. The default should be to return an empty list. A true value

702

suppresses execution of the request completely. Make sure you don't get

703

confused by recursive invocations when you output an osc sequence within

704

this callback.

705

</dd>

706

<dd>

707

<code>on_osc_seq_perl</code> should be used for new behaviour.

708

</dd>

709

</li>

710

<dt><a name="item_on_osc_seq_perl__24term_2c__24string">on_osc_seq_perl $term, $string</a>

711

712

<dd>

713

Called whenever the ESC ] 777 ; string ST command sequence (OSC =

661

714

operating system command) is processed. Cursor position and other state

662

715

information is up-to-date when this happens. For interoperability, the

663

716

string should start with the extension name and a colon, to distinguish

664

717

it from commands for other extensions, and this might be enforced in the

665

future.

718

future.

666

719

</dd>

667

720

<dd>

668

721

Be careful not ever to trust (in a security sense) the data you receive,

669

as its source can not easily be controleld (e-mail content, messages from

722

as its source can not easily be controlled (e-mail content, messages from

670

723

other users on the same system etc.).

671

724

</dd>

672

673

<dt><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a>

674

</dt>

725

</li>

726

<dt><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a>

727

675

728

<dd>

676

Called whenever text is about to be output, with the text as argument. You

729

Called whenever text is about to be output, with the text as argument. You

677

730

can filter/change and output the text yourself by returning a true value

678

731

and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this

679

732

might be very slow, however, as your hook is called for all text being

680

output.

681

</dd>

682

683

<dt><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a>

684

</dt>

685

<dd>

686

Called whenever some data is written to the tty/pty and can be used to

687

suppress or filter tty input.

688

</dd>

689

690

<dt><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a>

691

</dt>

692

<dd>

693

Called whenever a line was updated or changed. Can be used to filter

733

output.

734

</dd>

735

</li>

736

<dt><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a>

737

738

<dd>

739

Called whenever some data is written to the tty/pty and can be used to

740

suppress or filter tty input.

741

</dd>

742

</li>

743

<dt><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a>

744

745

<dd>

746

Called whenever a line was updated or changed. Can be used to filter

694

747

screen output (e.g. underline urls or other useless stuff). Only lines

695

748

that are being shown will be filtered, and, due to performance reasons,

696

not always immediately.

749

not always immediately.

697

750

</dd>

698

751

<dd>

699

752

The row number is always the topmost row of the line if the line spans

704

757

later with the already-modified line (e.g. if unrelated parts change), so

705

758

you cannot just toggle rendition bits, but only set them.

706

759

</dd>

707

708

<dt><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a>

709

</dt>

760

</li>

761

<dt><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a>

762

710

763

<dd>

711

Called just before the screen gets redrawn. Can be used for overlay

764

Called just before the screen gets redrawn. Can be used for overlay

712

765

or similar effects by modify terminal contents in refresh_begin, and

713

766

restoring them in refresh_end. The built-in overlay and selection display

714

code is run after this hook, and takes precedence.

715

</dd>

716

717

<dt><a name="item_on_refresh_end__24term">on_refresh_end $term</a>

718

</dt>

719

<dd>

720

Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.

721

</dd>

722

723

<dt><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a>

724

</dt>

725

<dd>

726

Called whenever the a user-configured event is being activated (e.g. via

767

code is run after this hook, and takes precedence.

768

</dd>

769

</li>

770

<dt><a name="item_on_refresh_end__24term">on_refresh_end $term</a>

771

772

<dd>

773

Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.

774

</dd>

775

</li>

776

<dt><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a>

777

778

<dd>

779

Called whenever a user-configured event is being activated (e.g. via

727

780

a <code>perl:string</code> action bound to a key, see description of the keysym

728

resource in the <code>rxvt(1)</code> manpage).

781

resource in the <code>rxvt(1)</code> manpage).

729

782

</dd>

730

783

<dd>

731

784

The event is simply the action string. This interface is assumed to change

732

785

slightly in the future.

733

786

</dd>

734

735

<dt><a name="item_on_resize_all_windows__24tern_2c__24new_width_2c__">on_resize_all_windows $tern, $new_width, $new_height</a>

736

</dt>

787

</li>

788

<dt><a name="item_on_resize_all_windows__24tern_2c__24new_width_2c__">on_resize_all_windows $tern, $new_width, $new_height</a>

789

737

790

<dd>

738

Called just after the new window size has been calculcated, but before

791

Called just after the new window size has been calculated, but before

739

792

windows are actually being resized or hints are being set. If this hook

740

returns TRUE, setting of the window hints is being skipped.

793

returns TRUE, setting of the window hints is being skipped.

741

794

</dd>

742

743

<dt><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a>

744

</dt>

795

</li>

796

<dt><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a>

797

745

798

<dd>

746

Called on every X event received on the vt window (and possibly other

799

Called on every X event received on the vt window (and possibly other

747

800

windows). Should only be used as a last resort. Most event structure

748

members are not passed.

749

</dd>

750

751

<dt><a name="item_on_focus_in__24term">on_focus_in $term</a>

752

</dt>

753

<dd>

754

Called whenever the window gets the keyboard focus, before rxvt-unicode

755

does focus in processing.

756

</dd>

757

758

<dt><a name="item_on_focus_out__24term">on_focus_out $term</a>

759

</dt>

760

<dd>

761

Called wheneever the window loses keyboard focus, before rxvt-unicode does

762

focus out processing.

763

</dd>

764

765

<dt><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a>

766

</dt>

767

<dt><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a>

768

</dt>

769

<dt><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a>

770

</dt>

771

<dt><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a>

772

</dt>

773

<dt><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a>

774

</dt>

775

<dt><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a>

776

</dt>

777

<dt><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a>

778

</dt>

779

<dt><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a>

780

</dt>

781

<dt><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a>

782

</dt>

783

<dd>

784

Called whenever the corresponding X event is received for the terminal If

785

the hook returns true, then the even will be ignored by rxvt-unicode.

801

members are not passed.

802

</dd>

803

</li>

804

<dt><a name="item_on_root_event__24term_2c__24event">on_root_event $term, $event</a>

805

806

<dd>

807

Like <code>on_x_event</code>, but is called for events on the root window.

808

</dd>

809

</li>

810

<dt><a name="item_on_focus_in__24term">on_focus_in $term</a>

811

812

<dd>

813

Called whenever the window gets the keyboard focus, before rxvt-unicode

814

does focus in processing.

815

</dd>

816

</li>

817

<dt><a name="item_on_focus_out__24term">on_focus_out $term</a>

818

819

<dd>

820

Called whenever the window loses keyboard focus, before rxvt-unicode does

821

focus out processing.

822

</dd>

823

</li>

824

<dt><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a>

825

826

<dt><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a>

827

828

<dt><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a>

829

830

<dt><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a>

831

832

<dt><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a>

833

834

<dt><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a>

835

836

<dt><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a>

837

838

<dt><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a>

839

840

<dt><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a>

841

842

<dd>

843

Called whenever the corresponding X event is received for the terminal If

844

the hook returns true, then the even will be ignored by rxvt-unicode.

786

845

</dd>

787

846

<dd>

788

847

The event is a hash with most values as named by Xlib (see the XEvent

796

855

<dd>

797

856

subwindow.

798

857

</dd>

799

800

<dt><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a>

801

</dt>

802

<dt><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a>

803

</dt>

804

<dt><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a>

805

</dt>

858

</li>

859

<dt><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a>

860

861

<dt><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a>

862

863

<dt><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a>

864

806

865

<dd>

807

Called when various types of ClientMessage events are received (all with

808

format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).

866

Called when various types of ClientMessage events are received (all with

867

format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).

809

868

</dd>

810

</dl>

869

</li>

870

</dl>

811

871

812

872

813

873

<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>

814

874

<dl>

815

<dt><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a>

816

</dt>

817

<dd>

818

The rxvt-unicode library directory, where, among other things, the perl

819

modules and scripts are stored.

820

</dd>

821

822

<dt><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a>

823

</dt>

824

<dd>

825

The resource class and name rxvt-unicode uses to look up X resources.

826

</dd>

827

828

<dt><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a>

829

</dt>

830

<dd>

831

The basename of the installed binaries, usually <code>urxvt</code>.

832

</dd>

833

834

<dt><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a>

835

</dt>

836

<dd>

837

The current terminal. This variable stores the current <code>urxvt::term</code>

838

object, whenever a callback/hook is executing.

839

</dd>

840

841

<dt><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a>

842

</dt>

843

<dd>

844

All coderefs in this array will be called as methods of the next newly

875

<dt><a name="item__urxvt__libdir">$urxvt::LIBDIR</a>

876

877

<dd>

878

The rxvt-unicode library directory, where, among other things, the perl

879

modules and scripts are stored.

880

</dd>

881

</li>

882

<dt><a name="item__urxvt__resclass_">$urxvt::RESCLASS, $urxvt::RESCLASS</a>

883

884

<dd>

885

The resource class and name rxvt-unicode uses to look up X resources.

886

</dd>

887

</li>

888

<dt><a name="item__urxvt__rxvtname">$urxvt::RXVTNAME</a>

889

890

<dd>

891

The basename of the installed binaries, usually <code>urxvt</code>.

892

</dd>

893

</li>

894

<dt><a name="item__urxvt__term">$urxvt::TERM</a>

895

896

<dd>

897

The current terminal. This variable stores the current <code>urxvt::term</code>

898

object, whenever a callback/hook is executing.

899

</dd>

900

</li>

901

<dt><a name="item__urxvt__term_init">@urxvt::TERM_INIT</a>

902

903

<dd>

904

All code references in this array will be called as methods of the next newly

845

905

created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array

846

gets cleared before the codereferences that were in it are being executed,

847

so coderefs can push themselves onto it again if they so desire.

906

gets cleared before the code references that were in it are being executed,

907

so references can push themselves onto it again if they so desire.

848

908

</dd>

849

909

<dd>

850

This complements to the perl-eval commandline option, but gets executed

910

This complements to the perl-eval command line option, but gets executed

851

911

first.

852

912

</dd>

853

854

<dt><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a>

855

</dt>

913

</li>

914

<dt><a name="item__urxvt__term_ext">@urxvt::TERM_EXT</a>

915

856

916

<dd>

857

Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which

917

Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which

858

918

get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>

859

but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.

919

but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.

860

920

</dd>

861

</dl>

921

</li>

922

</dl>

862

923

863

924

864

925

<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>

865

926

<dl>

866

<dt><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a>

867

</dt>

927

<dt><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a>

928

868

929

<dd>

869

Fatally aborts execution with the given error message. Avoid at all

930

Fatally aborts execution with the given error message. Avoid at all

870

931

costs! The only time this is acceptable is when the terminal process

871

starts up.

932

starts up.

872

933

</dd>

873

874

<dt><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a>

875

</dt>

934

</li>

935

<dt><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a>

936

876

937

<dd>

877

Calls <code>rxvt_warn</code> with the given string which should not include a

938

Calls <code>rxvt_warn</code> with the given string which should not include a

878

939

newline. The module also overwrites the <code>warn</code> builtin with a function

879

that calls this function.

940

that calls this function.

880

941

</dd>

881

942

<dd>

882

943

Using this function has the advantage that its output ends up in the

885

946

<dd>

886

947

Messages have a size limit of 1023 bytes currently.

887

948

</dd>

888

889

<dt><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a>

890

</dt>

949

</li>

950

<dt><a name="item__terms">@terms = urxvt::termlist</a>

951

891

952

<dd>

892

Returns all urxvt::term objects that exist in this process, regardless of

893

wether they are started, being destroyed etc., so be careful. Only term

953

Returns all urxvt::term objects that exist in this process, regardless of

954

whether they are started, being destroyed etc., so be careful. Only term

894

955

objects that have perl extensions attached will be returned (because there

895

is no urxvt::term objet associated with others).

956

is no urxvt::term objet associated with others).

896

957

</dd>

897

898

<dt><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a>

899

</dt>

958

</li>

959

<dt><a name="item__time">$time = urxvt::NOW</a>

960

900

961

<dd>

901

Returns the ``current time'' (as per the event loop).

962

Returns the ``current time'' (as per the event loop).

902

963

</dd>

903

904

<dt><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a>

905

</dt>

964

</li>

965

<dt><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a>

966

906

967

<dt><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,

907

968

Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,

908

Button4Mask, Button5Mask, AnyModifier</a>

909

</dt>

969

Button4Mask, Button5Mask, AnyModifier</a>

970

910

971

<dt><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,

911

972

ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,

912

973

PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,

913

974

Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,

914

975

KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,

915

976

ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,

916

FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a>

917

</dt>

977

FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a>

978

918

979

<dt><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,

919

980

EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,

920

981

GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,

921

982

UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,

922

983

ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,

923

984

CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,

924

SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a>

925

</dt>

985

SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a>

986

926

987

<dd>

927

Various constants for use in X calls and event processing.

988

Various constants for use in X calls and event processing.

928

989

</dd>

929

</dl>

990

</li>

991

</dl>

930

992

931

993

932

994

<h2><a name="rendition">RENDITION</a></h2>

937

999

as they contain important information required for correct operation of

938

1000

rxvt-unicode.

939

1001

<dl>

940

<dt><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a>

941

</dt>

942

<dd>

943

Returns the default rendition, as used when the terminal is starting up or

944

being reset. Useful as a base to start when creating renditions.

945

</dd>

946

947

<dt><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a>

948

</dt>

949

<dd>

950

Return the rendition mask used for overlays by default.

951

</dd>

952

953

<dt><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a>

954

</dt>

955

<dd>

956

Return the bit that enabled bold, italic, blink, reverse-video and

1002

<dt><a name="item__rend">$rend = urxvt::DEFAULT_RSTYLE</a>

1003

1004

<dd>

1005

Returns the default rendition, as used when the terminal is starting up or

1006

being reset. Useful as a base to start when creating renditions.

1007

</dd>

1008

</li>

1009

<dt>$rend = urxvt::OVERLAY_RSTYLE

1010

1011

<dd>

1012

Return the rendition mask used for overlays by default.

1013

</dd>

1014

</li>

1015

<dt><a name="item__rendbit">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a>

1016

1017

<dd>

1018

Return the bit that enabled bold, italic, blink, reverse-video and

957

1019

underline, respectively. To enable such a style, just logically OR it into

958

the bitset.

959

</dd>

960

961

<dt><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a>

962

</dt>

963

<dt><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a>

964

</dt>

965

<dd>

966

Return the foreground/background colour index, respectively.

967

</dd>

968

969

<dt><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a>

970

</dt>

971

<dt><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a>

972

</dt>

973

<dt><a name="item__24rend__3d_urxvt_3a_3aset_color__24rend_2c__24new">$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</a>

974

</dt>

975

<dd>

976

Replace the foreground/background colour in the rendition mask with the

977

specified one.

978

</dd>

979

980

<dt><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a>

981

</dt>

982

<dd>

983

Return the ``custom'' value: Every rendition has 5 bits for use by

1020

the bitset.

1021

</dd>

1022

</li>

1023

<dt><a name="item__foreground">$foreground = urxvt::GET_BASEFG $rend</a>

1024

1025

<dt><a name="item__background">$background = urxvt::GET_BASEBG $rend</a>

1026

1027

<dd>

1028

Return the foreground/background colour index, respectively.

1029

</dd>

1030

</li>

1031

<dt>$rend = urxvt::SET_FGCOLOR $rend, $new_colour

1032

1033

<dt>$rend = urxvt::SET_BGCOLOR $rend, $new_colour

1034

1035

<dt>$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg

1036

1037

<dd>

1038

Replace the foreground/background colour in the rendition mask with the

1039

specified one.

1040

</dd>

1041

</li>

1042

<dt><a name="item__value">$value = urxvt::GET_CUSTOM $rend</a>

1043

1044

<dd>

1045

Return the ``custom'' value: Every rendition has 5 bits for use by

984

1046

extensions. They can be set and changed as you like and are initially

985

zero.

1047

zero.

986

1048

</dd>

987

988

<dt><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a>

989

</dt>

1049

</li>

1050

<dt>$rend = urxvt::SET_CUSTOM $rend, $new_value

1051

990

1052

<dd>

991

Change the custom value.

1053

Change the custom value.

992

1054

</dd>

993

</dl>

1055

</li>

1056

</dl>

994

1057

995

1058

996

1059

<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>

1004

1067

1005

1068

<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>

1006

1069

<dl>

1007

<dt><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a>

1008

</dt>

1070

<dt><a name="item__term">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a>

1071

1009

1072

<dd>

1010

Creates a new terminal, very similar as if you had started it with system

1073

Creates a new terminal, very similar as if you had started it with system

1011

1074

<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like

1012

hash which defines the environment of the new terminal.

1075

hash which defines the environment of the new terminal.

1013

1076

</dd>

1014

1077

<dd>

1015

1078

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

1018

1081

<a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to

1019

1082

refer to global data (which is race free).

1020

1083

</dd>

1021

1022

<dt><a name="item_destroy">$term->destroy</a>

1023

</dt>

1084

</li>

1085

<dt><a name="item_destroy">$term->destroy</a>

1086

1024

1087

<dd>

1025

Destroy the terminal object (close the window, free resources

1088

Destroy the terminal object (close the window, free resources

1026

1089

etc.). Please note that rxvt will not exit as long as any event

1027

watchers (timers, io watchers) are still active.

1090

watchers (timers, io watchers) are still active.

1028

1091

</dd>

1029

1030

<dt><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a>

1031

</dt>

1092

</li>

1093

<dt><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a>

1094

1032

1095

<dd>

1033

Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes

1096

Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes

1034

1097

(``starts'') programs in the background. This function takes care of setting

1035

1098

the user environment before exec'ing the command (e.g. <code>PATH</code>) and should

1036

be preferred over explicit calls to <code>exec</code> or <code>system</code>.

1099

be preferred over explicit calls to <code>exec</code> or <code>system</code>.

1037

1100

</dd>

1038

1101

<dd>

1039

1102

Returns the pid of the subprocess or <code>undef</code> on error.

1040

1103

</dd>

1041

1042

<dt><a name="item_option">$isset = $term->option ($optval[, $set])</a>

1043

</dt>

1104

</li>

1105

<dt><a name="item_option">$isset = $term->option ($optval[, $set])</a>

1106

1044

1107

<dd>

1045

Returns true if the option specified by <code>$optval</code> is enabled, and

1108

Returns true if the option specified by <code>$optval</code> is enabled, and

1046

1109

optionally change it. All option values are stored by name in the hash

1047

<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.

1110

<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.

1048

1111

</dd>

1049

1112

<dd>

1050

Here is a a likely non-exhaustive list of option names, please see the

1113

Here is a likely non-exhaustive list of option names, please see the

1051

1114

source file /src/optinc.h to see the actual list:

1052

1115

</dd>

1053

1116

<dd>

1059

1122

scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs

1060

1123

transparent tripleclickwords utmpInhibit visualBell</pre>

1061

1124

</dd>

1062

1063

<dt><a name="item_resource">$value = $term->resource ($name[, $newval])</a>

1064

</dt>

1125

</li>

1126

<dt><a name="item_resource">$value = $term->resource ($name[, $newval])</a>

1127

1065

1128

<dd>

1066

Returns the current resource value associated with a given name and

1129

Returns the current resource value associated with a given name and

1067

1130

optionally sets a new value. Setting values is most useful in the <code>init</code>

1068

hook. Unset resources are returned and accepted as <code>undef</code>.

1131

hook. Unset resources are returned and accepted as <code>undef</code>.

1069

1132

</dd>

1070

1133

<dd>

1071

1134

The new value must be properly encoded to a suitable character encoding

1082

1145

terminal is destroyed, so changing options frequently will eat memory.

1083

1146

</dd>

1084

1147

<dd>

1085

Here is a a likely non-exhaustive list of resource names, not all of which

1148

Here is a likely non-exhaustive list of resource names, not all of which

1086

1149

are supported in every build, please see the source file /src/rsinc.h

1087

1150

to see the actual list:

1088

1151

</dd>

1102

1165

transient_for transparent transparent_all tripleclickwords utmpInhibit

1103

1166

visualBell</pre>

1104

1167

</dd>

1105

1106

<dt><a name="item_x_resource">$value = $term->x_resource ($pattern)</a>

1107

</dt>

1168

</li>

1169

<dt><a name="item_x_resource">$value = $term->x_resource ($pattern)</a>

1170

1108

1171

<dd>

1109

Returns the X-Resource for the given pattern, excluding the program or

1172

Returns the X-Resource for the given pattern, excluding the program or

1110

1173

class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the

1111

1174

same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no

1112

resource with that pattern exists.

1175

resource with that pattern exists.

1113

1176

</dd>

1114

1177

<dd>

1115

1178

This method should only be called during the <code>on_start</code> hook, as there is

1116

1179

only one resource database per display, and later invocations might return

1117

1180

the wrong resources.

1118

1181

</dd>

1119

1120

<dt><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a>

1121

</dt>

1122

<dd>

1123

Adds a keymap translation exactly as specified via a resource. See the

1124

<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.

1125

</dd>

1126

1127

<dt><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a>

1128

</dt>

1129

<dd>

1130

Return and optionally change the current rendition. Text that is output by

1131

the terminal application will use this style.

1132

</dd>

1133

1134

<dt><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a>

1135

</dt>

1136

<dd>

1137

Return the current coordinates of the text cursor position and optionally

1138

set it (which is usually bad as applications don't expect that).

1139

</dd>

1140

1141

<dt><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a>

1142

</dt>

1143

<dt><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a>

1144

</dt>

1145

<dt><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a>

1146

</dt>

1147

<dd>

1148

Return the current values of the selection mark, begin or end positions,

1149

and optionally set them to new values.

1150

</dd>

1151

1152

<dt><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a>

1153

</dt>

1154

<dd>

1155

Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and

1182

</li>

1183

<dt><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a>

1184

1185

<dd>

1186

Adds a keymap translation exactly as specified via a resource. See the

1187

<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.

1188

</dd>

1189

</li>

1190

<dt><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a>

1191

1192

<dd>

1193

Return and optionally change the current rendition. Text that is output by

1194

the terminal application will use this style.

1195

</dd>

1196

</li>

1197

<dt><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a>

1198

1199

<dd>

1200

Return the current coordinates of the text cursor position and optionally

1201

set it (which is usually bad as applications don't expect that).

1202

</dd>

1203

</li>

1204

<dt><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a>

1205

1206

<dt><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a>

1207

1208

<dt><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a>

1209

1210

<dd>

1211

Return the current values of the selection mark, begin or end positions,

1212

and optionally set them to new values.

1213

</dd>

1214

</li>

1215

<dt><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a>

1216

1217

<dd>

1218

Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and

1156

1219

<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a

1157

1220

rectangular selection will be made. This is the prefered function to make

1158

a selection.

1221

a selection.

1159

1222

</dd>

1160

1161

<dt><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a>

1162

</dt>

1223

</li>

1224

<dt><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a>

1225

1163

1226

<dd>

1164

Try to request the primary selection text from the server (for example, as

1227

Try to request the primary selection text from the server (for example, as

1165

1228

set by the next method). No visual feedback will be given. This function

1166

is mostly useful from within <code>on_sel_grab</code> hooks.

1167

</dd>

1168

1169

<dt>$oldtext = $term->selection ([$newtext])

1170

</dt>

1171

<dd>

1172

Return the current selection text and optionally replace it by <code>$newtext</code>.

1173

</dd>

1174

1175

<dt><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a>

1176

</dt>

1177

<dd>

1178

Create a simple multi-line overlay box. See the next method for details.

1179

</dd>

1180

1181

<dt><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a>

1182

</dt>

1183

<dd>

1184

Create a new (empty) overlay at the given position with the given

1229

is mostly useful from within <code>on_sel_grab</code> hooks.

1230

</dd>

1231

</li>

1232

<dt>$oldtext = $term->selection ([$newtext])

1233

1234

<dd>

1235

Return the current selection text and optionally replace it by <code>$newtext</code>.

1236

</dd>

1237

</li>

1238

<dt><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a>

1239

1240

<dd>

1241

Create a simple multi-line overlay box. See the next method for details.

1242

</dd>

1243

</li>

1244

<dt><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a>

1245

1246

<dd>

1247

Create a new (empty) overlay at the given position with the given

1185

1248

width/height. <code>$rstyle</code> defines the initial rendition style

1186

(default: <code>OVERLAY_RSTYLE</code>).

1249

(default: <code>OVERLAY_RSTYLE</code>).

1187

1250

</dd>

1188

1251

<dd>

1189

1252

If <code>$border</code> is <code>2</code> (default), then a decorative border will be put

1201

1264

The methods currently supported on <code>urxvt::overlay</code> objects are:

1202

1265

</dd>

1203

1266

<dl>

1204

<dt><a name="item_set">$overlay->set ($x, $y, $text, $rend)</a>

1205

</dt>

1267

<dt><a name="item_set">$overlay->set ($x, $y, $text, $rend)</a>

1268

1206

1269

<dd>

1207

Similar to <a href="#item_row_t"><code>$term->ROW_t</code></a> and <a href="#item_row_r"><code>$term->ROW_r</code></a> in that it puts

1270

Similar to <a href="#item_row_t"><code>$term->ROW_t</code></a> and <a href="#item_row_r"><code>$term->ROW_r</code></a> in that it puts

1208

1271

text in rxvt-unicode's special encoding and an array of rendition values

1209

at a specific position inside the overlay.

1210

</dd>

1211

1212

<dt><a name="item_hide">$overlay->hide</a>

1213

</dt>

1214

<dd>

1215

If visible, hide the overlay, but do not destroy it.

1216

</dd>

1217

1218

<dt><a name="item_show">$overlay->show</a>

1219

</dt>

1220

<dd>

1221

If hidden, display the overlay again.

1222

</dd>

1223

</dl>

1224

<dt>$popup = $term->popup ($event)

1225

</dt>

1226

<dd>

1227

Creates a new <code>urxvt::popup</code> object that implements a popup menu. The

1272

at a specific position inside the overlay.

1273

</dd>

1274

</li>

1275

<dt><a name="item_hide">$overlay->hide</a>

1276

1277

<dd>

1278

If visible, hide the overlay, but do not destroy it.

1279

</dd>

1280

</li>

1281

<dt><a name="item_show">$overlay->show</a>

1282

1283

<dd>

1284

If hidden, display the overlay again.

1285

</dd>

1286

</li>

1287

</dl>

1288

<dt>$popup = $term->popup ($event)

1289

1290

<dd>

1291

Creates a new <code>urxvt::popup</code> object that implements a popup menu. The

1228

1292

<code>$event</code> must be the event causing the menu to pop up (a button event,

1229

currently).

1230

</dd>

1231

1232

<dt><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a>

1233

</dt>

1234

<dd>

1235

Returns the number of screen-cells this string would need. Correctly

1236

accounts for wide and combining characters.

1237

</dd>

1238

1239

<dt><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a>

1240

</dt>

1241

<dd>

1242

Convert the given text string into the corresponding locale encoding.

1243

</dd>

1244

1245

<dt><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a>

1246

</dt>

1247

<dd>

1248

Convert the given locale-encoded octets into a perl string.

1249

</dd>

1250

1251

<dt><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a>

1252

</dt>

1253

<dd>

1254

XORs the rendition values in the given span with the provided value

1293

currently).

1294

</dd>

1295

</li>

1296

<dt><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a>

1297

1298

<dd>

1299

Returns the number of screen-cells this string would need. Correctly

1300

accounts for wide and combining characters.

1301

</dd>

1302

</li>

1303

<dt><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a>

1304

1305

<dd>

1306

Convert the given text string into the corresponding locale encoding.

1307

</dd>

1308

</li>

1309

<dt><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a>

1310

1311

<dd>

1312

Convert the given locale-encoded octets into a perl string.

1313

</dd>

1314

</li>

1315

<dt><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a>

1316

1317

<dd>

1318

XORs the rendition values in the given span with the provided value

1255

1319

(default: <code>RS_RVid</code>), which MUST NOT contain font styles. Useful in

1256

refresh hooks to provide effects similar to the selection.

1320

refresh hooks to provide effects similar to the selection.

1257

1321

</dd>

1258

1259

<dt><a name="item_scr_xor_rect">$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a>

1260

</dt>

1322

</li>

1323

<dt><a name="item_scr_xor_rect">$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a>

1324

1261

1325

<dd>

1262

Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing

1326

Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing

1263

1327

whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults

1264

1328

to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines

1265

it instead. Both styles MUST NOT contain font styles.

1266

</dd>

1267

1268

1269

</dt>

1270

<dd>

1271

Ring the bell!

1272

</dd>

1273

1274

<dt><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a>

1275

</dt>

1276

<dd>

1277

Write the given text string to the screen, as if output by the application

1329

it instead. Both styles MUST NOT contain font styles.

1330

</dd>

1331

</li>

1332

1333

1334

<dd>

1335

Ring the bell!

1336

</dd>

1337

</li>

1338

<dt><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a>

1339

1340

<dd>

1341

Write the given text string to the screen, as if output by the application

1278

1342

running inside the terminal. It may not contain command sequences (escape

1279

1343

codes), but is free to use line feeds, carriage returns and tabs. The

1280

string is a normal text string, not in locale-dependent encoding.

1344

string is a normal text string, not in locale-dependent encoding.

1281

1345

</dd>

1282

1346

<dd>

1283

1347

Normally its not a good idea to use this function, as programs might be

1284

1348

confused by changes in cursor position or scrolling. Its useful inside a

1285

1349

<code>on_add_lines</code> hook, though.

1286

1350

</dd>

1287

1288

<dt><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a>

1289

</dt>

1351

</li>

1352

<dt><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a>

1353

1290

1354

<dd>

1291

Switch to given screen - 0 primary, 1 secondary.

1355

Switch to given screen - 0 primary, 1 secondary.

1292

1356

</dd>

1293

1294

<dt><a name="item_cmd_parse">$term->cmd_parse ($octets)</a>

1295

</dt>

1357

</li>

1358

<dt><a name="item_cmd_parse">$term->cmd_parse ($octets)</a>

1359

1296

1360

<dd>

1297

Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the

1361

Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the

1298

1362

locale-specific encoding of the terminal and can contain command sequences

1299

(escape codes) that will be interpreted.

1363

(escape codes) that will be interpreted.

1300

1364

</dd>

1301

1302

<dt><a name="item_tt_write">$term->tt_write ($octets)</a>

1303

</dt>

1365

</li>

1366

<dt><a name="item_tt_write">$term->tt_write ($octets)</a>

1367

1304

1368

<dd>

1305

Write the octets given in <code>$data</code> to the tty (i.e. as program input). To

1369

Write the octets given in <code>$data</code> to the tty (i.e. as program input). To

1306

1370

pass characters instead of octets, you should convert your strings first

1307

to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>.

1371

to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>.

1308

1372

</dd>

1309

1310

<dt><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a>

1311

</dt>

1373

</li>

1374

<dt><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a>

1375

1312

1376

<dd>

1313

Replaces the event mask of the pty watcher by the given event mask. Can

1377

Replaces the event mask of the pty watcher by the given event mask. Can

1314

1378

be used to suppress input and output handling to the pty/tty. See the

1315

1379

description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore

1316

the previous value.

1317

</dd>

1318

1319

1320

</dt>

1321

<dd>

1322

Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty

1323

is used.

1324

</dd>

1325

1326

<dt><a name="item_parent">$windowid = $term->parent</a>

1327

</dt>

1328

<dd>

1329

Return the window id of the toplevel window.

1330

</dd>

1331

1332

<dt><a name="item_vt">$windowid = $term->vt</a>

1333

</dt>

1334

<dd>

1335

Return the window id of the terminal window.

1336

</dd>

1337

1338

<dt><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a>

1339

</dt>

1340

<dd>

1341

Adds the specified events to the vt event mask. Useful e.g. when you want

1342

to receive pointer events all the times:

1380

the previous value.

1381

</dd>

1382

</li>

1383

1384

1385

<dd>

1386

Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty

1387

is used.

1388

</dd>

1389

</li>

1390

<dt><a name="item_parent">$windowid = $term->parent</a>

1391

1392

<dd>

1393

Return the window id of the toplevel window.

1394

</dd>

1395

</li>

1396

<dt><a name="item_vt">$windowid = $term->vt</a>

1397

1398

<dd>

1399

Return the window id of the terminal window.

1400

</dd>

1401

</li>

1402

<dt><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a>

1403

1404

<dd>

1405

Adds the specified events to the vt event mask. Useful e.g. when you want

1406

to receive pointer events all the times:

1343

1407

</dd>

1344

1408

<dd>

1345

1409

<pre>

1346

1410

$term->vt_emask_add (urxvt::PointerMotionMask);</pre>

1347

1411

</dd>

1348

1349

<dt><a name="item_focus_in">$term->focus_in</a>

1350

</dt>

1351

<dt><a name="item_focus_out">$term->focus_out</a>

1352

</dt>

1353

<dt><a name="item_key_press">$term->key_press ($state, $keycode[, $time])</a>

1354

</dt>

1355

<dt><a name="item_key_release">$term->key_release ($state, $keycode[, $time])</a>

1356

</dt>

1357

<dd>

1358

Deliver various fake events to to terminal.

1359

</dd>

1360

1361

<dt><a name="item_width">$window_width = $term->width</a>

1362

</dt>

1363

<dt><a name="item_height">$window_height = $term->height</a>

1364

</dt>

1365

<dt><a name="item_fwidth">$font_width = $term->fwidth</a>

1366

</dt>

1367

<dt><a name="item_fheight">$font_height = $term->fheight</a>

1368

</dt>

1369

<dt><a name="item_fbase">$font_ascent = $term->fbase</a>

1370

</dt>

1371

<dt><a name="item_nrow">$terminal_rows = $term->nrow</a>

1372

</dt>

1373

<dt><a name="item_ncol">$terminal_columns = $term->ncol</a>

1374

</dt>

1375

<dt><a name="item_focus">$has_focus = $term->focus</a>

1376

</dt>

1377

<dt><a name="item_mapped">$is_mapped = $term->mapped</a>

1378

</dt>

1379

<dt><a name="item_savelines">$max_scrollback = $term->saveLines</a>

1380

</dt>

1381

<dt><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a>

1382

</dt>

1383

<dt><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a>

1384

</dt>

1385

<dd>

1386

Return various integers describing terminal characteristics.

1387

</dd>

1388

1389

<dt><a name="item_display_id">$x_display = $term->display_id</a>

1390

</dt>

1391

<dd>

1392

Return the DISPLAY used by rxvt-unicode.

1393

</dd>

1394

1395

<dt><a name="item_locale">$lc_ctype = $term->locale</a>

1396

</dt>

1397

<dd>

1398

Returns the LC_CTYPE category string used by this rxvt-unicode.

1399

</dd>

1400

1401

1402

</dt>

1403

<dd>

1404

Returns a copy of the environment in effect for the terminal as a hashref

1405

similar to <code>\%ENV</code>.

1406

</dd>

1407

1408

1409

</dt>

1410

<dd>

1411

Returns the environment as array of strings of the form <code>VAR=VALUE</code>.

1412

</dd>

1413

1414

1415

</dt>

1416

<dd>

1417

Return the argument vector as this terminal, similar to @ARGV, but

1418

includes the program name as first element.

1419

</dd>

1420

1421

<dt><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a>

1422

</dt>

1423

<dt><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a>

1424

</dt>

1425

<dt><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a>

1426

</dt>

1427

<dd>

1428

Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often

1429

AltGr), the meta key (often Alt) and the num lock key, if applicable.

1430

</dd>

1431

1432

<dt><a name="item_current_screen">$screen = $term->current_screen</a>

1433

</dt>

1434

<dd>

1435

Returns the currently displayed screen (0 primary, 1 secondary).

1436

</dd>

1437

1438

<dt><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a>

1439

</dt>

1440

<dd>

1441

Returns wether the cursor is currently hidden or not.

1442

</dd>

1443

1444

<dt><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a>

1445

</dt>

1446

<dd>

1447

Returns the row number of the topmost displayed line. Maximum value is

1412

</li>

1413

<dt><a name="item_focus_in">$term->focus_in</a>

1414

1415

<dt><a name="item_focus_out">$term->focus_out</a>

1416

1417

<dt><a name="item_key_press">$term->key_press ($state, $keycode[, $time])</a>

1418

1419

<dt><a name="item_key_release">$term->key_release ($state, $keycode[, $time])</a>

1420

1421

<dd>

1422

Deliver various fake events to to terminal.

1423

</dd>

1424

</li>

1425

<dt><a name="item_width">$window_width = $term->width</a>

1426

1427

<dt><a name="item_height">$window_height = $term->height</a>

1428

1429

<dt><a name="item_fwidth">$font_width = $term->fwidth</a>

1430

1431

<dt><a name="item_fheight">$font_height = $term->fheight</a>

1432

1433

<dt><a name="item_fbase">$font_ascent = $term->fbase</a>

1434

1435

<dt><a name="item_nrow">$terminal_rows = $term->nrow</a>

1436

1437

<dt><a name="item_ncol">$terminal_columns = $term->ncol</a>

1438

1439

<dt><a name="item_focus">$has_focus = $term->focus</a>

1440

1441

<dt><a name="item_mapped">$is_mapped = $term->mapped</a>

1442

1443

<dt><a name="item_savelines">$max_scrollback = $term->saveLines</a>

1444

1445

<dt><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a>

1446

1447

<dt><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a>

1448

1449

<dd>

1450

Return various integers describing terminal characteristics.

1451

</dd>

1452

</li>

1453

<dt><a name="item_display_id">$x_display = $term->display_id</a>

1454

1455

<dd>

1456

Return the DISPLAY used by rxvt-unicode.

1457

</dd>

1458

</li>

1459

<dt><a name="item_locale">$lc_ctype = $term->locale</a>

1460

1461

<dd>

1462

Returns the LC_CTYPE category string used by this rxvt-unicode.

1463

</dd>

1464

</li>

1465

1466

1467

<dd>

1468

Returns a copy of the environment in effect for the terminal as a hashref

1469

similar to <code>\%ENV</code>.

1470

</dd>

1471

</li>

1472

1473

1474

<dd>

1475

Returns the environment as array of strings of the form <code>VAR=VALUE</code>.

1476

</dd>

1477

</li>

1478

1479

1480

<dd>

1481

Return the argument vector as this terminal, similar to @ARGV, but

1482

includes the program name as first element.

1483

</dd>

1484

</li>

1485

<dt><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a>

1486

1487

<dt><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a>

1488

1489

<dt><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a>

1490

1491

<dd>

1492

Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often

1493

AltGr), the meta key (often Alt) and the num lock key, if applicable.

1494

</dd>

1495

</li>

1496

<dt><a name="item_current_screen">$screen = $term->current_screen</a>

1497

1498

<dd>

1499

Returns the currently displayed screen (0 primary, 1 secondary).

1500

</dd>

1501

</li>

1502

<dt><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a>

1503

1504

<dd>

1505

Returns whether the cursor is currently hidden or not.

1506

</dd>

1507

</li>

1508

<dt><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a>

1509

1510

<dd>

1511

Returns the row number of the topmost displayed line. Maximum value is

1448

1512

<code>0</code>, which displays the normal terminal contents. Lower values scroll

1449

this many lines into the scrollback buffer.

1513

this many lines into the scrollback buffer.

1450

1514

</dd>

1451

1452

<dt><a name="item_want_refresh">$term->want_refresh</a>

1453

</dt>

1515

</li>

1516

<dt><a name="item_want_refresh">$term->want_refresh</a>

1517

1454

1518

<dd>

1455

Requests a screen refresh. At the next opportunity, rxvt-unicode will

1519

Requests a screen refresh. At the next opportunity, rxvt-unicode will

1456

1520

compare the on-screen display with its stored representation. If they

1457

differ, it redraws the differences.

1521

differ, it redraws the differences.

1458

1522

</dd>

1459

1523

<dd>

1460

1524

Used after changing terminal contents to display them.

1461

1525

</dd>

1462

1463

<dt><a name="item_row_t">$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</a>

1464

</dt>

1526

</li>

1527

<dt><a name="item_row_t">$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</a>

1528

1465

1529

<dd>

1466

Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>

1530

Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>

1467

1531

is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost

1468

1532

terminal line. The scrollback buffer starts at line <code>-1</code> and extends to

1469

1533

line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line

1470

is requested.

1534

is requested.

1471

1535

</dd>

1472

1536

<dd>

1473

1537

If <code>$new_text</code> is specified, it will replace characters in the current

1476

1540

automatically be updated.

1477

1541

</dd>

1478

1542

<dd>

1479

<a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more

1543

<a href="#item__text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more

1480

1544

than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)

1481

1545

characters. Characters with combining characters and other characters that

1482

1546

do not fit into the normal tetx encoding will be replaced with characters

1491

1555

The methods <a href="#item_special_encode"><code>$term->special_encode</code></a> and <a href="#item_special_decode"><code>$term->special_decode</code></a>

1492

1556

can be used to convert normal strings into this encoding and vice versa.

1493

1557

</dd>

1494

1495

<dt><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a>

1496

</dt>

1558

</li>

1559

<dt><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a>

1560

1497

1561

<dd>

1498

Like <a href="#item_row_t"><code>$term->ROW_t</code></a>, but returns an arrayref with rendition

1562

Like <a href="#item_row_t"><code>$term->ROW_t</code></a>, but returns an arrayref with rendition

1499

1563

bitsets. Rendition bitsets contain information about colour, font, font

1500

styles and similar information. See also <a href="#item_row_t"><code>$term->ROW_t</code></a>.

1564

styles and similar information. See also <a href="#item_row_t"><code>$term->ROW_t</code></a>.

1501

1565

</dd>

1502

1566

<dd>

1503

1567

When setting rendition, the font mask will be ignored.

1505

1569

<dd>

1506

1570

See the section on RENDITION, above.

1507

1571

</dd>

1508

1509

<dt><a name="item_row_l">$length = $term->ROW_l ($row_number[, $new_length])</a>

1510

</dt>

1572

</li>

1573

<dt><a name="item_row_l">$length = $term->ROW_l ($row_number[, $new_length])</a>

1574

1511

1575

<dd>

1512

Returns the number of screen cells that are in use (``the line

1576

Returns the number of screen cells that are in use (``the line

1513

1577

length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term->ncol</code></a> if the

1514

line is joined with the following one.

1578

line is joined with the following one.

1515

1579

</dd>

1516

1517

<dt><a name="item_is_longer">$bool = $term->is_longer ($row_number)</a>

1518

</dt>

1580

</li>

1581

<dt><a name="item_is_longer">$bool = $term->is_longer ($row_number)</a>

1582

1519

1583

<dd>

1520

Returns true if the row is part of a multiple-row logical ``line'' (i.e.

1584

Returns true if the row is part of a multiple-row logical ``line'' (i.e.

1521

1585

joined with the following row), which means all characters are in use

1522

1586

and it is continued on the next row (and possibly a continuation of the

1523

previous row(s)).

1587

previous row(s)).

1524

1588

</dd>

1525

1526

<dt><a name="item_line">$line = $term->line ($row_number)</a>

1527

</dt>

1589

</li>

1590

<dt><a name="item_line">$line = $term->line ($row_number)</a>

1591

1528

1592

<dd>

1529

Create and return a new <code>urxvt::line</code> object that stores information

1593

Create and return a new <code>urxvt::line</code> object that stores information

1530

1594

about the logical line that row <code>$row_number</code> is part of. It supports the

1531

following methods:

1595

following methods:

1532

1596

</dd>

1533

1597

<dl>

1534

1535

</dt>

1536

<dd>

1537

Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>

1538

</dd>

1539

1540

1541

</dt>

1542

<dd>

1543

Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>

1544

</dd>

1545

1546

<dt><a name="item_l">$length = $line->l</a>

1547

</dt>

1548

<dd>

1549

Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.

1550

</dd>

1551

1552

<dt><a name="item_beg">$rownum = $line->beg</a>

1553

</dt>

1554

<dt><a name="item_end">$rownum = $line->end</a>

1555

</dt>

1556

<dd>

1557

Return the row number of the first/last row of the line, respectively.

1558

</dd>

1559

1560

<dt><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a>

1561

</dt>

1562

<dd>

1563

Returns the character offset of the given row|col pair within the logical

1598

1599

1600

<dd>

1601

Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>

1602

</dd>

1603

</li>

1604

1605

1606

<dd>

1607

Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>

1608

</dd>

1609

</li>

1610

<dt><a name="item_l">$length = $line->l</a>

1611

1612

<dd>

1613

Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.

1614

</dd>

1615

</li>

1616

<dt><a name="item_beg">$rownum = $line->beg</a>

1617

1618

<dt><a name="item_end">$rownum = $line->end</a>

1619

1620

<dd>

1621

Return the row number of the first/last row of the line, respectively.

1622

</dd>

1623

</li>

1624

<dt><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a>

1625

1626

<dd>

1627

Returns the character offset of the given row|col pair within the logical

1564

1628

line. Works for rows outside the line, too, and returns corresponding

1565

offsets outside the string.

1566

</dd>

1567

1568

<dt><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a>

1569

</dt>

1570

<dd>

1571

Translates a string offset into terminal coordinates again.

1572

</dd>

1573

</dl>

1574

<dt><a name="item_special_encode">$text = $term->special_encode $string</a>

1575

</dt>

1576

<dd>

1577

Converts a perl string into the special encoding used by rxvt-unicode,

1629

offsets outside the string.

1630

</dd>

1631

</li>

1632

<dt><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a>

1633

1634

<dd>

1635

Translates a string offset into terminal coordinates again.

1636

</dd>

1637

</li>

1638

</dl>

1639

<dt><a name="item_special_encode">$text = $term->special_encode $string</a>

1640

1641

<dd>

1642

Converts a perl string into the special encoding used by rxvt-unicode,

1578

1643

where one character corresponds to one screen cell. See

1579

<a href="#item_row_t"><code>$term->ROW_t</code></a> for details.

1580

</dd>

1581

1582

<dt><a name="item_special_decode">$string = $term->special_decode $text</a>

1583

</dt>

1584

<dd>

1585

Converts rxvt-unicodes text reprsentation into a perl string. See

1586

<a href="#item_row_t"><code>$term->ROW_t</code></a> for details.

1587

</dd>

1588

1589

<dt><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])</a>

1590

</dt>

1591

<dt><a name="item_ungrab_button">$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</a>

1592

</dt>

1593

<dd>

1594

1595

manpage.

1596

</dd>

1597

1598

<dt><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a>

1599

</dt>

1600

<dd>

1601

Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or

1602

synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.

1603

</dd>

1604

1605

<dt><a name="item_allow_events_async">$term->allow_events_async</a>

1606

</dt>

1607

<dd>

1608

Calls XAllowEvents with AsyncBoth for the most recent grab.

1609

</dd>

1610

1611

<dt><a name="item_allow_events_sync">$term->allow_events_sync</a>

1612

</dt>

1613

<dd>

1614

Calls XAllowEvents with SyncBoth for the most recent grab.

1615

</dd>

1616

1617

<dt><a name="item_allow_events_replay">$term->allow_events_replay</a>

1618

</dt>

1619

<dd>

1620

Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most

1621

recent grab.

1622

</dd>

1623

1624

<dt><a name="item_ungrab">$term->ungrab</a>

1625

</dt>

1626

<dd>

1627

Calls XUngrab for the most recent grab. Is called automatically on

1644

<a href="#item_row_t"><code>$term->ROW_t</code></a> for details.

1645

</dd>

1646

</li>

1647

<dt><a name="item_special_decode">$string = $term->special_decode $text</a>

1648

1649

<dd>

1650

Converts rxvt-unicodes text representation into a perl string. See

1651

<a href="#item_row_t"><code>$term->ROW_t</code></a> for details.

1652

</dd>

1653

</li>

1654

<dt><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])</a>

1655

1656

<dt><a name="item_ungrab_button">$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</a>

1657

1658

<dd>

1659

Register/unregister a synchronous button grab. See the XGrabButton

1660

manpage.

1661

</dd>

1662

</li>

1663

<dt><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a>

1664

1665

<dd>

1666

Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or

1667

synchronous (<code>$sync</code> is true). Also remembers the grab timestamp.

1668

</dd>

1669

</li>

1670

<dt><a name="item_allow_events_async">$term->allow_events_async</a>

1671

1672

<dd>

1673

Calls XAllowEvents with AsyncBoth for the most recent grab.

1674

</dd>

1675

</li>

1676

<dt><a name="item_allow_events_sync">$term->allow_events_sync</a>

1677

1678

<dd>

1679

Calls XAllowEvents with SyncBoth for the most recent grab.

1680

</dd>

1681

</li>

1682

<dt><a name="item_allow_events_replay">$term->allow_events_replay</a>

1683

1684

<dd>

1685

Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most

1686

recent grab.

1687

</dd>

1688

</li>

1689

<dt><a name="item_ungrab">$term->ungrab</a>

1690

1691

<dd>

1692

Calls XUngrab for the most recent grab. Is called automatically on

1628

1693

evaluation errors, as it is better to lose the grab in the error case as

1629

the session.

1694

the session.

1630

1695

</dd>

1631

1632

<dt><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a>

1633

</dt>

1634

<dt><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a>

1635

</dt>

1636

<dt><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a>

1637

</dt>

1638

<dt><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a>

1639

</dt>

1640

<dt><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a>

1641

</dt>

1642

<dt><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a>

1643

</dt>

1644

<dt><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a>

1645

</dt>

1646

<dt><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a>

1647

</dt>

1648

<dt><a name="item_xmapwindow">$term->XMapWindow ($window)</a>

1649

</dt>

1650

<dt><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a>

1651

</dt>

1652

<dt><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a>

1653

</dt>

1654

<dt><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a>

1655

</dt>

1656

<dt><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a>

1657

</dt>

1696

</li>

1697

<dt><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a>

1698

1699

<dt><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a>

1700

1701

<dt><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a>

1702

1703

<dt><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a>

1704

1705

<dt><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a>

1706

1707

<dt><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a>

1708

1709

<dt><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a>

1710

1711

<dt><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a>

1712

1713

<dt><a name="item_xmapwindow">$term->XMapWindow ($window)</a>

1714

1715

<dt><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a>

1716

1717

<dt><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a>

1718

1719

<dt><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a>

1720

1721

<dt><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a>

1722

1658

1723

<dd>

1659

Various X or X-related functions. The <code>$term</code> object only serves as

1724

Various X or X-related functions. The <a href="#item__term"><code>$term</code></a> object only serves as

1660

1725

the source of the display, otherwise those functions map more-or-less

1661

directory onto the X functions of the same name.

1726

directory onto the X functions of the same name.

1662

1727

</dd>

1663

</dl>

1728

</li>

1729

</dl>

1664

1730

1665

1731

1666

1732

<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>

1667

1733

<dl>

1668

<dt><a name="item_add_title">$popup->add_title ($title)</a>

1669

</dt>

1670

<dd>

1671

Adds a non-clickable title to the popup.

1672

</dd>

1673

1674

<dt><a name="item_add_separator">$popup->add_separator ([$sepchr])</a>

1675

</dt>

1676

<dd>

1677

Creates a separator, optionally using the character given as <code>$sepchr</code>.

1678

</dd>

1679

1680

<dt><a name="item_add_button">$popup->add_button ($text, $cb)</a>

1681

</dt>

1682

<dd>

1683

Adds a clickable button to the popup. <code>$cb</code> is called whenever it is

1684

selected.

1685

</dd>

1686

1687

<dt><a name="item_add_toggle">$popup->add_toggle ($text, $initial_value, $cb)</a>

1688

</dt>

1689

<dd>

1690

Adds a toggle/checkbox item to the popup. The callback gets called

1734

<dt><a name="item_add_title">$popup->add_title ($title)</a>

1735

1736

<dd>

1737

Adds a non-clickable title to the popup.

1738

</dd>

1739

</li>

1740

<dt><a name="item_add_separator">$popup->add_separator ([$sepchr])</a>

1741

1742

<dd>

1743

Creates a separator, optionally using the character given as <code>$sepchr</code>.

1744

</dd>

1745

</li>

1746

<dt><a name="item_add_button">$popup->add_button ($text, $cb)</a>

1747

1748

<dd>

1749

Adds a clickable button to the popup. <code>$cb</code> is called whenever it is

1750

selected.

1751

</dd>

1752

</li>

1753

<dt><a name="item_add_toggle">$popup->add_toggle ($text, $initial_value, $cb)</a>

1754

1755

<dd>

1756

Adds a toggle/checkbox item to the popup. The callback gets called

1691

1757

whenever it gets toggled, with a boolean indicating its new value as its

1692

first argument.

1758

first argument.

1693

1759

</dd>

1694

1695

<dt>$popup->show

1696

</dt>

1760

</li>

1761

<dt>$popup->show

1762

1697

1763

<dd>

1698

Displays the popup (which is initially hidden).

1764

Displays the popup (which is initially hidden).

1699

1765

</dd>

1700

</dl>

1766

</li>

1767

</dl>

1701

1768

1702

1769

1703

1770

<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>

1713

1780

sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);

1714

1781

});</pre>

1715

1782

<dl>

1716

<dt><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a>

1717

</dt>

1718

<dd>

1719

Create a new timer object in started state. It is scheduled to fire

1720

immediately.

1721

</dd>

1722

1723

<dt><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a>

1724

</dt>

1725

<dd>

1726

Set the callback to be called when the timer triggers.

1727

</dd>

1728

1729

<dt><a name="item_at">$tstamp = $timer->at</a>

1730

</dt>

1731

<dd>

1732

Return the time this watcher will fire next.

1733

</dd>

1734

1735

<dt>$timer = $timer->set ($tstamp)

1736

</dt>

1737

<dd>

1738

Set the time the event is generated to $tstamp.

1739

</dd>

1740

1741

<dt><a name="item_interval">$timer = $timer->interval ($interval)</a>

1742

</dt>

1743

<dd>

1744

Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically

1783

<dt><a name="item__timer">$timer = new urxvt::timer</a>

1784

1785

<dd>

1786

Create a new timer object in started state. It is scheduled to fire

1787

immediately.

1788

</dd>

1789

</li>

1790

<dt><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a>

1791

1792

<dd>

1793

Set the callback to be called when the timer triggers.

1794

</dd>

1795

</li>

1796

<dt><a name="item_at">$tstamp = $timer->at</a>

1797

1798

<dd>

1799

Return the time this watcher will fire next.

1800

</dd>

1801

</li>

1802

<dt>$timer = $timer->set ($tstamp)

1803

1804

<dd>

1805

Set the time the event is generated to $tstamp.

1806

</dd>

1807

</li>

1808

<dt><a name="item_interval">$timer = $timer->interval ($interval)</a>

1809

1810

<dd>

1811

Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically

1745

1812

stop after it has fired once. If <code>$interval</code> is non-zero, then the timer

1746

is automatically rescheduled at the given intervals.

1747

</dd>

1748

1749

<dt><a name="item_start">$timer = $timer->start</a>

1750

</dt>

1751

<dd>

1752

Start the timer.

1753

</dd>

1754

1755

<dt>$timer = $timer->start ($tstamp)

1756

</dt>

1757

<dd>

1758

Set the event trigger time to <code>$tstamp</code> and start the timer.

1759

</dd>

1760

1761

<dt><a name="item_after">$timer = $timer->after ($delay)</a>

1762

</dt>

1763

<dd>

1764

Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>.

1765

</dd>

1766

1767

<dt><a name="item_stop">$timer = $timer->stop</a>

1768

</dt>

1769

<dd>

1770

Stop the timer.

1771

</dd>

1772

</dl>

1813

is automatically rescheduled at the given intervals.

1814

</dd>

1815

</li>

1816

<dt><a name="item_start">$timer = $timer->start</a>

1817

1818

<dd>

1819

Start the timer.

1820

</dd>

1821

</li>

1822

<dt>$timer = $timer->start ($tstamp)

1823

1824

<dd>

1825

Set the event trigger time to <code>$tstamp</code> and start the timer.

1826

</dd>

1827

</li>

1828

<dt><a name="item_after">$timer = $timer->after ($delay)</a>

1829

1830

<dd>

1831

Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>.

1832

</dd>

1833

</li>

1834

<dt><a name="item_stop">$timer = $timer->stop</a>

1835

1836

<dd>

1837

Stop the timer.

1838

</dd>

1839

</li>

1840

</dl>

1773

1841

1774

1842

1775

1843

<h2><a name="the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></h2>

1788

1856

or end-of-file;

1789

1857

});</pre>

1790

1858

<dl>

1791

<dt><a name="item__24iow__3d_new_urxvt_3a_3aiow">$iow = new urxvt::iow</a>

1792

</dt>

1793

<dd>

1794

Create a new io watcher object in stopped state.

1795

</dd>

1796

1797

<dt>$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })

1798

</dt>

1799

<dd>

1800

Set the callback to be called when io events are triggered. <code>$reventmask</code>

1801

is a bitset as described in the <a href="#item_events"><code>events</code></a> method.

1802

</dd>

1803

1804

1805

</dt>

1806

<dd>

1807

Set the filedescriptor (not handle) to watch.

1808

</dd>

1809

1810

<dt><a name="item_events">$iow = $iow->events ($eventmask)</a>

1811

</dt>

1812

<dd>

1813

Set the event mask to watch. The only allowed values are

1859

<dt><a name="item__iow">$iow = new urxvt::iow</a>

1860

1861

<dd>

1862

Create a new io watcher object in stopped state.

1863

</dd>

1864

</li>

1865

<dt>$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })

1866

1867

<dd>

1868

Set the callback to be called when io events are triggered. <code>$reventmask</code>

1869

is a bitset as described in the <a href="#item_events"><code>events</code></a> method.

1870

</dd>

1871

</li>

1872

1873

1874

<dd>

1875

Set the file descriptor (not handle) to watch.

1876

</dd>

1877

</li>

1878

<dt><a name="item_events">$iow = $iow->events ($eventmask)</a>

1879

1880

<dd>

1881

Set the event mask to watch. The only allowed values are

1814

1882

<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed

1815

together, or <code>urxvt::EVENT_NONE</code>.

1816

</dd>

1817

1818

<dt>$iow = $iow->start

1819

</dt>

1820

<dd>

1821

Start watching for requested events on the given handle.

1822

</dd>

1823

1824

<dt>$iow = $iow->stop

1825

</dt>

1826

<dd>

1827

Stop watching for events on the given filehandle.

1828

</dd>

1829

</dl>

1883

together, or <code>urxvt::EVENT_NONE</code>.

1884

</dd>

1885

</li>

1886

<dt>$iow = $iow->start

1887

1888

<dd>

1889

Start watching for requested events on the given handle.

1890

</dd>

1891

</li>

1892

<dt>$iow = $iow->stop

1893

1894

<dd>

1895

Stop watching for events on the given file handle.

1896

</dd>

1897

</li>

1898

</dl>

1830

1899

1831

1900

1832

1901

<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2>

1834

1903

the process is idle. They should return as fast as possible, after doing

1835

1904

some useful work.

1836

1905

<dl>

1837

<dt><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a>

1838

</dt>

1839

<dd>

1840

Create a new idle watcher object in stopped state.

1841

</dd>

1842

1843

<dt>$iw = $iw->cb (sub { my ($iw) = @_; ... })

1844

</dt>

1845

<dd>

1846

Set the callback to be called when the watcher triggers.

1847

</dd>

1848

1849

<dt>$timer = $timer->start

1850

</dt>

1851

<dd>

1852

Start the watcher.

1853

</dd>

1854

1855

<dt>$timer = $timer->stop

1856

</dt>

1857

<dd>

1858

Stop the watcher.

1859

</dd>

1860

</dl>

1906

<dt><a name="item__iw">$iw = new urxvt::iw</a>

1907

1908

<dd>

1909

Create a new idle watcher object in stopped state.

1910

</dd>

1911

</li>

1912

<dt>$iw = $iw->cb (sub { my ($iw) = @_; ... })

1913

1914

<dd>

1915

Set the callback to be called when the watcher triggers.

1916

</dd>

1917

</li>

1918

<dt>$timer = $timer->start

1919

1920

<dd>

1921

Start the watcher.

1922

</dd>

1923

</li>

1924

<dt>$timer = $timer->stop

1925

1926

<dd>

1927

Stop the watcher.

1928

</dd>

1929

</li>

1930

</dl>

1861

1931

1862

1932

1863

1933

<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2>

1874

1944

...

1875

1945

});</pre>

1876

1946

<dl>

1877

<dt><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a>

1878

</dt>

1879

<dd>

1880

Create a new process watcher in stopped state.

1881

</dd>

1882

1883

<dt>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })

1884

</dt>

1885

<dd>

1886

Set the callback to be called when the timer triggers.

1887

</dd>

1888

1889

<dt>$pw = $timer->start ($pid)

1890

</dt>

1891

<dd>

1892

Tells the wqtcher to start watching for process <code>$pid</code>.

1893

</dd>

1894

1895

<dt>$pw = $pw->stop

1896

</dt>

1897

<dd>

1898

Stop the watcher.

1899

</dd>

1900

</dl>

1947

<dt><a name="item__pw">$pw = new urxvt::pw</a>

1948

1949

<dd>

1950

Create a new process watcher in stopped state.

1951

</dd>

1952

</li>

1953

<dt>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })

1954

1955

<dd>

1956

Set the callback to be called when the timer triggers.

1957

</dd>

1958

</li>

1959

<dt>$pw = $timer->start ($pid)

1960

1961

<dd>

1962

Tells the watcher to start watching for process <code>$pid</code>.

1963

</dd>

1964

</li>

1965

<dt>$pw = $pw->stop

1966

1967

<dd>

1968

Stop the watcher.

1969

</dd>

1970

</li>

1971

</dl>

1901

1972

1902

1973

1903

1974

<hr />

1908

1979

This variable controls the verbosity level of the perl extension. Higher

1909

1980

numbers indicate more verbose output.

1910

1981

<dl>

1911

<dt><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a>

1912

</dt>

1913

<dt><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a>

1914

</dt>

1915

<dt><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a>

1916

</dt>

1917

<dt><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a>

1918

</dt>

1982

<dt><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a>

1983

1984

<dt><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a>

1985

1986

<dt><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a>

1987

1988

<dt><a name="item__3e_3d11__2d_hook_return_values">>=11 - hook return values</a>

1989

1919

1990

</dl>

1920

1991

1921

1992

Older »