From 348390c15e1041ea6353a1572d42615fb35afbc1 Mon Sep 17 00:00:00 2001 From: root Date: Thu, 6 Jul 2006 18:56:09 +0000 Subject: [PATCH] *** empty log message *** --- Changes | 21 +- README.configure | 16 +- doc/rxvt.1.html | 1663 ++++++++++++++--------------- doc/rxvt.1.man.in | 99 +- doc/rxvt.1.txt | 55 +- doc/rxvt.7.html | 1302 +++++++++++------------ doc/rxvt.7.man.in | 449 ++++---- doc/rxvt.7.pod | 3 +- doc/rxvt.7.txt | 569 +++++----- doc/rxvtperl.3.html | 1784 ++++++++++++++++---------------- doc/rxvtperl.3.man.in | 687 ++++++------ doc/rxvtperl.3.txt | 38 +- src/Makefile.in | 99 ++ src/perl/searchable-scrollback | 5 + src/rxvt.h | 9 +- src/screen.C | 51 +- src/urxvt.pm | 6 + 17 files changed, 3520 insertions(+), 3336 deletions(-) diff --git a/Changes b/Changes index eab08e2d..1f35e445 100644 --- a/Changes +++ b/Changes @@ -22,18 +22,21 @@ DUMB: support tex fonts TODO: investigate -pe tabbed -g 80x25 being 23 not 24 or 25 lines TODO: zero scorllback buffer should free memory TODO: kuake -TODO: look into the selection hilight patch -TODO: implement smartcase-like search in searchable-scrollback TODO: investigate the color-management patch send ages ago, as well as other postings - - INCOMPATIBLE CHANGE: this version will always read ~/.Xdefaults, earlier - versions only read it if display-resources (usually from .Xresources) - are not set. This avoids the #1 FAQ ("why isn't my resource used") and - seems to be logical behaviour, too. .Xdefaults resources have a lower - priority than display-specific resources. - - use less "correct" color scaling that is compatible with libX11 and Xft - (avoids off-by-one colors resulting in striped backgrounds). + - INCOMPATIBLE CHANGE: this version will always read ~/.Xdefaults, + earlier versions only read it if display-resources (usually from + .Xresources) are not set. This avoids the #1 FAQ ("why isn't my + resource used") and seems to be logical behaviour, too. .Xdefaults + resources have a lower priority than display-specific resources. + - use less "correct" color scaling that is compatible with libX11 and + Xft (avoids off-by-one colors resulting in striped backgrounds). - the "depth" resource is now respected. + - preset the searchable-scrollback pattern with "(?i)" to default search + to case-insensitivity. Will automatically be cleared when typing an + uppercase character. - add FORCE_UNBUFFERED_XFT define to features.h. + - re-enabled highlightcolor support with --enable-frills, based on + a patch by Martin Stubenschrott. - double-buffered xft drawing did suffer from pixel offset issues when pixmap transparency was enabled. - moved on_osc_seq to on_osc_seq_perl and added a more diff --git a/README.configure b/README.configure index 480ae7fe..42601a14 100644 --- a/README.configure +++ b/README.configure @@ -37,13 +37,12 @@ CONFIGURE OPTIONS about 700kB), but it doesn't increase memory usage unless you use a font requiring one of these encodings. - all all available codeset groups - zh common chinese encodings - zh_ext rarely used but very big chinese encodigs - jp common japanese encodings - jp_ext rarely used but big japanese encodings - kr korean encodings - + all all available codeset groups + zh common chinese encodings + zh_ext rarely used but very big chinese encodigs + jp common japanese encodings + jp_ext rarely used but big japanese encodings + kr korean encodings --enable-xim (default: on) Add support for XIM (X Input Method) protocol. This allows using alternative input methods (e.g. kinput2) and will also correctly set @@ -177,8 +176,9 @@ CONFIGURE OPTIONS user-pty (-pty-fd) hold on exit (-hold) skip builtin block graphics (-sbg) + separate highlightcolor support (-hc) - It also enabled some non-essential features otherwise disabled, such + It also enables some non-essential features otherwise disabled, such as: some round-trip time optimisations diff --git a/doc/rxvt.1.html b/doc/rxvt.1.html index 0ea38831..54964cb2 100644 --- a/doc/rxvt.1.html +++ b/doc/rxvt.1.html @@ -1,7 +1,9 @@ + unicode) - + @@ -53,7 +55,7 @@

DESCRIPTION

-

rxvt-unicode, version 7.6, is a colour vt102 terminal +

rxvt-unicode, version 7.7, is a colour vt102 terminal emulator intended as an xterm(1) replacement for users who do not require features such as Tektronix 4014 emulation and toolkit-style configurability. As a result, rxvt-unicode uses much less swap space -- @@ -124,147 +126,147 @@ far greater than those listed. For example: `rxvt --loginShell --color1 Orange'.

The following options are available:

-
-help, --help
-
+
-help, --help +
-Print out a message describing available options. +

Print out a message describing available options.

-

-
-display displayname
-
+ +
-display displayname +
-Attempt to open a window on the named X display (-d still +

Attempt to open a window on the named X display (-d still respected). In the absence of this option, the display specified by the -DISPLAY environment variable is used. +DISPLAY environment variable is used.

-

-
-depth bitdepth
-
+ +
-depth bitdepth +
-Compile xft: Attempt to find a visual with the given bit depth; -resource depth. +

Compile xft: Attempt to find a visual with the given bit depth; +resource depth.

-

-
-geometry geom
-
+ +
-geometry geom +
-Window geometry (-g still respected); resource geometry. +

Window geometry (-g still respected); resource geometry.

-

-
-rv|+rv
-
+ +
-rv|+rv +
-Turn on/off simulated reverse video; resource reverseVideo. +

Turn on/off simulated reverse video; resource reverseVideo.

-

-
-j|+j
-
+ +
-j|+j +
-Turn on/off jump scrolling; resource jumpScroll. +

Turn on/off jump scrolling; resource jumpScroll.

-

-
-ip|+ip | -tr|+tr
-
+ +
-ip|+ip | -tr|+tr +
-Turn on/off inheriting parent window's pixmap. Alternative form is --tr; resource inheritPixmap. +

Turn on/off inheriting parent window's pixmap. Alternative form is +-tr; resource inheritPixmap.

Please note that transparency of any kind if completely unsupported by the author. Don't bug him with installation questions!

-

-
-fade number
-
+ +
-fade number +
-Fade the text by the given percentage when focus is lost. Small values +

Fade the text by the given percentage when focus is lost. Small values fade a little only, 100 completely replaces all colours by the fade -colour; resource fading. +colour; resource fading.

-

-
-fadecolor colour
-
+ +
-fadecolor colour +
-Fade to this colour when fading is used (see -fade). The default colour -is opaque black. resource fadeColor. +

Fade to this colour when fading is used (see -fade). The default colour +is opaque black. resource fadeColor.

-

-
-tint colour
-
+ +
-tint colour +
-Tint the transparent background pixmap with the given colour when +

Tint the transparent background pixmap with the given colour when transparency is enabled with -tr or -ip. This only works for non-tiled backgrounds, currently. See also the -sh option that can be used to brighten or darken the image in addition to tinting it; resource -tintColor. Example: +tintColor. Example:

    rxvt -tr -tint blue -sh 40
-

-
-sh
-
+ +
-sh +
-number Darken (0 .. 100) or lighten (-1 .. -100) the transparent +

number Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image in addition to tinting it (i.e. -tint must be -specified, too, e.g. -tint white). +specified, too, e.g. -tint white).

-

-
-bg colour
-
+ +
-bg colour +
-Window background colour; resource background. +

Window background colour; resource background.

-

-
-fg colour
-
+ +
-fg colour +
-Window foreground colour; resource foreground. +

Window foreground colour; resource foreground.

-

-
-pixmap file[;geom]
-
+ +
-pixmap file[;geom] +
-Compile XPM: Specify XPM file for the background and also optionally +

Compile XPM: Specify XPM file for the background and also optionally specify its scaling with a geometry string. Note you may need to add quotes to avoid special shell interpretation of the ; in the -command-line; resource backgroundPixmap. +command-line; resource backgroundPixmap.

-

-
-cr colour
-
+ +
-cr colour +
-The cursor colour; resource cursorColor. +

The cursor colour; resource cursorColor.

-

-
-pr colour
-
+ +
-pr colour +
-The mouse pointer foreground colour; resource pointerColor. +

The mouse pointer foreground colour; resource pointerColor.

-

-
-pr2 colour
-
+ +
-pr2 colour +
-The mouse pointer background colour; resource pointerColor2. +

The mouse pointer background colour; resource pointerColor2.

-

-
-bd colour
-
+ +
-bd colour +
-The colour of the border around the text area and between the scrollbar and the text; -resource borderColor. +

The colour of the border around the text area and between the scrollbar and the text; +resource borderColor.

-

-
-fn fontlist
-
+ +
-fn fontlist +
-Select the fonts to be used. This is a comma separated list of font names +

Select the fonts to be used. This is a comma separated list of font names that are checked in order when trying to find glyphs for characters. The first font defines the cell size for characters; other fonts might be smaller, but not (in general) larger. A (hopefully) reasonable default -font list is always appended to it. See resource font for more details. +font list is always appended to it. See resource font for more details.

In short, to specify an X11 core font, just specify it's name or prefix it @@ -280,202 +282,202 @@ e.g.:

See also the question ``How does rxvt-unicode choose fonts?'' in the FAQ section of rxvt(7).

-

-
-fb fontlist
-
+ +
-fb fontlist +
-Compile font-styles: The bold font list to use when bold characters -are to be printed. See resource boldFont for details. +

Compile font-styles: The bold font list to use when bold characters +are to be printed. See resource boldFont for details.

-

-
-fi fontlist
-
+ +
-fi fontlist +
-Compile font-styles: The italic font list to use when italic -characters are to be printed. See resource italicFont for details. +

Compile font-styles: The italic font list to use when italic +characters are to be printed. See resource italicFont for details.

-

-
-fbi fontlist
-
+ +
-fbi fontlist +
-Compile font-styles: The bold italic font list to use when bold +

Compile font-styles: The bold italic font list to use when bold italic > characters are to be printed. See resource boldItalicFont -for details. +for details.

-

-
-is|+is
-
+ +
-is|+is +
-Compile font-styles: Bold/Italic font styles imply high intensity +

Compile font-styles: Bold/Italic font styles imply high intensity foreground/background (default). See resource intensityStyles for -details. +details.

-

-
-name name
-
+ +
-name name +
-Specify the application name under which resources are to be obtained, +

Specify the application name under which resources are to be obtained, rather than the default executable file name. Name should not contain -`.' or `*' characters. Also sets the icon and title name. +`.' or `*' characters. Also sets the icon and title name.

-

-
-ls|+ls
-
+ +
-ls|+ls +
-Start as a login-shell/sub-shell; resource loginShell. +

Start as a login-shell/sub-shell; resource loginShell.

-

-
-ut|+ut
-
+ +
-ut|+ut +
-Compile utmp: Inhibit/enable writing a utmp entry; resource -utmpInhibit. +

Compile utmp: Inhibit/enable writing a utmp entry; resource +utmpInhibit.

-

-
-vb|+vb
-
+ +
-vb|+vb +
-Turn on/off visual bell on receipt of a bell character; resource -visualBell. +

Turn on/off visual bell on receipt of a bell character; resource +visualBell.

-

-
-sb|+sb
-
+ +
-sb|+sb +
-Turn on/off scrollbar; resource scrollBar. +

Turn on/off scrollbar; resource scrollBar.

-

-
-si|+si
-
+ +
-si|+si +
-Turn on/off scroll-to-bottom on TTY output inhibit; resource -scrollTtyOutput has opposite effect. +

Turn on/off scroll-to-bottom on TTY output inhibit; resource +scrollTtyOutput has opposite effect.

-

-
-sk|+sk
-
+ +
-sk|+sk +
-Turn on/off scroll-to-bottom on keypress; resource -scrollTtyKeypress. +

Turn on/off scroll-to-bottom on keypress; resource +scrollTtyKeypress.

-

-
-sw|+sw
-
+ +
-sw|+sw +
-Turn on/off scrolling with the scrollback buffer as new lines appear. +

Turn on/off scrolling with the scrollback buffer as new lines appear. This only takes effect if -si is also given; resource -scrollWithBuffer. +scrollWithBuffer.

-

-
-sr|+sr
-
+ +
-sr|+sr +
-Put scrollbar on right/left; resource scrollBar_right. +

Put scrollbar on right/left; resource scrollBar_right.

-

-
-st|+st
-
+ +
-st|+st +
-Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; -resource scrollBar_floating. +

Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; +resource scrollBar_floating.

-

-
-ptab|+ptab
-
+ +
-ptab|+ptab +
-If enabled (default), ``Horizontal Tab'' characters are being stored as +

If enabled (default), ``Horizontal Tab'' characters are being stored as actual wide characters in the screen buffer, which makes it possible to select and paste them. Since a horizontal tab is a cursor movement and not an actual glyph, this can sometimes be visually annoying as the cursor -on a tab character is displayed as a wide cursor; resource pastableTabs. +on a tab character is displayed as a wide cursor; resource pastableTabs.

-

-
-bc|+bc
-
+ +
-bc|+bc +
-Blink the cursor; resource cursorBlink. +

Blink the cursor; resource cursorBlink.

-

-
-iconic
-
+ +
-iconic +
-Start iconified, if the window manager supports that option. -Alternative form is -ic. +

Start iconified, if the window manager supports that option. +Alternative form is -ic.

-

-
-sl number
-
+ +
-sl number +
-Save number lines in the scrollback buffer. See resource entry for -limits; resource saveLines. +

Save number lines in the scrollback buffer. See resource entry for +limits; resource saveLines.

-

-
-b number
-
+ +
-b number +
-Compile frills: Internal border of number pixels. See resource -entry for limits; resource internalBorder. +

Compile frills: Internal border of number pixels. See resource +entry for limits; resource internalBorder.

-

-
-w number
-
+ +
-w number +
-Compile frills: External border of number pixels. Also, -bw +

Compile frills: External border of number pixels. Also, -bw and -borderwidth. See resource entry for limits; resource -externalBorder. +externalBorder.

-

-
-bl
-
+ +
-bl +
-Compile frills: Set MWM hints to request a borderless window, i.e. +

Compile frills: Set MWM hints to request a borderless window, i.e. if honoured by the WM, the rxvt-unicode window will not have window -decorations; resource borderLess. +decorations; resource borderLess.

-

-
-override-redirect
-
+ +
-override-redirect +
-Compile frills: Sets override-redirect on the window; resource -override-redirect. +

Compile frills: Sets override-redirect on the window; resource +override-redirect.

-

-
-sbg
-
+ +
-sbg +
-Compile frills: Disable the usage of the built-in block graphics/line +

Compile frills: Disable the usage of the built-in block graphics/line drawing characters and just rely on what the specified fonts provide. Use this if you have a good font and want to use its block graphic glyphs; -resource skipBuiltinGlyphs. +resource skipBuiltinGlyphs.

-

-
-lsp number
-
+ +
-lsp number +
-Compile frills: Lines (pixel height) to insert between each row of +

Compile frills: Lines (pixel height) to insert between each row of the display. Useful to work around font rendering problems; resource -linespace. +linespace.

-

-
-tn termname
-
+ +
-tn termname +
-This option specifies the name of the terminal type to be set in the +

This option specifies the name of the terminal type to be set in the TERM environment variable. This terminal type must exist in the termcap(5) database and should have li# and co# entries; -resource termName. +resource termName.

-

-
-e command [arguments]
-
+ +
-e command [arguments] +
-Run the command with its command-line arguments in the rxvt +

Run the command with its command-line arguments in the rxvt window; also sets the window title and icon name to be the basename of the program being executed if neither -title (-T) nor -n are given on the command line. If this option is used, it must be the last on the command-line. If there is no -e option then the default is to run the program specified by the SHELL environment variable or, -failing that, sh(1). +failing that, sh(1).

Please note that you must specify a program with arguments. If you want to @@ -485,116 +487,116 @@ run shell commands, you have to specify the shell, like this:

   rxvt -e sh -c "shell commands"
-

-
-title text
-
+ +
-title text +
-Window title (-T still respected); the default title is the basename +

Window title (-T still respected); the default title is the basename of the program specified after the -e option, if any, otherwise the -application name; resource title. +application name; resource title.

-

-
-n text
-
+ +
-n text +
-Icon name; the default name is the basename of the program specified +

Icon name; the default name is the basename of the program specified after the -e option, if any, otherwise the application name; -resource iconName. +resource iconName.

-

-
-C
-
+ +
-C +
-Capture system console messages. +

Capture system console messages.

-

-
-pt style
-
+ +
-pt style +
-Compile XIM: input style for input method; OverTheSpot, -OffTheSpot, Root; resource preeditType. +

Compile XIM: input style for input method; OverTheSpot, +OffTheSpot, Root; resource preeditType.

-

-
-im text
-
+ +
-im text +
-Compile XIM: input method name. resource inputMethod. +

Compile XIM: input method name. resource inputMethod.

-

-
-imlocale string
-
+ +
-imlocale string +
-The locale to use for opening the IM. You can use an LC_CTYPE of e.g. +

The locale to use for opening the IM. You can use an LC_CTYPE of e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input extension to be able to input japanese characters while staying in -another locale. resource imLocale. +another locale. resource imLocale.

-

-
-imfont fontset
-
+ +
-imfont fontset +
-Set the font set to use for the X Input Method, see resource imFont -for more info. +

Set the font set to use for the X Input Method, see resource imFont +for more info.

-

-
-tcw
-
+ +
-tcw +
-Change the meaning of triple-click selection with the left mouse +

Change the meaning of triple-click selection with the left mouse button. Instead of selecting a full line it will extend the selection the -end of the logical line only. resource tripleclickwords. +end of the logical line only. resource tripleclickwords.

-

-
-insecure
-
+ +
-insecure +
-Enable ``insecure'' mode, which currently enables most of the escape +

Enable ``insecure'' mode, which currently enables most of the escape sequences that echo strings. See the resource insecure for more -info. +info.

-

-
-mod modifier
-
+ +
-mod modifier +
-Override detection of Meta modifier with specified key: alt, +

Override detection of Meta modifier with specified key: alt, meta, hyper, super, mod1, mod2, mod3, mod4, -mod5; resource modifier. +mod5; resource modifier.

-

-
-ssc|+ssc
-
+ +
-ssc|+ssc +
-Turn on/off secondary screen (default enabled); resource -secondaryScreen. +

Turn on/off secondary screen (default enabled); resource +secondaryScreen.

-

-
-ssr|+ssr
-
+ +
-ssr|+ssr +
-Turn on/off secondary screen scroll (default enabled); resource -secondaryScroll. +

Turn on/off secondary screen scroll (default enabled); resource +secondaryScroll.

-

-
-hold|+hold
-
+ +
-hold|+hold +
-Turn on/off hold window after exit support. If enabled, rxvt +

Turn on/off hold window after exit support. If enabled, rxvt will not immediately destroy its window when the program executed within it exits. Instead, it will wait till it is being killed or closed by the -user; resource hold. +user; resource hold.

-

-
-keysym.sym string
-
+ +
-keysym.sym string +
-Remap a key symbol. See resource keysym. +

Remap a key symbol. See resource keysym.

-

-
-embed windowid
-
+ +
-embed windowid +
-Tells rxvt to embed it's windows into an already-existing window, -which enables applications to easily embed a terminal. +

Tells rxvt to embed it's windows into an already-existing window, +which enables applications to easily embed a terminal.

Right now, rxvt will first unmap/map the specified window, so it @@ -624,14 +626,14 @@ used (a longer example is in doc/embed):

system "rxvt -embed $xid &"; });
-

-
-pty-fd file descriptor
-
+ +
-pty-fd file descriptor +
-Tells rxvt NOT to execute any commands or create a new pty/tty +

Tells rxvt NOT to execute any commands or create a new pty/tty pair but instead use the given filehandle as the tty master. This is useful if you want to drive rxvt as a generic terminal emulator -without having to run a program within it. +without having to run a program within it.

If this switch is given, rxvt will not create any utmp/wtmp @@ -664,14 +666,15 @@ longer example is in doc/pty-fd):

my $slave = $pty->slave; while (<$slave>) { print $slave "got <$_>\n" }
-

-
-pe string
-
+ +
-pe string +
-Comma-separated list of perl extension scripts to use (or not to use) in -this terminal instance. See resource perl-ext for details. +

Comma-separated list of perl extension scripts to use (or not to use) in +this terminal instance. See resource perl-ext for details.

-

+ +

@@ -699,43 +702,43 @@ settings. The following resources are supported (you might want to check the rxvtperl(3) manpage for additional settings by perl extensions not documented here):

-
depth: bitdepth
-
+
depth: bitdepth +
-Compile xft: Attempt to find a visual with the given bit depth; -option -depth. +

Compile xft: Attempt to find a visual with the given bit depth; +option -depth.

-

-
geometry: geom
-
+ +
geometry: geom +
-Create the window with the specified X window geometry [default 80x24]; -option -geometry. +

Create the window with the specified X window geometry [default 80x24]; +option -geometry.

-

-
background: colour
-
+ +
background: colour +
-Use the specified colour as the window's background colour [default -White]; option -bg. +

Use the specified colour as the window's background colour [default +White]; option -bg.

-

-
foreground: colour
-
+ +
foreground: colour +
-Use the specified colour as the window's foreground colour [default -Black]; option -fg. +

Use the specified colour as the window's foreground colour [default +Black]; option -fg.

-

-
colorn: colour
-
+ +
colorn: colour +
-Use the specified colour for the colour value n, where 0-7 +

Use the specified colour for the colour value n, where 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity (bold = bright foreground, blink = bright background) colours. The canonical names are as follows: 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour -names used are listed in the COLORS AND GRAPHICS section. +names used are listed in the COLORS AND GRAPHICS section.

Colours higher than 15 cannot be set using resources (yet), but can be @@ -745,132 +748,132 @@ changed using an escape command (see rxvt(7)).

Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 88 colour support). Colours 80-87 are evenly spaces grey steps.

-

-
colorBD: colour
-
-
colorIT: colour
-
+ +
colorBD: colour + +
colorIT: colour +
-Use the specified colour to display bold or italic characters when the +

Use the specified colour to display bold or italic characters when the foreground colour is the default. If font styles are not available -(Compile styles) and this option is unset, reverse video is used instead. +(Compile styles) and this option is unset, reverse video is used instead.

-

-
colorUL: colour
-
+ +
colorUL: colour +
-Use the specified colour to display underlined characters when the -foreground colour is the default. +

Use the specified colour to display underlined characters when the +foreground colour is the default.

-

-
colorRV: colour
-
+ +
colorRV: colour +
-Use the specified colour as the background for reverse video -characters. +

Use the specified colour as the background for reverse video +characters.

-

-
underlineColor: colour
-
+ +
underlineColor: colour +
-If set, use the specified colour as the colour for the underline -itself. If unset, use the foreground colour. +

If set, use the specified colour as the colour for the underline +itself. If unset, use the foreground colour.

-

-
cursorColor: colour
-
+ +
cursorColor: colour +
-Use the specified colour for the cursor. The default is to use the -foreground colour; option -cr. +

Use the specified colour for the cursor. The default is to use the +foreground colour; option -cr.

-

-
cursorColor2: colour
-
+ +
cursorColor2: colour +
-Use the specified colour for the colour of the cursor text. For this to +

Use the specified colour for the colour of the cursor text. For this to take effect, cursorColor must also be specified. The default is to -use the background colour. +use the background colour.

-

-
reverseVideo: boolean
-
+ +
reverseVideo: boolean +
-True: simulate reverse video by foreground and background colours; +

True: simulate reverse video by foreground and background colours; option -rv. False: regular screen colours [default]; option -+rv. See note in COLORS AND GRAPHICS section. ++rv. See note in COLORS AND GRAPHICS section.

-

-
jumpScroll: boolean
-
+ +
jumpScroll: boolean +
-True: specify that jump scrolling should be used. When scrolling +

True: specify that jump scrolling should be used. When scrolling quickly, fewer screen updates are performed [default]; option -j. -False: specify that smooth scrolling should be used; option +j. +False: specify that smooth scrolling should be used; option +j.

-

-
inheritPixmap: boolean
-
+ +
inheritPixmap: boolean +
-True: make the background inherit the parent windows' pixmap, giving +

True: make the background inherit the parent windows' pixmap, giving artificial transparency. False: do not inherit the parent windows' -pixmap. +pixmap.

Please note that transparency of any kind if completely unsupported by the author. Don't bug him with installation questions!

-

-
fading: number
-
+ +
fading: number +
-Fade the text by the given percentage when focus is lost; option -fade. +

Fade the text by the given percentage when focus is lost; option -fade.

-

-
fadeColor: colour
-
+ +
fadeColor: colour +
-Fade to this colour, when fading is used (see fading:). The default -colour is black; option -fadecolor. +

Fade to this colour, when fading is used (see fading:). The default +colour is black; option -fadecolor.

-

-
tintColor: colour
-
+ +
tintColor: colour +
-Tint the transparent background pixmap with the given colour; option --tint. +

Tint the transparent background pixmap with the given colour; option +-tint.

-

-
shading: number
-
+ +
shading: number +
-Darken (0 .. 100) or lighten (-1 .. -100) the transparent background -image in addition to tinting it. +

Darken (0 .. 100) or lighten (-1 .. -100) the transparent background +image in addition to tinting it.

-

-
scrollColor: colour
-
+ +
scrollColor: colour +
-Use the specified colour for the scrollbar [default #B2B2B2]. +

Use the specified colour for the scrollbar [default #B2B2B2].

-

-
troughColor: colour
-
+ +
troughColor: colour +
-Use the specified colour for the scrollbar's trough area [default -#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. +

Use the specified colour for the scrollbar's trough area [default +#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.

-

-
borderColor: colour
-
+ +
borderColor: colour +
-The colour of the border around the text area and between the scrollbar -and the text. +

The colour of the border around the text area and between the scrollbar +and the text.

-

-
backgroundPixmap: file[;geom]
-
+ +
backgroundPixmap: file[;geom] +
-Use the specified XPM file (note the `.xpm' extension is optional) for +

Use the specified XPM file (note the `.xpm' extension is optional) for the background and also optionally specify its scaling with a geometry string WxH+X+Y, in which ``W'' / ``H'' specify the horizontal/vertical scale (percent) and ``X'' / ``Y'' locate the image @@ -878,23 +881,23 @@ centre (percent). A scale of 0 displays the image with tiling. A scale of 1 displays the image without any scaling. A scale of 2 to 9 specifies an integer number of images in that direction. No image will be magnified beyond 10 times its original size. The maximum permitted -scale is 1000. [default 0x0+50+50] +scale is 1000. [default 0x0+50+50]

-

-
path: path
-
+ +
path: path +
-Specify the colon-delimited search path for finding XPM files. +

Specify the colon-delimited search path for finding XPM files.

-

-
font: fontlist
-
+ +
font: fontlist +
-Select the fonts to be used. This is a comma separated list of font names +

Select the fonts to be used. This is a comma separated list of font names that are checked in order when trying to find glyphs for characters. The first font defines the cell size for characters; other fonts might be smaller, but not (in general) larger. A (hopefully) reasonable default -font list is always appended to it; option -fn. +font list is always appended to it; option -fn.

Each font can either be a standard X11 core font (XLFD) name, with @@ -938,16 +941,16 @@ contains other characters, but we are not interested in them.

The last font is a useful catch-all font that supplies most of the remaining unicode characters.

-

-
boldFont: fontlist
-
-
italicFont: fontlist
-
-
boldItalicFont: fontlist
-
+ +
boldFont: fontlist + +
italicFont: fontlist + +
boldItalicFont: fontlist +
-The font list to use for displaying bold, italic or bold -italic > characters, respectively. +

The font list to use for displaying bold, italic or bold +italic > characters, respectively.

If specified and non-empty, then the syntax is the same as for the @@ -964,84 +967,84 @@ not possible, replacement fonts of the desired shape will be tried.

If set, but empty, then this specific style is disabled and the normal text font will being used for the given style.

-

-
intensityStyles: boolean
-
+ +
intensityStyles: boolean +
-When font styles are not enabled, or this option is enabled (True, +

When font styles are not enabled, or this option is enabled (True, option -is, the default), bold and italic font styles imply high intensity foreground/backround colours. Disabling this option (False, option +is) disables this behaviour, the high intensity colours are not -reachable. +reachable.

-

-
selectstyle: mode
-
+ +
selectstyle: mode +
-Set mouse selection style to old which is 2.20, oldword which is +

Set mouse selection style to old which is 2.20, oldword which is xterm style with 2.20 old word selection, or anything else which gives -xterm style selection. +xterm style selection.

-

-
scrollstyle: mode
-
+ +
scrollstyle: mode +
-Set scrollbar style to rxvt, plain, next or xterm. plain is -the author's favourite. +

Set scrollbar style to rxvt, plain, next or xterm. plain is +the author's favourite.

-

-
title: string
-
+ +
title: string +
-Set window title string, the default title is the command-line +

Set window title string, the default title is the command-line specified after the -e option, if any, otherwise the application -name; option -title. +name; option -title.

-

-
iconName: string
-
+ +
iconName: string +
-Set the name used to label the window's icon or displayed in an icon +

Set the name used to label the window's icon or displayed in an icon manager window, it also sets the window's title unless it is explicitly -set; option -n. +set; option -n.

-

-
mapAlert: boolean
-
+ +
mapAlert: boolean +
-True: de-iconify (map) on receipt of a bell character. False: no -de-iconify (map) on receipt of a bell character [default]. +

True: de-iconify (map) on receipt of a bell character. False: no +de-iconify (map) on receipt of a bell character [default].

-

-
visualBell: boolean
-
+ +
visualBell: boolean +
-True: use visual bell on receipt of a bell character; option -vb. -False: no visual bell [default]; option +vb. +

True: use visual bell on receipt of a bell character; option -vb. +False: no visual bell [default]; option +vb.

-

-
loginShell: boolean
-
+ +
loginShell: boolean +
-True: start as a login shell by prepending a `-' to argv[0] of +

True: start as a login shell by prepending a `-' to argv[0] of the shell; option -ls. False: start as a normal sub-shell -[default]; option +ls. +[default]; option +ls.

-

-
utmpInhibit: boolean
-
+ +
utmpInhibit: boolean +
-True: inhibit writing record into the system log file utmp; +

True: inhibit writing record into the system log file utmp; option -ut. False: write record into the system log file utmp -[default]; option +ut. +[default]; option +ut.

-

-
print-pipe: string
-
+ +
print-pipe: string +
-Specify a command pipe for vt100 printer [default lpr(1)]. Use +

Specify a command pipe for vt100 printer [default lpr(1)]. Use Print to initiate a screen dump to the printer and Ctrl-Print or -Shift-Print to include the scrollback as well. +Shift-Print to include the scrollback as well.

The string will be interpreted as if typed into the shell as-is.

@@ -1057,188 +1060,188 @@ Specify a command pipe for vt100 printer [default lpr(1)]. Use

This creates a new file in your home directory with the screen contents everytime you hit Print.

-

-
scrollBar: boolean
-
+ +
scrollBar: boolean +
-True: enable the scrollbar [default]; option -sb. False: -disable the scrollbar; option +sb. +

True: enable the scrollbar [default]; option -sb. False: +disable the scrollbar; option +sb.

-

-
scrollBar_right: boolean
-
+ +
scrollBar_right: boolean +
-True: place the scrollbar on the right of the window; option -sr. -False: place the scrollbar on the left of the window; option +sr. +

True: place the scrollbar on the right of the window; option -sr. +False: place the scrollbar on the left of the window; option +sr.

-

-
scrollBar_floating: boolean
-
+ +
scrollBar_floating: boolean +
-True: display an rxvt scrollbar without a trough; option -st. -False: display an rxvt scrollbar with a trough; option +st. +

True: display an rxvt scrollbar without a trough; option -st. +False: display an rxvt scrollbar with a trough; option +st.

-

-
scrollBar_align: mode
-
+ +
scrollBar_align: mode +
-Align the top, bottom or centre [default] of the scrollbar -thumb with the pointer on middle button press/drag. +

Align the top, bottom or centre [default] of the scrollbar +thumb with the pointer on middle button press/drag.

-

-
scrollTtyOutput: boolean
-
+ +
scrollTtyOutput: boolean +
-True: scroll to bottom when tty receives output; option -si. +

True: scroll to bottom when tty receives output; option -si. False: do not scroll to bottom when tty receives output; option -+si. ++si.

-

-
scrollWithBuffer: boolean
-
+ +
scrollWithBuffer: boolean +
-True: scroll with scrollback buffer when tty receives new lines (and +

True: scroll with scrollback buffer when tty receives new lines (and scrollTtyOutput is False); option -sw. False: do not scroll -with scrollback buffer when tty recieves new lines; option +sw. +with scrollback buffer when tty recieves new lines; option +sw.

-

-
scrollTtyKeypress: boolean
-
+ +
scrollTtyKeypress: boolean +
-True: scroll to bottom when a non-special key is pressed. Special keys +

True: scroll to bottom when a non-special key is pressed. Special keys are those which are intercepted by rxvt-unicode for special handling and are not passed onto the shell; option -sk. False: do not scroll to -bottom when a non-special key is pressed; option +sk. +bottom when a non-special key is pressed; option +sk.

-

-
saveLines: number
-
+ +
saveLines: number +
-Save number lines in the scrollback buffer [default 64]. This -resource is limited on most machines to 65535; option -sl. +

Save number lines in the scrollback buffer [default 64]. This +resource is limited on most machines to 65535; option -sl.

-

-
internalBorder: number
-
+ +
internalBorder: number +
-Internal border of number pixels. This resource is limited to 100; -option -b. +

Internal border of number pixels. This resource is limited to 100; +option -b.

-

-
externalBorder: number
-
+ +
externalBorder: number +
-External border of number pixels. This resource is limited to 100; -option -w, -bw, -borderwidth. +

External border of number pixels. This resource is limited to 100; +option -w, -bw, -borderwidth.

-

-
borderLess: boolean
-
+ +
borderLess: boolean +
-Set MWM hints to request a borderless window, i.e. if honoured by the -WM, the rxvt-unicode window will not have window decorations; option -bl. +

Set MWM hints to request a borderless window, i.e. if honoured by the +WM, the rxvt-unicode window will not have window decorations; option -bl.

-

-
skipBuiltinGlyphs: boolean
-
+ +
skipBuiltinGlyphs: boolean +
-Compile frills: Disable the usage of the built-in block graphics/line +

Compile frills: Disable the usage of the built-in block graphics/line drawing characters and just rely on what the specified fonts provide. Use this if you have a good font and want to use its block graphic glyphs; -option -sbg. +option -sbg.

-

-
termName: termname
-
+ +
termName: termname +
-Specifies the terminal type name to be set in the TERM environment -variable; option -tn. +

Specifies the terminal type name to be set in the TERM environment +variable; option -tn.

-

-
linespace: number
-
+ +
linespace: number +
-Specifies number of lines (pixel height) to insert between each row of -the display [default 0]; option -lsp. +

Specifies number of lines (pixel height) to insert between each row of +the display [default 0]; option -lsp.

-

-
meta8: boolean
-
+ +
meta8: boolean +
-True: handle Meta (Alt) + keypress to set the 8th bit. False: -handle Meta (Alt) + keypress as an escape prefix [default]. +

True: handle Meta (Alt) + keypress to set the 8th bit. False: +handle Meta (Alt) + keypress as an escape prefix [default].

-

-
mouseWheelScrollPage: boolean
-
+ +
mouseWheelScrollPage: boolean +
-True: the mouse wheel scrolls a page full. False: the mouse wheel -scrolls five lines [default]. +

True: the mouse wheel scrolls a page full. False: the mouse wheel +scrolls five lines [default].

-

-
pastableTabs: boolean
-
+ +
pastableTabs: boolean +
-True: store tabs as wide characters. False: interpret tabs as cursor -movement only; option -ptab. +

True: store tabs as wide characters. False: interpret tabs as cursor +movement only; option -ptab.

-

-
cursorBlink: boolean
-
+ +
cursorBlink: boolean +
-True: blink the cursor. False: do not blink the cursor [default]; -option -bc. +

True: blink the cursor. False: do not blink the cursor [default]; +option -bc.

-

-
pointerBlank: boolean
-
+ +
pointerBlank: boolean +
-True: blank the pointer when a key is pressed or after a set number +

True: blank the pointer when a key is pressed or after a set number of seconds of inactivity. False: the pointer is always visible -[default]. +[default].

-

-
pointerColor: colour
-
+ +
pointerColor: colour +
-Mouse pointer foreground colour. +

Mouse pointer foreground colour.

-

-
pointerColor2: colour
-
+ +
pointerColor2: colour +
-Mouse pointer background colour. +

Mouse pointer background colour.

-

-
pointerBlankDelay: number
-
+ +
pointerBlankDelay: number +
-Specifies number of seconds before blanking the pointer [default 2]. Use a -large number (e.g. 987654321) to effectively disable the timeout. +

Specifies number of seconds before blanking the pointer [default 2]. Use a +large number (e.g. 987654321) to effectively disable the timeout.

-

-
backspacekey: string
-
+ +
backspacekey: string +
-The string to send when the backspace key is pressed. If set to DEC +

The string to send when the backspace key is pressed. If set to DEC or unset it will send Delete (code 127) or, if shifted, Backspace (code 8) - which can be reversed with the appropriate DEC private mode -escape sequence. +escape sequence.

-

-
deletekey: string
-
+ +
deletekey: string +
-The string to send when the delete key (not the keypad delete key) is +

The string to send when the delete key (not the keypad delete key) is pressed. If unset it will send the sequence traditionally associated -with the Execute key. +with the Execute key.

-

-
cutchars: string
-
+ +
cutchars: string +
-The characters used as delimiters for double-click word selection -(whitespace delimiting is added automatically if resource is given). +

The characters used as delimiters for double-click word selection +(whitespace delimiting is added automatically if resource is given).

When the selection extension is in use (the default if compiled in, see @@ -1253,109 +1256,109 @@ be used. If not specified, the built-in default is used:

BACKSLASH ```'&()*,;<=?@[]{|} >>

-

-
preeditType: style
-
+ +
preeditType: style +
-OverTheSpot, OffTheSpot, Root; option -pt. +

OverTheSpot, OffTheSpot, Root; option -pt.

-

-
inputMethod: name
-
+ +
inputMethod: name +
-name of inputMethod to use; option -im. +

name of inputMethod to use; option -im.

-

-
imLocale: name
-
+ +
imLocale: name +
-The locale to use for opening the IM. You can use an LC_CTYPE of e.g. +

The locale to use for opening the IM. You can use an LC_CTYPE of e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input extension to be able to input japanese characters while staying in -another locale; option -imlocale. +another locale; option -imlocale.

-

-
imFont: fontset
-
+ +
imFont: fontset +
-Specify the font-set used for XIM styles OverTheSpot or +

Specify the font-set used for XIM styles OverTheSpot or OffTheSpot. It must be a standard X font set (XLFD patterns separated by commas), i.e. it's not in the same format as the other font lists used in rxvt. The default will be set-up to chose *any* suitable found found, preferably one or two pixels differing in size to the base font. -option -imfont. +option -imfont.

-

-
tripleclickwords: boolean
-
+ +
tripleclickwords: boolean +
-Change the meaning of triple-click selection with the left mouse +

Change the meaning of triple-click selection with the left mouse button. Instead of selecting a full line it will extend the selection to -the end of the logical line only; option -tcw. +the end of the logical line only; option -tcw.

-

-
insecure: boolean
-
+ +
insecure: boolean +
-Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that +

Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that echo arbitrary strings like the icon name or the locale. This could be abused if somebody gets 8-bit-clean access to your display, whether through a mail client displaying mail bodies unfiltered or through write(1) or any other means. Therefore, these sequences are disabled by default. (Note that many other terminals, including xterm, have these -sequences enabled by default, which doesn't make it safer, though). +sequences enabled by default, which doesn't make it safer, though).

You can enable them by setting this boolean resource or specifying -insecure as an option. At the moment, this enables display-answer, locale, findfont, icon label and window title requests.

-

-
modifier: modifier
-
+ +
modifier: modifier +
-Set the key to be interpreted as the Meta key to: alt, meta, +

Set the key to be interpreted as the Meta key to: alt, meta, hyper, super, mod1, mod2, mod3, mod4, mod5; option --mod. +-mod.

-

-
answerbackString: string
-
+ +
answerbackString: string +
-Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) +

Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) character is passed through. It may contain escape values as described -in the entry on keysym following. +in the entry on keysym following.

-

-
secondaryScreen: boolean
-
+ +
secondaryScreen: boolean +
-Turn on/off secondary screen (default enabled). +

Turn on/off secondary screen (default enabled).

-

-
secondaryScroll: boolean
-
+ +
secondaryScroll: boolean +
-Turn on/off secondary screen scroll (default enabled). If the this +

Turn on/off secondary screen scroll (default enabled). If the this option is enabled, scrolls on the secondary screen will change the scrollback buffer and switching to/from the secondary screen will -instead scroll the screen up. +instead scroll the screen up.

-

-
hold: boolean
-
+ +
hold: boolean +
-Turn on/off hold window after exit support. If enabled, rxvt +

Turn on/off hold window after exit support. If enabled, rxvt will not immediately destroy its window when the program executed within it exits. Instead, it will wait till it is being killed or closed by the -user. +user.

-

-
keysym.sym: string
-
+ +
keysym.sym: string +
-Compile frills: Associate string with keysym sym. The -intervening resource name keysym. cannot be omitted. +

Compile frills: Associate string with keysym sym. The +intervening resource name keysym. cannot be omitted.

The format of sym is ``(modifiers-)key'', where modifiers can be @@ -1474,14 +1477,14 @@ info):

URxvt.keysym.M-C-3: command:\033[8;25;80t URxvt.keysym.M-C-4: command:\033[8;48;110t
-

-
perl-ext-common: string
-
-
perl-ext: string
-
+ +
perl-ext-common: string + +
perl-ext: string +
-Comma-separated list(s) of perl extension scripts (default: default) to -use in this terminal instance; option -pe. +

Comma-separated list(s) of perl extension scripts (default: default) to +use in this terminal instance; option -pe.

Extension names can be prefixed with a - sign to prohibit using @@ -1507,69 +1510,70 @@ interpreter will not be initialized. The idea behind two options is that perl-ext-common will be used for extensions that should be available to all instances, while perl-ext is used for specific instances.

-

-
perl-eval: string
-
+ +
perl-eval: string +
-Perl code to be evaluated when all extensions have been registered. See +

Perl code to be evaluated when all extensions have been registered. See the rxvtperl(3) manpage. Due to security reasons, this resource -will be ignored when running setuid/setgid. +will be ignored when running setuid/setgid.

-

-
perl-lib: path
-
+ +
perl-lib: path +
-Colon-separated list of additional directories that hold extension +

Colon-separated list of additional directories that hold extension scripts. When looking for extensions specified by the perl resource, rxvt will first look in these directories and then in /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource -will be ignored when running setuid/setgid. +will be ignored when running setuid/setgid.

See the rxvtperl(3) manpage.

-

-
selection.pattern-idx >: perl-regex
-
+ +
selection.pattern-idx >: perl-regex +
-Additional selection patterns, see the rxvtperl(3) manpage for -details. +

Additional selection patterns, see the rxvtperl(3) manpage for +details.

-

-
selection-autotransform.idx >: perl-transform
-
+ +
selection-autotransform.idx >: perl-transform +
-Selection auto-transform patterns, see the rxvtperl(3) manpage -for details. +

Selection auto-transform patterns, see the rxvtperl(3) manpage +for details.

-

-
searchable-scrollback: keysym
-
+ +
searchable-scrollback: keysym +
-Sets the hotkey that starts the incremental scrollback buffer search -(default: M-s). +

Sets the hotkey that starts the incremental scrollback buffer search +(default: M-s).

-

-
urlLauncher: string
-
+ +
urlLauncher: string +
-Specifies the program to be started with a URL argument. Used by the -selection-popup and mark-urls perl extensions. +

Specifies the program to be started with a URL argument. Used by the +selection-popup and mark-urls perl extensions.

-

-
transient-for: windowid
-
+ +
transient-for: windowid +
-Compile frills: Sets the WM_TRANSIENT_FOR property to the given window id. +

Compile frills: Sets the WM_TRANSIENT_FOR property to the given window id.

-

-
override-redirect: boolean
-
+ +
override-redirect: boolean +
-Compile frills: Sets override-redirect for the terminal window, making -it almost invisible to window managers; option -override-redirect. +

Compile frills: Sets override-redirect for the terminal window, making +it almost invisible to window managers; option -override-redirect.

-

+ +

@@ -1602,14 +1606,14 @@ respectively.

The behaviour of text selection and insertion mechanism is similar to xterm(1).

-
Selection:
-
+
Selection: +
-Left click at the beginning of the region, drag to the end of the region +

Left click at the beginning of the region, drag to the end of the region and release; Right click to extend the marked region; Left double-click to select a word; Left triple-click to select the entire logical line (which can span multiple screen lines), unless modified by resource -tripleclickwords. +tripleclickwords.

Starting a selection while pressing the Meta key (or Meta+Ctrl keys) @@ -1618,19 +1622,20 @@ normal one. In this mode, every selected row becomes its own line in the selection, and trailing whitespace is visually underlined and removed from the selection.

-

-
Insertion:
-
+ +
Insertion: +
-Pressing and releasing the Middle mouse button in an rxvt +

Pressing and releasing the Middle mouse button in an rxvt window causes the value of the PRIMARY selection (or CLIPBOARD with the -Meta modifier) to be inserted as if it had been typed on the keyboard. +Meta modifier) to be inserted as if it had been typed on the keyboard.

Pressing Shift-Insert causes the value of the PRIMARY selection to be inserted too.

-

+ +

@@ -1655,9 +1660,9 @@ first part is available rxvt-unicode has been compiled with --enable-frills, the rest is available when rxvt-unicode was compiled with --enable-iso14755.

    -
  • 5.1: Basic method
    -
    • -This allows you to enter unicode characters using their hexcode. +
  • 5.1: Basic method + +

    This allows you to enter unicode characters using their hexcode.

    Start by pressing and holding both Control and Shift, then enter hex-digits (between one and six). Releasing Control and Shift will commit the character as if it were typed directly. While holding down @@ -1669,11 +1674,11 @@ address, which you cannot type. Fortunately, the card has the e-mail address printed as hexcodes, e.g. 671d 65e5. You can enter this easily by pressing Control and Shift, followed by 6-7-1-D-SPACE-6-5-E-5, followed by releasing the modifier keys.

    -

    -
  • 5.2: Keyboard symbols entry method
    • -This mode lets you input characters representing the keycap symbols of -your keyboard, if representable in the current locale encoding. +
  • 5.2: Keyboard symbols entry method + +

    This mode lets you input characters representing the keycap symbols of +your keyboard, if representable in the current locale encoding.

    Start by pressing Control and Shift together, then releasing them. The next special key (cursor keys, home etc.) you enter will not invoke it's usual function but instead will insert the corresponding @@ -1681,16 +1686,16 @@ keycap symbol. The symbol will only be entered when the key has been released, otherwise pressing e.g. Shift would enter the symbol for ISO Level 2 Switch, although your intention might have been to enter a reverse tab (Shift-Tab).

    -

    -
  • 5.3: Screen-selection entry method
    • -While this is implemented already (it's basically the selection -mechanism), it could be extended by displaying a unicode character map. -

    -
  • 5.4: Feedback method for identifying displayed characters for later input
    +
  • 5.3: Screen-selection entry method + +

    While this is implemented already (it's basically the selection +mechanism), it could be extended by displaying a unicode character map.

    • -This method lets you display the unicode character code associated with -characters already displayed. +
  • 5.4: Feedback method for identifying displayed characters for later input + +

    This method lets you display the unicode character code associated with +characters already displayed.

    You enter this mode by holding down Control and Shift together, then pressing and holding the left mouse button and moving around. The unicode hex code(s) (it might be a combining character) of the character under the @@ -1699,7 +1704,8 @@ pointer is displayed until you release Control and Shift -

+ +

With respect to conformance, rxvt-unicode is supposed to be compliant to both scenario A and B of ISO 14755, including part 5.2.

@@ -1753,13 +1759,14 @@ always swapping the foreground/background colours. This is in contrast to xterm(1) where the colours are only swapped if they have not otherwise been specified. For example,

-
rxvt -fg Black -bg White -rv
-
+
rxvt -fg Black -bg White -rv +
-would yield White on Black, while on xterm(1) it would yield Black -on White. +

would yield White on Black, while on xterm(1) it would yield Black +on White.

-

+ +

ALPHA CHANNEL SUPPORT

@@ -1785,103 +1792,105 @@ the author. Don't bug him with installation questions!

ENVIRONMENT

rxvt sets and/or uses the following environment variables:

-
TERM
-
+
TERM +
-Normally set to rxvt-unicode, unless overwritten at configure time, via -resources or on the commandline. +

Normally set to rxvt-unicode, unless overwritten at configure time, via +resources or on the commandline.

-

-
COLORTERM
-
+ +
COLORTERM +
-Either rxvt, rxvt-xpm, depending on wether rxvt was +

Either rxvt, rxvt-xpm, depending on wether rxvt was compiled with XPM support, and optionally with the added extension --mono to indicate that rxvt-unicode runs on a monochrome screen. +-mono to indicate that rxvt-unicode runs on a monochrome screen.

-

-
COLORFGBG
-
+ +
COLORFGBG +
-Set to a string of the form fg;bg or fg;xpm;bg, where fg is +

Set to a string of the form fg;bg or fg;xpm;bg, where fg is the colour code used as default foreground/text colour (or the string default to indicate that the default-colour escape sequence is to be used), bg is the colour code used as default background colour (or the string default), and xpm is the string default if rxvt was compiled with XPM support. Libraries like ncurses and slang can -(and do) use this information to optimize screen output. +(and do) use this information to optimize screen output.

-

-
WINDOWID
-
+ +
WINDOWID +
-Set to the (decimal) X Window ID of the rxvt window (the toplevel +

Set to the (decimal) X Window ID of the rxvt window (the toplevel window, which usually has subwindows for the scrollbar, the terminal -window and so on). +window and so on).

-

-
TERMINFO
-
+ +
TERMINFO +
-Set to the terminfo directory iff rxvt was configured with ---with-terminfo=PATH. +

Set to the terminfo directory iff rxvt was configured with +--with-terminfo=PATH.

-

-
DISPLAY
-
+ +
DISPLAY +
-Used by rxvt to connect to the display and set to the correct -display in it's child processes. +

Used by rxvt to connect to the display and set to the correct +display in it's child processes.

-

-
SHELL
-
+ +
SHELL +
-The shell to be used for command execution, defaults to /bin/sh. +

The shell to be used for command execution, defaults to /bin/sh.

-

-
RXVT_SOCKET
-
+ +
RXVT_SOCKET +
-The unix domain socket path used by rxvtc(1) and -rxvtd(1). +

The unix domain socket path used by rxvtc(1) and +rxvtd(1).

Default $HOME/.rxvt-unicode-<nodename >>>.

-

-
HOME
-
+ +
HOME +
-Used to locate the default directory for the unix domain socket for +

Used to locate the default directory for the unix domain socket for daemon communications and to locate various resource files (such as -.Xdefaults) +.Xdefaults)

-

-
XAPPLRESDIR
-
+ +
XAPPLRESDIR +
-Directory where various X resource files are being located. +

Directory where various X resource files are being located.

-

-
XENVIRONMENT
-
+ +
XENVIRONMENT +
-If set and accessible, gives the name of a X resource file to be loaded by -rxvt. +

If set and accessible, gives the name of a X resource file to be loaded by +rxvt.

-

+ +

FILES

-
/usr/lib/X11/rgb.txt
-
+
/usr/lib/X11/rgb.txt +
-Color names. +

Color names.

-

+ +

@@ -1892,81 +1901,83 @@ Color names.

CURRENT PROJECT COORDINATOR

-
Project Coordinator
-
+
Project Coordinator +
-Marc A. Lehmann > +

Marc A. Lehmann >

-

http://software.schmorp.de/#rxvt-unicode

+

http://software.schmorp.de/pkg/rxvt-unicode.html

-

+ +

AUTHORS

-
John Bovey
-
+
John Bovey +
-University of Kent, 1992, wrote the original Xvt. +

University of Kent, 1992, wrote the original Xvt.

-

-
Rob Nation >
-
+ +
Rob Nation > +
-very heavily modified Xvt and came up with Rxvt +

very heavily modified Xvt and came up with Rxvt

-

-
Angelo Haritsis >
-
+ +
Angelo Haritsis > +
-wrote the Greek Keyboard Input (no longer in code) +

wrote the Greek Keyboard Input (no longer in code)

-

-
mj olesen >
-
+ +
mj olesen > +
-Wrote the menu system. +

Wrote the menu system.

Project Coordinator (changes.txt 2.11 to 2.21)

-

-
Oezguer Kesim >
-
+ +
Oezguer Kesim > +
-Project Coordinator (changes.txt 2.21a to 2.4.5) +

Project Coordinator (changes.txt 2.21a to 2.4.5)

-

-
Geoff Wing >
-
-
-Rewrote screen display and text selection routines. + +
Geoff Wing > +
+

Rewrote screen display and text selection routines. +

 
 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
-

-
Marc Alexander Lehmann >
-
+ +
Marc Alexander Lehmann > +
-Forked rxvt-unicode, unicode support, rewrote almost all the code, perl -extension, random hacks, numerous bugfixes and extensions. +

Forked rxvt-unicode, unicode support, rewrote almost all the code, perl +extension, random hacks, numerous bugfixes and extensions.

Project Coordinator (Changes 1.0 -)

-

-
Emanuele Giaquinta >
-
+ +
Emanuele Giaquinta > +
-Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. +

Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.

-

+ + diff --git a/doc/rxvt.1.man.in b/doc/rxvt.1.man.in index 23bb0c63..24494db5 100644 --- a/doc/rxvt.1.man.in +++ b/doc/rxvt.1.man.in @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" Automatically generated by Pod::Man 2.09 (Pod::Simple 3.04) .\" .\" Standard preamble: .\" ======================================================================== @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "rxvt 1" -.TH rxvt 1 "2006-02-21" "7.6" "RXVT-UNICODE" +.TH rxvt 1 "2006-07-06" "7.7" "RXVT-UNICODE" .SH "NAME" rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) .SH "SYNOPSIS" @@ -254,7 +254,7 @@ used to brighten or darken the image in addition to tinting it; resource \&\fItintColor\fR. Example: .Sp .Vb 1 -\& @@RXVT_NAME@@ -tr -tint blue -sh 40 +\& @@RXVT_NAME@@ \-tr \-tint blue \-sh 40 .Ve .IP "\fB\-sh\fR" 4 .IX Item "-sh" @@ -299,8 +299,8 @@ with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \ e.g.: .Sp .Vb 2 -\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" -\& @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" +\& @@RXVT_NAME@@ \-fn "xft:Bitstream Vera Sans Mono:pixelsize=15" +\& @@RXVT_NAME@@ \-fn "9x15bold,xft:Bitstream Vera Sans Mono" .Ve .Sp See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 @@ -429,7 +429,7 @@ Please note that you must specify a program with arguments. If you want to run shell commands, you have to specify the shell, like this: .Sp .Vb 1 -\& @@RXVT_NAME@@ -e sh -c "shell commands" +\& @@RXVT_NAME@@ \-e sh \-c "shell commands" .Ve .IP "\fB\-title\fR \fItext\fR" 4 .IX Item "-title text" @@ -516,9 +516,9 @@ used (a longer example is in \fIdoc/embed\fR): .Sp .Vb 5 \& my $rxvt = new Gtk2::Socket; -\& $rxvt->signal_connect_after (realize => sub { -\& my $xid = $_[0]->window->get_xid; -\& system "@@RXVT_NAME@@ -embed $xid &"; +\& $rxvt\->signal_connect_after (realize => sub { +\& my $xid = $_[0]\->window\->get_xid; +\& system "@@RXVT_NAME@@ \-embed $xid &"; \& }); .Ve .IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4 @@ -541,18 +541,14 @@ longer example is in \fIdoc/pty\-fd\fR): .Vb 2 \& use IO::Pty; \& use Fcntl; -.Ve -.Sp -.Vb 4 +\& \& my $pty = new IO::Pty; -\& fcntl $pty, F_SETFD, 0; # clear close-on-exec -\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; +\& fcntl $pty, F_SETFD, 0; # clear close\-on\-exec +\& system "@@RXVT_NAME@@ \-pty\-fd " . (fileno $pty) . "&"; \& close $pty; -.Ve -.Sp -.Vb 3 +\& \& # now communicate with rxvt -\& my $slave = $pty->slave; +\& my $slave = $pty\->slave; \& while (<$slave>) { print $slave "got <$_>\en" } .Ve .IP "\fB\-pe\fR \fIstring\fR" 4 @@ -570,11 +566,11 @@ starts. @@RXVT_NAME@@ will consult the following files/resources in order, with later settings overwriting earlier ones: .PP .Vb 5 -\& 1. system-wide app-defaults file, either locale-dependent OR global -\& 2. app-defaults file in $XAPPLRESDIR -\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults +\& 1. system\-wide app\-defaults file, either locale\-dependent OR global +\& 2. app\-defaults file in $XAPPLRESDIR +\& 3. RESOURCE_MANAGER property on root\-window OR $HOME/.Xdefaults \& 4. SCREEN_RESOURCES for the current screen -\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults- +\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults\- .Ve .PP Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class @@ -725,8 +721,8 @@ For example, this font resource .Sp .Vb 5 \& URxvt.font: 9x15bold,\e -\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e -\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e +\& \-misc\-fixed\-bold\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1,\e +\& \-misc\-fixed\-medium\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1, \e \& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e \& xft:Code2000:antialias=false .Ve @@ -824,7 +820,7 @@ The string will be interpreted as if typed into the shell as\-is. Example: .Sp .Vb 1 -\& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) +\& URxvt.print\-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) .Ve .Sp This creates a new file in your home directory with the screen contents @@ -1050,15 +1046,15 @@ should be a character not used by the strings. Its usage can be demonstrated by an example: .Sp .Vb 1 -\& URxvt.keysym.M-C-0x61: list|\e033 +\& URxvt.keysym.M\-C\-0x61: list|\e033 .Ve .Sp The above line is equivalent to the following three lines: .Sp .Vb 3 -\& URxvt.keysym.Meta-Control-0x61: \e033 -\& URxvt.keysym.Meta-Control-0x62: \e033 -\& URxvt.keysym.Meta-Control-0x63: \e033 +\& URxvt.keysym.Meta\-Control\-0x61: \e033 +\& URxvt.keysym.Meta\-Control\-0x62: \e033 +\& URxvt.keysym.Meta\-Control\-0x63: \e033 .Ve .Sp If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR @@ -1067,7 +1063,7 @@ example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*( when Control-Meta-c is being pressed": .Sp .Vb 1 -\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 +\& URxvt.keysym.M\-C\-c: command:\e033]701;zh_CN.GBK\e007 .Ve .Sp If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR @@ -1076,7 +1072,7 @@ manpage. For example, the \fIselection\fR extension (activated via \&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events: .Sp .Vb 1 -\& URxvt.keysym.M-C-c: perl:selection:rot13 +\& URxvt.keysym.M\-C\-c: perl:selection:rot13 .Ve .Sp Due the the large number of modifier combinations, a defined key mapping @@ -1093,7 +1089,7 @@ user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement: .Sp .Vb 2 \& URxvt.keysym.Insert: -\& URxvt.keysym.S-Insert: builtin: +\& URxvt.keysym.S\-Insert: builtin: .Ve .Sp The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination @@ -1105,16 +1101,16 @@ the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can font-switching at runtime: .Sp .Vb 2 -\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007 -\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007 +\& URxvt.keysym.M\-C\-1: command:\e033]50;suxuseuro\e007 +\& URxvt.keysym.M\-C\-2: command:\e033]50;9x15bold\e007 .Ve .Sp Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more info): .Sp .Vb 2 -\& URxvt.keysym.M-C-3: command:\e033[8;25;80t -\& URxvt.keysym.M-C-4: command:\e033[8;48;110t +\& URxvt.keysym.M\-C\-3: command:\e033[8;25;80t +\& URxvt.keysym.M\-C\-4: command:\e033[8;48;110t .Ve .IP "\fBperl-ext-common\fR: \fIstring\fR" 4 .IX Item "perl-ext-common: string" @@ -1243,8 +1239,8 @@ You can, however, switch fonts at runtime using escape sequences, e.g.: You can use keyboard shortcuts, too: .PP .Vb 2 -\& URxvt.keysym.M-C-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007 -\& URxvt.keysym.M-C-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007 +\& URxvt.keysym.M\-C\-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007 +\& URxvt.keysym.M\-C\-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007 .Ve .PP rxvt-unicode will automatically re-apply these fonts to the output so far. @@ -1255,8 +1251,9 @@ and character codes using the keyboard. It consists of 4 parts. The first part is available rxvt-unicode has been compiled with \&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. -.IP "* 5.1: Basic method" 4 -.IX Item "5.1: Basic method" +.IP "\(bu" 4 +5.1: Basic method +.Sp This allows you to enter unicode characters using their hexcode. .Sp Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter @@ -1271,8 +1268,9 @@ address, which you cannot type. Fortunately, the card has the e\-mail address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR, followed by releasing the modifier keys. -.IP "* 5.2: Keyboard symbols entry method" 4 -.IX Item "5.2: Keyboard symbols entry method" +.IP "\(bu" 4 +5.2: Keyboard symbols entry method +.Sp This mode lets you input characters representing the keycap symbols of your keyboard, if representable in the current locale encoding. .Sp @@ -1283,12 +1281,14 @@ keycap symbol. The symbol will only be entered when the key has been released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for \&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a reverse tab (Shift\-Tab). -.IP "* 5.3: Screen-selection entry method" 4 -.IX Item "5.3: Screen-selection entry method" +.IP "\(bu" 4 +5.3: Screen-selection entry method +.Sp While this is implemented already (it's basically the selection mechanism), it could be extended by displaying a unicode character map. -.IP "* 5.4: Feedback method for identifying displayed characters for later input" 4 -.IX Item "5.4: Feedback method for identifying displayed characters for later input" +.IP "\(bu" 4 +5.4: Feedback method for identifying displayed characters for later input +.Sp This method lets you display the unicode character code associated with characters already displayed. .Sp @@ -1337,7 +1337,6 @@ color15 (bright white) = White foreground = Black background = White .TE - .PP It is also possible to specify the colour values of \fBforeground\fR, \&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as @@ -1379,7 +1378,7 @@ For example, the following selects an almost completely transparent red background, and an almost opaque pink foreground: .PP .Vb 1 -\& @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" +\& @@RXVT_NAME@@ \-depth 32 \-bg rgba:0000/0000/0000/2222 \-fg "[e]pink" .Ve .PP \&\fIPlease note that transparency of any kind if completely unsupported by @@ -1426,7 +1425,7 @@ The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\f The unix domain socket path used by @@RXVT_NAME@@c(1) and @@RXVT_NAME@@d(1). .Sp -Default \fI$HOME/.rxvt\-unicode\-\fI .Sp - + .SH "AUTHORS" .IX Header "AUTHORS" .IP "John Bovey" 4 diff --git a/doc/rxvt.1.txt b/doc/rxvt.1.txt index caab6aea..02db9060 100644 --- a/doc/rxvt.1.txt +++ b/doc/rxvt.1.txt @@ -6,7 +6,7 @@ SYNOPSIS rxvt [options] [-e command [ args ]] DESCRIPTION - rxvt-unicode, version 7.6, is a colour vt102 terminal emulator intended + rxvt-unicode, version 7.7, is a colour vt102 terminal emulator intended as an *xterm*(1) replacement for users who do not require features such as Tektronix 4014 emulation and toolkit-style configurability. As a result, rxvt-unicode uses much less swap space -- a significant @@ -1090,7 +1090,8 @@ ISO 14755 SUPPORT the rest is available when rxvt-unicode was compiled with "--enable-iso14755". - * 5.1: Basic method + * 5.1: Basic method + This allows you to enter unicode characters using their hexcode. Start by pressing and holding both "Control" and "Shift", then enter @@ -1106,7 +1107,8 @@ ISO 14755 SUPPORT easily by pressing "Control" and "Shift", followed by "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. - * 5.2: Keyboard symbols entry method + * 5.2: Keyboard symbols entry method + This mode lets you input characters representing the keycap symbols of your keyboard, if representable in the current locale encoding. @@ -1118,13 +1120,15 @@ ISO 14755 SUPPORT enter the symbol for "ISO Level 2 Switch", although your intention might have been to enter a reverse tab (Shift-Tab). - * 5.3: Screen-selection entry method + * 5.3: Screen-selection entry method + While this is implemented already (it's basically the selection mechanism), it could be extended by displaying a unicode character map. - * 5.4: Feedback method for identifying displayed characters for later - input + * 5.4: Feedback method for identifying displayed characters for later + input + This method lets you display the unicode character code associated with characters already displayed. @@ -1153,25 +1157,24 @@ COLORS AND GRAPHICS display up to 16 colours (8 ANSI colours plus high-intensity bold/blink versions of the same). Here is a list of the colours with their names. - color0 (black) = Black - color1 (red) = Red3 - color2 (green) = Green3 - color3 (yellow) = Yellow3 - color4 (blue) = Blue3 - color5 (magenta) = Magenta3 - color6 (cyan) = Cyan3 - color7 (white) = AntiqueWhite - color8 (bright black) = Grey25 - color9 (bright red) = Red - color10 (bright green) = Green - color11 (bright yellow) = Yellow - color12 (bright blue) = Blue - color13 (bright magenta) = Magenta - color14 (bright cyan) = Cyan - color15 (bright white) = White - foreground = Black - background = White - + color0 (black) = Black + color1 (red) = Red3 + color2 (green) = Green3 + color3 (yellow) = Yellow3 + color4 (blue) = Blue3 + color5 (magenta) = Magenta3 + color6 (cyan) = Cyan3 + color7 (white) = AntiqueWhite + color8 (bright black) = Grey25 + color9 (bright red) = Red + color10 (bright green) = Green + color11 (bright yellow) = Yellow + color12 (bright blue) = Blue + color13 (bright magenta) = Magenta + color14 (bright cyan) = Cyan + color15 (bright white) = White + foreground = Black + background = White It is also possible to specify the colour values of foreground, background, cursorColor, cursorColor2, colorBD, colorUL as a number 0-15, as a convenient shorthand to reference the colour name of @@ -1283,7 +1286,7 @@ CURRENT PROJECT COORDINATOR Project Coordinator Marc A. Lehmann - + AUTHORS John Bovey diff --git a/doc/rxvt.7.html b/doc/rxvt.7.html index 07df00ff..c1b6c6c4 100644 --- a/doc/rxvt.7.html +++ b/doc/rxvt.7.html @@ -1,7 +1,9 @@ + REFERENCE - FAQ, command sequences and other background information + @@ -1073,34 +1075,34 @@ rxvt-unicode-locales.

Try a search engine, as this is slightly different for every input method server.

Here is a checklist:

-
- Make sure your locale and the imLocale are supported on your OS.
-
+
- Make sure your locale and the imLocale are supported on your OS. +
-Try locale -a or check the documentation for your OS. +

Try locale -a or check the documentation for your OS.

-

-
- Make sure your locale or imLocale matches a locale supported by your XIM.
-
+ +
- Make sure your locale or imLocale matches a locale supported by your XIM. +
-For example, kinput2 does not support UTF-8 locales, you should use -ja_JP.EUC-JP or equivalent. +

For example, kinput2 does not support UTF-8 locales, you should use +ja_JP.EUC-JP or equivalent.

-

-
- Make sure your XIM server is actually running.
-
-
- Make sure the XMODIFIERS environment variable is set correctly when starting rxvt-unicode.
-
+ +
- Make sure your XIM server is actually running. + +
- Make sure the XMODIFIERS environment variable is set correctly when starting rxvt-unicode. +
-When you want to use e.g. kinput2, it must be set to +

When you want to use e.g. kinput2, it must be set to @im=kinput2. For scim, use @im=SCIM. Youc an see what input -method servers are running with this command: +method servers are running with this command:

    xprop -root XIM_SERVERS
-

-
+ +

@@ -1238,240 +1240,242 @@ selectable at configure time.

Definitions

-
c >
-
+
c > +
-The literal character c. +

The literal character c.

-

-
C >
-
+ +
C > +
-A single (required) character. +

A single (required) character.

-

-
Ps >
-
+ +
Ps > +
-A single (usually optional) numeric parameter, composed of one or more -digits. +

A single (usually optional) numeric parameter, composed of one or more +digits.

-

-
Pm >
-
+ +
Pm > +
-A multiple numeric parameter composed of any number of single numeric -parameters, separated by ; character(s). +

A multiple numeric parameter composed of any number of single numeric +parameters, separated by ; character(s).

-

-
Pt >
-
+ +
Pt > +
-A text parameter composed of printable characters. +

A text parameter composed of printable characters.

-

+ +

Values

-
ENQ >
-
+
ENQ > +
-Enquiry (Ctrl-E) = Send Device Attributes (DA) -request attributes from terminal. See ESC [ Ps c >. +

Enquiry (Ctrl-E) = Send Device Attributes (DA) +request attributes from terminal. See ESC [ Ps c >.

-

-
BEL >
-
+ +
BEL > +
-Bell (Ctrl-G) +

Bell (Ctrl-G)

-

-
BS >
-
+ +
BS > +
-Backspace (Ctrl-H) +

Backspace (Ctrl-H)

-

-
TAB >
-
+ +
TAB > +
-Horizontal Tab (HT) (Ctrl-I) +

Horizontal Tab (HT) (Ctrl-I)

-

-
LF >
-
+ +
LF > +
-Line Feed or New Line (NL) (Ctrl-J) +

Line Feed or New Line (NL) (Ctrl-J)

-

-
VT >
-
+ +
VT > +
-Vertical Tab (Ctrl-K) same as LF > +

Vertical Tab (Ctrl-K) same as LF >

-

-
FF >
-
+ +
FF > +
-Form Feed or New Page (NP) (Ctrl-L) same as LF > +

Form Feed or New Page (NP) (Ctrl-L) same as LF >

-

-
CR >
-
+ +
CR > +
-Carriage Return (Ctrl-M) +

Carriage Return (Ctrl-M)

-

-
SO >
-
+ +
SO > +
-Shift Out (Ctrl-N), invokes the G1 character set. -Switch to Alternate Character Set +

Shift Out (Ctrl-N), invokes the G1 character set. +Switch to Alternate Character Set

-

-
SI >
-
+ +
SI > +
-Shift In (Ctrl-O), invokes the G0 character set (the default). -Switch to Standard Character Set +

Shift In (Ctrl-O), invokes the G0 character set (the default). +Switch to Standard Character Set

-

-
SPC >
-
+ +
SPC > +
-Space Character +

Space Character

-

+ +

Escape Sequences

-
ESC # 8 >
-
+
ESC # 8 > +
-DEC Screen Alignment Test (DECALN) +

DEC Screen Alignment Test (DECALN)

-

-
ESC 7 >
-
+ +
ESC 7 > +
-Save Cursor (SC) +

Save Cursor (SC)

-

-
ESC 8 >
-
+ +
ESC 8 > +
-Restore Cursor +

Restore Cursor

-

-
ESC = >
-
+ +
ESC = > +
-Application Keypad (SMKX). See also next sequence. +

Application Keypad (SMKX). See also next sequence.

-

-
ESC >>
-
+ +
ESC >> +
-Normal Keypad (RMKX) +

Normal Keypad (RMKX)

Note: If the numeric keypad is activated, eg, Num_Lock has been pressed, numbers or control functions are generated by the numeric keypad (see Key Codes).

-

-
ESC D >
-
+ +
ESC D > +
-Index (IND) +

Index (IND)

-

-
ESC E >
-
+ +
ESC E > +
-Next Line (NEL) +

Next Line (NEL)

-

-
ESC H >
-
+ +
ESC H > +
-Tab Set (HTS) +

Tab Set (HTS)

-

-
ESC M >
-
+ +
ESC M > +
-Reverse Index (RI) +

Reverse Index (RI)

-

-
ESC N >
-
+ +
ESC N > +
-Single Shift Select of G2 Character Set (SS2): affects next character -only unimplemented +

Single Shift Select of G2 Character Set (SS2): affects next character +only unimplemented

-

-
ESC O >
-
+ +
ESC O > +
-Single Shift Select of G3 Character Set (SS3): affects next character -only unimplemented +

Single Shift Select of G3 Character Set (SS3): affects next character +only unimplemented

-

-
ESC Z >
-
+ +
ESC Z > +
-Obsolete form of returns: ESC [ ? 1 ; 2 C > rxvt-unicode compile-time option +

Obsolete form of returns: ESC [ ? 1 ; 2 C > rxvt-unicode compile-time option

-

-
ESC c >
-
+ +
ESC c > +
-Full reset (RIS) +

Full reset (RIS)

-

-
ESC n >
-
+ +
ESC n > +
-Invoke the G2 Character Set (LS2) +

Invoke the G2 Character Set (LS2)

-

-
ESC o >
-
+ +
ESC o > +
-Invoke the G3 Character Set (LS3) +

Invoke the G3 Character Set (LS3)

-

-
ESC ( C >
-
+ +
ESC ( C > +
-Designate G0 Character Set (ISO 2022), see below for values of C. +

Designate G0 Character Set (ISO 2022), see below for values of C.

-

-
ESC ) C >
-
+ +
ESC ) C > +
-Designate G1 Character Set (ISO 2022), see below for values of C. +

Designate G1 Character Set (ISO 2022), see below for values of C.

-

-
ESC * C >
-
+ +
ESC * C > +
-Designate G2 Character Set (ISO 2022), see below for values of C. +

Designate G2 Character Set (ISO 2022), see below for values of C.

-

-
ESC + C >
-
+ +
ESC + C > +
-Designate G3 Character Set (ISO 2022), see below for values of C. +

Designate G3 Character Set (ISO 2022), see below for values of C.

-

-
ESC $ C >
-
+ +
ESC $ C > +
-Designate Kanji Character Set +

Designate Kanji Character Set

Where C > is one of:

@@ -1484,224 +1488,225 @@ Designate Kanji Character Set C = 5 Finnish character set unimplemented C = C Finnish character set unimplemented C = K German character set unimplemented -

+ +

CSI (Command Sequence Introducer) Sequences

-
ESC [ Ps @ >
-
+
ESC [ Ps @ > +
-Insert Ps > (Blank) Character(s) [default: 1] (ICH) +

Insert Ps > (Blank) Character(s) [default: 1] (ICH)

-

-
ESC [ Ps A >
-
+ +
ESC [ Ps A > +
-Cursor Up Ps > Times [default: 1] (CUU) +

Cursor Up Ps > Times [default: 1] (CUU)

-

-
ESC [ Ps B >
-
+ +
ESC [ Ps B > +
-Cursor Down Ps > Times [default: 1] (CUD) +

Cursor Down Ps > Times [default: 1] (CUD)

-

-
ESC [ Ps C >
-
+ +
ESC [ Ps C > +
-Cursor Forward Ps > Times [default: 1] (CUF) +

Cursor Forward Ps > Times [default: 1] (CUF)

-

-
ESC [ Ps D >
-
+ +
ESC [ Ps D > +
-Cursor Backward Ps > Times [default: 1] (CUB) +

Cursor Backward Ps > Times [default: 1] (CUB)

-

-
ESC [ Ps E >
-
+ +
ESC [ Ps E > +
-Cursor Down Ps > Times [default: 1] and to first column +

Cursor Down Ps > Times [default: 1] and to first column

-

-
ESC [ Ps F >
-
+ +
ESC [ Ps F > +
-Cursor Up Ps > Times [default: 1] and to first column +

Cursor Up Ps > Times [default: 1] and to first column

-

-
ESC [ Ps G >
-
+ +
ESC [ Ps G > +
-Cursor to Column Ps > (HPA) +

Cursor to Column Ps > (HPA)

-

-
ESC [ Ps;Ps H >
-
+ +
ESC [ Ps;Ps H > +
-Cursor Position [row;column] [default: 1;1] (CUP) +

Cursor Position [row;column] [default: 1;1] (CUP)

-

-
ESC [ Ps I >
-
+ +
ESC [ Ps I > +
-Move forward Ps > tab stops [default: 1] +

Move forward Ps > tab stops [default: 1]

-

-
ESC [ Ps J >
-
+ +
ESC [ Ps J > +
-Erase in Display (ED) +

Erase in Display (ED)

-
Ps = 0Clear Below (default)
Ps = 1Clear Above
Ps = 2Clear All

-
ESC [ Ps K >
-
+ +
ESC [ Ps K > +
-Erase in Line (EL) +

Erase in Line (EL)

-
Ps = 0Clear to Right (default)
Ps = 1Clear to Left
Ps = 2Clear All

-
ESC [ Ps L >
-
+ +
ESC [ Ps L > +
-Insert Ps > Line(s) [default: 1] (IL) +

Insert Ps > Line(s) [default: 1] (IL)

-

-
ESC [ Ps M >
-
+ +
ESC [ Ps M > +
-Delete Ps > Line(s) [default: 1] (DL) +

Delete Ps > Line(s) [default: 1] (DL)

-

-
ESC [ Ps P >
-
+ +
ESC [ Ps P > +
-Delete Ps > Character(s) [default: 1] (DCH) +

Delete Ps > Character(s) [default: 1] (DCH)

-

-
ESC [ Ps;Ps;Ps;Ps;Ps T >
-
+ +
ESC [ Ps;Ps;Ps;Ps;Ps T > +
-Initiate . unimplemented Parameters are -[func;startx;starty;firstrow;lastrow]. +

Initiate . unimplemented Parameters are +[func;startx;starty;firstrow;lastrow].

-

-
ESC [ Ps W >
-
+ +
ESC [ Ps W > +
-Tabulator functions +

Tabulator functions

-
Ps = 0Tab Set (HTS)
Ps = 2Tab Clear (TBC), Clear Current Column (default)
Ps = 5Tab Clear (TBC), Clear All

-
ESC [ Ps X >
-
+ +
ESC [ Ps X > +
-Erase Ps > Character(s) [default: 1] (ECH) +

Erase Ps > Character(s) [default: 1] (ECH)

-

-
ESC [ Ps Z >
-
+ +
ESC [ Ps Z > +
-Move backward Ps > [default: 1] tab stops +

Move backward Ps > [default: 1] tab stops

-

-
ESC [ Ps ' >
-
+ +
ESC [ Ps ' > +
-See ESC [ Ps G > +

See ESC [ Ps G >

-

-
ESC [ Ps a >
-
+ +
ESC [ Ps a > +
-See ESC [ Ps C > +

See ESC [ Ps C >

-

-
ESC [ Ps c >
-
+ +
ESC [ Ps c > +
-Send Device Attributes (DA) +

Send Device Attributes (DA) Ps = 0 > (or omitted): request attributes from terminal returns: ESC [ ? 1 ; 2 c > (``I am a VT100 with Advanced Video -Option'') +Option'')

-

-
ESC [ Ps d >
-
+ +
ESC [ Ps d > +
-Cursor to Line Ps > (VPA) +

Cursor to Line Ps > (VPA)

-

-
ESC [ Ps e >
-
+ +
ESC [ Ps e > +
-See ESC [ Ps A > +

See ESC [ Ps A >

-

-
ESC [ Ps;Ps f >
-
+ +
ESC [ Ps;Ps f > +
-Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] +

Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]

-

-
ESC [ Ps g >
-
+ +
ESC [ Ps g > +
-Tab Clear (TBC) +

Tab Clear (TBC)

-
Ps = 0Clear Current Column (default)
Ps = 3Clear All (TBC)

-
ESC [ Pm h >
-
+ +
ESC [ Pm h > +
-Set Mode (SM). See ESC [ Pm l > sequence for description of Pm. +

Set Mode (SM). See ESC [ Pm l > sequence for description of Pm.

-

-
ESC [ Ps i >
-
+ +
ESC [ Ps i > +
-Printing. See also the print-pipe resource. +

Printing. See also the print-pipe resource.

-
Ps = 0print screen (MC0)
Ps = 4disable transparent print mode (MC4)
Ps = 5enable transparent print mode (MC5)

-
ESC [ Pm l >
-
+ +
ESC [ Pm l > +
-Reset Mode (RM) +

Reset Mode (RM)

-
Ps = 4 >
-
+
Ps = 4 > + -
hInsert Mode (SMIR)
lReplace Mode (RMIR)
Ps = 20 > (partially implemented)
-
+
Ps = 20 > (partially implemented) +
hAutomatic Newline (LNM)
lNormal Linefeed (LNM)
-
ESC [ Pm m >
-
+
ESC [ Pm m > +
-Character Attributes (SGR) +

Character Attributes (SGR)

@@ -1731,35 +1736,35 @@ Character Attributes (SGR) -
Ps = 0Normal (default)
Ps = 96 / 106fg/bg Bright Cyan
Ps = 97 / 107fg/bg Bright White
Ps = 99 / 109fg/bg Bright Default

-
ESC [ Ps n >
-
+ +
ESC [ Ps n > +
-Device Status Report (DSR) +

Device Status Report (DSR)

-
Ps = 5Status Report ESC [ 0 n (``OK'')
Ps = 6Report Cursor Position (CPR) [row;column] as ESC [ r ; c R
Ps = 7Request Display Name
Ps = 8Request Version Number (place in window title)

-
ESC [ Ps;Ps r >
-
+ +
ESC [ Ps;Ps r > +
-Set Scrolling Region [top;bottom] -[default: full size of window] (CSR) +

Set Scrolling Region [top;bottom] +[default: full size of window] (CSR)

-

-
ESC [ s >
-
+ +
ESC [ s > +
-Save Cursor (SC) +

Save Cursor (SC)

-

-
ESC [ Ps;Pt t >
-
+ +
ESC [ Ps;Pt t > +
-Window Operations +

Window Operations

@@ -1778,190 +1783,191 @@ Window Operations -
Ps = 1Deiconify (map) window
Ps = 20Reports icon label (ESC ] L NAME \234)
Ps = 21Reports window title (ESC ] l NAME \234)
Ps = 24..Set window height to Ps rows

-
ESC [ u >
-
+ +
ESC [ u > +
-Restore Cursor +

Restore Cursor

-

-
ESC [ Ps x >
-
+ +
ESC [ Ps x > +
-Request Terminal Parameters (DECREQTPARM) +

Request Terminal Parameters (DECREQTPARM)

-

+ +

DEC Private Modes

-
ESC [ ? Pm h >
-
+
ESC [ ? Pm h > +
-DEC Private Mode Set (DECSET) +

DEC Private Mode Set (DECSET)

-

-
ESC [ ? Pm l >
-
+ +
ESC [ ? Pm l > +
-DEC Private Mode Reset (DECRST) +

DEC Private Mode Reset (DECRST)

-

-
ESC [ ? Pm r >
-
+ +
ESC [ ? Pm r > +
-Restore previously saved DEC Private Mode Values. +

Restore previously saved DEC Private Mode Values.

-

-
ESC [ ? Pm s >
-
+ +
ESC [ ? Pm s > +
-Save DEC Private Mode Values. +

Save DEC Private Mode Values.

-

-
ESC [ ? Pm t >
-
+ +
ESC [ ? Pm t > +
-Toggle DEC Private Mode Values (rxvt extension). where +

Toggle DEC Private Mode Values (rxvt extension). where

-
Ps = 1 > (DECCKM)
-
+
Pm = 1 > (DECCKM) + -
hApplication Cursor Keys
lNormal Cursor Keys
Ps = 2 > (ANSI/VT52 mode)
-
+
Pm = 2 > (ANSI/VT52 mode) + -
hEnter VT52 mode
lEnter VT52 mode
Ps = 3 >
-
+
Pm = 3 > + -
h132 Column Mode (DECCOLM)
l80 Column Mode (DECCOLM)
Ps = 4 >
-
+
Pm = 4 > + -
hSmooth (Slow) Scroll (DECSCLM)
lJump (Fast) Scroll (DECSCLM)
Ps = 5 >
-
+
Pm = 5 > + -
hReverse Video (DECSCNM)
lNormal Video (DECSCNM)
Ps = 6 >
-
+
Pm = 6 > + -
hOrigin Mode (DECOM)
lNormal Cursor Mode (DECOM)
Ps = 7 >
-
+
Pm = 7 > + -
hWraparound Mode (DECAWM)
lNo Wraparound Mode (DECAWM)
Ps = 8 > unimplemented
-
+
Pm = 8 > unimplemented + -
hAuto-repeat Keys (DECARM)
lNo Auto-repeat Keys (DECARM)
Ps = 9 > X10 XTerm
-
+
Pm = 9 > X10 XTerm + -
hSend Mouse X & Y on button press.
lNo mouse reporting.
Ps = 25 >
-
+
Pm = 25 > + -
hVisible cursor {cnorm/cvvis}
lInvisible cursor {civis}
Ps = 30 >
-
+
Pm = 30 > + -
hscrollBar visisble
lscrollBar invisisble
Ps = 35 > (rxvt)
-
+
Pm = 35 > (rxvt) + -
hAllow XTerm Shift+key sequences
lDisallow XTerm Shift+key sequences
Ps = 38 > unimplemented
-
+
Pm = 38 > unimplemented +
-Enter Tektronix Mode (DECTEK) +

Enter Tektronix Mode (DECTEK)

-

-
Ps = 40 >
-
+ +
Pm = 40 > + -
hAllow 80/132 Mode
lDisallow 80/132 Mode
Ps = 44 > unimplemented
-
+
Pm = 44 > unimplemented + -
hTurn On Margin Bell
lTurn Off Margin Bell
Ps = 45 > unimplemented
-
+
Pm = 45 > unimplemented + -
hReverse-wraparound Mode
lNo Reverse-wraparound Mode
Ps = 46 > unimplemented
-
-
Ps = 47 >
-
+
Pm = 46 > unimplemented + +
Pm = 47 > +
hUse Alternate Screen Buffer
lUse Normal Screen Buffer

-
Ps = 66 >
-
+
Pm = 66 > + -
hApplication Keypad (DECPAM) == ESC =
lNormal Keypad (DECPNM) == ESC >
Ps = 67 >
-
+
Pm = 67 > + -
hBackspace key sends BS (DECBKM)
lBackspace key sends DEL
Ps = 1000 > (X11 XTerm)
-
+
Pm = 1000 > (X11 XTerm) + -
hSend Mouse X & Y on button press and release.
lNo mouse reporting.
Ps = 1001 > (X11 XTerm) unimplemented
-
+
Pm = 1001 > (X11 XTerm) unimplemented + -
hUse Hilite Mouse Tracking.
lNo mouse reporting.
Ps = 1010 > (rxvt)
-
+
Pm = 1010 > (rxvt) + -
hDon't scroll to bottom on TTY output
lScroll to bottom on TTY output
Ps = 1011 > (rxvt)
-
+
Pm = 1011 > (rxvt) + -
hScroll to bottom when a key is pressed
lDon't scroll to bottom when a key is pressed
Ps = 1021 > (rxvt)
-
+
Pm = 1021 > (rxvt) + -
hBold/italic implies high intensity (see option -is)
lFont styles have no effect on intensity (Compile styles)
Ps = 1047 >
-
+
Pm = 1047 > + -
hUse Alternate Screen Buffer
lUse Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
Ps = 1048 >
-
+
Pm = 1048 > + -
hSave cursor position
lRestore cursor position
Ps = 1049 >
-
+
Pm = 1049 > + @@ -1972,12 +1978,12 @@ Enter Tektronix Mode (DECTEK)

XTerm Operating System Commands

-
ESC ] Ps;Pt ST >
-
+
ESC ] Ps;Pt ST > +
-Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b, +

Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b, 0x5c), backwards compatible terminator BEL (0x07) is also accepted. any -octet can be escaped by prefixing it with SYN (0x16, ^V). +octet can be escaped by prefixing it with SYN (0x16, ^V).

hUse Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
lUse Normal Screen Buffer
@@ -2011,7 +2017,8 @@ Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b, -
Ps = 0Change Icon Name and Window Title to Pt
Ps = 720Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
Ps = 721Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
Ps = 777Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).

+ +

@@ -2021,16 +2028,16 @@ of Pt > can be the name sequence of scaling/positioning commands separated by semi-colons. The scaling/positioning commands are as follows:

-
query scale/position
-
+
query scale/position +
-? +

?

-

-
change scale and position
-
+ +
change scale and position +
-WxH+X+Y +

WxH+X+Y

WxH+X (== WxH+X+X)

@@ -2047,70 +2054,73 @@ scaling/positioning commands are as follows:

W (same as WxW+50+50)

-

-
change position (absolute)
-
+ +
change position (absolute) +
-=+X+Y +

=+X+Y

=+X (same as =+X+Y)

-

-
change position (relative)
-
+ +
change position (relative) +
-+X+Y +

+X+Y

+X (same as +X+Y)

-

-
rescale (relative)
-
+ +
rescale (relative) +
-Wx0 -> W *= (W/100) +

Wx0 -> W *= (W/100)

0xH -> H *= (H/100)

-

+ +

For example:

-
\E]20;funky\a
-
+
\E]20;funky\a +
-load funky.xpm as a tiled image +

load funky.xpm as a tiled image

-

-
\E]20;mona;100\a
-
+ +
\E]20;mona;100\a +
-load mona.xpm with a scaling of 100% +

load mona.xpm with a scaling of 100%

-

-
\E]20;;200;?\a
-
+ +
\E]20;;200;?\a +
-rescale the current pixmap to 200% and display the image geometry in -the title +

rescale the current pixmap to 200% and display the image geometry in +the title

-

+ +

Mouse Reporting

-
ESC [ M <b> <x> <y> >
-
+
ESC [ M <b> <x> <y> > +
-report mouse position +

report mouse position

-

+ +

The lower 2 bits of <b> > indicate the button:

-
Button = (<b> - SPACE) & 3 >
-
+
Button = (<b> - SPACE) & 3 > + @@ -2120,8 +2130,8 @@ report mouse position

The upper bits of <b> > indicate the modifiers when the button was pressed and are added together (X11 mouse report only):

-
State = (<b> - SPACE) & 60 >
-
+
State = (<b> - SPACE) & 60 > +
0Button1 pressed
1Button2 pressed
@@ -2211,11 +2221,11 @@ always report when a combination doesn't work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.

All

-
--enable-everything
-
+
--enable-everything +
-Add (or remove) support for all non-multichoice options listed in ``./configure ---help''. +

Add (or remove) support for all non-multichoice options listed in ``./configure +--help''.

You can specify this and then disable options you do not like by @@ -2224,32 +2234,32 @@ or you can start with a minimal configuration by specifying --disable-everything and than adding just the --enable-... arguments you want.

-

-
--enable-xft (default: enabled)
-
+ +
--enable-xft (default: enabled) +
-Add support for Xft (anti-aliases, among others) fonts. Xft fonts are +

Add support for Xft (anti-aliases, among others) fonts. Xft fonts are slower and require lots of memory, but as long as you don't use them, you -don't pay for them. +don't pay for them.

-

-
--enable-font-styles (default: on)
-
+ +
--enable-font-styles (default: on) +
-Add support for bold, italic and bold italic > font -styles. The fonts can be set manually or automatically. +

Add support for bold, italic and bold italic > font +styles. The fonts can be set manually or automatically.

-

-
--with-codesets=NAME,... (default: all)
-
+ +
--with-codesets=NAME,... (default: all) +
-Compile in support for additional codeset (encoding) groups (eu, vn +

Compile in support for additional codeset (encoding) groups (eu, vn are always compiled in, which includes most 8-bit character sets). These codeset tables are used for driving X11 core fonts, they are not required for Xft fonts, although having them compiled in lets rxvt-unicode choose replacement fonts more intelligently. Compiling them in will make your binary bigger (all of together cost about 700kB), but it doesn't increase -memory usage unless you use a font requiring one of these encodings. +memory usage unless you use a font requiring one of these encodings.

4Shift
8Meta
@@ -2258,19 +2268,19 @@ memory usage unless you use a font requiring one of these encodings. -
allall available codeset groups
jpcommon japanese encodings
jp_extrarely used but big japanese encodings
krkorean encodings

-
--enable-xim (default: on)
-
+ +
--enable-xim (default: on) +
-Add support for XIM (X Input Method) protocol. This allows using +

Add support for XIM (X Input Method) protocol. This allows using alternative input methods (e.g. kinput2) and will also correctly -set up the input for people using dead keys or compose keys. +set up the input for people using dead keys or compose keys.

-

-
--enable-unicode3 (default: off)
-
+ +
--enable-unicode3 (default: off) +
-Recommended to stay off unless you really need non-BMP characters. +

Recommended to stay off unless you really need non-BMP characters.

Enable direct support for displaying unicode codepoints above @@ -2285,15 +2295,15 @@ limited to a view thousand (shared with combining characters, see next switch), and right now rxvt-unicode cannot display them (input/output and cut&paste still work, though).

-

-
--enable-combining (default: on)
-
+ +
--enable-combining (default: on) +
-Enable automatic composition of combining characters into +

Enable automatic composition of combining characters into composite characters. This is required for proper viewing of text where accents are encoded as seperate unicode characters. This is done by using precomposited characters when available or creating -new pseudo-characters when no precomposed form exists. +new pseudo-characters when no precomposed form exists.

Without --enable-unicode3, the number of additional precomposed @@ -2309,141 +2319,141 @@ beyond plane 0 (>65535) when --enable-unicode3 was not specified.

but these are not currently used. Bug me if you want these to be used (and tell me how these are to be used...).

-

-
--enable-fallback(=CLASS) (default: Rxvt)
-
+ +
--enable-fallback(=CLASS) (default: Rxvt) +
-When reading resource settings, also read settings for class CLASS. To -disable resource fallback use --disable-fallback. +

When reading resource settings, also read settings for class CLASS. To +disable resource fallback use --disable-fallback.

-

-
--with-res-name=NAME (default: urxvt)
-
+ +
--with-res-name=NAME (default: urxvt) +
-Use the given name as default application name when -reading resources. Specify --with-res-name=rxvt to replace rxvt. +

Use the given name as default application name when +reading resources. Specify --with-res-name=rxvt to replace rxvt.

-

-
--with-res-class=CLASS /default: URxvt)
-
+ +
--with-res-class=CLASS /default: URxvt) +
-Use the given class as default application class +

Use the given class as default application class when reading resources. Specify --with-res-class=Rxvt to replace -rxvt. +rxvt.

-

-
--enable-utmp (default: on)
-
+ +
--enable-utmp (default: on) +
-Write user and tty to utmp file (used by programs like w) at -start of rxvt execution and delete information when rxvt exits. +

Write user and tty to utmp file (used by programs like w) at +start of rxvt execution and delete information when rxvt exits.

-

-
--enable-wtmp (default: on)
-
+ +
--enable-wtmp (default: on) +
-Write user and tty to wtmp file (used by programs like last) at +

Write user and tty to wtmp file (used by programs like last) at start of rxvt execution and write logout when rxvt exits. This -option requires --enable-utmp to also be specified. +option requires --enable-utmp to also be specified.

-

-
--enable-lastlog (default: on)
-
+ +
--enable-lastlog (default: on) +
-Write user and tty to lastlog file (used by programs like +

Write user and tty to lastlog file (used by programs like lastlogin) at start of rxvt execution. This option requires ---enable-utmp to also be specified. +--enable-utmp to also be specified.

-

-
--enable-xpm-background (default: on)
-
+ +
--enable-xpm-background (default: on) +
-Add support for XPM background pixmaps. +

Add support for XPM background pixmaps.

-

-
--enable-transparency (default: on)
-
+ +
--enable-transparency (default: on) +
-Add support for inheriting parent backgrounds thus giving a fake -transparency to the term. +

Add support for inheriting parent backgrounds thus giving a fake +transparency to the term.

-

-
--enable-fading (default: on)
-
+ +
--enable-fading (default: on) +
-Add support for fading the text when focus is lost (requires --enable-transparency). +

Add support for fading the text when focus is lost (requires --enable-transparency).

-

-
--enable-tinting (default: on)
-
+ +
--enable-tinting (default: on) +
-Add support for tinting of transparent backgrounds (requires --enable-transparency). +

Add support for tinting of transparent backgrounds (requires --enable-transparency).

-

-
--enable-rxvt-scroll (default: on)
-
+ +
--enable-rxvt-scroll (default: on) +
-Add support for the original rxvt scrollbar. +

Add support for the original rxvt scrollbar.

-

-
--enable-next-scroll (default: on)
-
+ +
--enable-next-scroll (default: on) +
-Add support for a NeXT-like scrollbar. +

Add support for a NeXT-like scrollbar.

-

-
--enable-xterm-scroll (default: on)
-
+ +
--enable-xterm-scroll (default: on) +
-Add support for an Xterm-like scrollbar. +

Add support for an Xterm-like scrollbar.

-

-
--enable-plain-scroll (default: on)
-
+ +
--enable-plain-scroll (default: on) +
-Add support for a very unobtrusive, plain-looking scrollbar that +

Add support for a very unobtrusive, plain-looking scrollbar that is the favourite of the rxvt-unicode author, having used it for -many years. +many years.

-

-
--enable-ttygid (default: off)
-
+ +
--enable-ttygid (default: off) +
-Change tty device setting to group ``tty'' - only use this if -your system uses this type of security. +

Change tty device setting to group ``tty'' - only use this if +your system uses this type of security.

-

-
--disable-backspace-key
-
+ +
--disable-backspace-key +
-Removes any handling of the backspace key by us - let the X server do it. +

Removes any handling of the backspace key by us - let the X server do it.

-

-
--disable-delete-key
-
+ +
--disable-delete-key +
-Removes any handling of the delete key by us - let the X server -do it. +

Removes any handling of the delete key by us - let the X server +do it.

-

-
--disable-resources
-
+ +
--disable-resources +
-Removes any support for resource checking. +

Removes any support for resource checking.

-

-
--disable-swapscreen
-
+ +
--disable-swapscreen +
-Remove support for secondary/swap screen. +

Remove support for secondary/swap screen.

-

-
--enable-frills (default: on)
-
+ +
--enable-frills (default: on) +
-Add support for many small features that are not essential but nice to +

Add support for many small features that are not essential but nice to have. Normally you want this, but for very small binaries you may want to -disable this. +disable this.

A non-exhaustive list of features enabled by --enable-frills (possibly @@ -2465,10 +2475,11 @@ in combination with other switches) is:

XEmbed support (-embed) user-pty (-pty-fd) hold on exit (-hold) - skip builtin block graphics (-sbg) + skip builtin block graphics (-sbg) + separate highlightcolor support (-hc)
-

It also enabled some non-essential features otherwise disabled, such as:

+

It also enables some non-essential features otherwise disabled, such as:

@@ -2484,132 +2495,133 @@ in combination with other switches) is:

   trailing space removal for selections
   verbose X error handling
-

-
--enable-iso14755 (default: on)
-
+ +
--enable-iso14755 (default: on) +
-Enable extended ISO 14755 support (see rxvt(1), or +

Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). Basic support (section 5.1) is enabled by --enable-frills, while support for 5.2, 5.3 and 5.4 is enabled with -this switch. +this switch.

-

-
--enable-keepscrolling (default: on)
-
+ +
--enable-keepscrolling (default: on) +
-Add support for continual scrolling of the display when you hold -the mouse button down on a scrollbar arrow. +

Add support for continual scrolling of the display when you hold +the mouse button down on a scrollbar arrow.

-

-
--enable-mousewheel (default: on)
-
+ +
--enable-mousewheel (default: on) +
-Add support for scrolling via mouse wheel or buttons 4 & 5. +

Add support for scrolling via mouse wheel or buttons 4 & 5.

-

-
--enable-slipwheeling (default: on)
-
+ +
--enable-slipwheeling (default: on) +
-Add support for continual scrolling (using the mouse wheel as an +

Add support for continual scrolling (using the mouse wheel as an accelerator) while the control key is held down. This option -requires --enable-mousewheel to also be specified. +requires --enable-mousewheel to also be specified.

-

-
--disable-new-selection
-
+ +
--disable-new-selection +
-Remove support for mouse selection style like that of xterm. +

Remove support for mouse selection style like that of xterm.

-

-
--enable-dmalloc (default: off)
-
+ +
--enable-dmalloc (default: off) +
-Use Gray Watson's malloc - which is good for debugging See +

Use Gray Watson's malloc - which is good for debugging See http://www.letters.com/dmalloc/ for details If you use either this or the next option, you may need to edit src/Makefile after compiling to point -DINCLUDE and DLIB to the right places. +DINCLUDE and DLIB to the right places.

You can only use either this option and the following (should you use either) .

-

-
--enable-dlmalloc (default: off)
-
+ +
--enable-dlmalloc (default: off) +
-Use Doug Lea's malloc - which is good for a production version -See http://g.oswego.edu/dl/html/malloc.html for details. +

Use Doug Lea's malloc - which is good for a production version +See http://g.oswego.edu/dl/html/malloc.html for details.

-

-
--enable-smart-resize (default: on)
-
+ +
--enable-smart-resize (default: on) +
-Add smart growth/shrink behaviour when changing font size via hot +

Add smart growth/shrink behaviour when changing font size via hot keys. This should keep the window corner which is closest to a corner of -the screen in a fixed position. +the screen in a fixed position.

-

-
--enable-pointer-blank (default: on)
-
+ +
--enable-pointer-blank (default: on) +
-Add support to have the pointer disappear when typing or inactive. +

Add support to have the pointer disappear when typing or inactive.

-

-
--enable-perl (default: on)
-
+ +
--enable-perl (default: on) +
-Enable an embedded perl interpreter. See the rxvtperl(3) +

Enable an embedded perl interpreter. See the rxvtperl(3) manpage (doc/rxvtperl.txt) for more info on this feature, or the files in src/perl-ext/ for the extensions that are installed by default. The perl interpreter that is used can be specified via the PERL environment -variable when running configure. +variable when running configure.

-

-
--with-name=NAME (default: urxvt)
-
+ +
--with-name=NAME (default: urxvt) +
-Set the basename for the installed binaries, resulting +

Set the basename for the installed binaries, resulting in urxvt, urxvtd etc.). Specify --with-name=rxvt to replace with -rxvt. +rxvt.

-

-
--with-term=NAME (default: rxvt-unicode)
-
+ +
--with-term=NAME (default: rxvt-unicode) +
-Change the environmental variable for the terminal to NAME. +

Change the environmental variable for the terminal to NAME.

-

-
--with-terminfo=PATH
-
+ +
--with-terminfo=PATH +
-Change the environmental variable for the path to the terminfo tree to -PATH. +

Change the environmental variable for the path to the terminfo tree to +PATH.

-

-
--with-x
-
+ +
--with-x +
-Use the X Window System (pretty much default, eh?). +

Use the X Window System (pretty much default, eh?).

-

-
--with-xpm-includes=DIR
-
+ +
--with-xpm-includes=DIR +
-Look for the XPM includes in DIR. +

Look for the XPM includes in DIR.

-

-
--with-xpm-library=DIR
-
+ +
--with-xpm-library=DIR +
-Look for the XPM library in DIR. +

Look for the XPM library in DIR.

-

-
--with-xpm
-
+ +
--with-xpm +
-Not needed - define via --enable-xpm-background. +

Not needed - define via --enable-xpm-background.

-

+ +

diff --git a/doc/rxvt.7.man.in b/doc/rxvt.7.man.in index d9789714..b667e83d 100644 --- a/doc/rxvt.7.man.in +++ b/doc/rxvt.7.man.in @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" Automatically generated by Pod::Man 2.09 (Pod::Simple 3.04) .\" .\" Standard preamble: .\" ======================================================================== @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "rxvt 7" -.TH rxvt 7 "2006-02-22" "7.7" "RXVT-UNICODE" +.TH rxvt 7 "2006-07-06" "7.7" "RXVT-UNICODE" .SH "NAME" RXVT REFERENCE \- FAQ, command sequences and other background information .SH "SYNOPSIS" @@ -137,14 +137,10 @@ RXVT REFERENCE \- FAQ, command sequences and other background information .Vb 2 \& # set a new font set \& printf '\e33]50;%s\e007' 9x15,xft:Kochi" Mincho" -.Ve -.PP -.Vb 2 -\& # change the locale and tell rxvt-unicode about it -\& export LC_CTYPE=ja_JP.EUC-JP; printf "\e33]701;$LC_CTYPE\e007" -.Ve -.PP -.Vb 2 +\& +\& # change the locale and tell rxvt\-unicode about it +\& export LC_CTYPE=ja_JP.EUC\-JP; printf "\e33]701;$LC_CTYPE\e007" +\& \& # set window title \& printf '\e33]2;%s\e007' "new window title" .Ve @@ -174,11 +170,9 @@ simple tabbed terminal. It is installed by default, so any of these should give you tabs: .PP .Vb 1 -\& @@URXVT_NAME@@ -pe tabbed -.Ve -.PP -.Vb 1 -\& URxvt.perl-ext-common: default,tabbed +\& @@URXVT_NAME@@ \-pe tabbed +\& +\& URxvt.perl\-ext\-common: default,tabbed .Ve .PP It will also work fine with tabbing functionality of many window managers @@ -226,8 +220,8 @@ If you want to start @@URXVT_NAME@@d automatically whenever you run .Vb 6 \& #!/bin/sh \& @@URXVT_NAME@@c "$@" -\& if [ $? -eq 2 ]; then -\& @@URXVT_NAME@@d -q -o -f +\& if [ $? \-eq 2 ]; then +\& @@URXVT_NAME@@d \-q \-o \-f \& @@URXVT_NAME@@c "$@" \& fi .Ve @@ -260,14 +254,14 @@ snippets: .PP .Vb 12 \& # Bourne/Korn/POSIX family of shells: -\& [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know -\& if [ ${TERM:-foo} = xterm ]; then -\& stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not -\& echo -n '^[Z' +\& [ ${TERM:\-foo} = foo ] && TERM=xterm # assume an xterm if we don't know +\& if [ ${TERM:\-foo} = xterm ]; then +\& stty \-icanon \-echo min 0 time 15 # see if enhanced rxvt or not +\& echo \-n '^[Z' \& read term_id \& stty icanon echo -\& if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then -\& echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string +\& if [ ""${term_id} = '^[[?1;2C' \-a ${DISPLAY:\-foo} = foo ]; then +\& echo \-n '^[[7n' # query the rxvt we are in for the DISPLAY string \& read DISPLAY # set it in our local shell \& fi \& fi @@ -293,8 +287,8 @@ already in use in this mode. .PP .Vb 3 \& text data bss drs rss filename -\& 98398 1664 24 15695 1824 rxvt --disable-everything -\& 188985 9048 66616 18222 1788 urxvt --disable-everything +\& 98398 1664 24 15695 1824 rxvt \-\-disable\-everything +\& 188985 9048 66616 18222 1788 urxvt \-\-disable\-everything .Ve .PP When you \f(CW\*(C`\-\-enable\-everything\*(C'\fR (which \fIis\fR unfair, as this involves xft @@ -303,8 +297,8 @@ libc), the two diverge, but not unreasnobaly so. .PP .Vb 3 \& text data bss drs rss filename -\& 163431 2152 24 20123 2060 rxvt --enable-everything -\& 1035683 49680 66648 29096 3680 urxvt --enable-everything +\& 163431 2152 24 20123 2060 rxvt \-\-enable\-everything +\& 1035683 49680 66648 29096 3680 urxvt \-\-enable\-everything .Ve .PP The very large size of the text section is explained by the east-asian @@ -350,7 +344,7 @@ system with a minimal config: \& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) \& libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000) \& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000) -\& /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) +\& /lib64/ld\-linux\-x86\-64.so.2 (0x00002aaaaaaab000) .Ve .PP And here is rxvt\-unicode: @@ -360,7 +354,7 @@ And here is rxvt\-unicode: \& libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) \& libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) \& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) -\& /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) +\& /lib64/ld\-linux\-x86\-64.so.2 (0x00002aaaaaaab000) .Ve .PP No large bloated libraries (of course, none were linked in statically), @@ -382,7 +376,7 @@ descriptions for the programs mentioned and rxvt\-unicode. Really, do it! .PP .Vb 2 \& Esetroot wallpaper.jpg -\& @@URXVT_NAME@@ -ip -tint red -sh 40 +\& @@URXVT_NAME@@ \-ip \-tint red \-sh 40 .Ve .PP That works. If you think it doesn't, you lack transparency and tinting @@ -393,8 +387,8 @@ to use effects other than tinting and shading: Just shade/tint/whatever your picture with gimp or any other tool: .PP .Vb 2 -\& convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm -\& @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background +\& convert wallpaper.jpg \-blur 20x20 \-modulate 30 background.xpm +\& @@URXVT_NAME@@ \-pixmap background.xpm \-pe automove\-background .Ve .PP That works. If you think it doesn't, you lack \s-1XPM\s0 and Perl support, or you @@ -403,7 +397,7 @@ are unable to read. 3. Use an \s-1ARGB\s0 visual: .PP .Vb 1 -\& @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc +\& @@URXVT_NAME@@ \-depth 32 \-fg grey90 \-bg rgba:0000/0000/4444/cccc .Ve .PP This requires \s-1XFT\s0 support, and the support of your X\-server. If that @@ -415,8 +409,8 @@ doesn't mean that your \s-1WM\s0 has the required kludges in place. 4. Use xcompmgr and let it do the job: .PP .Vb 2 -\& xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \e -\& -set _NET_WM_WINDOW_OPACITY 0xc0000000 +\& xprop \-frame \-f _NET_WM_WINDOW_OPACITY 32c \e +\& \-set _NET_WM_WINDOW_OPACITY 0xc0000000 .Ve .PP Then click on a window you want to make transparent. Replace \f(CW0xc0000000\fR @@ -555,9 +549,7 @@ including the murky brown that passes for low-intensity yellow: \& URxvt.color5: #A800A8 \& URxvt.color6: #00A8A8 \& URxvt.color7: #A8A8A8 -.Ve -.PP -.Vb 8 +\& \& URxvt.color8: #000054 \& URxvt.color9: #FF0054 \& URxvt.color10: #00FF54 @@ -570,7 +562,7 @@ including the murky brown that passes for low-intensity yellow: .PP And here is a more complete set of non-standard colors. .PP -.Vb 18 +.Vb 10 \& URxvt.cursorColor: #dc74d1 \& URxvt.pointerColor: #dc74d1 \& URxvt.background: #0e0e0e @@ -617,7 +609,7 @@ In that case, select a font of your taste and add it to the font list, e.g.: .PP .Vb 1 -\& @@URXVT_NAME@@ -fn basefont,font2,font3... +\& @@URXVT_NAME@@ \-fn basefont,font2,font3... .Ve .PP When rxvt-unicode sees a character, it will first look at the base @@ -652,7 +644,8 @@ runtime (the internal data structure has no problem with using different fonts for the same character at the same time, but no interface for this has been designed yet). .PP -Until then, you might get away with switching fonts at runtime (see \*(L"Can I switch the fonts at runtime?\*(R" later in this document). +Until then, you might get away with switching fonts at runtime (see \*(L"Can +I switch the fonts at runtime?\*(R" later in this document). .Sh "Keyboard, Mouse & User Interaction" .IX Subsection "Keyboard, Mouse & User Interaction" \fIThe new selection selects pieces that are too big, how can I select single words?\fR @@ -662,7 +655,7 @@ If you want to select e.g. alphanumeric words, you can use the following setting: .PP .Vb 1 -\& URxvt.selection.pattern-0: ([[:word:]]+) +\& URxvt.selection.pattern\-0: ([[:word:]]+) .Ve .PP If you click more than twice, the selection will be extended @@ -671,7 +664,7 @@ more and more. To get a selection that is very similar to the old code, try this pattern: .PP .Vb 1 -\& URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\e\e\e\e]^`{|})]+) +\& URxvt.selection.pattern\-0: ([^"&'()*,;<=>?@[\e\e\e\e]^`{|})]+) .Ve .PP Please also note that the \fILeftClick Shift-LeftClik\fR combination also @@ -691,7 +684,7 @@ example, to disable the \fBselection-popup\fR and \fBoption-popup\fR, specify this \fBperl-ext-common\fR resource: .PP .Vb 1 -\& URxvt.perl-ext-common: default,-selection-popup,-option-popup +\& URxvt.perl\-ext\-common: default,\-selection\-popup,\-option\-popup .Ve .PP This will keep the default extensions, but disable the two popup @@ -700,7 +693,7 @@ scrollback search mode is triggered by \fBM\-s\fR. You can move it to any other combination either by setting the \fBsearchable-scrollback\fR resource: .PP .Vb 1 -\& URxvt.searchable-scrollback: CM-s +\& URxvt.searchable\-scrollback: CM\-s .Ve .PP \fIThe cursor moves when selecting text in the current input line, how do I switch this off?\fR @@ -721,7 +714,7 @@ You can permamently switch this feature off by disabling the \f(CW\*(C`readline\ extension: .PP .Vb 1 -\& URxvt.perl-ext-common: default,-readline +\& URxvt.perl\-ext\-common: default,\-readline .Ve .PP \fIMy numerical keypad acts weird and generates differing output?\fR @@ -789,9 +782,7 @@ For starting a new rxvt\-unicode: \& # use Backspace = ^H \& $ stty erase ^H \& $ @@URXVT_NAME@@ -.Ve -.PP -.Vb 3 +\& \& # use Backspace = ^? \& $ stty erase ^? \& $ @@URXVT_NAME@@ @@ -804,13 +795,11 @@ For an existing rxvt\-unicode: .Vb 3 \& # use Backspace = ^H \& $ stty erase ^H -\& $ echo -n "^[[36h" -.Ve -.PP -.Vb 3 +\& $ echo \-n "^[[36h" +\& \& # use Backspace = ^? \& $ stty erase ^? -\& $ echo -n "^[[36l" +\& $ echo \-n "^[[36l" .Ve .PP This helps satisfy some of the Backspace discrepancies that occur, but @@ -839,26 +828,26 @@ use the `keysym' resource to alter the keystrings associated with keysyms. .PP Here's an example for a URxvt session started using \f(CW\*(C`@@URXVT_NAME@@ \-name URxvt\*(C'\fR .PP -.Vb 20 +.Vb 10 \& URxvt.keysym.Home: \e033[1~ \& URxvt.keysym.End: \e033[4~ -\& URxvt.keysym.C-apostrophe: \e033 -\& URxvt.keysym.C-slash: \e033 -\& URxvt.keysym.C-semicolon: \e033 -\& URxvt.keysym.C-grave: \e033 -\& URxvt.keysym.C-comma: \e033 -\& URxvt.keysym.C-period: \e033 -\& URxvt.keysym.C-0x60: \e033 -\& URxvt.keysym.C-Tab: \e033 -\& URxvt.keysym.C-Return: \e033 -\& URxvt.keysym.S-Return: \e033 -\& URxvt.keysym.S-space: \e033 -\& URxvt.keysym.M-Up: \e033 -\& URxvt.keysym.M-Down: \e033 -\& URxvt.keysym.M-Left: \e033 -\& URxvt.keysym.M-Right: \e033 -\& URxvt.keysym.M-C-0: list \e033 -\& URxvt.keysym.M-C-a: list \e033 +\& URxvt.keysym.C\-apostrophe: \e033 +\& URxvt.keysym.C\-slash: \e033 +\& URxvt.keysym.C\-semicolon: \e033 +\& URxvt.keysym.C\-grave: \e033 +\& URxvt.keysym.C\-comma: \e033 +\& URxvt.keysym.C\-period: \e033 +\& URxvt.keysym.C\-0x60: \e033 +\& URxvt.keysym.C\-Tab: \e033 +\& URxvt.keysym.C\-Return: \e033 +\& URxvt.keysym.S\-Return: \e033 +\& URxvt.keysym.S\-space: \e033 +\& URxvt.keysym.M\-Up: \e033 +\& URxvt.keysym.M\-Down: \e033 +\& URxvt.keysym.M\-Left: \e033 +\& URxvt.keysym.M\-Right: \e033 +\& URxvt.keysym.M\-C\-0: list \e033 +\& URxvt.keysym.M\-C\-a: list \e033 \& URxvt.keysym.F12: command:\e033]701;zh_CN.GBK\e007 .Ve .PP @@ -894,13 +883,13 @@ not \fItypical\fR, but what's typical... .PP .Vb 2 \& URxvt.cutchars: "()*,<>[]{}|' -\& URxvt.print-pipe: cat >/tmp/xxx +\& URxvt.print\-pipe: cat >/tmp/xxx .Ve .PP These are just for testing stuff. .PP .Vb 2 -\& URxvt.imLocale: ja_JP.UTF-8 +\& URxvt.imLocale: ja_JP.UTF\-8 \& URxvt.preeditType: OnTheSpot,None .Ve .PP @@ -910,12 +899,12 @@ type, which requires the \f(CW\*(C`xim\-onthespot\*(C'\fR perl extension but rew with correct-looking fonts. .PP .Vb 6 -\& URxvt.perl-lib: /root/lib/urxvt -\& URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard -\& URxvt.selection.pattern-0: ( at .*? line \e\ed+) -\& URxvt.selection.pattern-1: ^(/[^:]+):\e -\& URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\e\ed+):?$/:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/ -\& URxvt.selection-autotransform.1: s/^ at (.*?) line (\e\ed+)$/:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/ +\& URxvt.perl\-lib: /root/lib/urxvt +\& URxvt.perl\-ext\-common: default,selection\-autotransform,selection\-pastebin,xim\-onthespot,remote\-clipboard +\& URxvt.selection.pattern\-0: ( at .*? line \e\ed+) +\& URxvt.selection.pattern\-1: ^(/[^:]+):\e +\& URxvt.selection\-autotransform.0: s/^([^:[:space:]]+):(\e\ed+):?$/:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/ +\& URxvt.selection\-autotransform.1: s/^ at (.*?) line (\e\ed+)$/:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/ .Ve .PP This is my perl configuration. The first two set the perl library @@ -1002,12 +991,12 @@ I once thought this is a great idea. .PP .Vb 9 \& urxvt.font: 9x15bold,\e -\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e -\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e +\& \-misc\-fixed\-bold\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1,\e +\& \-misc\-fixed\-medium\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1, \e \& [codeset=JISX0208]xft:Kochi Gothic, \e \& xft:Bitstream Vera Sans Mono:autohint=true, \e \& xft:Code2000:antialias=false -\& urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15 +\& urxvt.boldFont: \-xos4\-terminus\-bold\-r\-normal\-\-14\-140\-72\-72\-c\-80\-iso8859\-15 \& urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true \& urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true .Ve @@ -1039,8 +1028,8 @@ defaults: \& IRC*font: suxuseuro \& IRC*boldFont: suxuseuro \& IRC*colorBD: white -\& IRC*keysym.M-C-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007 -\& IRC*keysym.M-C-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007 +\& IRC*keysym.M\-C\-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007 +\& IRC*keysym.M\-C\-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007 .Ve .PP \&\f(CW\*(C`Alt\-Shift\-1\*(C'\fR and \f(CW\*(C`Alt\-Shift\-2\*(C'\fR switch between two different font @@ -1053,11 +1042,11 @@ The above is all in my \f(CW\*(C`.Xdefaults\*(C'\fR (I don't use \f(CW\*(C`.Xres file for different hosts, for example, on ym main desktop, I use: .PP .Vb 5 -\& URxvt.keysym.C-M-q: command:\e033[3;5;5t -\& URxvt.keysym.C-M-y: command:\e033[3;5;606t -\& URxvt.keysym.C-M-e: command:\e033[3;1605;5t -\& URxvt.keysym.C-M-c: command:\e033[3;1605;606t -\& URxvt.keysym.C-M-p: perl:test +\& URxvt.keysym.C\-M\-q: command:\e033[3;5;5t +\& URxvt.keysym.C\-M\-y: command:\e033[3;5;606t +\& URxvt.keysym.C\-M\-e: command:\e033[3;1605;5t +\& URxvt.keysym.C\-M\-c: command:\e033[3;1605;606t +\& URxvt.keysym.C\-M\-p: perl:test .Ve .PP The first for keysym definitions allow me to quickly bring some windows @@ -1073,9 +1062,9 @@ Well, why, indeed? It does, in a way very similar to other X applications. Most importantly, this means that if you or your \s-1OS\s0 loads resources into the X display (the right way to do it), rxvt-unicode will ignore any resource files in your home directory. It will only read -\&\fI$HOME/.Xdefaults\fR when no resources are attached to the display. +\&\fI\f(CI$HOME\fI/.Xdefaults\fR when no resources are attached to the display. .PP -If you have or use an \fI$HOME/.Xresources\fR file, chances are that +If you have or use an \fI\f(CI$HOME\fI/.Xresources\fR file, chances are that resources are loaded into your X\-server. In this case, you have to re-login after every change (or run \fIxrdb \-merge \f(CI$HOME\fI/.Xresources\fR). .PP @@ -1100,7 +1089,7 @@ be done like this (with ncurses' infocmp): .PP .Vb 2 \& REMOTE=remotesystem.domain -\& infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" +\& infocmp rxvt\-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" .Ve .PP \&... or by installing rxvt-unicode normally on the remote system, @@ -1146,13 +1135,13 @@ You can also create a termcap entry by using terminfo's infocmp program like this: .PP .Vb 1 -\& infocmp -C rxvt-unicode +\& infocmp \-C rxvt\-unicode .Ve .PP Or you could use this termcap entry, generated by the command above: .PP -.Vb 20 -\& rxvt-unicode|rxvt-unicode terminal (X Window System):\e +.Vb 10 +\& rxvt\-unicode|rxvt\-unicode terminal (X Window System):\e \& :am:bw:eo:km:mi:ms:xn:xo:\e \& :co#80:it#8:li#24:lm#0:\e \& :AL=\eE[%dL:DC=\eE[%dP:DL=\eE[%dM:DO=\eE[%dB:IC=\eE[%d@:\e @@ -1183,13 +1172,13 @@ file. Needless to say, \f(CW\*(C`rxvt\-unicode\*(C'\fR is not in it's default fi with most other terminals supporting colour). Either add: .PP .Vb 1 -\& TERM rxvt-unicode +\& TERM rxvt\-unicode .Ve .PP to \f(CW\*(C`/etc/DIR_COLORS\*(C'\fR or simply add: .PP .Vb 1 -\& alias ls='ls --color=auto' +\& alias ls='ls \-\-color=auto' .Ve .PP to your \f(CW\*(C`.profile\*(C'\fR or \f(CW\*(C`.bashrc\*(C'\fR. @@ -1317,8 +1306,8 @@ first switches to a locale supported by xjdic and back later: .PP .Vb 3 \& printf '\e33]701;%s\e007' ja_JP.SJIS -\& xjdic -js -\& printf '\e33]701;%s\e007' de_DE.UTF-8 +\& xjdic \-js +\& printf '\e33]701;%s\e007' de_DE.UTF\-8 .Ve .PP You can also use xterm's \f(CW\*(C`luit\*(C'\fR program, which usually works fine, except @@ -1350,9 +1339,9 @@ When you want to use e.g. \fBkinput2\fR, it must be set to method servers are running with this command: .Sp .Vb 1 -\& xprop -root XIM_SERVERS +\& xprop \-root XIM_SERVERS .Ve -.IP "*" 4 +.IP "" 4 .PP \fIMy input method wants but I want \s-1UTF\-8\s0, what can I do?\fR .IX Subsection "My input method wants but I want UTF-8, what can I do?" @@ -1361,7 +1350,7 @@ You can specify separate locales for the input method and the rest of the terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR: .PP .Vb 1 -\& URxvt.imlocale: ja_JP.EUC-JP +\& URxvt.imlocale: ja_JP.EUC\-JP .Ve .PP Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still @@ -1680,7 +1669,6 @@ C = 5 Finnish character set unimplemented C = C Finnish character set unimplemented C = K German character set unimplemented .TE - .PP .IX Xref "CSI" @@ -1739,7 +1727,6 @@ Ps = 0 Clear Below (default) Ps = 1 Clear Above Ps = 2 Clear All .TE - .ie n .IP "\fB\fB""ESC [ Ps K""\fB\fR" 4 .el .IP "\fB\f(CBESC [ Ps K\fB\fR" 4 .IX Item "ESC [ Ps K" @@ -1750,7 +1737,6 @@ Ps = 0 Clear to Right (default) Ps = 1 Clear to Left Ps = 2 Clear All .TE - .ie n .IP "\fB\fB""ESC [ Ps L""\fB\fR" 4 .el .IP "\fB\f(CBESC [ Ps L\fB\fR" 4 .IX Item "ESC [ Ps L" @@ -1778,7 +1764,6 @@ Ps = 0 Tab Set (HTS) Ps = 2 Tab Clear (TBC), Clear Current Column (default) Ps = 5 Tab Clear (TBC), Clear All .TE - .ie n .IP "\fB\fB""ESC [ Ps X""\fB\fR" 4 .el .IP "\fB\f(CBESC [ Ps X\fB\fR" 4 .IX Item "ESC [ Ps X" @@ -1823,7 +1808,6 @@ l l . Ps = 0 Clear Current Column (default) Ps = 3 Clear All (TBC) .TE - .ie n .IP "\fB\fB""ESC [ Pm h""\fB\fR" 4 .el .IP "\fB\f(CBESC [ Pm h\fB\fR" 4 .IX Item "ESC [ Pm h" @@ -1838,7 +1822,6 @@ Ps = 0 print screen (MC0) Ps = 4 disable transparent print mode (MC4) Ps = 5 enable transparent print mode (MC5) .TE - .ie n .IP "\fB\fB""ESC [ Pm l""\fB\fR" 4 .el .IP "\fB\f(CBESC [ Pm l\fB\fR" 4 .IX Item "ESC [ Pm l" @@ -1852,7 +1835,6 @@ l l . h Insert Mode (SMIR) l Replace Mode (RMIR) .TE - .PD 0 .ie n .IP "\fB\fB""Ps = 20""\fB\fR (partially implemented)" 4 .el .IP "\fB\f(CBPs = 20\fB\fR (partially implemented)" 4 @@ -1862,7 +1844,6 @@ l l . h Automatic Newline (LNM) l Normal Linefeed (LNM) .TE - .RE .RS 4 .RE @@ -1901,7 +1882,6 @@ Ps = 96 / 106 fg/bg Bright Cyan Ps = 97 / 107 fg/bg Bright White Ps = 99 / 109 fg/bg Bright Default .TE - .ie n .IP "\fB\fB""ESC [ Ps n""\fB\fR" 4 .el .IP "\fB\f(CBESC [ Ps n\fB\fR" 4 .IX Item "ESC [ Ps n" @@ -1913,7 +1893,6 @@ Ps = 6 Report Cursor Position (CPR) [row;column] as ESC [ r ; c R Ps = 7 Request Display Name Ps = 8 Request Version Number (place in window title) .TE - .ie n .IP "\fB\fB""ESC [ Ps;Ps r""\fB\fR" 4 .el .IP "\fB\f(CBESC [ Ps;Ps r\fB\fR" 4 .IX Item "ESC [ Ps;Ps r" @@ -1946,7 +1925,6 @@ Ps = 20 Reports icon label (ESC ] L NAME \234) Ps = 21 Reports window title (ESC ] l NAME \234) Ps = 24.. Set window height to Ps rows .TE - .ie n .IP "\fB\fB""ESC [ u""\fB\fR" 4 .el .IP "\fB\f(CBESC [ u\fB\fR" 4 .IX Item "ESC [ u" @@ -1981,254 +1959,228 @@ Save \s-1DEC\s0 Private Mode Values. .IX Item "ESC [ ? Pm t" Toggle \s-1DEC\s0 Private Mode Values (rxvt extension). \fIwhere\fR .RS 4 -.ie n .IP "\fB\fB""Ps = 1""\fB\fR (\s-1DECCKM\s0)" 4 -.el .IP "\fB\f(CBPs = 1\fB\fR (\s-1DECCKM\s0)" 4 -.IX Item "Ps = 1 (DECCKM)" +.ie n .IP "\fB\fB""Pm = 1""\fB\fR (\s-1DECCKM\s0)" 4 +.el .IP "\fB\f(CBPm = 1\fB\fR (\s-1DECCKM\s0)" 4 +.IX Item "Pm = 1 (DECCKM)" .TS l l . h Application Cursor Keys l Normal Cursor Keys .TE - .PD 0 -.ie n .IP "\fB\fB""Ps = 2""\fB\fR (\s-1ANSI/VT52\s0 mode)" 4 -.el .IP "\fB\f(CBPs = 2\fB\fR (\s-1ANSI/VT52\s0 mode)" 4 -.IX Item "Ps = 2 (ANSI/VT52 mode)" +.ie n .IP "\fB\fB""Pm = 2""\fB\fR (\s-1ANSI/VT52\s0 mode)" 4 +.el .IP "\fB\f(CBPm = 2\fB\fR (\s-1ANSI/VT52\s0 mode)" 4 +.IX Item "Pm = 2 (ANSI/VT52 mode)" .TS l l . h Enter VT52 mode l Enter VT52 mode .TE - -.ie n .IP "\fB\fB""Ps = 3""\fB\fR" 4 -.el .IP "\fB\f(CBPs = 3\fB\fR" 4 -.IX Item "Ps = 3" +.ie n .IP "\fB\fB""Pm = 3""\fB\fR" 4 +.el .IP "\fB\f(CBPm = 3\fB\fR" 4 +.IX Item "Pm = 3" .TS l l . h 132 Column Mode (DECCOLM) l 80 Column Mode (DECCOLM) .TE - -.ie n .IP "\fB\fB""Ps = 4""\fB\fR" 4 -.el .IP "\fB\f(CBPs = 4\fB\fR" 4 -.IX Item "Ps = 4" +.ie n .IP "\fB\fB""Pm = 4""\fB\fR" 4 +.el .IP "\fB\f(CBPm = 4\fB\fR" 4 +.IX Item "Pm = 4" .TS l l . h Smooth (Slow) Scroll (DECSCLM) l Jump (Fast) Scroll (DECSCLM) .TE - -.ie n .IP "\fB\fB""Ps = 5""\fB\fR" 4 -.el .IP "\fB\f(CBPs = 5\fB\fR" 4 -.IX Item "Ps = 5" +.ie n .IP "\fB\fB""Pm = 5""\fB\fR" 4 +.el .IP "\fB\f(CBPm = 5\fB\fR" 4 +.IX Item "Pm = 5" .TS l l . h Reverse Video (DECSCNM) l Normal Video (DECSCNM) .TE - -.ie n .IP "\fB\fB""Ps = 6""\fB\fR" 4 -.el .IP "\fB\f(CBPs = 6\fB\fR" 4 -.IX Item "Ps = 6" +.ie n .IP "\fB\fB""Pm = 6""\fB\fR" 4 +.el .IP "\fB\f(CBPm = 6\fB\fR" 4 +.IX Item "Pm = 6" .TS l l . h Origin Mode (DECOM) l Normal Cursor Mode (DECOM) .TE - -.ie n .IP "\fB\fB""Ps = 7""\fB\fR" 4 -.el .IP "\fB\f(CBPs = 7\fB\fR" 4 -.IX Item "Ps = 7" +.ie n .IP "\fB\fB""Pm = 7""\fB\fR" 4 +.el .IP "\fB\f(CBPm = 7\fB\fR" 4 +.IX Item "Pm = 7" .TS l l . h Wraparound Mode (DECAWM) l No Wraparound Mode (DECAWM) .TE - -.ie n .IP "\fB\fB""Ps = 8""\fB\fR \fIunimplemented\fR" 4 -.el .IP "\fB\f(CBPs = 8\fB\fR \fIunimplemented\fR" 4 -.IX Item "Ps = 8 unimplemented" +.ie n .IP "\fB\fB""Pm = 8""\fB\fR \fIunimplemented\fR" 4 +.el .IP "\fB\f(CBPm = 8\fB\fR \fIunimplemented\fR" 4 +.IX Item "Pm = 8 unimplemented" .TS l l . h Auto-repeat Keys (DECARM) l No Auto-repeat Keys (DECARM) .TE - -.ie n .IP "\fB\fB""Ps = 9""\fB\fR X10 XTerm" 4 -.el .IP "\fB\f(CBPs = 9\fB\fR X10 XTerm" 4 -.IX Item "Ps = 9 X10 XTerm" +.ie n .IP "\fB\fB""Pm = 9""\fB\fR X10 XTerm" 4 +.el .IP "\fB\f(CBPm = 9\fB\fR X10 XTerm" 4 +.IX Item "Pm = 9 X10 XTerm" .TS l l . h Send Mouse X & Y on button press. l No mouse reporting. .TE - -.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4 -.el .IP "\fB\f(CBPs = 25\fB\fR" 4 -.IX Item "Ps = 25" +.ie n .IP "\fB\fB""Pm = 25""\fB\fR" 4 +.el .IP "\fB\f(CBPm = 25\fB\fR" 4 +.IX Item "Pm = 25" .TS l l . h Visible cursor {cnorm/cvvis} l Invisible cursor {civis} .TE - -.ie n .IP "\fB\fB""Ps = 30""\fB\fR" 4 -.el .IP "\fB\f(CBPs = 30\fB\fR" 4 -.IX Item "Ps = 30" +.ie n .IP "\fB\fB""Pm = 30""\fB\fR" 4 +.el .IP "\fB\f(CBPm = 30\fB\fR" 4 +.IX Item "Pm = 30" .TS l l . h scrollBar visisble l scrollBar invisisble .TE - -.ie n .IP "\fB\fB""Ps = 35""\fB\fR (\fBrxvt\fR)" 4 -.el .IP "\fB\f(CBPs = 35\fB\fR (\fBrxvt\fR)" 4 -.IX Item "Ps = 35 (rxvt)" +.ie n .IP "\fB\fB""Pm = 35""\fB\fR (\fBrxvt\fR)" 4 +.el .IP "\fB\f(CBPm = 35\fB\fR (\fBrxvt\fR)" 4 +.IX Item "Pm = 35 (rxvt)" .TS l l . h Allow XTerm Shift+key sequences l Disallow XTerm Shift+key sequences .TE - -.ie n .IP "\fB\fB""Ps = 38""\fB\fR \fIunimplemented\fR" 4 -.el .IP "\fB\f(CBPs = 38\fB\fR \fIunimplemented\fR" 4 -.IX Item "Ps = 38 unimplemented" +.ie n .IP "\fB\fB""Pm = 38""\fB\fR \fIunimplemented\fR" 4 +.el .IP "\fB\f(CBPm = 38\fB\fR \fIunimplemented\fR" 4 +.IX Item "Pm = 38 unimplemented" .PD Enter Tektronix Mode (\s-1DECTEK\s0) -.ie n .IP "\fB\fB""Ps = 40""\fB\fR" 4 -.el .IP "\fB\f(CBPs = 40\fB\fR" 4 -.IX Item "Ps = 40" +.ie n .IP "\fB\fB""Pm = 40""\fB\fR" 4 +.el .IP "\fB\f(CBPm = 40\fB\fR" 4 +.IX Item "Pm = 40" .TS l l . h Allow 80/132 Mode l Disallow 80/132 Mode .TE - .PD 0 -.ie n .IP "\fB\fB""Ps = 44""\fB\fR \fIunimplemented\fR" 4 -.el .IP "\fB\f(CBPs = 44\fB\fR \fIunimplemented\fR" 4 -.IX Item "Ps = 44 unimplemented" +.ie n .IP "\fB\fB""Pm = 44""\fB\fR \fIunimplemented\fR" 4 +.el .IP "\fB\f(CBPm = 44\fB\fR \fIunimplemented\fR" 4 +.IX Item "Pm = 44 unimplemented" .TS l l . h Turn On Margin Bell l Turn Off Margin Bell .TE - -.ie n .IP "\fB\fB""Ps = 45""\fB\fR \fIunimplemented\fR" 4 -.el .IP "\fB\f(CBPs = 45\fB\fR \fIunimplemented\fR" 4 -.IX Item "Ps = 45 unimplemented" +.ie n .IP "\fB\fB""Pm = 45""\fB\fR \fIunimplemented\fR" 4 +.el .IP "\fB\f(CBPm = 45\fB\fR \fIunimplemented\fR" 4 +.IX Item "Pm = 45 unimplemented" .TS l l . h Reverse-wraparound Mode l No Reverse-wraparound Mode .TE - -.ie n .IP "\fB\fB""Ps = 46""\fB\fR \fIunimplemented\fR" 4 -.el .IP "\fB\f(CBPs = 46\fB\fR \fIunimplemented\fR" 4 -.IX Item "Ps = 46 unimplemented" -.ie n .IP "\fB\fB""Ps = 47""\fB\fR" 4 -.el .IP "\fB\f(CBPs = 47\fB\fR" 4 -.IX Item "Ps = 47" +.ie n .IP "\fB\fB""Pm = 46""\fB\fR \fIunimplemented\fR" 4 +.el .IP "\fB\f(CBPm = 46\fB\fR \fIunimplemented\fR" 4 +.IX Item "Pm = 46 unimplemented" +.ie n .IP "\fB\fB""Pm = 47""\fB\fR" 4 +.el .IP "\fB\f(CBPm = 47\fB\fR" 4 +.IX Item "Pm = 47" .TS l l . h Use Alternate Screen Buffer l Use Normal Screen Buffer .TE - .PD .IX Xref "Priv66" -.ie n .IP "\fB\fB""Ps = 66""\fB\fR" 4 -.el .IP "\fB\f(CBPs = 66\fB\fR" 4 -.IX Item "Ps = 66" +.ie n .IP "\fB\fB""Pm = 66""\fB\fR" 4 +.el .IP "\fB\f(CBPm = 66\fB\fR" 4 +.IX Item "Pm = 66" .TS l l . h Application Keypad (DECPAM) == ESC = l Normal Keypad (DECPNM) == ESC > .TE - .PD 0 -.ie n .IP "\fB\fB""Ps = 67""\fB\fR" 4 -.el .IP "\fB\f(CBPs = 67\fB\fR" 4 -.IX Item "Ps = 67" +.ie n .IP "\fB\fB""Pm = 67""\fB\fR" 4 +.el .IP "\fB\f(CBPm = 67\fB\fR" 4 +.IX Item "Pm = 67" .TS l l . h Backspace key sends BS (DECBKM) l Backspace key sends DEL .TE - -.ie n .IP "\fB\fB""Ps = 1000""\fB\fR (X11 XTerm)" 4 -.el .IP "\fB\f(CBPs = 1000\fB\fR (X11 XTerm)" 4 -.IX Item "Ps = 1000 (X11 XTerm)" +.ie n .IP "\fB\fB""Pm = 1000""\fB\fR (X11 XTerm)" 4 +.el .IP "\fB\f(CBPm = 1000\fB\fR (X11 XTerm)" 4 +.IX Item "Pm = 1000 (X11 XTerm)" .TS l l . h Send Mouse X & Y on button press and release. l No mouse reporting. .TE - -.ie n .IP "\fB\fB""Ps = 1001""\fB\fR (X11 XTerm) \fIunimplemented\fR" 4 -.el .IP "\fB\f(CBPs = 1001\fB\fR (X11 XTerm) \fIunimplemented\fR" 4 -.IX Item "Ps = 1001 (X11 XTerm) unimplemented" +.ie n .IP "\fB\fB""Pm = 1001""\fB\fR (X11 XTerm) \fIunimplemented\fR" 4 +.el .IP "\fB\f(CBPm = 1001\fB\fR (X11 XTerm) \fIunimplemented\fR" 4 +.IX Item "Pm = 1001 (X11 XTerm) unimplemented" .TS l l . h Use Hilite Mouse Tracking. l No mouse reporting. .TE - -.ie n .IP "\fB\fB""Ps = 1010""\fB\fR (\fBrxvt\fR)" 4 -.el .IP "\fB\f(CBPs = 1010\fB\fR (\fBrxvt\fR)" 4 -.IX Item "Ps = 1010 (rxvt)" +.ie n .IP "\fB\fB""Pm = 1010""\fB\fR (\fBrxvt\fR)" 4 +.el .IP "\fB\f(CBPm = 1010\fB\fR (\fBrxvt\fR)" 4 +.IX Item "Pm = 1010 (rxvt)" .TS l l . h Don't scroll to bottom on TTY output l Scroll to bottom on TTY output .TE - -.ie n .IP "\fB\fB""Ps = 1011""\fB\fR (\fBrxvt\fR)" 4 -.el .IP "\fB\f(CBPs = 1011\fB\fR (\fBrxvt\fR)" 4 -.IX Item "Ps = 1011 (rxvt)" +.ie n .IP "\fB\fB""Pm = 1011""\fB\fR (\fBrxvt\fR)" 4 +.el .IP "\fB\f(CBPm = 1011\fB\fR (\fBrxvt\fR)" 4 +.IX Item "Pm = 1011 (rxvt)" .TS l l . h Scroll to bottom when a key is pressed l Don't scroll to bottom when a key is pressed .TE - -.ie n .IP "\fB\fB""Ps = 1021""\fB\fR (\fBrxvt\fR)" 4 -.el .IP "\fB\f(CBPs = 1021\fB\fR (\fBrxvt\fR)" 4 -.IX Item "Ps = 1021 (rxvt)" +.ie n .IP "\fB\fB""Pm = 1021""\fB\fR (\fBrxvt\fR)" 4 +.el .IP "\fB\f(CBPm = 1021\fB\fR (\fBrxvt\fR)" 4 +.IX Item "Pm = 1021 (rxvt)" .TS l l . h Bold/italic implies high intensity (see option -is) l Font styles have no effect on intensity (Compile styles) .TE - -.ie n .IP "\fB\fB""Ps = 1047""\fB\fR" 4 -.el .IP "\fB\f(CBPs = 1047\fB\fR" 4 -.IX Item "Ps = 1047" +.ie n .IP "\fB\fB""Pm = 1047""\fB\fR" 4 +.el .IP "\fB\f(CBPm = 1047\fB\fR" 4 +.IX Item "Pm = 1047" .TS l l . h Use Alternate Screen Buffer l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it .TE - -.ie n .IP "\fB\fB""Ps = 1048""\fB\fR" 4 -.el .IP "\fB\f(CBPs = 1048\fB\fR" 4 -.IX Item "Ps = 1048" +.ie n .IP "\fB\fB""Pm = 1048""\fB\fR" 4 +.el .IP "\fB\f(CBPm = 1048\fB\fR" 4 +.IX Item "Pm = 1048" .TS l l . h Save cursor position l Restore cursor position .TE - -.ie n .IP "\fB\fB""Ps = 1049""\fB\fR" 4 -.el .IP "\fB\f(CBPs = 1049\fB\fR" 4 -.IX Item "Ps = 1049" +.ie n .IP "\fB\fB""Pm = 1049""\fB\fR" 4 +.el .IP "\fB\f(CBPm = 1049\fB\fR" 4 +.IX Item "Pm = 1049" .TS l l . h Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it l Use Normal Screen Buffer .TE - .RE .RS 4 .RE @@ -2278,7 +2230,6 @@ Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl). .TE - .SH "XPM" .IX Header "XPM" For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value @@ -2346,7 +2297,6 @@ l l . 2 Button3 pressed 3 button released (X11 mouse report) .TE - .PP The upper bits of \fB\f(CB\*(C`\*(C'\fB\fR indicate the modifiers when the button was pressed and are added together (X11 mouse report only): @@ -2360,7 +2310,6 @@ l l . 16 Control 32 Double Click (rxvt extension) .TE - Col = \fB\f(CB\*(C` \- SPACE\*(C'\fB\fR .Sp Row = \fB\f(CB\*(C` \- SPACE\*(C'\fB\fR @@ -2434,7 +2383,6 @@ XK_KP_7 7 ESC O w XK_KP_8 8 ESC O x XK_KP_9 9 ESC O y .TE - .SH "CONFIGURE OPTIONS" .IX Header "CONFIGURE OPTIONS" General hint: if you get compile errors, then likely your configuration @@ -2482,7 +2430,6 @@ jp common japanese encodings jp_ext rarely used but big japanese encodings kr korean encodings .TE - .IP "\-\-enable\-xim (default: on)" 4 .IX Item "--enable-xim (default: on)" Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using @@ -2600,28 +2547,29 @@ disable this. A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly in combination with other switches) is: .Sp -.Vb 15 -\& MWM-hints -\& EWMH-hints (pid, utf8 names) and protocols (ping) -\& seperate underline colour (-underlineColor) -\& settable border widths and borderless switch (-w, -b, -bl) -\& visual depth selection (-depth) -\& settable extra linespacing /-lsp) -\& iso-14755-2 and -3, and visual feedback -\& tripleclickwords (-tcw) -\& settable insecure mode (-insecure) +.Vb 10 +\& MWM\-hints +\& EWMH\-hints (pid, utf8 names) and protocols (ping) +\& seperate underline colour (\-underlineColor) +\& settable border widths and borderless switch (\-w, \-b, \-bl) +\& visual depth selection (\-depth) +\& settable extra linespacing /\-lsp) +\& iso\-14755\-2 and \-3, and visual feedback +\& tripleclickwords (\-tcw) +\& settable insecure mode (\-insecure) \& keysym remapping support -\& cursor blinking and underline cursor (-cb, -uc) -\& XEmbed support (-embed) -\& user-pty (-pty-fd) -\& hold on exit (-hold) -\& skip builtin block graphics (-sbg) +\& cursor blinking and underline cursor (\-cb, \-uc) +\& XEmbed support (\-embed) +\& user\-pty (\-pty\-fd) +\& hold on exit (\-hold) +\& skip builtin block graphics (\-sbg) +\& separate highlightcolor support (\-hc) .Ve .Sp -It also enabled some non-essential features otherwise disabled, such as: +It also enables some non-essential features otherwise disabled, such as: .Sp .Vb 11 -\& some round-trip time optimisations +\& some round\-trip time optimisations \& nearest color allocation on pseudocolor screens \& UTF8_STRING supporr for selection \& sgr modes 90..97 and 100..107 @@ -2712,3 +2660,12 @@ Marc Lehmann converted this document to pod and reworked it from the original Rxvt documentation, which was done by Geoff Wing , who in turn used the XTerm documentation and other sources. +.SH "POD ERRORS" +.IX Header "POD ERRORS" +Hey! \fBThe above document had some coding errors, which are explained below:\fR +.IP "Around line 2952:" 4 +.IX Item "Around line 2952:" +=back doesn't take any parameters, but you said =back X +.IP "Around line 3048:" 4 +.IX Item "Around line 3048:" +=back doesn't take any parameters, but you said =back X diff --git a/doc/rxvt.7.pod b/doc/rxvt.7.pod index 37082fc5..bb92e642 100644 --- a/doc/rxvt.7.pod +++ b/doc/rxvt.7.pod @@ -2405,8 +2405,9 @@ in combination with other switches) is: user-pty (-pty-fd) hold on exit (-hold) skip builtin block graphics (-sbg) + separate highlightcolor support (-hc) -It also enabled some non-essential features otherwise disabled, such as: +It also enables some non-essential features otherwise disabled, such as: some round-trip time optimisations nearest color allocation on pseudocolor screens diff --git a/doc/rxvt.7.txt b/doc/rxvt.7.txt index d707a43e..c25a603b 100644 --- a/doc/rxvt.7.txt +++ b/doc/rxvt.7.txt @@ -185,7 +185,7 @@ RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) - /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) + /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) No large bloated libraries (of course, none were linked in statically), except maybe libX11 :) @@ -1004,7 +1004,7 @@ RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS xprop -root XIM_SERVERS - * + My input method wants but I want UTF-8, what can I do? You can specify separate locales for the input method and the rest of @@ -1261,14 +1261,13 @@ RXVT-UNICODE TECHNICAL REFERENCE Where "C" is one of: - C = 0 DEC Special Character and Line Drawing Set - C = A United Kingdom (UK) - C = B United States (USASCII) - C = < Multinational character set unimplemented - C = 5 Finnish character set unimplemented - C = C Finnish character set unimplemented - C = K German character set unimplemented - + C = 0 DEC Special Character and Line Drawing Set + C = A United Kingdom (UK) + C = B United States (USASCII) + C = < Multinational character set unimplemented + C = 5 Finnish character set unimplemented + C = C Finnish character set unimplemented + C = K German character set unimplemented CSI (Command Sequence Introducer) Sequences @@ -1305,17 +1304,15 @@ RXVT-UNICODE TECHNICAL REFERENCE "ESC [ Ps J" Erase in Display (ED) - Ps = 0 Clear Below (default) - Ps = 1 Clear Above - Ps = 2 Clear All - + Ps = 0 Clear Below (default) + Ps = 1 Clear Above + Ps = 2 Clear All "ESC [ Ps K" Erase in Line (EL) - Ps = 0 Clear to Right (default) - Ps = 1 Clear to Left - Ps = 2 Clear All - + Ps = 0 Clear to Right (default) + Ps = 1 Clear to Left + Ps = 2 Clear All "ESC [ Ps L" Insert "Ps" Line(s) [default: 1] (IL) @@ -1332,10 +1329,9 @@ RXVT-UNICODE TECHNICAL REFERENCE "ESC [ Ps W" Tabulator functions - Ps = 0 Tab Set (HTS) - Ps = 2 Tab Clear (TBC), Clear Current Column (default) - Ps = 5 Tab Clear (TBC), Clear All - + Ps = 0 Tab Set (HTS) + Ps = 2 Tab Clear (TBC), Clear Current Column (default) + Ps = 5 Tab Clear (TBC), Clear All "ESC [ Ps X" Erase "Ps" Character(s) [default: 1] (ECH) @@ -1365,69 +1361,64 @@ RXVT-UNICODE TECHNICAL REFERENCE "ESC [ Ps g" Tab Clear (TBC) - Ps = 0 Clear Current Column (default) - Ps = 3 Clear All (TBC) - + Ps = 0 Clear Current Column (default) + Ps = 3 Clear All (TBC) "ESC [ Pm h" Set Mode (SM). See "ESC [ Pm l" sequence for description of "Pm". "ESC [ Ps i" Printing. See also the "print-pipe" resource. - Ps = 0 print screen (MC0) - Ps = 4 disable transparent print mode (MC4) - Ps = 5 enable transparent print mode (MC5) - + Ps = 0 print screen (MC0) + Ps = 4 disable transparent print mode (MC4) + Ps = 5 enable transparent print mode (MC5) "ESC [ Pm l" Reset Mode (RM) + h Insert Mode (SMIR) + l Replace Mode (RMIR) "Ps = 4" - h Insert Mode (SMIR) - l Replace Mode (RMIR) - + h Automatic Newline (LNM) + l Normal Linefeed (LNM) "Ps = 20" (partially implemented) - h Automatic Newline (LNM) - l Normal Linefeed (LNM) "ESC [ Pm m" Character Attributes (SGR) - Ps = 0 Normal (default) - Ps = 1 / 21 On / Off Bold (bright fg) - Ps = 3 / 23 On / Off Italic - Ps = 4 / 24 On / Off Underline - Ps = 5 / 25 On / Off Slow Blink (bright bg) - Ps = 6 / 26 On / Off Rapid Blink (bright bg) - Ps = 7 / 27 On / Off Inverse - Ps = 8 / 27 On / Off Invisible (NYI) - Ps = 30 / 40 fg/bg Black - Ps = 31 / 41 fg/bg Red - Ps = 32 / 42 fg/bg Green - Ps = 33 / 43 fg/bg Yellow - Ps = 34 / 44 fg/bg Blue - Ps = 35 / 45 fg/bg Magenta - Ps = 36 / 46 fg/bg Cyan - Ps = 38;5 / 48;5 set fg/bg to color #m (ISO 8613-6) - Ps = 37 / 47 fg/bg White - Ps = 39 / 49 fg/bg Default - Ps = 90 / 100 fg/bg Bright Black - Ps = 91 / 101 fg/bg Bright Red - Ps = 92 / 102 fg/bg Bright Green - Ps = 93 / 103 fg/bg Bright Yellow - Ps = 94 / 104 fg/bg Bright Blue - Ps = 95 / 105 fg/bg Bright Magenta - Ps = 96 / 106 fg/bg Bright Cyan - Ps = 97 / 107 fg/bg Bright White - Ps = 99 / 109 fg/bg Bright Default - + Ps = 0 Normal (default) + Ps = 1 / 21 On / Off Bold (bright fg) + Ps = 3 / 23 On / Off Italic + Ps = 4 / 24 On / Off Underline + Ps = 5 / 25 On / Off Slow Blink (bright bg) + Ps = 6 / 26 On / Off Rapid Blink (bright bg) + Ps = 7 / 27 On / Off Inverse + Ps = 8 / 27 On / Off Invisible (NYI) + Ps = 30 / 40 fg/bg Black + Ps = 31 / 41 fg/bg Red + Ps = 32 / 42 fg/bg Green + Ps = 33 / 43 fg/bg Yellow + Ps = 34 / 44 fg/bg Blue + Ps = 35 / 45 fg/bg Magenta + Ps = 36 / 46 fg/bg Cyan + Ps = 38;5 / 48;5 set fg/bg to color #m (ISO 8613-6) + Ps = 37 / 47 fg/bg White + Ps = 39 / 49 fg/bg Default + Ps = 90 / 100 fg/bg Bright Black + Ps = 91 / 101 fg/bg Bright Red + Ps = 92 / 102 fg/bg Bright Green + Ps = 93 / 103 fg/bg Bright Yellow + Ps = 94 / 104 fg/bg Bright Blue + Ps = 95 / 105 fg/bg Bright Magenta + Ps = 96 / 106 fg/bg Bright Cyan + Ps = 97 / 107 fg/bg Bright White + Ps = 99 / 109 fg/bg Bright Default "ESC [ Ps n" Device Status Report (DSR) - Ps = 5 Status Report ESC [ 0 n (``OK'') - Ps = 6 Report Cursor Position (CPR) [row;column] as ESC [ r ; c R - Ps = 7 Request Display Name - Ps = 8 Request Version Number (place in window title) - + Ps = 5 Status Report ESC [ 0 n (``OK'') + Ps = 6 Report Cursor Position (CPR) [row;column] as ESC [ r ; c R + Ps = 7 Request Display Name + Ps = 8 Request Version Number (place in window title) "ESC [ Ps;Ps r" Set Scrolling Region [top;bottom] [default: full size of window] (CSR) @@ -1438,23 +1429,22 @@ RXVT-UNICODE TECHNICAL REFERENCE "ESC [ Ps;Pt t" Window Operations - Ps = 1 Deiconify (map) window - Ps = 2 Iconify window - Ps = 3 ESC [ 3 ; X ; Y t Move window to (X|Y) - Ps = 4 ESC [ 4 ; H ; W t Resize to WxH pixels - Ps = 5 Raise window - Ps = 6 Lower window - Ps = 7 Refresh screen once - Ps = 8 ESC [ 8 ; R ; C t Resize to R rows and C columns - Ps = 11 Report window state (responds with Ps = 1 or Ps = 2) - Ps = 13 Report window position (responds with Ps = 3) - Ps = 14 Report window pixel size (responds with Ps = 4) - Ps = 18 Report window text size (responds with Ps = 7) - Ps = 19 Currently the same as Ps = 18, but responds with Ps = 9 - Ps = 20 Reports icon label (ESC ] L NAME \234) - Ps = 21 Reports window title (ESC ] l NAME \234) - Ps = 24.. Set window height to Ps rows - + Ps = 1 Deiconify (map) window + Ps = 2 Iconify window + Ps = 3 ESC [ 3 ; X ; Y t Move window to (X|Y) + Ps = 4 ESC [ 4 ; H ; W t Resize to WxH pixels + Ps = 5 Raise window + Ps = 6 Lower window + Ps = 7 Refresh screen once + Ps = 8 ESC [ 8 ; R ; C t Resize to R rows and C columns + Ps = 11 Report window state (responds with Ps = 1 or Ps = 2) + Ps = 13 Report window position (responds with Ps = 3) + Ps = 14 Report window pixel size (responds with Ps = 4) + Ps = 18 Report window text size (responds with Ps = 7) + Ps = 19 Currently the same as Ps = 18, but responds with Ps = 9 + Ps = 20 Reports icon label (ESC ] L NAME \234) + Ps = 21 Reports window title (ESC ] l NAME \234) + Ps = 24.. Set window height to Ps rows "ESC [ u" Restore Cursor @@ -1479,115 +1469,89 @@ RXVT-UNICODE TECHNICAL REFERENCE "ESC [ ? Pm t" Toggle DEC Private Mode Values (rxvt extension). *where* - "Ps = 1" (DECCKM) - h Application Cursor Keys - l Normal Cursor Keys - - "Ps = 2" (ANSI/VT52 mode) - h Enter VT52 mode - l Enter VT52 mode - - "Ps = 3" - h 132 Column Mode (DECCOLM) - l 80 Column Mode (DECCOLM) - - "Ps = 4" - h Smooth (Slow) Scroll (DECSCLM) - l Jump (Fast) Scroll (DECSCLM) - - "Ps = 5" - h Reverse Video (DECSCNM) - l Normal Video (DECSCNM) - - "Ps = 6" - h Origin Mode (DECOM) - l Normal Cursor Mode (DECOM) - - "Ps = 7" - h Wraparound Mode (DECAWM) - l No Wraparound Mode (DECAWM) - - "Ps = 8" *unimplemented* - h Auto-repeat Keys (DECARM) - l No Auto-repeat Keys (DECARM) - - "Ps = 9" X10 XTerm - h Send Mouse X & Y on button press. - l No mouse reporting. - - "Ps = 25" - h Visible cursor {cnorm/cvvis} - l Invisible cursor {civis} - - "Ps = 30" - h scrollBar visisble - l scrollBar invisisble - - "Ps = 35" (rxvt) - h Allow XTerm Shift+key sequences - l Disallow XTerm Shift+key sequences - - "Ps = 38" *unimplemented* + h Application Cursor Keys + l Normal Cursor Keys + "Pm = 1" (DECCKM) + h Enter VT52 mode + l Enter VT52 mode + "Pm = 2" (ANSI/VT52 mode) + h 132 Column Mode (DECCOLM) + l 80 Column Mode (DECCOLM) + "Pm = 3" + h Smooth (Slow) Scroll (DECSCLM) + l Jump (Fast) Scroll (DECSCLM) + "Pm = 4" + h Reverse Video (DECSCNM) + l Normal Video (DECSCNM) + "Pm = 5" + h Origin Mode (DECOM) + l Normal Cursor Mode (DECOM) + "Pm = 6" + h Wraparound Mode (DECAWM) + l No Wraparound Mode (DECAWM) + "Pm = 7" + h Auto-repeat Keys (DECARM) + l No Auto-repeat Keys (DECARM) + "Pm = 8" *unimplemented* + h Send Mouse X & Y on button press. + l No mouse reporting. + "Pm = 9" X10 XTerm + h Visible cursor {cnorm/cvvis} + l Invisible cursor {civis} + "Pm = 25" + h scrollBar visisble + l scrollBar invisisble + "Pm = 30" + h Allow XTerm Shift+key sequences + l Disallow XTerm Shift+key sequences + "Pm = 35" (rxvt) + "Pm = 38" *unimplemented* Enter Tektronix Mode (DECTEK) - "Ps = 40" - h Allow 80/132 Mode - l Disallow 80/132 Mode - - "Ps = 44" *unimplemented* - h Turn On Margin Bell - l Turn Off Margin Bell - - "Ps = 45" *unimplemented* - h Reverse-wraparound Mode - l No Reverse-wraparound Mode - - "Ps = 46" *unimplemented* - "Ps = 47" - h Use Alternate Screen Buffer - l Use Normal Screen Buffer - - - - "Ps = 66" - h Application Keypad (DECPAM) == ESC = - l Normal Keypad (DECPNM) == ESC > - - "Ps = 67" - h Backspace key sends BS (DECBKM) - l Backspace key sends DEL - - "Ps = 1000" (X11 XTerm) - h Send Mouse X & Y on button press and release. - l No mouse reporting. - - "Ps = 1001" (X11 XTerm) *unimplemented* - h Use Hilite Mouse Tracking. - l No mouse reporting. - - "Ps = 1010" (rxvt) - h Don't scroll to bottom on TTY output - l Scroll to bottom on TTY output - - "Ps = 1011" (rxvt) - h Scroll to bottom when a key is pressed - l Don't scroll to bottom when a key is pressed - - "Ps = 1021" (rxvt) - h Bold/italic implies high intensity (see option -is) - l Font styles have no effect on intensity (Compile styles) - - "Ps = 1047" - h Use Alternate Screen Buffer - l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it - - "Ps = 1048" - h Save cursor position - l Restore cursor position - - "Ps = 1049" - h Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it - l Use Normal Screen Buffer + h Allow 80/132 Mode + l Disallow 80/132 Mode + "Pm = 40" + h Turn On Margin Bell + l Turn Off Margin Bell + "Pm = 44" *unimplemented* + h Reverse-wraparound Mode + l No Reverse-wraparound Mode + "Pm = 45" *unimplemented* + "Pm = 46" *unimplemented* + h Use Alternate Screen Buffer + l Use Normal Screen Buffer + "Pm = 47" + + h Application Keypad (DECPAM) == ESC = + l Normal Keypad (DECPNM) == ESC > + "Pm = 66" + h Backspace key sends BS (DECBKM) + l Backspace key sends DEL + "Pm = 67" + h Send Mouse X & Y on button press and release. + l No mouse reporting. + "Pm = 1000" (X11 XTerm) + h Use Hilite Mouse Tracking. + l No mouse reporting. + "Pm = 1001" (X11 XTerm) *unimplemented* + h Don't scroll to bottom on TTY output + l Scroll to bottom on TTY output + "Pm = 1010" (rxvt) + h Scroll to bottom when a key is pressed + l Don't scroll to bottom when a key is pressed + "Pm = 1011" (rxvt) + h Bold/italic implies high intensity (see option -is) + l Font styles have no effect on intensity (Compile styles) + "Pm = 1021" (rxvt) + h Use Alternate Screen Buffer + l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it + "Pm = 1047" + h Save cursor position + l Restore cursor position + "Pm = 1048" + h Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it + l Use Normal Screen Buffer + "Pm = 1049" @@ -1598,38 +1562,37 @@ RXVT-UNICODE TECHNICAL REFERENCE accepted. any octet can be escaped by prefixing it with SYN (0x16, ^V). - Ps = 0 Change Icon Name and Window Title to Pt - Ps = 1 Change Icon Name to Pt - Ps = 2 Change Window Title to Pt - Ps = 3 If Pt starts with a ?, query the (STRING) property of the window and return it. If Pt contains a =, set the named property to the given value, else delete the specified property. - Ps = 4 Pt is a semi-colon separated sequence of one or more semi-colon separated number/name pairs, where number is an index to a colour and name is the name of a colour. Each pair causes the numbered colour to be changed to name. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white - Ps = 10 Change colour of text foreground to Pt (NB: may change in future) - Ps = 11 Change colour of text background to Pt (NB: may change in future) - Ps = 12 Change colour of text cursor foreground to Pt - Ps = 13 Change colour of mouse foreground to Pt - Ps = 17 Change colour of highlight characters to Pt - Ps = 18 Change colour of bold characters to Pt [deprecated, see 706] - Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707] - Ps = 20 Change background pixmap parameters (see section XPM) (Compile XPM). - Ps = 39 Change default foreground colour to Pt. - Ps = 46 Change Log File to Pt unimplemented - Ps = 49 Change default background colour to Pt. - Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n - Ps = 55 Log all scrollback buffer and all of screen to Pt - Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). - Ps = 702 Request version if Pt is ?, returning rxvt-unicode, the resource name, the major and minor version numbers, e.g. ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST. - Ps = 704 Change colour of italic characters to Pt - Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). - Ps = 706 Change colour of bold characters to Pt - Ps = 707 Change colour of underlined characters to Pt - Ps = 710 Set normal fontset to Pt. Same as Ps = 50. - Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles). - Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles). - Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles). - Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). - Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). - Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl). - + Ps = 0 Change Icon Name and Window Title to Pt + Ps = 1 Change Icon Name to Pt + Ps = 2 Change Window Title to Pt + Ps = 3 If Pt starts with a ?, query the (STRING) property of the window and return it. If Pt contains a =, set the named property to the given value, else delete the specified property. + Ps = 4 Pt is a semi-colon separated sequence of one or more semi-colon separated number/name pairs, where number is an index to a colour and name is the name of a colour. Each pair causes the numbered colour to be changed to name. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white + Ps = 10 Change colour of text foreground to Pt (NB: may change in future) + Ps = 11 Change colour of text background to Pt (NB: may change in future) + Ps = 12 Change colour of text cursor foreground to Pt + Ps = 13 Change colour of mouse foreground to Pt + Ps = 17 Change colour of highlight characters to Pt + Ps = 18 Change colour of bold characters to Pt [deprecated, see 706] + Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707] + Ps = 20 Change background pixmap parameters (see section XPM) (Compile XPM). + Ps = 39 Change default foreground colour to Pt. + Ps = 46 Change Log File to Pt unimplemented + Ps = 49 Change default background colour to Pt. + Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n + Ps = 55 Log all scrollback buffer and all of screen to Pt + Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). + Ps = 702 Request version if Pt is ?, returning rxvt-unicode, the resource name, the major and minor version numbers, e.g. ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST. + Ps = 704 Change colour of italic characters to Pt + Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). + Ps = 706 Change colour of bold characters to Pt + Ps = 707 Change colour of underlined characters to Pt + Ps = 710 Set normal fontset to Pt. Same as Ps = 50. + Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles). + Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles). + Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles). + Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). + Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). + Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl). XPM For the XPM XTerm escape sequence "ESC ] 20 ; Pt ST" then value of "Pt" can be the name of the background pixmap followed by a sequence of @@ -1685,21 +1648,20 @@ Mouse Reporting The lower 2 bits of "" indicate the button: + 0 Button1 pressed + 1 Button2 pressed + 2 Button3 pressed + 3 button released (X11 mouse report) Button = "( - SPACE) & 3" - 0 Button1 pressed - 1 Button2 pressed - 2 Button3 pressed - 3 button released (X11 mouse report) The upper bits of "" indicate the modifiers when the button was pressed and are added together (X11 mouse report only): + 4 Shift + 8 Meta + 16 Control + 32 Double Click (rxvt extension) State = "( - SPACE) & 60" - 4 Shift - 8 Meta - 16 Control - 32 Double Click (rxvt extension) - Col = " - SPACE" Row = " - SPACE" @@ -1712,65 +1674,64 @@ Key Codes off, toggle Application-Keypad setting. Also note that values of Home, End, Delete may have been compiled differently on your system. - Normal Shift Control Ctrl+Shift - Tab ^I ESC [ Z ^I ESC [ Z - BackSpace ^H ^? ^? ^? - Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @ - Insert ESC [ 2 ~ paste ESC [ 2 ^ ESC [ 2 @ - Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ - Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @ - Prior ESC [ 5 ~ scroll-up ESC [ 5 ^ ESC [ 5 @ - Next ESC [ 6 ~ scroll-down ESC [ 6 ^ ESC [ 6 @ - Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @ - End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @ - Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ - F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^ - F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^ - F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^ - F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^ - F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^ - F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^ - F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^ - F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^ - F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^ - F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^ - F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @ - F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @ - F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @ - F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @ - F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @ - F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @ - F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @ - F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @ - F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @ - F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @ - Application - Up ESC [ A ESC [ a ESC O a ESC O A - Down ESC [ B ESC [ b ESC O b ESC O B - Right ESC [ C ESC [ c ESC O c ESC O C - Left ESC [ D ESC [ d ESC O d ESC O D - KP_Enter ^M ESC O M - KP_F1 ESC O P ESC O P - KP_F2 ESC O Q ESC O Q - KP_F3 ESC O R ESC O R - KP_F4 ESC O S ESC O S - XK_KP_Multiply * ESC O j - XK_KP_Add + ESC O k - XK_KP_Separator , ESC O l - XK_KP_Subtract - ESC O m - XK_KP_Decimal . ESC O n - XK_KP_Divide / ESC O o - XK_KP_0 0 ESC O p - XK_KP_1 1 ESC O q - XK_KP_2 2 ESC O r - XK_KP_3 3 ESC O s - XK_KP_4 4 ESC O t - XK_KP_5 5 ESC O u - XK_KP_6 6 ESC O v - XK_KP_7 7 ESC O w - XK_KP_8 8 ESC O x - XK_KP_9 9 ESC O y - + Normal Shift Control Ctrl+Shift + Tab ^I ESC [ Z ^I ESC [ Z + BackSpace ^H ^? ^? ^? + Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @ + Insert ESC [ 2 ~ paste ESC [ 2 ^ ESC [ 2 @ + Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ + Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @ + Prior ESC [ 5 ~ scroll-up ESC [ 5 ^ ESC [ 5 @ + Next ESC [ 6 ~ scroll-down ESC [ 6 ^ ESC [ 6 @ + Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @ + End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @ + Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ + F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^ + F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^ + F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^ + F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^ + F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^ + F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^ + F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^ + F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^ + F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^ + F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^ + F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @ + F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @ + F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @ + F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @ + F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @ + F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @ + F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @ + F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @ + F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @ + F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @ + Application + Up ESC [ A ESC [ a ESC O a ESC O A + Down ESC [ B ESC [ b ESC O b ESC O B + Right ESC [ C ESC [ c ESC O c ESC O C + Left ESC [ D ESC [ d ESC O d ESC O D + KP_Enter ^M ESC O M + KP_F1 ESC O P ESC O P + KP_F2 ESC O Q ESC O Q + KP_F3 ESC O R ESC O R + KP_F4 ESC O S ESC O S + XK_KP_Multiply * ESC O j + XK_KP_Add + ESC O k + XK_KP_Separator , ESC O l + XK_KP_Subtract - ESC O m + XK_KP_Decimal . ESC O n + XK_KP_Divide / ESC O o + XK_KP_0 0 ESC O p + XK_KP_1 1 ESC O q + XK_KP_2 2 ESC O r + XK_KP_3 3 ESC O s + XK_KP_4 4 ESC O t + XK_KP_5 5 ESC O u + XK_KP_6 6 ESC O v + XK_KP_7 7 ESC O w + XK_KP_8 8 ESC O x + XK_KP_9 9 ESC O y CONFIGURE OPTIONS General hint: if you get compile errors, then likely your configuration hasn't been tested well. Either try with "--enable-everything" or use @@ -1810,13 +1771,12 @@ CONFIGURE OPTIONS about 700kB), but it doesn't increase memory usage unless you use a font requiring one of these encodings. - all all available codeset groups - zh common chinese encodings - zh_ext rarely used but very big chinese encodigs - jp common japanese encodings - jp_ext rarely used but big japanese encodings - kr korean encodings - + all all available codeset groups + zh common chinese encodings + zh_ext rarely used but very big chinese encodigs + jp common japanese encodings + jp_ext rarely used but big japanese encodings + kr korean encodings --enable-xim (default: on) Add support for XIM (X Input Method) protocol. This allows using alternative input methods (e.g. kinput2) and will also correctly set @@ -1950,8 +1910,9 @@ CONFIGURE OPTIONS user-pty (-pty-fd) hold on exit (-hold) skip builtin block graphics (-sbg) + separate highlightcolor support (-hc) - It also enabled some non-essential features otherwise disabled, such + It also enables some non-essential features otherwise disabled, such as: some round-trip time optimisations @@ -2043,3 +2004,13 @@ AUTHORS Geoff Wing , who in turn used the XTerm documentation and other sources. +POD ERRORS + Hey! The above document had some coding errors, which are explained + below: + + Around line 2952: + =back doesn't take any parameters, but you said =back X + + Around line 3048: + =back doesn't take any parameters, but you said =back X + diff --git a/doc/rxvtperl.3.html b/doc/rxvtperl.3.html index 4feb2320..8e86c5e1 100644 --- a/doc/rxvtperl.3.html +++ b/doc/rxvtperl.3.html @@ -1,7 +1,9 @@ + rxvtperl - rxvt-unicode's embedded perl interpreter + @@ -88,14 +90,14 @@ find them in /opt/rxvt/lib/urxvt/perl/.

   URxvt.perl-ext-common: default,automove-background,selection-autotransform
-
selection (enabled by default)
-
+
selection (enabled by default) +
-(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 ---quoting-style=shell. +--quoting-style=shell.

A double-click usually selects the word under the cursor, further clicks @@ -140,21 +142,22 @@ interesting uses, such as parsing a line from beginning to end.

This extension also offers following bindable keyboard commands:

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

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

    URxvt.keysym.C-M-r: perl:selection:rot13
-

-
option-popup (enabled by default)
-
+ +
+
option-popup (enabled by default) +
-Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at -runtime. +

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

Other extensions can extend this popup menu by pushing a code reference @@ -178,13 +181,13 @@ first argument.

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

-
selection-popup (enabled by default)
-
+ +
selection-popup (enabled by default) +
-Binds a popup menu to Ctrl-Button3 that lets you convert the selection +

Binds a popup menu to Ctrl-Button3 that lets you convert the selection text into various other formats/action (such as uri unescaping, perl -evaluation, web-browser starting etc.), depending on content. +evaluation, web-browser starting etc.), depending on content.

Other extensions can extend this popup menu by pushing a code reference @@ -210,14 +213,14 @@ the selection to bs, but only if the selection currently contains a : () };

-

-
searchable-scrollback<hotkey> (enabled by default)
-
+ +
searchable-scrollback<hotkey> (enabled by default) +
-Adds regex search functionality to the scrollback buffer, triggered +

Adds regex search functionality to the scrollback buffer, triggered by a hotkey (default: M-s). While in search mode, normal terminal input/output is suspended and a regex is displayed at the bottom of the -screen. +screen.

Inputting characters appends them to the regex and continues incremental @@ -228,36 +231,44 @@ was started, while Enter or Return stay at the current additionally stores the first match in the current line into the primary selection.

-

-
readline (enabled by default)
-
-A support package that tries to make editing with readline easier. At +

The regex defaults to ``(?i)'', resulting in a case-insensitive search. To +get a case-sensitive search you can delete this prefix using BackSpace +or simply use an uppercase character which removes the ``(?i)'' prefix.

+
+
+

See perlre for more info about perl regular expression syntax.

+
+ +
readline (enabled by default) + +
+

A support package that tries to make editing with readline easier. At the moment, it reacts to clicking shift-left mouse button by trying to move the text cursor to this position. It does so by generating as many cursor-left or cursor-right keypresses as required (the this only works -for programs that correctly support wide characters). +for programs that correctly support wide characters).

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

-
- the tty is in ICANON state.
-
-
- the text cursor is visible.
-
-
- the primary screen is currently being displayed.
-
-
- the mouse is on the same (multi-row-) line as the text cursor.
-
+
- the tty is in ICANON state. + +
- the text cursor is visible. + +
- the primary screen is currently being displayed. + +
- the mouse is on the same (multi-row-) line as the text cursor. +

The normal selection mechanism isn't disabled, so quick successive clicks might interfere with selection creation in harmless ways.

-
selection-autotransform
-
+
selection-autotransform +
-This selection allows you to do automatic transforms on a selection -whenever a selection is made. +

This selection allows you to do automatic transforms on a selection +whenever a selection is made.

It works by specifying perl snippets (most useful is a single s/// @@ -303,14 +314,14 @@ FILENAME line YYY.''), you need a slightly more elaborate solution:

every error message as a selection pattern, and the second line transforms the message into vi commands to load the file.

-

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

This transforms the terminal into a tabbar with additional terminals, that is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one -button per tab. +button per tab.

Clicking a button will activate that tab. Pressing Shift-Left and @@ -333,23 +344,23 @@ following four resources (shown with defaults):

See COLOR AND GRAPHICS in the rxvt(1) manpage for valid indices.

-

-
mark-urls
-
+ +
mark-urls +
-Uses per-line display filtering (on_line_update) to underline urls and +

Uses per-line display filtering (on_line_update) to underline urls and make them clickable. When middle-clicked, the program specified in the resource urlLauncher (default x-www-browser) will be started with -the URL as first argument. +the URL as first argument.

-

-
xim-onthespot
-
+ +
xim-onthespot +
-This (experimental) perl extension implements OnTheSpot editing. It does +

This (experimental) perl extension implements OnTheSpot editing. It does not work perfectly, and some input methods don't seem to work well with OnTheSpot editing in general, but it seems to work at leats for SCIM and -kinput2. +kinput2.

You enable it by specifying this extension and a preedit style of @@ -359,39 +370,40 @@ kinput2. 

    rxvt -pt OnTheSpot -pe xim-onthespot
-

-
automove-background
-
+ +
automove-background +
-This is basically a one-line extension that dynamically changes the background pixmap offset -to the window position, in effect creating the same effect as pseudo transparency with -a custom pixmap. No scaling is supported in this mode. Exmaple: +

This is basically a very small extension that dynamically changes the +background pixmap offset to the window position, in effect creating the +same effect as pseudo transparency with a custom pixmap. No scaling is +supported in this mode. Exmaple:

    rxvt -pixmap background.xpm -pe automove-background
-

-
block-graphics-to-ascii
-
+ +
block-graphics-to-ascii +
-A not very useful example of filtering all text output to the terminal, +

A not very useful example of filtering all text output to the terminal by replacing all line-drawing characters (U+2500 .. U+259F) by a -similar-looking ascii character. +similar-looking ascii character.

-

-
digital-clock
-
+ +
digital-clock +
-Displays a digital clock using the built-in overlay. +

Displays a digital clock using the built-in overlay.

-

-
remote-clipboard
-
+ +
remote-clipboard +
-Somewhat of a misnomer, this extension adds two menu entries to the +

Somewhat of a misnomer, this extension adds two menu entries to the selection popup that allows one ti run external commands to store the -selection somewhere and fetch it again. +selection somewhere and fetch it again.

We use it to implement a ``distributed selection mechanism'', which just @@ -412,14 +424,14 @@ the selection data on STDOUT (also in UTF-8).

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

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

This is a little rarely useful extension that Uploads the selection as textfile to a remote site (or does other things). (The implementation is not currently secure for use in a multiuser environment as it writes to -/tmp directly.). +/tmp directly.).

It listens to the selection-pastebin:remote-pastebin keyboard command, @@ -454,15 +466,16 @@ for the filename):

    URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
-

-
example-refresh-hooks
-
+ +
example-refresh-hooks +
-Displays a very simple digital clock in the upper right corner of the +

Displays a very simple digital clock in the upper right corner of the window. Illustrates overwriting the refresh callbacks to create your own -overlays or changes. +overlays or changes.

-

+ +

@@ -482,32 +495,33 @@ terminal is destroyed.

Argument names also often indicate the type of a parameter. Here are some hints on what they mean:

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

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

-

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

A perl text string, with an emphasis on text. It can store all unicode characters and is to be distinguished with text encoded in a specific -encoding (often locale-specific) and binary data. +encoding (often locale-specific) and binary data.

-

-
$octets
-
+ +
$octets +
-Either binary data or - more common - a text string encoded in a -locale-specific way. +

Either binary data or - more common - a text string encoded in a +locale-specific way.

-

+ +

Extension Objects

-

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

Every perl extension is a perl class. A separate perl object is created for each terminal and each extension and passed as the first parameter to hooks. So extensions can use their $self object without having to think about other extensions, with the exception of methods and members that @@ -517,27 +531,28 @@ use.

urxvt::term class on this object.

It has the following methods and data members:

-
$urxvt_term = $self->{term}
-
+
$urxvt_term = $self->{term} +
-Returns the urxvt::term object associated with this instance of the -extension. This member must not be changed in any way. +

Returns the urxvt::term object associated with this instance of the +extension. This member must not be changed in any way.

-

-
$self->enable ($hook_name => $cb, [$hook_name => $cb..])
-
+ +
$self->enable ($hook_name => $cb, [$hook_name => $cb..]) +
-Dynamically enable the given hooks (named without the on_ prefix) for +

Dynamically enable the given hooks (named without the on_ prefix) for this extension, replacing any previous hook. This is useful when you want -to overwrite time-critical hooks only temporarily. +to overwrite time-critical hooks only temporarily.

-

-
$self->disable ($hook_name[, $hook_name..])
-
+ +
$self->disable ($hook_name[, $hook_name..]) +
-Dynamically disable the given hooks. +

Dynamically disable the given hooks.

-

+ +

Hooks

@@ -550,150 +565,163 @@ hooks returns true, then the event counts as being consumed, and the relevant action might not be carried out by the C++ code.

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

-
on_init $term
-
+
on_init $term +
-Called after a new terminal object has been initialized, but before +

Called after a new terminal object has been initialized, but before windows are created or the command gets run. Most methods are unsafe to call or deliver senseless data, as terminal size and other characteristics have not yet been determined. You can safely query and change resources and options, though. For many purposes the on_start hook is a better -place. +place.

-

-
on_start $term
-
+ +
on_start $term +
-Called at the very end of initialisation of a new terminal, just before -trying to map (display) the toplevel and returning to the mainloop. +

Called at the very end of initialisation of a new terminal, just before +trying to map (display) the toplevel and returning to the mainloop.

-

-
on_destroy $term
-
+ +
on_destroy $term +
-Called whenever something tries to destroy terminal, when the terminal is -still fully functional (not for long, though). +

Called whenever something tries to destroy terminal, when the terminal is +still fully functional (not for long, though).

-

-
on_reset $term
-
+ +
on_reset $term +
-Called after the screen is ``reset'' for any reason, such as resizing or +

Called after the screen is ``reset'' for any reason, such as resizing or control sequences. Here is where you can react on changes to size-related -variables. +variables.

-

-
on_child_start $term, $pid
-
+ +
on_child_start $term, $pid +
-Called just after the child process has been forked. +

Called just after the child process has been forked.

-

-
on_child_exit $term, $status
-
+ +
on_child_exit $term, $status +
-Called just after the child process has exited. $status is the status -from waitpid. +

Called just after the child process has exited. $status is the status +from waitpid.

-

-
on_sel_make $term, $eventtime
-
+ +
on_sel_make $term, $eventtime +
-Called whenever a selection has been made by the user, but before the +

Called whenever a selection has been made by the user, but before the selection text is copied, so changes to the beginning, end or type of the -selection will be honored. +selection will be honored.

Returning a true value aborts selection making by urxvt, in which case you have to make a selection yourself by calling $term->selection_grab.

-

-
on_sel_grab $term, $eventtime
-
+ +
on_sel_grab $term, $eventtime +
-Called whenever a selection has been copied, but before the selection is +

Called whenever a selection has been copied, but before the selection is requested from the server. The selection text can be queried and changed -by calling $term->selection. +by calling $term->selection.

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

-

-
on_sel_extend $term
-
+ +
on_sel_extend $term +
-Called whenever the user tries to extend the selection (e.g. with a double +

Called whenever the user tries to extend the selection (e.g. with a double click) and is either supposed to return false (normal operation), or should extend the selection itelf and return true to suppress the built-in processing. This can happen multiple times, as long as the callback returns true, it will be called on every further click by the user and is -supposed to enlarge the selection more and more, if possible. +supposed to enlarge the selection more and more, if possible.

See the selection example extension.

-

-
on_view_change $term, $offset
-
+ +
on_view_change $term, $offset +
-Called whenever the view offset changes, i..e the user or program +

Called whenever the view offset changes, i..e the user or program scrolls. Offset 0 means display the normal terminal, positive values -show this many lines of scrollback. +show this many lines of scrollback.

-

-
on_scroll_back $term, $lines, $saved
-
+ +
on_scroll_back $term, $lines, $saved +
-Called whenever lines scroll out of the terminal area into the scrollback +

Called whenever lines scroll out of the terminal area into the scrollback buffer. $lines is the number of lines scrolled out and may be larger -than the scroll back buffer or the terminal. +than the scroll back buffer or the terminal.

It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, $nrow - 1) represent the lines to be scrolled out). $saved is the total number of lines that will be in the scrollback buffer.

-

-
on_osc_seq $term, $string
-
+ +
on_osc_seq $term, $op, $args + +
+

Called on every OSC sequence and can be used to suppress it or modify its +behaviour. The default should be to return an empty list. A true value +suppresses execution of the request completely. Make sure you don't get +confused by recursive invocations when you output an osc sequence within +this callback.

+
+
+

on_osc_seq_perl should be used for new behaviour.

+
+ +
on_osc_seq_perl $term, $string +
-Called whenever the ESC ] 777 ; string ST command sequence (OSC = +

Called whenever the ESC ] 777 ; string ST command sequence (OSC = operating system command) is processed. Cursor position and other state information is up-to-date when this happens. For interoperability, the string should start with the extension name and a colon, to distinguish it from commands for other extensions, and this might be enforced in the -future. +future.

Be careful not ever to trust (in a security sense) the data you receive, as its source can not easily be controleld (e-mail content, messages from other users on the same system etc.).

-

-
on_add_lines $term, $string
-
+ +
on_add_lines $term, $string +
-Called whenever text is about to be output, with the text as argument. You +

Called whenever text is about to be output, with the text as argument. You can filter/change and output the text yourself by returning a true value and calling $term->scr_add_lines yourself. Please note that this might be very slow, however, as your hook is called for all text being -output. +output.

-

-
on_tt_write $term, $octets
-
+ +
on_tt_write $term, $octets +
-Called whenever some data is written to the tty/pty and can be used to -suppress or filter tty input. +

Called whenever some data is written to the tty/pty and can be used to +suppress or filter tty input.

-

-
on_line_update $term, $row
-
+ +
on_line_update $term, $row +
-Called whenever a line was updated or changed. Can be used to filter +

Called whenever a line was updated or changed. Can be used to filter screen output (e.g. underline urls or other useless stuff). Only lines that are being shown will be filtered, and, due to performance reasons, -not always immediately. +not always immediately.

The row number is always the topmost row of the line if the line spans @@ -704,85 +732,85 @@ multiple rows.

later with the already-modified line (e.g. if unrelated parts change), so you cannot just toggle rendition bits, but only set them.

-

-
on_refresh_begin $term
-
+ +
on_refresh_begin $term +
-Called just before the screen gets redrawn. Can be used for overlay +

Called just before the screen gets redrawn. Can be used for overlay or similar effects by modify terminal contents in refresh_begin, and restoring them in refresh_end. The built-in overlay and selection display -code is run after this hook, and takes precedence. +code is run after this hook, and takes precedence.

-

-
on_refresh_end $term
-
+ +
on_refresh_end $term +
-Called just after the screen gets redrawn. See on_refresh_begin. +

Called just after the screen gets redrawn. See on_refresh_begin.

-

-
on_user_command $term, $string
-
+ +
on_user_command $term, $string +
-Called whenever the a user-configured event is being activated (e.g. via +

Called whenever the a user-configured event is being activated (e.g. via a perl:string action bound to a key, see description of the keysym -resource in the rxvt(1) manpage). +resource in the rxvt(1) manpage).

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

-

-
on_resize_all_windows $tern, $new_width, $new_height
-
+ +
on_resize_all_windows $tern, $new_width, $new_height +
-Called just after the new window size has been calculcated, but before +

Called just after the new window size has been calculcated, but before windows are actually being resized or hints are being set. If this hook -returns TRUE, setting of the window hints is being skipped. +returns TRUE, setting of the window hints is being skipped.

-

-
on_x_event $term, $event
-
+ +
on_x_event $term, $event +
-Called on every X event received on the vt window (and possibly other +

Called on every X event received on the vt window (and possibly other windows). Should only be used as a last resort. Most event structure -members are not passed. -

-

-
on_focus_in $term
-
-
-Called whenever the window gets the keyboard focus, before rxvt-unicode -does focus in processing. -
-

-
on_focus_out $term
-
-
-Called wheneever the window loses keyboard focus, before rxvt-unicode does -focus out processing. -
-

-
on_configure_notify $term, $event
-
-
on_property_notify $term, $event
-
-
on_key_press $term, $event, $keysym, $octets
-
-
on_key_release $term, $event, $keysym
-
-
on_button_press $term, $event
-
-
on_button_release $term, $event
-
-
on_motion_notify $term, $event
-
-
on_map_notify $term, $event
-
-
on_unmap_notify $term, $event
-
-
-Called whenever the corresponding X event is received for the terminal If -the hook returns true, then the even will be ignored by rxvt-unicode. +members are not passed.

+
+ +
on_focus_in $term + +
+

Called whenever the window gets the keyboard focus, before rxvt-unicode +does focus in processing.

+
+ +
on_focus_out $term + +
+

Called wheneever the window loses keyboard focus, before rxvt-unicode does +focus out processing.

+
+ +
on_configure_notify $term, $event + +
on_property_notify $term, $event + +
on_key_press $term, $event, $keysym, $octets + +
on_key_release $term, $event, $keysym + +
on_button_press $term, $event + +
on_button_release $term, $event + +
on_motion_notify $term, $event + +
on_map_notify $term, $event + +
on_unmap_notify $term, $event + +
+

Called whenever the corresponding X event is received for the terminal If +the hook returns true, then the even will be ignored by rxvt-unicode.

The event is a hash with most values as named by Xlib (see the XEvent @@ -796,87 +824,89 @@ output, if any, in locale-specific encoding.

subwindow.

-

-
on_client_message $term, $event
-
-
on_wm_protocols $term, $event
-
-
on_wm_delete_window $term, $event
-
+ +
on_client_message $term, $event + +
on_wm_protocols $term, $event + +
on_wm_delete_window $term, $event +
-Called when various types of ClientMessage events are received (all with -format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). +

Called when various types of ClientMessage events are received (all with +format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).

-

+ +

Variables in the urxvt Package

-
$urxvt::LIBDIR
-
+
$urxvt::LIBDIR +
-The rxvt-unicode library directory, where, among other things, the perl -modules and scripts are stored. +

The rxvt-unicode library directory, where, among other things, the perl +modules and scripts are stored.

-

-
$urxvt::RESCLASS, $urxvt::RESCLASS
-
+ +
$urxvt::RESCLASS, $urxvt::RESCLASS +
-The resource class and name rxvt-unicode uses to look up X resources. +

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

-

-
$urxvt::RXVTNAME
-
+ +
$urxvt::RXVTNAME +
-The basename of the installed binaries, usually urxvt. +

The basename of the installed binaries, usually urxvt.

-

-
$urxvt::TERM
-
+ +
$urxvt::TERM +
-The current terminal. This variable stores the current urxvt::term -object, whenever a callback/hook is executing. +

The current terminal. This variable stores the current urxvt::term +object, whenever a callback/hook is executing.

-

-
@urxvt::TERM_INIT
-
+ +
@urxvt::TERM_INIT +
-All coderefs in this array will be called as methods of the next newly +

All coderefs in this array will be called as methods of the next newly created urxvt::term object (during the on_init phase). The array gets cleared before the codereferences that were in it are being executed, -so coderefs can push themselves onto it again if they so desire. +so coderefs can push themselves onto it again if they so desire.

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

-

-
@urxvt::TERM_EXT
-
+ +
@urxvt::TERM_EXT +
-Works similar to @TERM_INIT, but contains perl package/class names, which +

Works similar to @TERM_INIT, but contains perl package/class names, which get registered as normal extensions after calling the hooks in @TERM_INIT -but before other extensions. Gets cleared just like @TERM_INIT. +but before other extensions. Gets cleared just like @TERM_INIT.

-

+ +

Functions in the urxvt Package

 + +

RENDITION

@@ -937,60 +968,61 @@ never just create a bitset, you should always modify an existing one, as they contain important information required for correct operation of rxvt-unicode.

-
$rend = urxvt::DEFAULT_RSTYLE
-
+
$rend = urxvt::DEFAULT_RSTYLE +
-Returns the default rendition, as used when the terminal is starting up or -being reset. Useful as a base to start when creating renditions. +

Returns the default rendition, as used when the terminal is starting up or +being reset. Useful as a base to start when creating renditions.

-

-
$rend = urxvt::OVERLAY_RSTYLE
-
+ +
$rend = urxvt::OVERLAY_RSTYLE +
-Return the rendition mask used for overlays by default. +

Return the rendition mask used for overlays by default.

-

-
$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
-
+ +
$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline +
-Return the bit that enabled bold, italic, blink, reverse-video and +

Return the bit that enabled bold, italic, blink, reverse-video and underline, respectively. To enable such a style, just logically OR it into -the bitset. +the bitset.

-

-
$foreground = urxvt::GET_BASEFG $rend
-
-
$background = urxvt::GET_BASEBG $rend
-
+ +
$foreground = urxvt::GET_BASEFG $rend + +
$background = urxvt::GET_BASEBG $rend +
-Return the foreground/background colour index, respectively. +

Return the foreground/background colour index, respectively.

-

-
$rend = urxvt::SET_FGCOLOR $rend, $new_colour
-
-
$rend = urxvt::SET_BGCOLOR $rend, $new_colour
-
-
$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
-
+ +
$rend = urxvt::SET_FGCOLOR $rend, $new_colour + +
$rend = urxvt::SET_BGCOLOR $rend, $new_colour + +
$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg +
-Replace the foreground/background colour in the rendition mask with the -specified one. +

Replace the foreground/background colour in the rendition mask with the +specified one.

-

-
$value = urxvt::GET_CUSTOM $rend
-
+ +
$value = urxvt::GET_CUSTOM $rend +
-Return the ``custom'' value: Every rendition has 5 bits for use by +

Return the ``custom'' value: Every rendition has 5 bits for use by extensions. They can be set and changed as you like and are initially -zero. +zero.

-

-
$rend = urxvt::SET_CUSTOM $rend, $new_value
-
+ +
$rend = urxvt::SET_CUSTOM $rend, $new_value +
-Change the custom value. +

Change the custom value.

-

+ +

The urxvt::anyevent Class

@@ -1004,12 +1036,12 @@ work.

The urxvt::term Class

-
$term = new urxvt::term $envhashref, $rxvtname, [arg...]
-
+
$term = new urxvt::term $envhashref, $rxvtname, [arg...] +
-Creates a new terminal, very similar as if you had started it with system +

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

Croaks (and probably outputs an error message) if the new instance @@ -1018,33 +1050,33 @@ initialise perl, and the terminal object otherwise. The init and start hooks will be called before this call returns, and are free to refer to global data (which is race free).

-

-
$term->destroy
-
+ +
$term->destroy +
-Destroy the terminal object (close the window, free resources +

Destroy the terminal object (close the window, free resources etc.). Please note that rxvt will not exit as long as any event -watchers (timers, io watchers) are still active. +watchers (timers, io watchers) are still active.

-

-
$term->exec_async ($cmd[, @args])
-
+ +
$term->exec_async ($cmd[, @args]) +
-Works like the combination of the fork/exec builtins, which executes +

Works like the combination of the fork/exec builtins, which executes (``starts'') programs in the background. This function takes care of setting the user environment before exec'ing the command (e.g. PATH) and should -be preferred over explicit calls to exec or system. +be preferred over explicit calls to exec or system.

Returns the pid of the subprocess or undef on error.

-

-
$isset = $term->option ($optval[, $set])
-
+ +
$isset = $term->option ($optval[, $set]) +
-Returns true if the option specified by $optval is enabled, and +

Returns true if the option specified by $optval is enabled, and optionally change it. All option values are stored by name in the hash -%urxvt::OPTION. Options not enabled in this binary are not in the hash. +%urxvt::OPTION. Options not enabled in this binary are not in the hash.

Here is a a likely non-exhaustive list of option names, please see the @@ -1059,13 +1091,13 @@ source file /src/optinc.h to see the actual list:

scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs transparent tripleclickwords utmpInhibit visualBell
-

-
$value = $term->resource ($name[, $newval])
-
+ +
$value = $term->resource ($name[, $newval]) +
-Returns the current resource value associated with a given name and +

Returns the current resource value associated with a given name and optionally sets a new value. Setting values is most useful in the init -hook. Unset resources are returned and accepted as undef. +hook. Unset resources are returned and accepted as undef.

The new value must be properly encoded to a suitable character encoding @@ -1102,88 +1134,88 @@ to see the actual list:

transient_for transparent transparent_all tripleclickwords utmpInhibit visualBell
-

-
$value = $term->x_resource ($pattern)
-
+ +
$value = $term->x_resource ($pattern) +
-Returns the X-Resource for the given pattern, excluding the program or +

Returns the X-Resource for the given pattern, excluding the program or class name, i.e. $term->x_resource ("boldFont") should return the same value as used by this instance of rxvt-unicode. Returns undef if no -resource with that pattern exists. +resource with that pattern exists.

This method should only be called during the on_start hook, as there is only one resource database per display, and later invocations might return the wrong resources.

-

-
$success = $term->parse_keysym ($keysym_spec, $command_string)
-
+ +
$success = $term->parse_keysym ($keysym_spec, $command_string) +
-Adds a keymap translation exactly as specified via a resource. See the -keysym resource in the rxvt(1) manpage. +

Adds a keymap translation exactly as specified via a resource. See the +keysym resource in the rxvt(1) manpage.

-

-
$rend = $term->rstyle ([$new_rstyle])
-
+ +
$rend = $term->rstyle ([$new_rstyle]) +
-Return and optionally change the current rendition. Text that is output by -the terminal application will use this style. +

Return and optionally change the current rendition. Text that is output by +the terminal application will use this style.

-

-
($row, $col) = $term->screen_cur ([$row, $col])
-
+ +
($row, $col) = $term->screen_cur ([$row, $col]) +
-Return the current coordinates of the text cursor position and optionally -set it (which is usually bad as applications don't expect that). +

Return the current coordinates of the text cursor position and optionally +set it (which is usually bad as applications don't expect that).

-

-
($row, $col) = $term->selection_mark ([$row, $col])
-
-
($row, $col) = $term->selection_beg ([$row, $col])
-
-
($row, $col) = $term->selection_end ([$row, $col])
-
+ +
($row, $col) = $term->selection_mark ([$row, $col]) + +
($row, $col) = $term->selection_beg ([$row, $col]) + +
($row, $col) = $term->selection_end ([$row, $col]) +
-Return the current values of the selection mark, begin or end positions, -and optionally set them to new values. +

Return the current values of the selection mark, begin or end positions, +and optionally set them to new values.

-

-
$term->selection_make ($eventtime[, $rectangular])
-
+ +
$term->selection_make ($eventtime[, $rectangular]) +
-Tries to make a selection as set by selection_beg and +

Tries to make a selection as set by selection_beg and selection_end. If $rectangular is true (default: false), a rectangular selection will be made. This is the prefered function to make -a selection. +a selection.

-

-
$success = $term->selection_grab ($eventtime)
-
+ +
$success = $term->selection_grab ($eventtime) +
-Try to request the primary selection text from the server (for example, as +

Try to request the primary selection text from the server (for example, as set by the next method). No visual feedback will be given. This function -is mostly useful from within on_sel_grab hooks. +is mostly useful from within on_sel_grab hooks.

-

-
$oldtext = $term->selection ([$newtext])
-
+ +
$oldtext = $term->selection ([$newtext]) +
-Return the current selection text and optionally replace it by $newtext. +

Return the current selection text and optionally replace it by $newtext.

-

-
$term->overlay_simple ($x, $y, $text)
-
+ +
$term->overlay_simple ($x, $y, $text) +
-Create a simple multi-line overlay box. See the next method for details. +

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

-

-
$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
-
+ +
$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) +
-Create a new (empty) overlay at the given position with the given +

Create a new (empty) overlay at the given position with the given width/height. $rstyle defines the initial rendition style -(default: OVERLAY_RSTYLE). +(default: OVERLAY_RSTYLE).

If $border is 2 (default), then a decorative border will be put @@ -1201,273 +1233,274 @@ as long as the perl object is referenced.

The methods currently supported on urxvt::overlay objects are:

-
$overlay->set ($x, $y, $text, $rend)
-
+
$overlay->set ($x, $y, $text, $rend) +
-Similar to $term->ROW_t and $term->ROW_r in that it puts +

Similar to $term->ROW_t and $term->ROW_r in that it puts text in rxvt-unicode's special encoding and an array of rendition values -at a specific position inside the overlay. +at a specific position inside the overlay.

-

-
$overlay->hide
-
+ +
$overlay->hide +
-If visible, hide the overlay, but do not destroy it. +

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

-

-
$overlay->show
-
+ +
$overlay->show +
-If hidden, display the overlay again. +

If hidden, display the overlay again.

-

-
$popup = $term->popup ($event)
-
+ +
+
$popup = $term->popup ($event) +
-Creates a new urxvt::popup object that implements a popup menu. The +

Creates a new urxvt::popup object that implements a popup menu. The $event must be the event causing the menu to pop up (a button event, -currently). +currently).

-

-
$cellwidth = $term->strwidth ($string)
-
+ +
$cellwidth = $term->strwidth ($string) +
-Returns the number of screen-cells this string would need. Correctly -accounts for wide and combining characters. +

Returns the number of screen-cells this string would need. Correctly +accounts for wide and combining characters.

-

-
$octets = $term->locale_encode ($string)
-
+ +
$octets = $term->locale_encode ($string) +
-Convert the given text string into the corresponding locale encoding. +

Convert the given text string into the corresponding locale encoding.

-

-
$string = $term->locale_decode ($octets)
-
+ +
$string = $term->locale_decode ($octets) +
-Convert the given locale-encoded octets into a perl string. +

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

-

-
$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
-
+ +
$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) +
-XORs the rendition values in the given span with the provided value +

XORs the rendition values in the given span with the provided value (default: RS_RVid), which MUST NOT contain font styles. Useful in -refresh hooks to provide effects similar to the selection. +refresh hooks to provide effects similar to the selection.

-

-
$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
-
+ +
$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) +
-Similar to scr_xor_span, but xors a rectangle instead. Trailing +

Similar to scr_xor_span, but xors a rectangle instead. Trailing whitespace will additionally be xored with the $rstyle2, which defaults to RS_RVid | RS_Uline, which removes reverse video again and underlines -it instead. Both styles MUST NOT contain font styles. +it instead. Both styles MUST NOT contain font styles.

-

-
$term->scr_bell
-
+ +
$term->scr_bell +
-Ring the bell! +

Ring the bell!

-

-
$term->scr_add_lines ($string)
-
+ +
$term->scr_add_lines ($string) +
-Write the given text string to the screen, as if output by the application +

Write the given text string to the screen, as if output by the application running inside the terminal. It may not contain command sequences (escape codes), but is free to use line feeds, carriage returns and tabs. The -string is a normal text string, not in locale-dependent encoding. +string is a normal text string, not in locale-dependent encoding.

Normally its not a good idea to use this function, as programs might be confused by changes in cursor position or scrolling. Its useful inside a on_add_lines hook, though.

-

-
$term->scr_change_screen ($screen)
-
+ +
$term->scr_change_screen ($screen) +
-Switch to given screen - 0 primary, 1 secondary. +

Switch to given screen - 0 primary, 1 secondary.

-

-
$term->cmd_parse ($octets)
-
+ +
$term->cmd_parse ($octets) +
-Similar to scr_add_lines, but the argument must be in the +

Similar to scr_add_lines, but the argument must be in the locale-specific encoding of the terminal and can contain command sequences -(escape codes) that will be interpreted. +(escape codes) that will be interpreted.

-

-
$term->tt_write ($octets)
-
+ +
$term->tt_write ($octets) +
-Write the octets given in $data to the tty (i.e. as program input). To +

Write the octets given in $data to the tty (i.e. as program input). To pass characters instead of octets, you should convert your strings first -to the locale-specific encoding using $term->locale_encode. +to the locale-specific encoding using $term->locale_encode.

-

-
$old_events = $term->pty_ev_events ([$new_events])
-
+ +
$old_events = $term->pty_ev_events ([$new_events]) +
-Replaces the event mask of the pty watcher by the given event mask. Can +

Replaces the event mask of the pty watcher by the given event mask. Can be used to suppress input and output handling to the pty/tty. See the description of urxvt::timer->events. Make sure to always restore -the previous value. +the previous value.

-

-
$fd = $term->pty_fd
-
+ +
$fd = $term->pty_fd +
-Returns the master file descriptor for the pty in use, or -1 if no pty -is used. +

Returns the master file descriptor for the pty in use, or -1 if no pty +is used.

-

-
$windowid = $term->parent
-
+ +
$windowid = $term->parent +
-Return the window id of the toplevel window. +

Return the window id of the toplevel window.

-

-
$windowid = $term->vt
-
+ +
$windowid = $term->vt +
-Return the window id of the terminal window. +

Return the window id of the terminal window.

-

-
$term->vt_emask_add ($x_event_mask)
-
+ +
$term->vt_emask_add ($x_event_mask) +
-Adds the specified events to the vt event mask. Useful e.g. when you want -to receive pointer events all the times: +

Adds the specified events to the vt event mask. Useful e.g. when you want +to receive pointer events all the times:

    $term->vt_emask_add (urxvt::PointerMotionMask);
-

-
$term->focus_in
-
-
$term->focus_out
-
-
$term->key_press ($state, $keycode[, $time])
-
-
$term->key_release ($state, $keycode[, $time])
-
-
-Deliver various fake events to to terminal. -
-

-
$window_width = $term->width
-
-
$window_height = $term->height
-
-
$font_width = $term->fwidth
-
-
$font_height = $term->fheight
-
-
$font_ascent = $term->fbase
-
-
$terminal_rows = $term->nrow
-
-
$terminal_columns = $term->ncol
-
-
$has_focus = $term->focus
-
-
$is_mapped = $term->mapped
-
-
$max_scrollback = $term->saveLines
-
-
$nrow_plus_saveLines = $term->total_rows
-
-
$topmost_scrollback_row = $term->top_row
-
-
-Return various integers describing terminal characteristics. -
-

-
$x_display = $term->display_id
-
-
-Return the DISPLAY used by rxvt-unicode. -
-

-
$lc_ctype = $term->locale
-
-
-Returns the LC_CTYPE category string used by this rxvt-unicode. -
-

-
$env = $term->env
-
-
-Returns a copy of the environment in effect for the terminal as a hashref -similar to \%ENV. -
-

-
@envv = $term->envv
-
-
-Returns the environment as array of strings of the form VAR=VALUE. -
-

-
@argv = $term->argv
-
-
-Return the argument vector as this terminal, similar to @ARGV, but -includes the program name as first element. -
-

-
$modifiermask = $term->ModLevel3Mask
-
-
$modifiermask = $term->ModMetaMask
-
-
$modifiermask = $term->ModNumLockMask
-
-
-Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often -AltGr), the meta key (often Alt) and the num lock key, if applicable. -
-

-
$screen = $term->current_screen
-
-
-Returns the currently displayed screen (0 primary, 1 secondary). -
-

-
$cursor_is_hidden = $term->hidden_cursor
-
-
-Returns wether the cursor is currently hidden or not. -
-

-
$view_start = $term->view_start ([$newvalue])
-
-
-Returns the row number of the topmost displayed line. Maximum value is + +
$term->focus_in + +
$term->focus_out + +
$term->key_press ($state, $keycode[, $time]) + +
$term->key_release ($state, $keycode[, $time]) + +
+

Deliver various fake events to to terminal.

+
+ +
$window_width = $term->width + +
$window_height = $term->height + +
$font_width = $term->fwidth + +
$font_height = $term->fheight + +
$font_ascent = $term->fbase + +
$terminal_rows = $term->nrow + +
$terminal_columns = $term->ncol + +
$has_focus = $term->focus + +
$is_mapped = $term->mapped + +
$max_scrollback = $term->saveLines + +
$nrow_plus_saveLines = $term->total_rows + +
$topmost_scrollback_row = $term->top_row + +
+

Return various integers describing terminal characteristics.

+
+ +
$x_display = $term->display_id + +
+

Return the DISPLAY used by rxvt-unicode.

+
+ +
$lc_ctype = $term->locale + +
+

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

+
+ +
$env = $term->env + +
+

Returns a copy of the environment in effect for the terminal as a hashref +similar to \%ENV.

+
+ +
@envv = $term->envv + +
+

Returns the environment as array of strings of the form VAR=VALUE.

+
+ +
@argv = $term->argv + +
+

Return the argument vector as this terminal, similar to @ARGV, but +includes the program name as first element.

+
+ +
$modifiermask = $term->ModLevel3Mask + +
$modifiermask = $term->ModMetaMask + +
$modifiermask = $term->ModNumLockMask + +
+

Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often +AltGr), the meta key (often Alt) and the num lock key, if applicable.

+
+ +
$screen = $term->current_screen + +
+

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

+
+ +
$cursor_is_hidden = $term->hidden_cursor + +
+

Returns wether the cursor is currently hidden or not.

+
+ +
$view_start = $term->view_start ([$newvalue]) + +
+

Returns the row number of the topmost displayed line. Maximum value is 0, which displays the normal terminal contents. Lower values scroll -this many lines into the scrollback buffer. +this many lines into the scrollback buffer.

-

-
$term->want_refresh
-
+ +
$term->want_refresh +
-Requests a screen refresh. At the next opportunity, rxvt-unicode will +

Requests a screen refresh. At the next opportunity, rxvt-unicode will compare the on-screen display with its stored representation. If they -differ, it redraws the differences. +differ, it redraws the differences.

Used after changing terminal contents to display them.

-

-
$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
-
+ +
$text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) +
-Returns the text of the entire row with number $row_number. Row 0 +

Returns the text of the entire row with number $row_number. Row 0 is the topmost terminal line, row $term->$ncol-1 is the bottommost terminal line. The scrollback buffer starts at line -1 and extends to line -$term->nsaved. Nothing will be returned if a nonexistent line -is requested. +is requested.

If $new_text is specified, it will replace characters in the current @@ -1476,7 +1509,7 @@ to replace only parts of a line. The font index in the rendition will automatically be updated.

-

$text is in a special encoding: tabs and wide characters that use more +

$text is in a special encoding: tabs and wide characters that use more than one cell when displayed are padded with $urxvt::NOCHAR (chr 65535) characters. Characters with combining characters and other characters that do not fit into the normal tetx encoding will be replaced with characters @@ -1491,13 +1524,13 @@ characters.

The methods $term->special_encode and $term->special_decode can be used to convert normal strings into this encoding and vice versa.

-

-
$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
-
+ +
$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]]) +
-Like $term->ROW_t, but returns an arrayref with rendition +

Like $term->ROW_t, but returns an arrayref with rendition bitsets. Rendition bitsets contain information about colour, font, font -styles and similar information. See also $term->ROW_t. +styles and similar information. See also $term->ROW_t.

When setting rendition, the font mask will be ignored.

@@ -1505,199 +1538,202 @@ styles and similar information. See also $term->R

See the section on RENDITION, above.

-

-
$length = $term->ROW_l ($row_number[, $new_length])
-
+ +
$length = $term->ROW_l ($row_number[, $new_length]) +
-Returns the number of screen cells that are in use (``the line +

Returns the number of screen cells that are in use (``the line length''). Unlike the urxvt core, this returns $term->ncol if the -line is joined with the following one. +line is joined with the following one.

-

-
$bool = $term->is_longer ($row_number)
-
+ +
$bool = $term->is_longer ($row_number) +
-Returns true if the row is part of a multiple-row logical ``line'' (i.e. +

Returns true if the row is part of a multiple-row logical ``line'' (i.e. joined with the following row), which means all characters are in use and it is continued on the next row (and possibly a continuation of the -previous row(s)). +previous row(s)).

-

-
$line = $term->line ($row_number)
-
+ +
$line = $term->line ($row_number) +
-Create and return a new urxvt::line object that stores information +

Create and return a new urxvt::line object that stores information about the logical line that row $row_number is part of. It supports the -following methods: +following methods:

-
$text = $line->t ([$new_text])
-
+
$text = $line->t ([$new_text]) +
-Returns or replaces the full text of the line, similar to ROW_t +

Returns or replaces the full text of the line, similar to ROW_t

-

-
$rend = $line->r ([$new_rend])
-
+ +
$rend = $line->r ([$new_rend]) +
-Returns or replaces the full rendition array of the line, similar to ROW_r +

Returns or replaces the full rendition array of the line, similar to ROW_r

-

-
$length = $line->l
-
+ +
$length = $line->l +
-Returns the length of the line in cells, similar to ROW_l. +

Returns the length of the line in cells, similar to ROW_l.

-

-
$rownum = $line->beg
-
-
$rownum = $line->end
-
+ +
$rownum = $line->beg + +
$rownum = $line->end +
-Return the row number of the first/last row of the line, respectively. +

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

-

-
$offset = $line->offset_of ($row, $col)
-
+ +
$offset = $line->offset_of ($row, $col) +
-Returns the character offset of the given row|col pair within the logical +

Returns the character offset of the given row|col pair within the logical line. Works for rows outside the line, too, and returns corresponding -offsets outside the string. +offsets outside the string.

-

-
($row, $col) = $line->coord_of ($offset)
-
+ +
($row, $col) = $line->coord_of ($offset) +
-Translates a string offset into terminal coordinates again. +

Translates a string offset into terminal coordinates again.

-

-
$text = $term->special_encode $string
-
+ + +
$text = $term->special_encode $string +
-Converts a perl string into the special encoding used by rxvt-unicode, +

Converts a perl string into the special encoding used by rxvt-unicode, where one character corresponds to one screen cell. See -$term->ROW_t for details. +$term->ROW_t for details.

-

-
$string = $term->special_decode $text
-
+ +
$string = $term->special_decode $text +
-Converts rxvt-unicodes text reprsentation into a perl string. See -$term->ROW_t for details. +

Converts rxvt-unicodes text reprsentation into a perl string. See +$term->ROW_t for details.

-

-
$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
-
-
$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
-
+ +
$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) + +
$term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) +
-Register/unregister a synchronous button grab. See the XGrabButton -manpage. +

Register/unregister a synchronous button grab. See the XGrabButton +manpage.

-

-
$success = $term->grab ($eventtime[, $sync])
-
+ +
$success = $term->grab ($eventtime[, $sync]) +
-Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or -synchronous ($sync is true). Also remembers the grab timestampe. +

Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or +synchronous ($sync is true). Also remembers the grab timestampe.

-

-
$term->allow_events_async
-
+ +
$term->allow_events_async +
-Calls XAllowEvents with AsyncBoth for the most recent grab. +

Calls XAllowEvents with AsyncBoth for the most recent grab.

-

-
$term->allow_events_sync
-
+ +
$term->allow_events_sync +
-Calls XAllowEvents with SyncBoth for the most recent grab. +

Calls XAllowEvents with SyncBoth for the most recent grab.

-

-
$term->allow_events_replay
-
+ +
$term->allow_events_replay +
-Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most -recent grab. +

Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most +recent grab.

-

-
$term->ungrab
-
+ +
$term->ungrab +
-Calls XUngrab for the most recent grab. Is called automatically on +

Calls XUngrab for the most recent grab. Is called automatically on evaluation errors, as it is better to lose the grab in the error case as -the session. -

-

-
$atom = $term->XInternAtom ($atom_name[, $only_if_exists])
-
-
$atom_name = $term->XGetAtomName ($atom)
-
-
@atoms = $term->XListProperties ($window)
-
-
($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
-
-
$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
-
-
$term->XDeleteProperty ($window, $property)
-
-
$window = $term->DefaultRootWindow
-
-
$term->XReparentWindow ($window, $parent, [$x, $y])
-
-
$term->XMapWindow ($window)
-
-
$term->XUnmapWindow ($window)
-
-
$term->XMoveResizeWindow ($window, $x, $y, $width, $height)
-
-
($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
-
-
$term->XChangeInput ($window, $add_events[, $del_events])
-
-
-Various X or X-related functions. The $term object only serves as +the session.

+
+ +
$atom = $term->XInternAtom ($atom_name[, $only_if_exists]) + +
$atom_name = $term->XGetAtomName ($atom) + +
@atoms = $term->XListProperties ($window) + +
($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) + +
$term->XChangeWindowProperty ($window, $property, $type, $format, $octets) + +
$term->XDeleteProperty ($window, $property) + +
$window = $term->DefaultRootWindow + +
$term->XReparentWindow ($window, $parent, [$x, $y]) + +
$term->XMapWindow ($window) + +
$term->XUnmapWindow ($window) + +
$term->XMoveResizeWindow ($window, $x, $y, $width, $height) + +
($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) + +
$term->XChangeInput ($window, $add_events[, $del_events]) + +
+

Various X or X-related functions. The $term object only serves as the source of the display, otherwise those functions map more-or-less -directory onto the X functions of the same name. +directory onto the X functions of the same name.

-

+ +

The urxvt::popup Class

-
$popup->add_title ($title)
-
+
$popup->add_title ($title) +
-Adds a non-clickable title to the popup. +

Adds a non-clickable title to the popup.

-

-
$popup->add_separator ([$sepchr])
-
+ +
$popup->add_separator ([$sepchr]) +
-Creates a separator, optionally using the character given as $sepchr. +

Creates a separator, optionally using the character given as $sepchr.

-

-
$popup->add_button ($text, $cb)
-
+ +
$popup->add_button ($text, $cb) +
-Adds a clickable button to the popup. $cb is called whenever it is -selected. +

Adds a clickable button to the popup. $cb is called whenever it is +selected.

-

-
$popup->add_toggle ($text, $initial_value, $cb)
-
+ +
$popup->add_toggle ($text, $initial_value, $cb) +
-Adds a toggle/checkbox item to the popup. The callback gets called +

Adds a toggle/checkbox item to the popup. The callback gets called whenever it gets toggled, with a boolean indicating its new value as its -first argument. +first argument.

-

-
$popup->show
-
+ +
$popup->show +
-Displays the popup (which is initially hidden). +

Displays the popup (which is initially hidden).

-

+ +

The urxvt::timer Class

@@ -1713,63 +1749,64 @@ fractional number of seconds since the epoch. Example:

sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); });
-
$timer = new urxvt::timer
-
+
$timer = new urxvt::timer +
-Create a new timer object in started state. It is scheduled to fire -immediately. +

Create a new timer object in started state. It is scheduled to fire +immediately.

-

-
$timer = $timer->cb (sub { my ($timer) = @_; ... })
-
+ +
$timer = $timer->cb (sub { my ($timer) = @_; ... }) +
-Set the callback to be called when the timer triggers. +

Set the callback to be called when the timer triggers.

-

-
$tstamp = $timer->at
-
+ +
$tstamp = $timer->at +
-Return the time this watcher will fire next. +

Return the time this watcher will fire next.

-

-
$timer = $timer->set ($tstamp)
-
+ +
$timer = $timer->set ($tstamp) +
-Set the time the event is generated to $tstamp. +

Set the time the event is generated to $tstamp.

-

-
$timer = $timer->interval ($interval)
-
+ +
$timer = $timer->interval ($interval) +
-Normally (and when $interval is 0), the timer will automatically +

Normally (and when $interval is 0), the timer will automatically stop after it has fired once. If $interval is non-zero, then the timer -is automatically rescheduled at the given intervals. +is automatically rescheduled at the given intervals.

-

-
$timer = $timer->start
-
+ +
$timer = $timer->start +
-Start the timer. +

Start the timer.

-

-
$timer = $timer->start ($tstamp)
-
+ +
$timer = $timer->start ($tstamp) +
-Set the event trigger time to $tstamp and start the timer. +

Set the event trigger time to $tstamp and start the timer.

-

-
$timer = $timer->after ($delay)
-
+ +
$timer = $timer->after ($delay) +
-Like start, but sets the expiry timer to c<urxvt::NOW + $delay>. +

Like start, but sets the expiry timer to c<urxvt::NOW + $delay>.

-

-
$timer = $timer->stop
-
+ +
$timer = $timer->stop +
-Stop the timer. +

Stop the timer.

-

+ +

The urxvt::iow Class

@@ -1788,45 +1825,46 @@ Stop the timer. or end-of-file; });
-
$iow = new urxvt::iow
-
+
$iow = new urxvt::iow +
-Create a new io watcher object in stopped state. +

Create a new io watcher object in stopped state.

-

-
$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
-
+ +
$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) +
-Set the callback to be called when io events are triggered. $reventmask -is a bitset as described in the events method. +

Set the callback to be called when io events are triggered. $reventmask +is a bitset as described in the events method.

-

-
$iow = $iow->fd ($fd)
-
+ +
$iow = $iow->fd ($fd) +
-Set the filedescriptor (not handle) to watch. +

Set the filedescriptor (not handle) to watch.

-

-
$iow = $iow->events ($eventmask)
-
+ +
$iow = $iow->events ($eventmask) +
-Set the event mask to watch. The only allowed values are +

Set the event mask to watch. The only allowed values are urxvt::EVENT_READ and urxvt::EVENT_WRITE, which might be ORed -together, or urxvt::EVENT_NONE. +together, or urxvt::EVENT_NONE.

-

-
$iow = $iow->start
-
+ +
$iow = $iow->start +
-Start watching for requested events on the given handle. +

Start watching for requested events on the given handle.

-

-
$iow = $iow->stop
-
+ +
$iow = $iow->stop +
-Stop watching for events on the given filehandle. +

Stop watching for events on the given filehandle.

-

+ +

The urxvt::iw Class

@@ -1834,30 +1872,31 @@ Stop watching for events on the given filehandle. the process is idle. They should return as fast as possible, after doing some useful work.

-
$iw = new urxvt::iw
-
+
$iw = new urxvt::iw +
-Create a new idle watcher object in stopped state. +

Create a new idle watcher object in stopped state.

-

-
$iw = $iw->cb (sub { my ($iw) = @_; ... })
-
+ +
$iw = $iw->cb (sub { my ($iw) = @_; ... }) +
-Set the callback to be called when the watcher triggers. +

Set the callback to be called when the watcher triggers.

-

-
$timer = $timer->start
-
+ +
$timer = $timer->start +
-Start the watcher. +

Start the watcher.

-

-
$timer = $timer->stop
-
+ +
$timer = $timer->stop +
-Stop the watcher. +

Stop the watcher.

-

+ +

The urxvt::pw Class

@@ -1874,30 +1913,31 @@ process exits, after which they stop automatically.

... });
-
$pw = new urxvt::pw
-
+
$pw = new urxvt::pw +
-Create a new process watcher in stopped state. +

Create a new process watcher in stopped state.

-

-
$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
-
+ +
$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) +
-Set the callback to be called when the timer triggers. +

Set the callback to be called when the timer triggers.

-

-
$pw = $timer->start ($pid)
-
+ +
$pw = $timer->start ($pid) +
-Tells the wqtcher to start watching for process $pid. +

Tells the wqtcher to start watching for process $pid.

-

-
$pw = $pw->stop
-
+ +
$pw = $pw->stop +
-Stop the watcher. +

Stop the watcher.

-

+ +

@@ -1908,14 +1948,14 @@ Stop the watcher.

This variable controls the verbosity level of the perl extension. Higher numbers indicate more verbose output.

-
== 0 - fatal messages
-
-
>= 3 - script loading and management
-
-
>=10 - all called hooks
-
-
>=11 - hook reutrn values
-
+
== 0 - fatal messages + +
>= 3 - script loading and management + +
>=10 - all called hooks + +
>=11 - hook reutrn values +

diff --git a/doc/rxvtperl.3.man.in b/doc/rxvtperl.3.man.in index 439922ac..19e1a537 100644 --- a/doc/rxvtperl.3.man.in +++ b/doc/rxvtperl.3.man.in @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" Automatically generated by Pod::Man 2.09 (Pod::Simple 3.04) .\" .\" Standard preamble: .\" ======================================================================== @@ -129,28 +129,22 @@ .\" ======================================================================== .\" .IX Title "rxvt 3" -.TH rxvt 3 "2006-02-21" "7.6" "RXVT-UNICODE" +.TH rxvt 3 "2006-07-06" "7.7" "RXVT-UNICODE" .SH "NAME" @@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& # create a file grab_test in $HOME: -.Ve -.PP -.Vb 4 +\& \& sub on_sel_grab { -\& warn "you selected ", $_[0]->selection; +\& warn "you selected ", $_[0]\->selection; \& () \& } -.Ve -.PP -.Vb 1 +\& \& # start a @@RXVT_NAME@@ using it: -.Ve -.PP -.Vb 1 -\& @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test +\& +\& @@RXVT_NAME@@ \-\-perl\-lib $HOME \-pe grab_test .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" @@ -170,13 +164,13 @@ find them in \fI@@RXVT_LIBDIR@@/urxvt/perl/\fR. You can activate them like this: .PP .Vb 1 -\& @@RXVT_NAME@@ -pe +\& @@RXVT_NAME@@ \-pe .Ve .PP Or by adding them to the resource for extensions loaded by default: .PP .Vb 1 -\& URxvt.perl-ext-common: default,automove-background,selection-autotransform +\& URxvt.perl\-ext\-common: default,automove\-background,selection\-autotransform .Ve .IP "selection (enabled by default)" 4 .IX Item "selection (enabled by default)" @@ -194,8 +188,8 @@ them in increasing order of length. You can add your own regexes by specifying resources of the form: .Sp .Vb 3 -\& URxvt.selection.pattern-0: perl-regex -\& URxvt.selection.pattern-1: perl-regex +\& URxvt.selection.pattern\-0: perl\-regex +\& URxvt.selection.pattern\-1: perl\-regex \& ... .Ve .Sp @@ -205,7 +199,7 @@ the match. For example, the followign adds a regex that matches everything between two vertical bars: .Sp .Vb 1 -\& URxvt.selection.pattern-0: \e\e|([^|]+)\e\e| +\& URxvt.selection.pattern\-0: \e\e|([^|]+)\e\e| .Ve .Sp Another example: Programs I use often output \*(L"absolute path: \*(R" at the @@ -214,7 +208,7 @@ pattern matches the filename (note, there is a single space at the very end): .Sp .Vb 1 -\& URxvt.selection.pattern-0: ^(/[^:]+):\e +\& URxvt.selection.pattern\-0: ^(/[^:]+):\e .Ve .Sp You can look at the source of the selection extension to see more @@ -227,7 +221,7 @@ This extension also offers following bindable keyboard commands: Rot\-13 the selection when activated. Used via keyboard trigger: .Sp .Vb 1 -\& URxvt.keysym.C-M-r: perl:selection:rot13 +\& URxvt.keysym.C\-M\-r: perl:selection:rot13 .Ve .RE .RS 4 @@ -251,8 +245,8 @@ The following will add an entry \f(CW\*(C`myoption\*(C'\fR that changes \&\f(CW\*(C`$self\-\*(C'\fR{myoption}>: .Sp .Vb 3 -\& push @{ $self->{term}{option_popup_hook} }, sub { -\& ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) +\& push @{ $self\->{term}{option_popup_hook} }, sub { +\& ("my option" => $myoption, sub { $self\->{myoption} = $_[0] }) \& }; .Ve .IP "selection-popup (enabled by default)" 4 @@ -276,7 +270,7 @@ the selection to \f(CW\*(C`b\*(C'\fRs, but only if the selection currently conta \&\f(CW\*(C`a\*(C'\fRs: .Sp .Vb 4 -\& push @{ $self->{term}{selection_popup_hook} }, sub { +\& push @{ $self\->{term}{selection_popup_hook} }, sub { \& /a/ ? ("a to be" => sub { s/a/b/g } \& : () \& }; @@ -295,6 +289,12 @@ bottom. \f(CW\*(C`Escape\*(C'\fR leaves search mode and returns to the point whe was started, while \f(CW\*(C`Enter\*(C'\fR or \f(CW\*(C`Return\*(C'\fR stay at the current position and additionally stores the first match in the current line into the primary selection. +.Sp +The regex defaults to \*(L"(?i)\*(R", resulting in a case-insensitive search. To +get a case-sensitive search you can delete this prefix using \f(CW\*(C`BackSpace\*(C'\fR +or simply use an uppercase character which removes the \*(L"(?i)\*(R" prefix. +.Sp +See perlre for more info about perl regular expression syntax. .IP "readline (enabled by default)" 4 .IX Item "readline (enabled by default)" A support package that tries to make editing with readline easier. At @@ -330,8 +330,8 @@ It works by specifying perl snippets (most useful is a single \f(CW\*(C`s///\*(C operator) that modify \f(CW$_\fR as resources: .Sp .Vb 3 -\& URxvt.selection-autotransform.0: transform -\& URxvt.selection-autotransform.1: transform +\& URxvt.selection\-autotransform.0: transform +\& URxvt.selection\-autotransform.1: transform \& ... .Ve .Sp @@ -340,14 +340,14 @@ For example, the following will transform selections of the form $word\*(C'\fR: .Sp .Vb 1 -\& URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\e\ed+):?$/vi +$2 \e\eQ$1\e\eE\e\ex0d/ +\& URxvt.selection\-autotransform.0: s/^([^:[:space:]]+):(\e\ed+):?$/vi +$2 \e\eQ$1\e\eE\e\ex0d/ .Ve .Sp And this example matches the same,but replaces it with vi-commands you can paste directly into your (vi :) editor: .Sp .Vb 1 -\& URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\e\ed+):?$/:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/ +\& URxvt.selection\-autotransform.0: s/^([^:[:space:]]+(\e\ed+):?$/:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/ .Ve .Sp Of course, this can be modified to suit your needs and your editor :) @@ -356,8 +356,8 @@ To expand the example above to typical perl error messages (\*(L"\s-1XXX\s0 at \&\s-1FILENAME\s0 line \s-1YYY\s0.\*(R"), you need a slightly more elaborate solution: .Sp .Vb 2 -\& URxvt.selection.pattern-0: ( at .*? line \e\ed+[,.]) -\& URxvt.selection-autotransform.0: s/^ at (.*?) line (\e\ed+)[,.]$/:e \e\eQ$1\eE\e\ex0d:$2\e\ex0d/ +\& URxvt.selection.pattern\-0: ( at .*? line \e\ed+[,.]) +\& URxvt.selection\-autotransform.0: s/^ at (.*?) line (\e\ed+)[,.]$/:e \e\eQ$1\eE\e\ex0d:$2\e\ex0d/ .Ve .Sp The first line tells the selection code to treat the unchanging part of @@ -379,10 +379,10 @@ with a resource class of \f(CW\*(C`URxvt.tabbed\*(C'\fR. In addition, it support following four resources (shown with defaults): .Sp .Vb 4 -\& URxvt.tabbed.tabbar-fg: -\& URxvt.tabbed.tabbar-bg: -\& URxvt.tabbed.tab-fg: -\& URxvt.tabbed.tab-bg: +\& URxvt.tabbed.tabbar\-fg: +\& URxvt.tabbed.tabbar\-bg: +\& URxvt.tabbed.tab\-fg: +\& URxvt.tabbed.tab\-bg: .Ve .Sp See \fI\s-1COLOR\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR in the @@RXVT_NAME@@(1) manpage for valid @@ -404,20 +404,21 @@ You enable it by specifying this extension and a preedit style of \&\f(CW\*(C`OnTheSpot\*(C'\fR, i.e.: .Sp .Vb 1 -\& @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot +\& @@RXVT_NAME@@ \-pt OnTheSpot \-pe xim\-onthespot .Ve .IP "automove-background" 4 .IX Item "automove-background" -This is basically a one-line extension that dynamically changes the background pixmap offset -to the window position, in effect creating the same effect as pseudo transparency with -a custom pixmap. No scaling is supported in this mode. Exmaple: +This is basically a very small extension that dynamically changes the +background pixmap offset to the window position, in effect creating the +same effect as pseudo transparency with a custom pixmap. No scaling is +supported in this mode. Exmaple: .Sp .Vb 1 -\& @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background +\& @@RXVT_NAME@@ \-pixmap background.xpm \-pe automove\-background .Ve .IP "block-graphics-to-ascii" 4 .IX Item "block-graphics-to-ascii" -A not very useful example of filtering all text output to the terminal, +A not very useful example of filtering all text output to the terminal by replacing all line-drawing characters (U+2500 .. U+259F) by a similar-looking ascii character. .IP "digital-clock" 4 @@ -441,8 +442,8 @@ the selection data on \s-1STDOUT\s0 (also in \s-1UTF\-8\s0). The defaults (which are likely useless to you) use rsh and cat: .Sp .Vb 2 -\& URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' -\& URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' +\& URxvt.remote\-selection.store: rsh ruth 'cat >/tmp/distributed\-selection' +\& URxvt.remote\-selection.fetch: rsh ruth 'cat /tmp/distributed\-selection' .Ve .IP "selection-pastebin" 4 .IX Item "selection-pastebin" @@ -455,14 +456,14 @@ It listens to the \f(CW\*(C`selection\-pastebin:remote\-pastebin\*(C'\fR keyboar i.e. .Sp .Vb 1 -\& URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin +\& URxvt.keysym.C\-M\-e: perl:selection\-pastebin:remote\-pastebin .Ve .Sp Pressing this combination runs a command with \f(CW\*(C`%\*(C'\fR replaced by the name of the textfile. This command can be set via a resource: .Sp .Vb 1 -\& URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. +\& URxvt.selection\-pastebin.cmd: rsync \-apP % ruth:/var/www/www.ta\-sa.org/files/txt/. .Ve .Sp And the default is likely not useful to anybody but the few people around @@ -476,7 +477,7 @@ in the \f(CW\*(C`selection\-pastebin\-url\*(C'\fR resource (again, the % is the for the filename): .Sp .Vb 1 -\& URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% +\& URxvt.selection\-pastebin.url: http://www.ta\-sa.org/files/txt/% .Ve .IP "example-refresh-hooks" 4 .IX Item "example-refresh-hooks" @@ -500,22 +501,25 @@ terminal is destroyed. .PP Argument names also often indicate the type of a parameter. Here are some hints on what they mean: -.IP "$text" 4 +.ie n .IP "$text" 4 +.el .IP "\f(CW$text\fR" 4 .IX Item "$text" Rxvt-unicodes special way of encoding text, where one \*(L"unicode\*(R" character always represents one screen cell. See ROW_t for a discussion of this format. -.IP "$string" 4 +.ie n .IP "$string" 4 +.el .IP "\f(CW$string\fR" 4 .IX Item "$string" A perl text string, with an emphasis on \fItext\fR. It can store all unicode characters and is to be distinguished with text encoded in a specific encoding (often locale\-specific) and binary data. -.IP "$octets" 4 +.ie n .IP "$octets" 4 +.el .IP "\f(CW$octets\fR" 4 .IX Item "$octets" Either binary data or \- more common \- a text string encoded in a locale-specific way. .Sh "Extension Objects" .IX Subsection "Extension Objects" -Very perl extension is a perl class. A separate perl object is created +Every perl extension is a perl class. A separate perl object is created for each terminal and each extension and passed as the first parameter to hooks. So extensions can use their \f(CW$self\fR object without having to think about other extensions, with the exception of methods and members that @@ -526,19 +530,19 @@ Although it isn't a \f(CW\*(C`urxvt::term\*(C'\fR object, you can call all metho \&\f(CW\*(C`urxvt::term\*(C'\fR class on this object. .PP It has the following methods and data members: -.ie n .IP "$urxvt_term = $self\->{term}" 4 -.el .IP "$urxvt_term = \f(CW$self\fR\->{term}" 4 +.ie n .IP "$urxvt_term\fR = \f(CW$self\->{term}" 4 +.el .IP "\f(CW$urxvt_term\fR = \f(CW$self\fR\->{term}" 4 .IX Item "$urxvt_term = $self->{term}" Returns the \f(CW\*(C`urxvt::term\*(C'\fR object associated with this instance of the extension. This member \fImust not\fR be changed in any way. -.ie n .IP "$self\->enable ($hook_name => $cb\fR, [$hook_name => \f(CW$cb..])" 4 -.el .IP "$self\->enable ($hook_name => \f(CW$cb\fR, [$hook_name => \f(CW$cb\fR..])" 4 +.ie n .IP "$self\fR\->enable ($hook_name => \f(CW$cb\fR, [$hook_name => \f(CW$cb..])" 4 +.el .IP "\f(CW$self\fR\->enable ($hook_name => \f(CW$cb\fR, [$hook_name => \f(CW$cb\fR..])" 4 .IX Item "$self->enable ($hook_name => $cb, [$hook_name => $cb..])" Dynamically enable the given hooks (named without the \f(CW\*(C`on_\*(C'\fR prefix) for this extension, replacing any previous hook. This is useful when you want to overwrite time-critical hooks only temporarily. -.ie n .IP "$self\->disable ($hook_name[, $hook_name..])" 4 -.el .IP "$self\->disable ($hook_name[, \f(CW$hook_name\fR..])" 4 +.ie n .IP "$self\fR\->disable ($hook_name[, \f(CW$hook_name..])" 4 +.el .IP "\f(CW$self\fR\->disable ($hook_name[, \f(CW$hook_name\fR..])" 4 .IX Item "$self->disable ($hook_name[, $hook_name..])" Dynamically disable the given hooks. .Sh "Hooks" @@ -632,9 +636,19 @@ than the scroll back buffer or the terminal. It is called before lines are scrolled out (so rows 0 .. min ($lines \- 1, \&\f(CW$nrow\fR \- 1) represent the lines to be scrolled out). \f(CW$saved\fR is the total number of lines that will be in the scrollback buffer. -.ie n .IP "on_osc_seq $term\fR, \f(CW$string" 4 -.el .IP "on_osc_seq \f(CW$term\fR, \f(CW$string\fR" 4 -.IX Item "on_osc_seq $term, $string" +.ie n .IP "on_osc_seq $term\fR, \f(CW$op\fR, \f(CW$args" 4 +.el .IP "on_osc_seq \f(CW$term\fR, \f(CW$op\fR, \f(CW$args\fR" 4 +.IX Item "on_osc_seq $term, $op, $args" +Called on every \s-1OSC\s0 sequence and can be used to suppress it or modify its +behaviour. The default should be to return an empty list. A true value +suppresses execution of the request completely. Make sure you don't get +confused by recursive invocations when you output an osc sequence within +this callback. +.Sp +\&\f(CW\*(C`on_osc_seq_perl\*(C'\fR should be used for new behaviour. +.ie n .IP "on_osc_seq_perl $term\fR, \f(CW$string" 4 +.el .IP "on_osc_seq_perl \f(CW$term\fR, \f(CW$string\fR" 4 +.IX Item "on_osc_seq_perl $term, $string" Called whenever the \fB\s-1ESC\s0 ] 777 ; string \s-1ST\s0\fR command sequence (\s-1OSC\s0 = operating system command) is processed. Cursor position and other state information is up-to-date when this happens. For interoperability, the @@ -770,22 +784,26 @@ format=32, \s-1WM_PROTOCOLS\s0 or \s-1WM_PROTOCOLS:WM_DELETE_WINDOW\s0). .ie n .Sh "Variables in the ""urxvt"" Package" .el .Sh "Variables in the \f(CWurxvt\fP Package" .IX Subsection "Variables in the urxvt Package" -.IP "$urxvt::LIBDIR" 4 +.ie n .IP "$urxvt::LIBDIR" 4 +.el .IP "\f(CW$urxvt::LIBDIR\fR" 4 .IX Item "$urxvt::LIBDIR" The rxvt-unicode library directory, where, among other things, the perl modules and scripts are stored. -.ie n .IP "$urxvt::RESCLASS, $urxvt::RESCLASS" 4 -.el .IP "$urxvt::RESCLASS, \f(CW$urxvt::RESCLASS\fR" 4 +.ie n .IP "$urxvt::RESCLASS\fR, \f(CW$urxvt::RESCLASS" 4 +.el .IP "\f(CW$urxvt::RESCLASS\fR, \f(CW$urxvt::RESCLASS\fR" 4 .IX Item "$urxvt::RESCLASS, $urxvt::RESCLASS" The resource class and name rxvt-unicode uses to look up X resources. -.IP "$urxvt::RXVTNAME" 4 +.ie n .IP "$urxvt::RXVTNAME" 4 +.el .IP "\f(CW$urxvt::RXVTNAME\fR" 4 .IX Item "$urxvt::RXVTNAME" The basename of the installed binaries, usually \f(CW\*(C`urxvt\*(C'\fR. -.IP "$urxvt::TERM" 4 +.ie n .IP "$urxvt::TERM" 4 +.el .IP "\f(CW$urxvt::TERM\fR" 4 .IX Item "$urxvt::TERM" The current terminal. This variable stores the current \f(CW\*(C`urxvt::term\*(C'\fR object, whenever a callback/hook is executing. -.IP "@urxvt::TERM_INIT" 4 +.ie n .IP "@urxvt::TERM_INIT" 4 +.el .IP "\f(CW@urxvt::TERM_INIT\fR" 4 .IX Item "@urxvt::TERM_INIT" All coderefs in this array will be called as methods of the next newly created \f(CW\*(C`urxvt::term\*(C'\fR object (during the \f(CW\*(C`on_init\*(C'\fR phase). The array @@ -794,7 +812,8 @@ so coderefs can push themselves onto it again if they so desire. .Sp This complements to the perl-eval commandline option, but gets executed first. -.IP "@urxvt::TERM_EXT" 4 +.ie n .IP "@urxvt::TERM_EXT" 4 +.el .IP "\f(CW@urxvt::TERM_EXT\fR" 4 .IX Item "@urxvt::TERM_EXT" Works similar to \f(CW@TERM_INIT\fR, but contains perl package/class names, which get registered as normal extensions after calling the hooks in \f(CW@TERM_INIT\fR @@ -819,13 +838,15 @@ Using this function has the advantage that its output ends up in the correct place, e.g. on stderr of the connecting urxvtc client. .Sp Messages have a size limit of 1023 bytes currently. -.IP "@terms = urxvt::termlist" 4 +.ie n .IP "@terms = urxvt::termlist" 4 +.el .IP "\f(CW@terms\fR = urxvt::termlist" 4 .IX Item "@terms = urxvt::termlist" Returns all urxvt::term objects that exist in this process, regardless of wether they are started, being destroyed etc., so be careful. Only term objects that have perl extensions attached will be returned (because there is no urxvt::term objet associated with others). -.IP "$time = urxvt::NOW" 4 +.ie n .IP "$time = urxvt::NOW" 4 +.el .IP "\f(CW$time\fR = urxvt::NOW" 4 .IX Item "$time = urxvt::NOW" Returns the \*(L"current time\*(R" (as per the event loop). .IP "urxvt::CurrentTime" 4 @@ -848,48 +869,51 @@ The following \*(L"macros\*(R" deal with changes in rendition sets. You should never just create a bitset, you should always modify an existing one, as they contain important information required for correct operation of rxvt\-unicode. -.IP "$rend = urxvt::DEFAULT_RSTYLE" 4 +.ie n .IP "$rend = urxvt::DEFAULT_RSTYLE" 4 +.el .IP "\f(CW$rend\fR = urxvt::DEFAULT_RSTYLE" 4 .IX Item "$rend = urxvt::DEFAULT_RSTYLE" Returns the default rendition, as used when the terminal is starting up or being reset. Useful as a base to start when creating renditions. -.IP "$rend = urxvt::OVERLAY_RSTYLE" 4 +.ie n .IP "$rend = urxvt::OVERLAY_RSTYLE" 4 +.el .IP "\f(CW$rend\fR = urxvt::OVERLAY_RSTYLE" 4 .IX Item "$rend = urxvt::OVERLAY_RSTYLE" Return the rendition mask used for overlays by default. -.IP "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" 4 +.ie n .IP "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" 4 +.el .IP "\f(CW$rendbit\fR = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" 4 .IX Item "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" Return the bit that enabled bold, italic, blink, reverse-video and underline, respectively. To enable such a style, just logically \s-1OR\s0 it into the bitset. -.ie n .IP "$foreground = urxvt::GET_BASEFG $rend" 4 -.el .IP "$foreground = urxvt::GET_BASEFG \f(CW$rend\fR" 4 +.ie n .IP "$foreground\fR = urxvt::GET_BASEFG \f(CW$rend" 4 +.el .IP "\f(CW$foreground\fR = urxvt::GET_BASEFG \f(CW$rend\fR" 4 .IX Item "$foreground = urxvt::GET_BASEFG $rend" .PD 0 -.ie n .IP "$background = urxvt::GET_BASEBG $rend" 4 -.el .IP "$background = urxvt::GET_BASEBG \f(CW$rend\fR" 4 +.ie n .IP "$background\fR = urxvt::GET_BASEBG \f(CW$rend" 4 +.el .IP "\f(CW$background\fR = urxvt::GET_BASEBG \f(CW$rend\fR" 4 .IX Item "$background = urxvt::GET_BASEBG $rend" .PD Return the foreground/background colour index, respectively. -.ie n .IP "$rend = urxvt::SET_FGCOLOR $rend\fR, \f(CW$new_colour" 4 -.el .IP "$rend = urxvt::SET_FGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4 +.ie n .IP "$rend\fR = urxvt::SET_FGCOLOR \f(CW$rend\fR, \f(CW$new_colour" 4 +.el .IP "\f(CW$rend\fR = urxvt::SET_FGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4 .IX Item "$rend = urxvt::SET_FGCOLOR $rend, $new_colour" .PD 0 -.ie n .IP "$rend = urxvt::SET_BGCOLOR $rend\fR, \f(CW$new_colour" 4 -.el .IP "$rend = urxvt::SET_BGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4 +.ie n .IP "$rend\fR = urxvt::SET_BGCOLOR \f(CW$rend\fR, \f(CW$new_colour" 4 +.el .IP "\f(CW$rend\fR = urxvt::SET_BGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4 .IX Item "$rend = urxvt::SET_BGCOLOR $rend, $new_colour" -.ie n .IP "$rend = urxvt::SET_COLOR $rend\fR, \f(CW$new_fg\fR, \f(CW$new_bg" 4 -.el .IP "$rend = urxvt::SET_COLOR \f(CW$rend\fR, \f(CW$new_fg\fR, \f(CW$new_bg\fR" 4 +.ie n .IP "$rend\fR = urxvt::SET_COLOR \f(CW$rend\fR, \f(CW$new_fg\fR, \f(CW$new_bg" 4 +.el .IP "\f(CW$rend\fR = urxvt::SET_COLOR \f(CW$rend\fR, \f(CW$new_fg\fR, \f(CW$new_bg\fR" 4 .IX Item "$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg" .PD Replace the foreground/background colour in the rendition mask with the specified one. -.ie n .IP "$value = urxvt::GET_CUSTOM $rend" 4 -.el .IP "$value = urxvt::GET_CUSTOM \f(CW$rend\fR" 4 +.ie n .IP "$value\fR = urxvt::GET_CUSTOM \f(CW$rend" 4 +.el .IP "\f(CW$value\fR = urxvt::GET_CUSTOM \f(CW$rend\fR" 4 .IX Item "$value = urxvt::GET_CUSTOM $rend" Return the \*(L"custom\*(R" value: Every rendition has 5 bits for use by extensions. They can be set and changed as you like and are initially zero. -.ie n .IP "$rend = urxvt::SET_CUSTOM $rend\fR, \f(CW$new_value" 4 -.el .IP "$rend = urxvt::SET_CUSTOM \f(CW$rend\fR, \f(CW$new_value\fR" 4 +.ie n .IP "$rend\fR = urxvt::SET_CUSTOM \f(CW$rend\fR, \f(CW$new_value" 4 +.el .IP "\f(CW$rend\fR = urxvt::SET_CUSTOM \f(CW$rend\fR, \f(CW$new_value\fR" 4 .IX Item "$rend = urxvt::SET_CUSTOM $rend, $new_value" Change the custom value. .ie n .Sh "The ""urxvt::anyevent"" Class" @@ -904,8 +928,8 @@ work. .ie n .Sh "The ""urxvt::term"" Class" .el .Sh "The \f(CWurxvt::term\fP Class" .IX Subsection "The urxvt::term Class" -.ie n .IP "$term = new urxvt::term $envhashref\fR, \f(CW$rxvtname, [arg...]" 4 -.el .IP "$term = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname\fR, [arg...]" 4 +.ie n .IP "$term\fR = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname, [arg...]" 4 +.el .IP "\f(CW$term\fR = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname\fR, [arg...]" 4 .IX Item "$term = new urxvt::term $envhashref, $rxvtname, [arg...]" Creates a new terminal, very similar as if you had started it with system \&\f(CW\*(C`$rxvtname, arg...\*(C'\fR. \f(CW$envhashref\fR must be a reference to a \f(CW%ENV\fR\-like @@ -916,13 +940,14 @@ couldn't be created. Returns \f(CW\*(C`undef\*(C'\fR if the new instance didn't initialise perl, and the terminal object otherwise. The \f(CW\*(C`init\*(C'\fR and \&\f(CW\*(C`start\*(C'\fR hooks will be called before this call returns, and are free to refer to global data (which is race free). -.IP "$term\->destroy" 4 +.ie n .IP "$term\->destroy" 4 +.el .IP "\f(CW$term\fR\->destroy" 4 .IX Item "$term->destroy" Destroy the terminal object (close the window, free resources etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event watchers (timers, io watchers) are still active. -.ie n .IP "$term\->exec_async ($cmd[, @args])" 4 -.el .IP "$term\->exec_async ($cmd[, \f(CW@args\fR])" 4 +.ie n .IP "$term\fR\->exec_async ($cmd[, \f(CW@args])" 4 +.el .IP "\f(CW$term\fR\->exec_async ($cmd[, \f(CW@args\fR])" 4 .IX Item "$term->exec_async ($cmd[, @args])" Works like the combination of the \f(CW\*(C`fork\*(C'\fR/\f(CW\*(C`exec\*(C'\fR builtins, which executes (\*(L"starts\*(R") programs in the background. This function takes care of setting @@ -930,8 +955,8 @@ the user environment before exec'ing the command (e.g. \f(CW\*(C`PATH\*(C'\fR) a be preferred over explicit calls to \f(CW\*(C`exec\*(C'\fR or \f(CW\*(C`system\*(C'\fR. .Sp Returns the pid of the subprocess or \f(CW\*(C`undef\*(C'\fR on error. -.ie n .IP "$isset = $term\fR\->option ($optval[, \f(CW$set])" 4 -.el .IP "$isset = \f(CW$term\fR\->option ($optval[, \f(CW$set\fR])" 4 +.ie n .IP "$isset\fR = \f(CW$term\fR\->option ($optval[, \f(CW$set])" 4 +.el .IP "\f(CW$isset\fR = \f(CW$term\fR\->option ($optval[, \f(CW$set\fR])" 4 .IX Item "$isset = $term->option ($optval[, $set])" Returns true if the option specified by \f(CW$optval\fR is enabled, and optionally change it. All option values are stored by name in the hash @@ -943,13 +968,13 @@ source file \fI/src/optinc.h\fR to see the actual list: .Vb 6 \& borderLess console cursorBlink cursorUnderline hold iconic insecure \& intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage -\& override-redirect pastableTabs pointerBlank reverseVideo scrollBar +\& override\-redirect pastableTabs pointerBlank reverseVideo scrollBar \& scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput \& scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs \& transparent tripleclickwords utmpInhibit visualBell .Ve -.ie n .IP "$value = $term\fR\->resource ($name[, \f(CW$newval])" 4 -.el .IP "$value = \f(CW$term\fR\->resource ($name[, \f(CW$newval\fR])" 4 +.ie n .IP "$value\fR = \f(CW$term\fR\->resource ($name[, \f(CW$newval])" 4 +.el .IP "\f(CW$value\fR = \f(CW$term\fR\->resource ($name[, \f(CW$newval\fR])" 4 .IX Item "$value = $term->resource ($name[, $newval])" Returns the current resource value associated with a given name and optionally sets a new value. Setting values is most useful in the \f(CW\*(C`init\*(C'\fR @@ -970,7 +995,7 @@ Here is a a likely non-exhaustive list of resource names, not all of which are supported in every build, please see the source file \fI/src/rsinc.h\fR to see the actual list: .Sp -.Vb 13 +.Vb 10 \& answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont \& borderLess color cursorBlink cursorUnderline cutchars delete_key \& display_name embed ext_bwidth fade font geometry hold iconName @@ -985,8 +1010,8 @@ to see the actual list: \& transient_for transparent transparent_all tripleclickwords utmpInhibit \& visualBell .Ve -.ie n .IP "$value = $term\->x_resource ($pattern)" 4 -.el .IP "$value = \f(CW$term\fR\->x_resource ($pattern)" 4 +.ie n .IP "$value\fR = \f(CW$term\->x_resource ($pattern)" 4 +.el .IP "\f(CW$value\fR = \f(CW$term\fR\->x_resource ($pattern)" 4 .IX Item "$value = $term->x_resource ($pattern)" Returns the X\-Resource for the given pattern, excluding the program or class name, i.e. \f(CW\*(C`$term\->x_resource ("boldFont")\*(C'\fR should return the @@ -996,13 +1021,13 @@ resource with that pattern exists. This method should only be called during the \f(CW\*(C`on_start\*(C'\fR hook, as there is only one resource database per display, and later invocations might return the wrong resources. -.ie n .IP "$success = $term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string)" 4 -.el .IP "$success = \f(CW$term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string\fR)" 4 +.ie n .IP "$success\fR = \f(CW$term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string)" 4 +.el .IP "\f(CW$success\fR = \f(CW$term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string\fR)" 4 .IX Item "$success = $term->parse_keysym ($keysym_spec, $command_string)" Adds a keymap translation exactly as specified via a resource. See the \&\f(CW\*(C`keysym\*(C'\fR resource in the @@RXVT_NAME@@(1) manpage. -.ie n .IP "$rend = $term\->rstyle ([$new_rstyle])" 4 -.el .IP "$rend = \f(CW$term\fR\->rstyle ([$new_rstyle])" 4 +.ie n .IP "$rend\fR = \f(CW$term\->rstyle ([$new_rstyle])" 4 +.el .IP "\f(CW$rend\fR = \f(CW$term\fR\->rstyle ([$new_rstyle])" 4 .IX Item "$rend = $term->rstyle ([$new_rstyle])" Return and optionally change the current rendition. Text that is output by the terminal application will use this style. @@ -1024,29 +1049,29 @@ set it (which is usually bad as applications don't expect that). .PD Return the current values of the selection mark, begin or end positions, and optionally set them to new values. -.ie n .IP "$term\->selection_make ($eventtime[, $rectangular])" 4 -.el .IP "$term\->selection_make ($eventtime[, \f(CW$rectangular\fR])" 4 +.ie n .IP "$term\fR\->selection_make ($eventtime[, \f(CW$rectangular])" 4 +.el .IP "\f(CW$term\fR\->selection_make ($eventtime[, \f(CW$rectangular\fR])" 4 .IX Item "$term->selection_make ($eventtime[, $rectangular])" Tries to make a selection as set by \f(CW\*(C`selection_beg\*(C'\fR and \&\f(CW\*(C`selection_end\*(C'\fR. If \f(CW$rectangular\fR is true (default: false), a rectangular selection will be made. This is the prefered function to make a selection. -.ie n .IP "$success = $term\->selection_grab ($eventtime)" 4 -.el .IP "$success = \f(CW$term\fR\->selection_grab ($eventtime)" 4 +.ie n .IP "$success\fR = \f(CW$term\->selection_grab ($eventtime)" 4 +.el .IP "\f(CW$success\fR = \f(CW$term\fR\->selection_grab ($eventtime)" 4 .IX Item "$success = $term->selection_grab ($eventtime)" Try to request the primary selection text from the server (for example, as set by the next method). No visual feedback will be given. This function is mostly useful from within \f(CW\*(C`on_sel_grab\*(C'\fR hooks. -.ie n .IP "$oldtext = $term\->selection ([$newtext])" 4 -.el .IP "$oldtext = \f(CW$term\fR\->selection ([$newtext])" 4 +.ie n .IP "$oldtext\fR = \f(CW$term\->selection ([$newtext])" 4 +.el .IP "\f(CW$oldtext\fR = \f(CW$term\fR\->selection ([$newtext])" 4 .IX Item "$oldtext = $term->selection ([$newtext])" Return the current selection text and optionally replace it by \f(CW$newtext\fR. -.ie n .IP "$term\->overlay_simple ($x, $y\fR, \f(CW$text)" 4 -.el .IP "$term\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text\fR)" 4 +.ie n .IP "$term\fR\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text)" 4 +.el .IP "\f(CW$term\fR\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text\fR)" 4 .IX Item "$term->overlay_simple ($x, $y, $text)" Create a simple multi-line overlay box. See the next method for details. -.ie n .IP "$term\->overlay ($x, $y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border]])" 4 -.el .IP "$term\->overlay ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border\fR]])" 4 +.ie n .IP "$term\fR\->overlay ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border]])" 4 +.el .IP "\f(CW$term\fR\->overlay ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border\fR]])" 4 .IX Item "$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])" Create a new (empty) overlay at the given position with the given width/height. \f(CW$rstyle\fR defines the initial rendition style @@ -1063,57 +1088,61 @@ as long as the perl object is referenced. .Sp The methods currently supported on \f(CW\*(C`urxvt::overlay\*(C'\fR objects are: .RS 4 -.ie n .IP "$overlay\->set ($x, $y\fR, \f(CW$text\fR, \f(CW$rend)" 4 -.el .IP "$overlay\->set ($x, \f(CW$y\fR, \f(CW$text\fR, \f(CW$rend\fR)" 4 +.ie n .IP "$overlay\fR\->set ($x, \f(CW$y\fR, \f(CW$text\fR, \f(CW$rend)" 4 +.el .IP "\f(CW$overlay\fR\->set ($x, \f(CW$y\fR, \f(CW$text\fR, \f(CW$rend\fR)" 4 .IX Item "$overlay->set ($x, $y, $text, $rend)" Similar to \f(CW\*(C`$term\->ROW_t\*(C'\fR and \f(CW\*(C`$term\->ROW_r\*(C'\fR in that it puts text in rxvt\-unicode's special encoding and an array of rendition values at a specific position inside the overlay. -.IP "$overlay\->hide" 4 +.ie n .IP "$overlay\->hide" 4 +.el .IP "\f(CW$overlay\fR\->hide" 4 .IX Item "$overlay->hide" If visible, hide the overlay, but do not destroy it. -.IP "$overlay\->show" 4 +.ie n .IP "$overlay\->show" 4 +.el .IP "\f(CW$overlay\fR\->show" 4 .IX Item "$overlay->show" If hidden, display the overlay again. .RE .RS 4 .RE -.ie n .IP "$popup = $term\->popup ($event)" 4 -.el .IP "$popup = \f(CW$term\fR\->popup ($event)" 4 +.ie n .IP "$popup\fR = \f(CW$term\->popup ($event)" 4 +.el .IP "\f(CW$popup\fR = \f(CW$term\fR\->popup ($event)" 4 .IX Item "$popup = $term->popup ($event)" Creates a new \f(CW\*(C`urxvt::popup\*(C'\fR object that implements a popup menu. The \&\f(CW$event\fR \fImust\fR be the event causing the menu to pop up (a button event, currently). -.ie n .IP "$cellwidth = $term\->strwidth ($string)" 4 -.el .IP "$cellwidth = \f(CW$term\fR\->strwidth ($string)" 4 +.ie n .IP "$cellwidth\fR = \f(CW$term\->strwidth ($string)" 4 +.el .IP "\f(CW$cellwidth\fR = \f(CW$term\fR\->strwidth ($string)" 4 .IX Item "$cellwidth = $term->strwidth ($string)" Returns the number of screen-cells this string would need. Correctly accounts for wide and combining characters. -.ie n .IP "$octets = $term\->locale_encode ($string)" 4 -.el .IP "$octets = \f(CW$term\fR\->locale_encode ($string)" 4 +.ie n .IP "$octets\fR = \f(CW$term\->locale_encode ($string)" 4 +.el .IP "\f(CW$octets\fR = \f(CW$term\fR\->locale_encode ($string)" 4 .IX Item "$octets = $term->locale_encode ($string)" Convert the given text string into the corresponding locale encoding. -.ie n .IP "$string = $term\->locale_decode ($octets)" 4 -.el .IP "$string = \f(CW$term\fR\->locale_decode ($octets)" 4 +.ie n .IP "$string\fR = \f(CW$term\->locale_decode ($octets)" 4 +.el .IP "\f(CW$string\fR = \f(CW$term\fR\->locale_decode ($octets)" 4 .IX Item "$string = $term->locale_decode ($octets)" Convert the given locale-encoded octets into a perl string. -.ie n .IP "$term\->scr_xor_span ($beg_row, $beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle])" 4 -.el .IP "$term\->scr_xor_span ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle\fR])" 4 +.ie n .IP "$term\fR\->scr_xor_span ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle])" 4 +.el .IP "\f(CW$term\fR\->scr_xor_span ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle\fR])" 4 .IX Item "$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])" XORs the rendition values in the given span with the provided value (default: \f(CW\*(C`RS_RVid\*(C'\fR), which \fI\s-1MUST\s0 \s-1NOT\s0\fR contain font styles. Useful in refresh hooks to provide effects similar to the selection. -.ie n .IP "$term\->scr_xor_rect ($beg_row, $beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2]])" 4 -.el .IP "$term\->scr_xor_rect ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2\fR]])" 4 +.ie n .IP "$term\fR\->scr_xor_rect ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2]])" 4 +.el .IP "\f(CW$term\fR\->scr_xor_rect ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2\fR]])" 4 .IX Item "$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])" Similar to \f(CW\*(C`scr_xor_span\*(C'\fR, but xors a rectangle instead. Trailing whitespace will additionally be xored with the \f(CW$rstyle2\fR, which defaults to \f(CW\*(C`RS_RVid | RS_Uline\*(C'\fR, which removes reverse video again and underlines it instead. Both styles \fI\s-1MUST\s0 \s-1NOT\s0\fR contain font styles. -.IP "$term\->scr_bell" 4 +.ie n .IP "$term\->scr_bell" 4 +.el .IP "\f(CW$term\fR\->scr_bell" 4 .IX Item "$term->scr_bell" Ring the bell! -.IP "$term\->scr_add_lines ($string)" 4 +.ie n .IP "$term\->scr_add_lines ($string)" 4 +.el .IP "\f(CW$term\fR\->scr_add_lines ($string)" 4 .IX Item "$term->scr_add_lines ($string)" Write the given text string to the screen, as if output by the application running inside the terminal. It may not contain command sequences (escape @@ -1123,157 +1152,164 @@ string is a normal text string, not in locale-dependent encoding. Normally its not a good idea to use this function, as programs might be confused by changes in cursor position or scrolling. Its useful inside a \&\f(CW\*(C`on_add_lines\*(C'\fR hook, though. -.IP "$term\->scr_change_screen ($screen)" 4 +.ie n .IP "$term\->scr_change_screen ($screen)" 4 +.el .IP "\f(CW$term\fR\->scr_change_screen ($screen)" 4 .IX Item "$term->scr_change_screen ($screen)" Switch to given screen \- 0 primary, 1 secondary. -.IP "$term\->cmd_parse ($octets)" 4 +.ie n .IP "$term\->cmd_parse ($octets)" 4 +.el .IP "\f(CW$term\fR\->cmd_parse ($octets)" 4 .IX Item "$term->cmd_parse ($octets)" Similar to \f(CW\*(C`scr_add_lines\*(C'\fR, but the argument must be in the locale-specific encoding of the terminal and can contain command sequences (escape codes) that will be interpreted. -.IP "$term\->tt_write ($octets)" 4 +.ie n .IP "$term\->tt_write ($octets)" 4 +.el .IP "\f(CW$term\fR\->tt_write ($octets)" 4 .IX Item "$term->tt_write ($octets)" Write the octets given in \f(CW$data\fR to the tty (i.e. as program input). To pass characters instead of octets, you should convert your strings first to the locale-specific encoding using \f(CW\*(C`$term\->locale_encode\*(C'\fR. -.ie n .IP "$old_events = $term\->pty_ev_events ([$new_events])" 4 -.el .IP "$old_events = \f(CW$term\fR\->pty_ev_events ([$new_events])" 4 +.ie n .IP "$old_events\fR = \f(CW$term\->pty_ev_events ([$new_events])" 4 +.el .IP "\f(CW$old_events\fR = \f(CW$term\fR\->pty_ev_events ([$new_events])" 4 .IX Item "$old_events = $term->pty_ev_events ([$new_events])" Replaces the event mask of the pty watcher by the given event mask. Can be used to suppress input and output handling to the pty/tty. See the description of \f(CW\*(C`urxvt::timer\->events\*(C'\fR. Make sure to always restore the previous value. -.ie n .IP "$fd = $term\->pty_fd" 4 -.el .IP "$fd = \f(CW$term\fR\->pty_fd" 4 +.ie n .IP "$fd\fR = \f(CW$term\->pty_fd" 4 +.el .IP "\f(CW$fd\fR = \f(CW$term\fR\->pty_fd" 4 .IX Item "$fd = $term->pty_fd" Returns the master file descriptor for the pty in use, or \f(CW\*(C`\-1\*(C'\fR if no pty is used. -.ie n .IP "$windowid = $term\->parent" 4 -.el .IP "$windowid = \f(CW$term\fR\->parent" 4 +.ie n .IP "$windowid\fR = \f(CW$term\->parent" 4 +.el .IP "\f(CW$windowid\fR = \f(CW$term\fR\->parent" 4 .IX Item "$windowid = $term->parent" Return the window id of the toplevel window. -.ie n .IP "$windowid = $term\->vt" 4 -.el .IP "$windowid = \f(CW$term\fR\->vt" 4 +.ie n .IP "$windowid\fR = \f(CW$term\->vt" 4 +.el .IP "\f(CW$windowid\fR = \f(CW$term\fR\->vt" 4 .IX Item "$windowid = $term->vt" Return the window id of the terminal window. -.IP "$term\->vt_emask_add ($x_event_mask)" 4 +.ie n .IP "$term\->vt_emask_add ($x_event_mask)" 4 +.el .IP "\f(CW$term\fR\->vt_emask_add ($x_event_mask)" 4 .IX Item "$term->vt_emask_add ($x_event_mask)" Adds the specified events to the vt event mask. Useful e.g. when you want to receive pointer events all the times: .Sp .Vb 1 -\& $term->vt_emask_add (urxvt::PointerMotionMask); +\& $term\->vt_emask_add (urxvt::PointerMotionMask); .Ve -.IP "$term\->focus_in" 4 +.ie n .IP "$term\->focus_in" 4 +.el .IP "\f(CW$term\fR\->focus_in" 4 .IX Item "$term->focus_in" .PD 0 -.IP "$term\->focus_out" 4 +.ie n .IP "$term\->focus_out" 4 +.el .IP "\f(CW$term\fR\->focus_out" 4 .IX Item "$term->focus_out" -.ie n .IP "$term\->key_press ($state, $keycode\fR[, \f(CW$time])" 4 -.el .IP "$term\->key_press ($state, \f(CW$keycode\fR[, \f(CW$time\fR])" 4 +.ie n .IP "$term\fR\->key_press ($state, \f(CW$keycode\fR[, \f(CW$time])" 4 +.el .IP "\f(CW$term\fR\->key_press ($state, \f(CW$keycode\fR[, \f(CW$time\fR])" 4 .IX Item "$term->key_press ($state, $keycode[, $time])" -.ie n .IP "$term\->key_release ($state, $keycode\fR[, \f(CW$time])" 4 -.el .IP "$term\->key_release ($state, \f(CW$keycode\fR[, \f(CW$time\fR])" 4 +.ie n .IP "$term\fR\->key_release ($state, \f(CW$keycode\fR[, \f(CW$time])" 4 +.el .IP "\f(CW$term\fR\->key_release ($state, \f(CW$keycode\fR[, \f(CW$time\fR])" 4 .IX Item "$term->key_release ($state, $keycode[, $time])" .PD Deliver various fake events to to terminal. -.ie n .IP "$window_width = $term\->width" 4 -.el .IP "$window_width = \f(CW$term\fR\->width" 4 +.ie n .IP "$window_width\fR = \f(CW$term\->width" 4 +.el .IP "\f(CW$window_width\fR = \f(CW$term\fR\->width" 4 .IX Item "$window_width = $term->width" .PD 0 -.ie n .IP "$window_height = $term\->height" 4 -.el .IP "$window_height = \f(CW$term\fR\->height" 4 +.ie n .IP "$window_height\fR = \f(CW$term\->height" 4 +.el .IP "\f(CW$window_height\fR = \f(CW$term\fR\->height" 4 .IX Item "$window_height = $term->height" -.ie n .IP "$font_width = $term\->fwidth" 4 -.el .IP "$font_width = \f(CW$term\fR\->fwidth" 4 +.ie n .IP "$font_width\fR = \f(CW$term\->fwidth" 4 +.el .IP "\f(CW$font_width\fR = \f(CW$term\fR\->fwidth" 4 .IX Item "$font_width = $term->fwidth" -.ie n .IP "$font_height = $term\->fheight" 4 -.el .IP "$font_height = \f(CW$term\fR\->fheight" 4 +.ie n .IP "$font_height\fR = \f(CW$term\->fheight" 4 +.el .IP "\f(CW$font_height\fR = \f(CW$term\fR\->fheight" 4 .IX Item "$font_height = $term->fheight" -.ie n .IP "$font_ascent = $term\->fbase" 4 -.el .IP "$font_ascent = \f(CW$term\fR\->fbase" 4 +.ie n .IP "$font_ascent\fR = \f(CW$term\->fbase" 4 +.el .IP "\f(CW$font_ascent\fR = \f(CW$term\fR\->fbase" 4 .IX Item "$font_ascent = $term->fbase" -.ie n .IP "$terminal_rows = $term\->nrow" 4 -.el .IP "$terminal_rows = \f(CW$term\fR\->nrow" 4 +.ie n .IP "$terminal_rows\fR = \f(CW$term\->nrow" 4 +.el .IP "\f(CW$terminal_rows\fR = \f(CW$term\fR\->nrow" 4 .IX Item "$terminal_rows = $term->nrow" -.ie n .IP "$terminal_columns = $term\->ncol" 4 -.el .IP "$terminal_columns = \f(CW$term\fR\->ncol" 4 +.ie n .IP "$terminal_columns\fR = \f(CW$term\->ncol" 4 +.el .IP "\f(CW$terminal_columns\fR = \f(CW$term\fR\->ncol" 4 .IX Item "$terminal_columns = $term->ncol" -.ie n .IP "$has_focus = $term\->focus" 4 -.el .IP "$has_focus = \f(CW$term\fR\->focus" 4 +.ie n .IP "$has_focus\fR = \f(CW$term\->focus" 4 +.el .IP "\f(CW$has_focus\fR = \f(CW$term\fR\->focus" 4 .IX Item "$has_focus = $term->focus" -.ie n .IP "$is_mapped = $term\->mapped" 4 -.el .IP "$is_mapped = \f(CW$term\fR\->mapped" 4 +.ie n .IP "$is_mapped\fR = \f(CW$term\->mapped" 4 +.el .IP "\f(CW$is_mapped\fR = \f(CW$term\fR\->mapped" 4 .IX Item "$is_mapped = $term->mapped" -.ie n .IP "$max_scrollback = $term\->saveLines" 4 -.el .IP "$max_scrollback = \f(CW$term\fR\->saveLines" 4 +.ie n .IP "$max_scrollback\fR = \f(CW$term\->saveLines" 4 +.el .IP "\f(CW$max_scrollback\fR = \f(CW$term\fR\->saveLines" 4 .IX Item "$max_scrollback = $term->saveLines" -.ie n .IP "$nrow_plus_saveLines = $term\->total_rows" 4 -.el .IP "$nrow_plus_saveLines = \f(CW$term\fR\->total_rows" 4 +.ie n .IP "$nrow_plus_saveLines\fR = \f(CW$term\->total_rows" 4 +.el .IP "\f(CW$nrow_plus_saveLines\fR = \f(CW$term\fR\->total_rows" 4 .IX Item "$nrow_plus_saveLines = $term->total_rows" -.ie n .IP "$topmost_scrollback_row = $term\->top_row" 4 -.el .IP "$topmost_scrollback_row = \f(CW$term\fR\->top_row" 4 +.ie n .IP "$topmost_scrollback_row\fR = \f(CW$term\->top_row" 4 +.el .IP "\f(CW$topmost_scrollback_row\fR = \f(CW$term\fR\->top_row" 4 .IX Item "$topmost_scrollback_row = $term->top_row" .PD Return various integers describing terminal characteristics. -.ie n .IP "$x_display = $term\->display_id" 4 -.el .IP "$x_display = \f(CW$term\fR\->display_id" 4 +.ie n .IP "$x_display\fR = \f(CW$term\->display_id" 4 +.el .IP "\f(CW$x_display\fR = \f(CW$term\fR\->display_id" 4 .IX Item "$x_display = $term->display_id" Return the \s-1DISPLAY\s0 used by rxvt\-unicode. -.ie n .IP "$lc_ctype = $term\->locale" 4 -.el .IP "$lc_ctype = \f(CW$term\fR\->locale" 4 +.ie n .IP "$lc_ctype\fR = \f(CW$term\->locale" 4 +.el .IP "\f(CW$lc_ctype\fR = \f(CW$term\fR\->locale" 4 .IX Item "$lc_ctype = $term->locale" Returns the \s-1LC_CTYPE\s0 category string used by this rxvt\-unicode. -.ie n .IP "$env = $term\->env" 4 -.el .IP "$env = \f(CW$term\fR\->env" 4 +.ie n .IP "$env\fR = \f(CW$term\->env" 4 +.el .IP "\f(CW$env\fR = \f(CW$term\fR\->env" 4 .IX Item "$env = $term->env" Returns a copy of the environment in effect for the terminal as a hashref similar to \f(CW\*(C`\e%ENV\*(C'\fR. -.ie n .IP "@envv = $term\->envv" 4 -.el .IP "@envv = \f(CW$term\fR\->envv" 4 +.ie n .IP "@envv\fR = \f(CW$term\->envv" 4 +.el .IP "\f(CW@envv\fR = \f(CW$term\fR\->envv" 4 .IX Item "@envv = $term->envv" Returns the environment as array of strings of the form \f(CW\*(C`VAR=VALUE\*(C'\fR. -.ie n .IP "@argv = $term\->argv" 4 -.el .IP "@argv = \f(CW$term\fR\->argv" 4 +.ie n .IP "@argv\fR = \f(CW$term\->argv" 4 +.el .IP "\f(CW@argv\fR = \f(CW$term\fR\->argv" 4 .IX Item "@argv = $term->argv" Return the argument vector as this terminal, similar to \f(CW@ARGV\fR, but includes the program name as first element. -.ie n .IP "$modifiermask = $term\->ModLevel3Mask" 4 -.el .IP "$modifiermask = \f(CW$term\fR\->ModLevel3Mask" 4 +.ie n .IP "$modifiermask\fR = \f(CW$term\->ModLevel3Mask" 4 +.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModLevel3Mask" 4 .IX Item "$modifiermask = $term->ModLevel3Mask" .PD 0 -.ie n .IP "$modifiermask = $term\->ModMetaMask" 4 -.el .IP "$modifiermask = \f(CW$term\fR\->ModMetaMask" 4 +.ie n .IP "$modifiermask\fR = \f(CW$term\->ModMetaMask" 4 +.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModMetaMask" 4 .IX Item "$modifiermask = $term->ModMetaMask" -.ie n .IP "$modifiermask = $term\->ModNumLockMask" 4 -.el .IP "$modifiermask = \f(CW$term\fR\->ModNumLockMask" 4 +.ie n .IP "$modifiermask\fR = \f(CW$term\->ModNumLockMask" 4 +.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModNumLockMask" 4 .IX Item "$modifiermask = $term->ModNumLockMask" .PD Return the modifier masks corresponding to the \*(L"\s-1ISO\s0 Level 3 Shift\*(R" (often AltGr), the meta key (often Alt) and the num lock key, if applicable. -.ie n .IP "$screen = $term\->current_screen" 4 -.el .IP "$screen = \f(CW$term\fR\->current_screen" 4 +.ie n .IP "$screen\fR = \f(CW$term\->current_screen" 4 +.el .IP "\f(CW$screen\fR = \f(CW$term\fR\->current_screen" 4 .IX Item "$screen = $term->current_screen" Returns the currently displayed screen (0 primary, 1 secondary). -.ie n .IP "$cursor_is_hidden = $term\->hidden_cursor" 4 -.el .IP "$cursor_is_hidden = \f(CW$term\fR\->hidden_cursor" 4 +.ie n .IP "$cursor_is_hidden\fR = \f(CW$term\->hidden_cursor" 4 +.el .IP "\f(CW$cursor_is_hidden\fR = \f(CW$term\fR\->hidden_cursor" 4 .IX Item "$cursor_is_hidden = $term->hidden_cursor" Returns wether the cursor is currently hidden or not. -.ie n .IP "$view_start = $term\->view_start ([$newvalue])" 4 -.el .IP "$view_start = \f(CW$term\fR\->view_start ([$newvalue])" 4 +.ie n .IP "$view_start\fR = \f(CW$term\->view_start ([$newvalue])" 4 +.el .IP "\f(CW$view_start\fR = \f(CW$term\fR\->view_start ([$newvalue])" 4 .IX Item "$view_start = $term->view_start ([$newvalue])" Returns the row number of the topmost displayed line. Maximum value is \&\f(CW0\fR, which displays the normal terminal contents. Lower values scroll this many lines into the scrollback buffer. -.IP "$term\->want_refresh" 4 +.ie n .IP "$term\->want_refresh" 4 +.el .IP "\f(CW$term\fR\->want_refresh" 4 .IX Item "$term->want_refresh" Requests a screen refresh. At the next opportunity, rxvt-unicode will compare the on-screen display with its stored representation. If they differ, it redraws the differences. .Sp Used after changing terminal contents to display them. -.ie n .IP "$text = $term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col]])" 4 -.el .IP "$text = \f(CW$term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col\fR]])" 4 +.ie n .IP "$text\fR = \f(CW$term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col]])" 4 +.el .IP "\f(CW$text\fR = \f(CW$term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col\fR]])" 4 .IX Item "$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])" Returns the text of the entire row with number \f(CW$row_number\fR. Row \f(CW0\fR is the topmost terminal line, row \f(CW\*(C`$term\->$ncol\-1\*(C'\fR is the bottommost @@ -1298,8 +1334,8 @@ characters. .Sp The methods \f(CW\*(C`$term\->special_encode\*(C'\fR and \f(CW\*(C`$term\->special_decode\*(C'\fR can be used to convert normal strings into this encoding and vice versa. -.ie n .IP "$rend = $term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col]])" 4 -.el .IP "$rend = \f(CW$term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col\fR]])" 4 +.ie n .IP "$rend\fR = \f(CW$term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col]])" 4 +.el .IP "\f(CW$rend\fR = \f(CW$term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col\fR]])" 4 .IX Item "$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])" Like \f(CW\*(C`$term\->ROW_t\*(C'\fR, but returns an arrayref with rendition bitsets. Rendition bitsets contain information about colour, font, font @@ -1308,49 +1344,49 @@ styles and similar information. See also \f(CW\*(C`$term\->ROW_t\*(C'\fR. When setting rendition, the font mask will be ignored. .Sp See the section on \s-1RENDITION\s0, above. -.ie n .IP "$length = $term\fR\->ROW_l ($row_number[, \f(CW$new_length])" 4 -.el .IP "$length = \f(CW$term\fR\->ROW_l ($row_number[, \f(CW$new_length\fR])" 4 +.ie n .IP "$length\fR = \f(CW$term\fR\->ROW_l ($row_number[, \f(CW$new_length])" 4 +.el .IP "\f(CW$length\fR = \f(CW$term\fR\->ROW_l ($row_number[, \f(CW$new_length\fR])" 4 .IX Item "$length = $term->ROW_l ($row_number[, $new_length])" Returns the number of screen cells that are in use (\*(L"the line length\*(R"). Unlike the urxvt core, this returns \f(CW\*(C`$term\->ncol\*(C'\fR if the line is joined with the following one. -.ie n .IP "$bool = $term\->is_longer ($row_number)" 4 -.el .IP "$bool = \f(CW$term\fR\->is_longer ($row_number)" 4 +.ie n .IP "$bool\fR = \f(CW$term\->is_longer ($row_number)" 4 +.el .IP "\f(CW$bool\fR = \f(CW$term\fR\->is_longer ($row_number)" 4 .IX Item "$bool = $term->is_longer ($row_number)" Returns true if the row is part of a multiple-row logical \*(L"line\*(R" (i.e. joined with the following row), which means all characters are in use and it is continued on the next row (and possibly a continuation of the previous row(s)). -.ie n .IP "$line = $term\->line ($row_number)" 4 -.el .IP "$line = \f(CW$term\fR\->line ($row_number)" 4 +.ie n .IP "$line\fR = \f(CW$term\->line ($row_number)" 4 +.el .IP "\f(CW$line\fR = \f(CW$term\fR\->line ($row_number)" 4 .IX Item "$line = $term->line ($row_number)" Create and return a new \f(CW\*(C`urxvt::line\*(C'\fR object that stores information about the logical line that row \f(CW$row_number\fR is part of. It supports the following methods: .RS 4 -.ie n .IP "$text = $line\->t ([$new_text])" 4 -.el .IP "$text = \f(CW$line\fR\->t ([$new_text])" 4 +.ie n .IP "$text\fR = \f(CW$line\->t ([$new_text])" 4 +.el .IP "\f(CW$text\fR = \f(CW$line\fR\->t ([$new_text])" 4 .IX Item "$text = $line->t ([$new_text])" Returns or replaces the full text of the line, similar to \f(CW\*(C`ROW_t\*(C'\fR -.ie n .IP "$rend = $line\->r ([$new_rend])" 4 -.el .IP "$rend = \f(CW$line\fR\->r ([$new_rend])" 4 +.ie n .IP "$rend\fR = \f(CW$line\->r ([$new_rend])" 4 +.el .IP "\f(CW$rend\fR = \f(CW$line\fR\->r ([$new_rend])" 4 .IX Item "$rend = $line->r ([$new_rend])" Returns or replaces the full rendition array of the line, similar to \f(CW\*(C`ROW_r\*(C'\fR -.ie n .IP "$length = $line\->l" 4 -.el .IP "$length = \f(CW$line\fR\->l" 4 +.ie n .IP "$length\fR = \f(CW$line\->l" 4 +.el .IP "\f(CW$length\fR = \f(CW$line\fR\->l" 4 .IX Item "$length = $line->l" Returns the length of the line in cells, similar to \f(CW\*(C`ROW_l\*(C'\fR. -.ie n .IP "$rownum = $line\->beg" 4 -.el .IP "$rownum = \f(CW$line\fR\->beg" 4 +.ie n .IP "$rownum\fR = \f(CW$line\->beg" 4 +.el .IP "\f(CW$rownum\fR = \f(CW$line\fR\->beg" 4 .IX Item "$rownum = $line->beg" .PD 0 -.ie n .IP "$rownum = $line\->end" 4 -.el .IP "$rownum = \f(CW$line\fR\->end" 4 +.ie n .IP "$rownum\fR = \f(CW$line\->end" 4 +.el .IP "\f(CW$rownum\fR = \f(CW$line\fR\->end" 4 .IX Item "$rownum = $line->end" .PD Return the row number of the first/last row of the line, respectively. -.ie n .IP "$offset = $line\fR\->offset_of ($row, \f(CW$col)" 4 -.el .IP "$offset = \f(CW$line\fR\->offset_of ($row, \f(CW$col\fR)" 4 +.ie n .IP "$offset\fR = \f(CW$line\fR\->offset_of ($row, \f(CW$col)" 4 +.el .IP "\f(CW$offset\fR = \f(CW$line\fR\->offset_of ($row, \f(CW$col\fR)" 4 .IX Item "$offset = $line->offset_of ($row, $col)" Returns the character offset of the given row|col pair within the logical line. Works for rows outside the line, too, and returns corresponding @@ -1362,84 +1398,90 @@ Translates a string offset into terminal coordinates again. .RE .RS 4 .RE -.ie n .IP "$text = $term\fR\->special_encode \f(CW$string" 4 -.el .IP "$text = \f(CW$term\fR\->special_encode \f(CW$string\fR" 4 +.ie n .IP "$text\fR = \f(CW$term\fR\->special_encode \f(CW$string" 4 +.el .IP "\f(CW$text\fR = \f(CW$term\fR\->special_encode \f(CW$string\fR" 4 .IX Item "$text = $term->special_encode $string" Converts a perl string into the special encoding used by rxvt\-unicode, where one character corresponds to one screen cell. See \&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. -.ie n .IP "$string = $term\fR\->special_decode \f(CW$text" 4 -.el .IP "$string = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4 +.ie n .IP "$string\fR = \f(CW$term\fR\->special_decode \f(CW$text" 4 +.el .IP "\f(CW$string\fR = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4 .IX Item "$string = $term->special_decode $text" Converts rxvt-unicodes text reprsentation into a perl string. See \&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. -.ie n .IP "$success = $term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4 -.el .IP "$success = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4 +.ie n .IP "$success\fR = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4 +.el .IP "\f(CW$success\fR = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4 .IX Item "$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])" .PD 0 -.ie n .IP "$term\->ungrab_button ($button, $modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4 -.el .IP "$term\->ungrab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4 +.ie n .IP "$term\fR\->ungrab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4 +.el .IP "\f(CW$term\fR\->ungrab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4 .IX Item "$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])" .PD Register/unregister a synchronous button grab. See the XGrabButton manpage. -.ie n .IP "$success = $term\fR\->grab ($eventtime[, \f(CW$sync])" 4 -.el .IP "$success = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync\fR])" 4 +.ie n .IP "$success\fR = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync])" 4 +.el .IP "\f(CW$success\fR = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync\fR])" 4 .IX Item "$success = $term->grab ($eventtime[, $sync])" Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or synchronous (\f(CW$sync\fR is true). Also remembers the grab timestampe. -.IP "$term\->allow_events_async" 4 +.ie n .IP "$term\->allow_events_async" 4 +.el .IP "\f(CW$term\fR\->allow_events_async" 4 .IX Item "$term->allow_events_async" Calls XAllowEvents with AsyncBoth for the most recent grab. -.IP "$term\->allow_events_sync" 4 +.ie n .IP "$term\->allow_events_sync" 4 +.el .IP "\f(CW$term\fR\->allow_events_sync" 4 .IX Item "$term->allow_events_sync" Calls XAllowEvents with SyncBoth for the most recent grab. -.IP "$term\->allow_events_replay" 4 +.ie n .IP "$term\->allow_events_replay" 4 +.el .IP "\f(CW$term\fR\->allow_events_replay" 4 .IX Item "$term->allow_events_replay" Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most recent grab. -.IP "$term\->ungrab" 4 +.ie n .IP "$term\->ungrab" 4 +.el .IP "\f(CW$term\fR\->ungrab" 4 .IX Item "$term->ungrab" Calls XUngrab for the most recent grab. Is called automatically on evaluation errors, as it is better to lose the grab in the error case as the session. -.ie n .IP "$atom = $term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists])" 4 -.el .IP "$atom = \f(CW$term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists\fR])" 4 +.ie n .IP "$atom\fR = \f(CW$term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists])" 4 +.el .IP "\f(CW$atom\fR = \f(CW$term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists\fR])" 4 .IX Item "$atom = $term->XInternAtom ($atom_name[, $only_if_exists])" .PD 0 -.ie n .IP "$atom_name = $term\->XGetAtomName ($atom)" 4 -.el .IP "$atom_name = \f(CW$term\fR\->XGetAtomName ($atom)" 4 +.ie n .IP "$atom_name\fR = \f(CW$term\->XGetAtomName ($atom)" 4 +.el .IP "\f(CW$atom_name\fR = \f(CW$term\fR\->XGetAtomName ($atom)" 4 .IX Item "$atom_name = $term->XGetAtomName ($atom)" -.ie n .IP "@atoms = $term\->XListProperties ($window)" 4 -.el .IP "@atoms = \f(CW$term\fR\->XListProperties ($window)" 4 +.ie n .IP "@atoms\fR = \f(CW$term\->XListProperties ($window)" 4 +.el .IP "\f(CW@atoms\fR = \f(CW$term\fR\->XListProperties ($window)" 4 .IX Item "@atoms = $term->XListProperties ($window)" .ie n .IP "($type,$format,$octets) = $term\fR\->XGetWindowProperty ($window, \f(CW$property)" 4 .el .IP "($type,$format,$octets) = \f(CW$term\fR\->XGetWindowProperty ($window, \f(CW$property\fR)" 4 .IX Item "($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)" -.ie n .IP "$term\->XChangeWindowProperty ($window, $property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets)" 4 -.el .IP "$term\->XChangeWindowProperty ($window, \f(CW$property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets\fR)" 4 +.ie n .IP "$term\fR\->XChangeWindowProperty ($window, \f(CW$property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets)" 4 +.el .IP "\f(CW$term\fR\->XChangeWindowProperty ($window, \f(CW$property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets\fR)" 4 .IX Item "$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)" -.ie n .IP "$term\->XDeleteProperty ($window, $property)" 4 -.el .IP "$term\->XDeleteProperty ($window, \f(CW$property\fR)" 4 +.ie n .IP "$term\fR\->XDeleteProperty ($window, \f(CW$property)" 4 +.el .IP "\f(CW$term\fR\->XDeleteProperty ($window, \f(CW$property\fR)" 4 .IX Item "$term->XDeleteProperty ($window, $property)" -.ie n .IP "$window = $term\->DefaultRootWindow" 4 -.el .IP "$window = \f(CW$term\fR\->DefaultRootWindow" 4 +.ie n .IP "$window\fR = \f(CW$term\->DefaultRootWindow" 4 +.el .IP "\f(CW$window\fR = \f(CW$term\fR\->DefaultRootWindow" 4 .IX Item "$window = $term->DefaultRootWindow" -.ie n .IP "$term\->XReparentWindow ($window, $parent\fR, [$x, \f(CW$y])" 4 -.el .IP "$term\->XReparentWindow ($window, \f(CW$parent\fR, [$x, \f(CW$y\fR])" 4 +.ie n .IP "$term\fR\->XReparentWindow ($window, \f(CW$parent\fR, [$x, \f(CW$y])" 4 +.el .IP "\f(CW$term\fR\->XReparentWindow ($window, \f(CW$parent\fR, [$x, \f(CW$y\fR])" 4 .IX Item "$term->XReparentWindow ($window, $parent, [$x, $y])" -.IP "$term\->XMapWindow ($window)" 4 +.ie n .IP "$term\->XMapWindow ($window)" 4 +.el .IP "\f(CW$term\fR\->XMapWindow ($window)" 4 .IX Item "$term->XMapWindow ($window)" -.IP "$term\->XUnmapWindow ($window)" 4 +.ie n .IP "$term\->XUnmapWindow ($window)" 4 +.el .IP "\f(CW$term\fR\->XUnmapWindow ($window)" 4 .IX Item "$term->XUnmapWindow ($window)" -.ie n .IP "$term\->XMoveResizeWindow ($window, $x\fR, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height)" 4 -.el .IP "$term\->XMoveResizeWindow ($window, \f(CW$x\fR, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR)" 4 +.ie n .IP "$term\fR\->XMoveResizeWindow ($window, \f(CW$x\fR, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height)" 4 +.el .IP "\f(CW$term\fR\->XMoveResizeWindow ($window, \f(CW$x\fR, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR)" 4 .IX Item "$term->XMoveResizeWindow ($window, $x, $y, $width, $height)" .ie n .IP "($x, $y\fR, \f(CW$child_window\fR) = \f(CW$term\fR\->XTranslateCoordinates ($src, \f(CW$dst\fR, \f(CW$x\fR, \f(CW$y)" 4 .el .IP "($x, \f(CW$y\fR, \f(CW$child_window\fR) = \f(CW$term\fR\->XTranslateCoordinates ($src, \f(CW$dst\fR, \f(CW$x\fR, \f(CW$y\fR)" 4 .IX Item "($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)" -.ie n .IP "$term\->XChangeInput ($window, $add_events\fR[, \f(CW$del_events])" 4 -.el .IP "$term\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events\fR])" 4 +.ie n .IP "$term\fR\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events])" 4 +.el .IP "\f(CW$term\fR\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events\fR])" 4 .IX Item "$term->XChangeInput ($window, $add_events[, $del_events])" .PD Various X or X\-related functions. The \f(CW$term\fR object only serves as @@ -1448,24 +1490,27 @@ directory onto the X functions of the same name. .ie n .Sh "The ""urxvt::popup"" Class" .el .Sh "The \f(CWurxvt::popup\fP Class" .IX Subsection "The urxvt::popup Class" -.IP "$popup\->add_title ($title)" 4 +.ie n .IP "$popup\->add_title ($title)" 4 +.el .IP "\f(CW$popup\fR\->add_title ($title)" 4 .IX Item "$popup->add_title ($title)" Adds a non-clickable title to the popup. -.IP "$popup\->add_separator ([$sepchr])" 4 +.ie n .IP "$popup\->add_separator ([$sepchr])" 4 +.el .IP "\f(CW$popup\fR\->add_separator ([$sepchr])" 4 .IX Item "$popup->add_separator ([$sepchr])" Creates a separator, optionally using the character given as \f(CW$sepchr\fR. -.ie n .IP "$popup\->add_button ($text, $cb)" 4 -.el .IP "$popup\->add_button ($text, \f(CW$cb\fR)" 4 +.ie n .IP "$popup\fR\->add_button ($text, \f(CW$cb)" 4 +.el .IP "\f(CW$popup\fR\->add_button ($text, \f(CW$cb\fR)" 4 .IX Item "$popup->add_button ($text, $cb)" Adds a clickable button to the popup. \f(CW$cb\fR is called whenever it is selected. -.ie n .IP "$popup\->add_toggle ($text, $initial_value\fR, \f(CW$cb)" 4 -.el .IP "$popup\->add_toggle ($text, \f(CW$initial_value\fR, \f(CW$cb\fR)" 4 +.ie n .IP "$popup\fR\->add_toggle ($text, \f(CW$initial_value\fR, \f(CW$cb)" 4 +.el .IP "\f(CW$popup\fR\->add_toggle ($text, \f(CW$initial_value\fR, \f(CW$cb\fR)" 4 .IX Item "$popup->add_toggle ($text, $initial_value, $cb)" Adds a toggle/checkbox item to the popup. The callback gets called whenever it gets toggled, with a boolean indicating its new value as its first argument. -.IP "$popup\->show" 4 +.ie n .IP "$popup\->show" 4 +.el .IP "\f(CW$popup\fR\->show" 4 .IX Item "$popup->show" Displays the popup (which is initially hidden). .ie n .Sh "The ""urxvt::timer"" Class" @@ -1475,51 +1520,52 @@ This class implements timer watchers/events. Time is represented as a fractional number of seconds since the epoch. Example: .PP .Vb 8 -\& $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); -\& $term->{timer} = urxvt::timer -\& ->new -\& ->interval (1) -\& ->cb (sub { -\& $term->{overlay}->set (0, 0, +\& $term\->{overlay} = $term\->overlay (\-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); +\& $term\->{timer} = urxvt::timer +\& \->new +\& \->interval (1) +\& \->cb (sub { +\& $term\->{overlay}\->set (0, 0, \& sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); \& }); .Ve -.IP "$timer = new urxvt::timer" 4 +.ie n .IP "$timer = new urxvt::timer" 4 +.el .IP "\f(CW$timer\fR = new urxvt::timer" 4 .IX Item "$timer = new urxvt::timer" Create a new timer object in started state. It is scheduled to fire immediately. -.ie n .IP "$timer = $timer\fR\->cb (sub { my ($timer) = \f(CW@_; ... })" 4 -.el .IP "$timer = \f(CW$timer\fR\->cb (sub { my ($timer) = \f(CW@_\fR; ... })" 4 +.ie n .IP "$timer\fR = \f(CW$timer\fR\->cb (sub { my ($timer) = \f(CW@_; ... })" 4 +.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->cb (sub { my ($timer) = \f(CW@_\fR; ... })" 4 .IX Item "$timer = $timer->cb (sub { my ($timer) = @_; ... })" Set the callback to be called when the timer triggers. -.ie n .IP "$tstamp = $timer\->at" 4 -.el .IP "$tstamp = \f(CW$timer\fR\->at" 4 +.ie n .IP "$tstamp\fR = \f(CW$timer\->at" 4 +.el .IP "\f(CW$tstamp\fR = \f(CW$timer\fR\->at" 4 .IX Item "$tstamp = $timer->at" Return the time this watcher will fire next. -.ie n .IP "$timer = $timer\->set ($tstamp)" 4 -.el .IP "$timer = \f(CW$timer\fR\->set ($tstamp)" 4 +.ie n .IP "$timer\fR = \f(CW$timer\->set ($tstamp)" 4 +.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->set ($tstamp)" 4 .IX Item "$timer = $timer->set ($tstamp)" Set the time the event is generated to \f(CW$tstamp\fR. -.ie n .IP "$timer = $timer\->interval ($interval)" 4 -.el .IP "$timer = \f(CW$timer\fR\->interval ($interval)" 4 +.ie n .IP "$timer\fR = \f(CW$timer\->interval ($interval)" 4 +.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->interval ($interval)" 4 .IX Item "$timer = $timer->interval ($interval)" Normally (and when \f(CW$interval\fR is \f(CW0\fR), the timer will automatically stop after it has fired once. If \f(CW$interval\fR is non\-zero, then the timer is automatically rescheduled at the given intervals. -.ie n .IP "$timer = $timer\->start" 4 -.el .IP "$timer = \f(CW$timer\fR\->start" 4 +.ie n .IP "$timer\fR = \f(CW$timer\->start" 4 +.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start" 4 .IX Item "$timer = $timer->start" Start the timer. -.ie n .IP "$timer = $timer\->start ($tstamp)" 4 -.el .IP "$timer = \f(CW$timer\fR\->start ($tstamp)" 4 +.ie n .IP "$timer\fR = \f(CW$timer\->start ($tstamp)" 4 +.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start ($tstamp)" 4 .IX Item "$timer = $timer->start ($tstamp)" Set the event trigger time to \f(CW$tstamp\fR and start the timer. -.ie n .IP "$timer = $timer\->after ($delay)" 4 -.el .IP "$timer = \f(CW$timer\fR\->after ($delay)" 4 +.ie n .IP "$timer\fR = \f(CW$timer\->after ($delay)" 4 +.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->after ($delay)" 4 .IX Item "$timer = $timer->after ($delay)" Like \f(CW\*(C`start\*(C'\fR, but sets the expiry timer to c. -.ie n .IP "$timer = $timer\->stop" 4 -.el .IP "$timer = \f(CW$timer\fR\->stop" 4 +.ie n .IP "$timer\fR = \f(CW$timer\->stop" 4 +.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->stop" 4 .IX Item "$timer = $timer->stop" Stop the timer. .ie n .Sh "The ""urxvt::iow"" Class" @@ -1528,43 +1574,44 @@ Stop the timer. This class implements io watchers/events. Example: .PP .Vb 12 -\& $term->{socket} = ... -\& $term->{iow} = urxvt::iow -\& ->new -\& ->fd (fileno $term->{socket}) -\& ->events (urxvt::EVENT_READ) -\& ->start -\& ->cb (sub { +\& $term\->{socket} = ... +\& $term\->{iow} = urxvt::iow +\& \->new +\& \->fd (fileno $term\->{socket}) +\& \->events (urxvt::EVENT_READ) +\& \->start +\& \->cb (sub { \& my ($iow, $revents) = @_; \& # $revents must be 1 here, no need to check -\& sysread $term->{socket}, my $buf, 8192 -\& or end-of-file; +\& sysread $term\->{socket}, my $buf, 8192 +\& or end\-of\-file; \& }); .Ve -.IP "$iow = new urxvt::iow" 4 +.ie n .IP "$iow = new urxvt::iow" 4 +.el .IP "\f(CW$iow\fR = new urxvt::iow" 4 .IX Item "$iow = new urxvt::iow" Create a new io watcher object in stopped state. -.ie n .IP "$iow = $iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_; ... })" 4 -.el .IP "$iow = \f(CW$iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_\fR; ... })" 4 +.ie n .IP "$iow\fR = \f(CW$iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_; ... })" 4 +.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_\fR; ... })" 4 .IX Item "$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })" Set the callback to be called when io events are triggered. \f(CW$reventmask\fR is a bitset as described in the \f(CW\*(C`events\*(C'\fR method. -.ie n .IP "$iow = $iow\->fd ($fd)" 4 -.el .IP "$iow = \f(CW$iow\fR\->fd ($fd)" 4 +.ie n .IP "$iow\fR = \f(CW$iow\->fd ($fd)" 4 +.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->fd ($fd)" 4 .IX Item "$iow = $iow->fd ($fd)" Set the filedescriptor (not handle) to watch. -.ie n .IP "$iow = $iow\->events ($eventmask)" 4 -.el .IP "$iow = \f(CW$iow\fR\->events ($eventmask)" 4 +.ie n .IP "$iow\fR = \f(CW$iow\->events ($eventmask)" 4 +.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->events ($eventmask)" 4 .IX Item "$iow = $iow->events ($eventmask)" Set the event mask to watch. The only allowed values are \&\f(CW\*(C`urxvt::EVENT_READ\*(C'\fR and \f(CW\*(C`urxvt::EVENT_WRITE\*(C'\fR, which might be ORed together, or \f(CW\*(C`urxvt::EVENT_NONE\*(C'\fR. -.ie n .IP "$iow = $iow\->start" 4 -.el .IP "$iow = \f(CW$iow\fR\->start" 4 +.ie n .IP "$iow\fR = \f(CW$iow\->start" 4 +.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->start" 4 .IX Item "$iow = $iow->start" Start watching for requested events on the given handle. -.ie n .IP "$iow = $iow\->stop" 4 -.el .IP "$iow = \f(CW$iow\fR\->stop" 4 +.ie n .IP "$iow\fR = \f(CW$iow\->stop" 4 +.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->stop" 4 .IX Item "$iow = $iow->stop" Stop watching for events on the given filehandle. .ie n .Sh "The ""urxvt::iw"" Class" @@ -1573,19 +1620,20 @@ Stop watching for events on the given filehandle. This class implements idle watchers, that get called automatically when the process is idle. They should return as fast as possible, after doing some useful work. -.IP "$iw = new urxvt::iw" 4 +.ie n .IP "$iw = new urxvt::iw" 4 +.el .IP "\f(CW$iw\fR = new urxvt::iw" 4 .IX Item "$iw = new urxvt::iw" Create a new idle watcher object in stopped state. -.ie n .IP "$iw = $iw\fR\->cb (sub { my ($iw) = \f(CW@_; ... })" 4 -.el .IP "$iw = \f(CW$iw\fR\->cb (sub { my ($iw) = \f(CW@_\fR; ... })" 4 +.ie n .IP "$iw\fR = \f(CW$iw\fR\->cb (sub { my ($iw) = \f(CW@_; ... })" 4 +.el .IP "\f(CW$iw\fR = \f(CW$iw\fR\->cb (sub { my ($iw) = \f(CW@_\fR; ... })" 4 .IX Item "$iw = $iw->cb (sub { my ($iw) = @_; ... })" Set the callback to be called when the watcher triggers. -.ie n .IP "$timer = $timer\->start" 4 -.el .IP "$timer = \f(CW$timer\fR\->start" 4 +.ie n .IP "$timer\fR = \f(CW$timer\->start" 4 +.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start" 4 .IX Item "$timer = $timer->start" Start the watcher. -.ie n .IP "$timer = $timer\->stop" 4 -.el .IP "$timer = \f(CW$timer\fR\->stop" 4 +.ie n .IP "$timer\fR = \f(CW$timer\->stop" 4 +.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->stop" 4 .IX Item "$timer = $timer->stop" Stop the watcher. .ie n .Sh "The ""urxvt::pw"" Class" @@ -1597,27 +1645,28 @@ process exits, after which they stop automatically. .Vb 9 \& my $pid = fork; \& ... -\& $term->{pw} = urxvt::pw -\& ->new -\& ->start ($pid) -\& ->cb (sub { +\& $term\->{pw} = urxvt::pw +\& \->new +\& \->start ($pid) +\& \->cb (sub { \& my ($pw, $exit_status) = @_; \& ... \& }); .Ve -.IP "$pw = new urxvt::pw" 4 +.ie n .IP "$pw = new urxvt::pw" 4 +.el .IP "\f(CW$pw\fR = new urxvt::pw" 4 .IX Item "$pw = new urxvt::pw" Create a new process watcher in stopped state. -.ie n .IP "$pw = $pw\fR\->cb (sub { my ($pw, \f(CW$exit_status\fR) = \f(CW@_; ... })" 4 -.el .IP "$pw = \f(CW$pw\fR\->cb (sub { my ($pw, \f(CW$exit_status\fR) = \f(CW@_\fR; ... })" 4 +.ie n .IP "$pw\fR = \f(CW$pw\fR\->cb (sub { my ($pw, \f(CW$exit_status\fR) = \f(CW@_; ... })" 4 +.el .IP "\f(CW$pw\fR = \f(CW$pw\fR\->cb (sub { my ($pw, \f(CW$exit_status\fR) = \f(CW@_\fR; ... })" 4 .IX Item "$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })" Set the callback to be called when the timer triggers. -.ie n .IP "$pw = $timer\->start ($pid)" 4 -.el .IP "$pw = \f(CW$timer\fR\->start ($pid)" 4 +.ie n .IP "$pw\fR = \f(CW$timer\->start ($pid)" 4 +.el .IP "\f(CW$pw\fR = \f(CW$timer\fR\->start ($pid)" 4 .IX Item "$pw = $timer->start ($pid)" Tells the wqtcher to start watching for process \f(CW$pid\fR. -.ie n .IP "$pw = $pw\->stop" 4 -.el .IP "$pw = \f(CW$pw\fR\->stop" 4 +.ie n .IP "$pw\fR = \f(CW$pw\->stop" 4 +.el .IP "\f(CW$pw\fR = \f(CW$pw\fR\->stop" 4 .IX Item "$pw = $pw->stop" Stop the watcher. .SH "ENVIRONMENT" @@ -1640,5 +1689,5 @@ numbers indicate more verbose output. .IX Header "AUTHOR" .Vb 2 \& Marc Lehmann -\& http://software.schmorp.de/pkg/rxvt-unicode +\& http://software.schmorp.de/pkg/rxvt\-unicode .Ve diff --git a/doc/rxvtperl.3.txt b/doc/rxvtperl.3.txt index 78240eea..1dddc73c 100644 --- a/doc/rxvtperl.3.txt +++ b/doc/rxvtperl.3.txt @@ -65,7 +65,7 @@ PREPACKAGED EXTENSIONS following pattern matches the filename (note, there is a single space at the very end): - URxvt.selection.pattern-0: ^(/[^:]+):\ + URxvt.selection.pattern-0: ^(/[^:]+):\ You can look at the source of the selection extension to see more interesting uses, such as parsing a line from beginning to end. @@ -138,6 +138,13 @@ PREPACKAGED EXTENSIONS stay at the current position and additionally stores the first match in the current line into the primary selection. + The regex defaults to "(?i)", resulting in a case-insensitive + search. To get a case-sensitive search you can delete this prefix + using "BackSpace" or simply use an uppercase character which removes + the "(?i)" prefix. + + See perlre for more info about perl regular expression syntax. + readline (enabled by default) A support package that tries to make editing with readline easier. At the moment, it reacts to clicking shift-left mouse button by @@ -231,17 +238,17 @@ PREPACKAGED EXTENSIONS rxvt -pt OnTheSpot -pe xim-onthespot automove-background - This is basically a one-line extension that dynamically changes the - background pixmap offset to the window position, in effect creating - the same effect as pseudo transparency with a custom pixmap. No - scaling is supported in this mode. Exmaple: + This is basically a very small extension that dynamically changes + the background pixmap offset to the window position, in effect + creating the same effect as pseudo transparency with a custom + pixmap. No scaling is supported in this mode. Exmaple: rxvt -pixmap background.xpm -pe automove-background block-graphics-to-ascii A not very useful example of filtering all text output to the - terminal, by replacing all line-drawing characters (U+2500 .. - U+259F) by a similar-looking ascii character. + terminal by replacing all line-drawing characters (U+2500 .. U+259F) + by a similar-looking ascii character. digital-clock Displays a digital clock using the built-in overlay. @@ -329,7 +336,7 @@ API DOCUMENTATION locale-specific way. Extension Objects - Very perl extension is a perl class. A separate perl object is created + Every perl extension is a perl class. A separate perl object is created for each terminal and each extension and passed as the first parameter to hooks. So extensions can use their $self object without having to think about other extensions, with the exception of methods and members @@ -437,7 +444,16 @@ API DOCUMENTATION - 1, $nrow - 1) represent the lines to be scrolled out). $saved is the total number of lines that will be in the scrollback buffer. - on_osc_seq $term, $string + on_osc_seq $term, $op, $args + Called on every OSC sequence and can be used to suppress it or + modify its behaviour. The default should be to return an empty list. + A true value suppresses execution of the request completely. Make + sure you don't get confused by recursive invocations when you output + an osc sequence within this callback. + + "on_osc_seq_perl" should be used for new behaviour. + + on_osc_seq_perl $term, $string Called whenever the ESC ] 777 ; string ST command sequence (OSC = operating system command) is processed. Cursor position and other state information is up-to-date when this happens. For @@ -1118,7 +1134,7 @@ API DOCUMENTATION ->cb (sub { $term->{overlay}->set (0, 0, sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); - }); + }); $timer = new urxvt::timer Create a new timer object in started state. It is scheduled to fire @@ -1216,7 +1232,7 @@ API DOCUMENTATION ->cb (sub { my ($pw, $exit_status) = @_; ... - }); + }); $pw = new urxvt::pw Create a new process watcher in stopped state. diff --git a/src/Makefile.in b/src/Makefile.in index 2dca5a75..2e2a204d 100644 --- a/src/Makefile.in +++ b/src/Makefile.in @@ -1136,3 +1136,102 @@ xdefaults.lo: keyboard.h xpm.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h rxvtutil.h xpm.lo: rxvtfont.h rxvttoolkit.h iom.h iom_conf.h callback.h salloc.h xpm.lo: libptytty.h rxvtperl.h hookinc.h rsinc.h + +command.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +command.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h callback.h +command.lo: salloc.h libptytty.h rxvtperl.h hookinc.h rsinc.h version.h +command.lo: command.h keyboard.h +encoding.lo: ../config.h encoding.h table/iso8859_1.h table/iso8859_15.h +encoding.lo: table/iso8859_2.h table/iso8859_3.h table/iso8859_4.h +encoding.lo: table/iso8859_5.h table/iso8859_6.h table/iso8859_7.h +encoding.lo: table/iso8859_8.h table/iso8859_9.h table/iso8859_10.h +encoding.lo: table/iso8859_11.h table/iso8859_13.h table/iso8859_14.h +encoding.lo: table/iso8859_16.h table/koi8_r.h table/koi8_u.h +encoding.lo: table/ksc5601_1987_0.h table/big5.h table/gbk_0.h +encoding.lo: table/gb2312_1980_0.h table/cns11643_1992_1.h +encoding.lo: table/cns11643_1992_2.h table/cns11643_1992_3.h +encoding.lo: table/cns11643_1992_4.h table/cns11643_1992_5.h +encoding.lo: table/cns11643_1992_6.h table/cns11643_1992_7.h +encoding.lo: table/cns11643_1992_f.h table/big5_ext.h table/big5_plus.h +encoding.lo: table/viscii.h table/jis0201_1976_0.h table/jis0208_1990_0.h +encoding.lo: table/jis0212_1990_0.h table/jis0213_1.h table/jis0213_2.h +encoding.lo: table/compose.h table/category.h +fdpass.lo: ../config.h libptytty.h +init.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +init.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h callback.h +init.lo: salloc.h libptytty.h rxvtperl.h hookinc.h rsinc.h init.h +iom.lo: iom.h iom_conf.h rxvtutil.h callback.h +keyboard.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +keyboard.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h callback.h +keyboard.lo: salloc.h libptytty.h rxvtperl.h hookinc.h rsinc.h keyboard.h +keyboard.lo: command.h +logging.lo: ../config.h ptytty.h libptytty.h ptytty_conf.h rxvt.h rxvtlib.h +logging.lo: optinc.h feature.h encoding.h rxvtutil.h rxvtfont.h rxvttoolkit.h +logging.lo: iom.h iom_conf.h callback.h salloc.h rxvtperl.h hookinc.h rsinc.h +main.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +main.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h callback.h +main.lo: salloc.h libptytty.h rxvtperl.h hookinc.h rsinc.h keyboard.h +misc.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +misc.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h callback.h +misc.lo: salloc.h libptytty.h rxvtperl.h hookinc.h rsinc.h +netdisp.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +netdisp.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h callback.h +netdisp.lo: salloc.h libptytty.h rxvtperl.h hookinc.h rsinc.h +proxy.lo: ../config.h ptytty.h libptytty.h ptytty_conf.h rxvt.h rxvtlib.h +proxy.lo: optinc.h feature.h encoding.h rxvtutil.h rxvtfont.h rxvttoolkit.h +proxy.lo: iom.h iom_conf.h callback.h salloc.h rxvtperl.h hookinc.h rsinc.h +ptytty.lo: ../config.h ptytty.h libptytty.h ptytty_conf.h rxvt.h rxvtlib.h +ptytty.lo: optinc.h feature.h encoding.h rxvtutil.h rxvtfont.h rxvttoolkit.h +ptytty.lo: iom.h iom_conf.h callback.h salloc.h rxvtperl.h hookinc.h rsinc.h +rxvt.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +rxvt.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h callback.h +rxvt.lo: salloc.h libptytty.h rxvtperl.h hookinc.h rsinc.h +rxvtc.lo: ../config.h rxvtdaemon.h rxvtutil.h libptytty.h rxvt.h rxvtlib.h +rxvtc.lo: optinc.h feature.h encoding.h rxvtfont.h rxvttoolkit.h iom.h +rxvtc.lo: iom_conf.h callback.h salloc.h rxvtperl.h hookinc.h rsinc.h +rxvtd.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +rxvtd.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h callback.h +rxvtd.lo: salloc.h libptytty.h rxvtperl.h hookinc.h rsinc.h rxvtdaemon.h +rxvtdaemon.lo: rxvtdaemon.h rxvtutil.h +rxvtfont.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +rxvtfont.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h callback.h +rxvtfont.lo: salloc.h libptytty.h rxvtperl.h hookinc.h rsinc.h +rxvtfont.lo: table/linedraw.h +rxvtperl.lo: ../config.h iom.h iom_conf.h rxvtutil.h callback.h rxvt.h +rxvtperl.lo: rxvtlib.h optinc.h feature.h encoding.h rxvtfont.h rxvttoolkit.h +rxvtperl.lo: salloc.h libptytty.h rxvtperl.h hookinc.h rsinc.h keyboard.h +rxvtperl.lo: perlxsi.c +rxvttoolkit.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +rxvttoolkit.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h +rxvttoolkit.lo: callback.h salloc.h libptytty.h rxvtperl.h hookinc.h rsinc.h +rxvtutil.lo: rxvtutil.h +salloc.lo: salloc.h +screen.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +screen.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h callback.h +screen.lo: salloc.h libptytty.h rxvtperl.h hookinc.h rsinc.h salloc.C +scrollbar-next.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +scrollbar-next.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h +scrollbar-next.lo: callback.h salloc.h libptytty.h rxvtperl.h hookinc.h +scrollbar-next.lo: rsinc.h +scrollbar-plain.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h +scrollbar-plain.lo: encoding.h rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h +scrollbar-plain.lo: iom_conf.h callback.h salloc.h libptytty.h rxvtperl.h +scrollbar-plain.lo: hookinc.h rsinc.h +scrollbar-rxvt.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +scrollbar-rxvt.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h +scrollbar-rxvt.lo: callback.h salloc.h libptytty.h rxvtperl.h hookinc.h +scrollbar-rxvt.lo: rsinc.h +scrollbar-xterm.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h +scrollbar-xterm.lo: encoding.h rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h +scrollbar-xterm.lo: iom_conf.h callback.h salloc.h libptytty.h rxvtperl.h +scrollbar-xterm.lo: hookinc.h rsinc.h +scrollbar.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +scrollbar.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h callback.h +scrollbar.lo: salloc.h libptytty.h rxvtperl.h hookinc.h rsinc.h +xdefaults.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h +xdefaults.lo: rxvtutil.h rxvtfont.h rxvttoolkit.h iom.h iom_conf.h callback.h +xdefaults.lo: salloc.h libptytty.h rxvtperl.h hookinc.h rsinc.h version.h +xdefaults.lo: keyboard.h +xpm.lo: ../config.h rxvt.h rxvtlib.h optinc.h feature.h encoding.h rxvtutil.h +xpm.lo: rxvtfont.h rxvttoolkit.h iom.h iom_conf.h callback.h salloc.h +xpm.lo: libptytty.h rxvtperl.h hookinc.h rsinc.h diff --git a/src/perl/searchable-scrollback b/src/perl/searchable-scrollback index 41188890..6f9565e7 100644 --- a/src/perl/searchable-scrollback +++ b/src/perl/searchable-scrollback @@ -39,6 +39,7 @@ sub enter { $self->{view_start} = $self->view_start; $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EVENT_NONE); $self->{row} = $self->nrow - 1; + $self->{search} = "(?i)"; $self->enable ( key_press => \&key_press, @@ -158,6 +159,10 @@ sub tt_write { my ($self, $data) = @_; $self->{search} .= $self->locale_decode ($data); + + $self->{search} =~ s/^\(\?i\)// + if $self->{search} =~ /^\(.*[[:upper:]]/; + $self->search (-1); $self->idle; diff --git a/src/rxvt.h b/src/rxvt.h index 608b2c52..e71e9af5 100644 --- a/src/rxvt.h +++ b/src/rxvt.h @@ -10,15 +10,16 @@ #endif #if ENABLE_PERL -# define ENABLE_FRILLS 1 +# define ENABLE_FRILLS 1 # define ENABLE_COMBINING 1 #endif #if ENABLE_FRILLS -# define ENABLE_XEMBED 1 -# define ENABLE_EWMH 1 +# define ENABLE_XEMBED 1 +# define ENABLE_EWMH 1 # define ENABLE_XIM_ONTHESPOT 1 -# define CURSOR_BLINK 1 +# define CURSOR_BLINK 1 +# define OPTION_HC 1 #else # define ENABLE_MINIMAL 1 #endif diff --git a/src/screen.C b/src/screen.C index 982f6d21..321b2d48 100644 --- a/src/screen.C +++ b/src/screen.C @@ -2255,24 +2255,6 @@ rxvt_term::scr_refresh () NOTHROW // only do special processing if any attributes are set, which is unlikely if (rend & (RS_Bold | RS_Italic | RS_Uline | RS_RVid | RS_Blink | RS_Careful)) { -#if ENABLE_STYLES - // "careful" (too wide) character handling - - // include previous careful character(s) if possible, looks nicer (best effort...) - while (text > stp - && srp[text - stp - 1] & RS_Careful - && RS_SAME (rend, srp[text - stp - 1])) - text--, count++, xpixel -= fwidth; - - // force redraw after "careful" characters to avoid pixel droppings - for (int i = 0; srp[col + i] & RS_Careful && col + i < ncol - 1; i++) - drp[col + i + 1] = srp[col + i + 1] ^ RS_redraw; - - // force redraw before "careful" characters to avoid pixel droppings - for (int i = 0; srp[text - stp - i] & RS_Careful && text - i > stp; i++) - drp[text - stp - i - 1] = srp[text - stp - i - 1] ^ RS_redraw; -#endif - bool invert = rend & RS_RVid; #ifndef NO_BOLD_UNDERLINE_REVERSE @@ -2304,12 +2286,23 @@ rxvt_term::scr_refresh () NOTHROW if (invert) { - ::swap (fore, back); +#ifdef OPTION_HC + if ((showcursor && row == screen.cur.row && text - stp == screen.cur.col) + || !ISSET_PIXCOLOR (Color_HC)) +#endif + /* invert the column if no highlightColor is set or it is the + * current cursor column */ + ::swap (fore, back); +#ifdef OPTION_HC + else if (ISSET_PIXCOLOR (Color_HC)) + back = Color_HC; +#endif #ifndef NO_BOLD_UNDERLINE_REVERSE +# ifndef OPTION_HC if (ISSET_PIXCOLOR (Color_RV)) back = Color_RV; - +# endif if (fore == back) { fore = Color_bg; @@ -2330,6 +2323,24 @@ rxvt_term::scr_refresh () NOTHROW fore = back; } #endif + +#if ENABLE_STYLES + // "careful" (too wide) character handling + + // include previous careful character(s) if possible, looks nicer (best effort...) + while (text > stp + && srp[text - stp - 1] & RS_Careful + && RS_SAME (rend, srp[text - stp - 1])) + text--, count++, xpixel -= fwidth; + + // force redraw after "careful" characters to avoid pixel droppings + for (int i = 0; srp[col + i] & RS_Careful && col + i < ncol - 1; i++) + drp[col + i + 1] = srp[col + i + 1] ^ RS_redraw; + + // force redraw before "careful" characters to avoid pixel droppings + for (int i = 0; srp[text - stp - i] & RS_Careful && text - i > stp; i++) + drp[text - stp - i - 1] = srp[text - stp - i - 1] ^ RS_redraw; +#endif } /* diff --git a/src/urxvt.pm b/src/urxvt.pm index 5eea3ef6..a9265809 100644 --- a/src/urxvt.pm +++ b/src/urxvt.pm @@ -153,6 +153,12 @@ was started, while C or C stay at the current position and additionally stores the first match in the current line into the primary selection. +The regex defaults to "(?i)", resulting in a case-insensitive search. To +get a case-sensitive search you can delete this prefix using C +or simply use an uppercase character which removes the "(?i)" prefix. + +See L for more info about perl regular expression syntax. + =item readline (enabled by default) A support package that tries to make editing with readline easier. At -- 2.34.1
-
urxvt::fatal $errormessage
-
+
urxvt::fatal $errormessage +
-Fatally aborts execution with the given error message. Avoid at all +

Fatally aborts execution with the given error message. Avoid at all costs! The only time this is acceptable is when the terminal process -starts up. +starts up.

-

-
urxvt::warn $string
-
+ +
urxvt::warn $string +
-Calls rxvt_warn with the given string which should not include a +

Calls rxvt_warn with the given string which should not include a newline. The module also overwrites the warn builtin with a function -that calls this function. +that calls this function.

Using this function has the advantage that its output ends up in the @@ -885,48 +915,49 @@ correct place, e.g. on stderr of the connecting urxvtc client.

Messages have a size limit of 1023 bytes currently.

-

-
@terms = urxvt::termlist
-
+ +
@terms = urxvt::termlist +
-Returns all urxvt::term objects that exist in this process, regardless of +

Returns all urxvt::term objects that exist in this process, regardless of wether they are started, being destroyed etc., so be careful. Only term objects that have perl extensions attached will be returned (because there -is no urxvt::term objet associated with others). +is no urxvt::term objet associated with others).

-

-
$time = urxvt::NOW
-
+ +
$time = urxvt::NOW +
-Returns the ``current time'' (as per the event loop). +

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

-

-
urxvt::CurrentTime
-
+ +
urxvt::CurrentTime +
urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, -Button4Mask, Button5Mask, AnyModifier
-
+Button4Mask, Button5Mask, AnyModifier +
urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, -FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
-
+FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask +
urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, -SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
-
+SelectionNotify, ColormapNotify, ClientMessage, MappingNotify +
-Various constants for use in X calls and event processing. +

Various constants for use in X calls and event processing.

-