ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.97 by root, Mon Jan 16 15:07:27 2006 UTC vs.
Revision 1.205 by sf-exg, Fri Nov 18 02:15:22 2011 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 44terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 45because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 46another for japanese.
44 47
45Therefore another design rationale was the use of multiple fonts to 48Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 49display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 50programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 51to choose any font for any script freely.
49 52
50Apart from that, rxvt-unicode is also much better internationalised than 53Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 54its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 55in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 56rxvt. This all in addition to dozens of other small improvements.
54 57
55It is still faithfully following the original rxvt idea of being lean 58It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 59and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 60without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 61a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 62from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 63drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 64@@RXVT_NAME@@c(1) (client).
62 65
63It also makes technical information about escape sequences (which have 66It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 67been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 68reference documentation (escape sequences etc.).
66 69
67=head1 OPTIONS 70=head1 OPTIONS
68 71
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 72The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100
101=item B<-depth> I<bitdepth>
102
103Compile I<xft>: Attempt to find a visual with the given bit depth;
104resource B<depth>.
105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
97 110
98=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
99 112
100Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
101 114
103 116
104Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
105 118
106=item B<-j>|B<+j> 119=item B<-j>|B<+j>
107 120
108Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 122
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
111 124
112Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 126
127=item B<-tr>|B<+tr>
128
129Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
114 133
115=item B<-fade> I<number> 134=item B<-fade> I<number>
116 135
117Fade the text by the given percentage when focus is lost. Small values 136Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 138colour; resource B<fading>.
120 139
121=item B<-fadecolor> I<colour> 140=item B<-fadecolor> I<colour>
122 141
123Fade to this colour when fading is used (see B<-fade>). The default colour 142Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
125 144
126=item B<-tint> I<colour> 145=item B<-tint> I<colour>
127 146
128Tint the transparent background pixmap with the given colour when 147Tint the transparent background with the given colour;
129transparency is enabled with B<-tr> or B<-ip>. This only works for 148resource I<tintColor>.
130non-tiled backgrounds, currently. See also the B<-sh> option that can be
131used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example:
133 149
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 150=item B<-sh> I<number>
135 151
136=item B<-sh>
137
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
139background image in addition to tinting it (i.e. B<-tint> must be 153A value of 100 means no shading; resource I<shading>.
140specified, too, e.g. C<-tint white>). 154
155=item B<-blt> I<string>
156
157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over
159the transparent background, using the method specified. Supported values are:
160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163alpha-blending. Compile I<afterimage>; resource I<blendType>.
164
165=item B<-blr> I<HxV>
166
167Apply Gaussian Blur with the specified radii to the transparent
168background. If a single number is specified - both vertical and
169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and another to a large number creates interesting effects
171on some backgrounds. Maximum radius value is 128;
172resource I<blurRadius>.
173
174=item B<-icon> I<file>
175
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>.
141 179
142=item B<-bg> I<colour> 180=item B<-bg> I<colour>
143 181
144Window background colour; resource B<background>. 182Window background colour; resource B<background>.
145 183
146=item B<-fg> I<colour> 184=item B<-fg> I<colour>
147 185
148Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
149 187
150=item B<-pixmap> I<file[;geom]> 188=item B<-pixmap> I<file[;oplist]>
151 189
152Compile I<XPM>: Specify XPM file for the background and also optionally 190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 191optionally specify a list of operations to modify it. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 192add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
156 194
157=item B<-cr> I<colour> 195=item B<-cr> I<colour>
158 196
159The cursor colour; resource B<cursorColor>. 197The cursor colour; resource B<cursorColor>.
160 198
177that are checked in order when trying to find glyphs for characters. The 215that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 216first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 217smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 218font list is always appended to it. See resource B<font> for more details.
181 219
182In short, to specify an X11 core font, just specify it's name or prefix it 220In short, to specify an X11 core font, just specify its name or prefix it
183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 221with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 222e.g.:
185 223
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 224 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 225 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
205italic> >> characters are to be printed. See resource B<boldItalicFont> 243italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details. 244for details.
207 245
208=item B<-is>|B<+is> 246=item B<-is>|B<+is>
209 247
210Compile I<font-styles>: Bold/Italic font styles imply high intensity 248Compile I<font-styles>: Bold/Blink font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for 249foreground/background (default). See resource B<intensityStyles> for
212details. 250details.
213 251
214=item B<-name> I<name> 252=item B<-name> I<name>
215 253
233 271
234=item B<-sb>|B<+sb> 272=item B<-sb>|B<+sb>
235 273
236Turn on/off scrollbar; resource B<scrollBar>. 274Turn on/off scrollbar; resource B<scrollBar>.
237 275
276=item B<-sr>|B<+sr>
277
278Put scrollbar on right/left; resource B<scrollBar_right>.
279
280=item B<-st>|B<+st>
281
282Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
283resource B<scrollBar_floating>.
284
238=item B<-si>|B<+si> 285=item B<-si>|B<+si>
239 286
240Turn on/off scroll-to-bottom on TTY output inhibit; resource 287Turn on/off scroll-to-bottom on TTY output inhibit; resource
241B<scrollTtyOutput> has opposite effect. 288B<scrollTtyOutput> has opposite effect.
242 289
248=item B<-sw>|B<+sw> 295=item B<-sw>|B<+sw>
249 296
250Turn on/off scrolling with the scrollback buffer as new lines appear. 297Turn on/off scrolling with the scrollback buffer as new lines appear.
251This only takes effect if B<-si> is also given; resource 298This only takes effect if B<-si> is also given; resource
252B<scrollWithBuffer>. 299B<scrollWithBuffer>.
253
254=item B<-sr>|B<+sr>
255
256Put scrollbar on right/left; resource B<scrollBar_right>.
257
258=item B<-st>|B<+st>
259
260Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
261resource B<scrollBar_floating>.
262 300
263=item B<-ptab>|B<+ptab> 301=item B<-ptab>|B<+ptab>
264 302
265If enabled (default), "Horizontal Tab" characters are being stored as 303If enabled (default), "Horizontal Tab" characters are being stored as
266actual wide characters in the screen buffer, which makes it possible to 304actual wide characters in the screen buffer, which makes it possible to
270 308
271=item B<-bc>|B<+bc> 309=item B<-bc>|B<+bc>
272 310
273Blink the cursor; resource B<cursorBlink>. 311Blink the cursor; resource B<cursorBlink>.
274 312
313=item B<-uc>|B<+uc>
314
315Make the cursor underlined; resource B<cursorUnderline>.
316
275=item B<-iconic> 317=item B<-iconic>
276 318
277Start iconified, if the window manager supports that option. 319Start iconified, if the window manager supports that option.
278Alternative form is B<-ic>. 320Alternative form is B<-ic>.
279 321
295 337
296=item B<-bl> 338=item B<-bl>
297 339
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 340Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299if honoured by the WM, the rxvt-unicode window will not have window 341if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 342decorations; resource B<borderLess>. If the window manager does not
343support MWM hints (e.g. kwin), enables override-redirect mode.
344
345=item B<-override-redirect>
346
347Compile I<frills>: Sets override-redirect on the window; resource
348B<override-redirect>.
301 349
302=item B<-sbg> 350=item B<-sbg>
303 351
304Compile I<frills>: Disable the usage of the built-in block graphics/line 352Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 353drawing characters and just rely on what the specified fonts provide. Use
308 356
309=item B<-lsp> I<number> 357=item B<-lsp> I<number>
310 358
311Compile I<frills>: Lines (pixel height) to insert between each row of 359Compile I<frills>: Lines (pixel height) to insert between each row of
312the display. Useful to work around font rendering problems; resource 360the display. Useful to work around font rendering problems; resource
313B<linespace>. 361B<lineSpace>.
362
363=item B<-letsp> I<number>
364
365Compile I<frills>: Amount to adjust the computed character width by
366to control overall letter spacing. Negative values will tighten up the
367letter spacing, positive values will space letters out more. Useful to
368work around odd font metrics; resource B<letterSpace>.
314 369
315=item B<-tn> I<termname> 370=item B<-tn> I<termname>
316 371
317This option specifies the name of the terminal type to be set in the 372This option specifies the name of the terminal type to be set in the
318B<TERM> environment variable. This terminal type must exist in the 373B<TERM> environment variable. This terminal type must exist in the
372for more info. 427for more info.
373 428
374=item B<-tcw> 429=item B<-tcw>
375 430
376Change the meaning of triple-click selection with the left mouse 431Change the meaning of triple-click selection with the left mouse
432button. Only effective when the original (non-perl) selection code is
377button. Instead of selecting a full line it will extend the selection the 433in-use. Instead of selecting a full line it will extend the selection to
378end of the logical line only. resource B<tripleclickwords>. 434the end of the logical line only. resource B<tripleclickwords>.
379 435
380=item B<-insecure> 436=item B<-insecure>
381 437
382Enable "insecure" mode, which currently enables most of the escape 438Enable "insecure" mode, which currently enables most of the escape
383sequences that echo strings. See the resource B<insecure> for more 439sequences that echo strings. See the resource B<insecure> for more
404Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 460Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405will not immediately destroy its window when the program executed within 461will not immediately destroy its window when the program executed within
406it exits. Instead, it will wait till it is being killed or closed by the 462it exits. Instead, it will wait till it is being killed or closed by the
407user; resource B<hold>. 463user; resource B<hold>.
408 464
465=item B<-cd> I<path>
466
467Sets the working directory for the shell (or the command specified via
468B<-e>). The I<path> must be an absolute path and it must exist for
469@@RXVT_NAME@@ to start; resource B<chdir>.
470
471=item B<-xrm> I<string>
472
473Works like the X Toolkit option of the same name, by adding the I<string>
474as if it were specified in a resource file. Resource values specified this
475way take precedence over all other resource specifications.
476
477Note that you need to use the I<same> syntax as in the .Xdefaults file,
478e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
479options can be specified as long-options on the commandline, so use
480of B<-xrm> is mostly limited to cases where you want to specify other
481resources (e.g. for input methods) or for compatibility with other
482programs.
483
409=item B<-keysym.>I<sym> I<string> 484=item B<-keysym.>I<sym> I<string>
410 485
411Remap a key symbol. See resource B<keysym>. 486Remap a key symbol. See resource B<keysym>.
412 487
413=item B<-embed> I<windowid> 488=item B<-embed> I<windowid>
414 489
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 490Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416which enables applications to easily embed a terminal. 491which enables applications to easily embed a terminal.
417 492
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 493Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 494shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420quite a bit, so don't expect it to keep some specific state. It's best to 495quite a bit, so don't expect it to keep some specific state. It's best to
423The window will not be destroyed when @@RXVT_NAME@@ exits. 498The window will not be destroyed when @@RXVT_NAME@@ exits.
424 499
425It might be useful to know that @@RXVT_NAME@@ will not close file 500It might be useful to know that @@RXVT_NAME@@ will not close file
426descriptors passed to it (except for stdin/out/err, of course), so you 501descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the 502can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or 503terminal. This works regardless of whether the C<-embed> option was used or
429not. 504not.
430 505
431Here is a short Gtk2-perl snippet that illustrates how this option can be 506Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>): 507used (a longer example is in F<doc/embed>):
433 508
438 }); 513 });
439 514
440=item B<-pty-fd> I<file descriptor> 515=item B<-pty-fd> I<file descriptor>
441 516
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 517Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443pair but instead use the given filehandle as the tty master. This is 518pair but instead use the given file descriptor as the tty master. This is
444useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 519useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it. 520without having to run a program within it.
446 521
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 522If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448entries and will not tinker with pty/tty permissions - you have to do that 523entries and will not tinker with pty/tty permissions - you have to do that
449yourself if you want that. 524yourself if you want that.
450 525
451As an extremely special case, specifying C<-1> will completely suppress 526As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations. 527pty/tty operations, which is probably only useful in conjunction with some
528perl extension that manages the terminal.
453 529
454Here is a example in perl that illustrates how this option can be used (a 530Here is a example in perl that illustrates how this option can be used (a
455longer example is in F<doc/pty-fd>): 531longer example is in F<doc/pty-fd>):
456 532
457 use IO::Pty; 533 use IO::Pty;
471Comma-separated list of perl extension scripts to use (or not to use) in 547Comma-separated list of perl extension scripts to use (or not to use) in
472this terminal instance. See resource B<perl-ext> for details. 548this terminal instance. See resource B<perl-ext> for details.
473 549
474=back 550=back
475 551
476=head1 RESOURCES (available also as long-options) 552=head1 RESOURCES
477 553
478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 554Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479options) compiled into your version. 555options) compiled into your version. All resources are also available as
556long-options.
480 557
481You can set and change the resources using X11 tools like B<xrdb>. Many 558You can set and change the resources using X11 tools like B<xrdb>. Many
482distribution do also load settings from the B<~/.Xresources> file when X 559distribution do also load settings from the B<~/.Xresources> file when X
483starts. @@RXVT_NAME@@ will consult the following files/resources in order, 560starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484with later settings overwriting earlier ones: 561with later settings overwriting earlier ones:
485 562
486 1. system-wide app-defaults file, either locale-dependent OR global
487 2. app-defaults file in $XAPPLRESDIR 563 1. app-defaults file in $XAPPLRESDIR
564 2. $HOME/.Xdefaults
488 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 565 3. RESOURCE_MANAGER property on root-window of screen 0
489 4. SCREEN_RESOURCES for the current screen 566 4. SCREEN_RESOURCES property on root-window of the current screen
490 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
568 6. resources specified via -xrm on the commandline
491 569
492Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
493names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 571names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
494common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 572common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
495configured, while the class name B<URxvt> allows resources unique to 573configured, while the class name B<URxvt> allows resources unique to
500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 578check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here): 579extensions not documented here):
502 580
503=over 4 581=over 4
504 582
583=item B<depth:> I<bitdepth>
584
585Compile I<xft>: Attempt to find a visual with the given bit depth;
586option B<-depth>.
587
588=item B<buffered:> I<boolean>
589
590Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
591On some card/driver combination enabling it slightly decreases
592performance, on most it greatly helps it. The slowdown is small, so it
593should normally be enabled.
594
505=item B<geometry:> I<geom> 595=item B<geometry:> I<geom>
506 596
507Create the window with the specified X window geometry [default 80x24]; 597Create the window with the specified X window geometry [default 80x24];
508option B<-geometry>. 598option B<-geometry>.
509 599
522Use the specified colour for the colour value I<n>, where 0-7 612Use the specified colour for the colour value I<n>, where 0-7
523corresponds to low-intensity (normal) colours and 8-15 corresponds to 613corresponds to low-intensity (normal) colours and 8-15 corresponds to
524high-intensity (bold = bright foreground, blink = bright background) 614high-intensity (bold = bright foreground, blink = bright background)
525colours. The canonical names are as follows: 0=black, 1=red, 2=green, 615colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5263=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6163=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
527names used are listed in the B<COLORS AND GRAPHICS> section. 617names used are listed in the B<COLOURS AND GRAPHICS> section.
528 618
529Colours higher than 15 cannot be set using resources (yet), but can be 619Colours higher than 15 cannot be set using resources (yet), but can be
530changed using an escape command (see @@RXVT_NAME@@(7)). 620changed using an escape command (see @@RXVT_NAME@@(7)).
531 621
532Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 622Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
543=item B<colorUL:> I<colour> 633=item B<colorUL:> I<colour>
544 634
545Use the specified colour to display underlined characters when the 635Use the specified colour to display underlined characters when the
546foreground colour is the default. 636foreground colour is the default.
547 637
548=item B<colorRV:> I<colour>
549
550Use the specified colour as the background for reverse video
551characters.
552
553=item B<underlineColor:> I<colour> 638=item B<underlineColor:> I<colour>
554 639
555If set, use the specified colour as the colour for the underline 640If set, use the specified colour as the colour for the underline
556itself. If unset, use the foreground colour. 641itself. If unset, use the foreground colour.
642
643=item B<highlightColor:> I<colour>
644
645If set, use the specified colour as the background for highlighted
646characters. If unset, use reverse video.
647
648=item B<highlightTextColor:> I<colour>
649
650If set and highlightColor is set, use the specified colour as the
651foreground for highlighted characters.
557 652
558=item B<cursorColor:> I<colour> 653=item B<cursorColor:> I<colour>
559 654
560Use the specified colour for the cursor. The default is to use the 655Use the specified colour for the cursor. The default is to use the
561foreground colour; option B<-cr>. 656foreground colour; option B<-cr>.
568 663
569=item B<reverseVideo:> I<boolean> 664=item B<reverseVideo:> I<boolean>
570 665
571B<True>: simulate reverse video by foreground and background colours; 666B<True>: simulate reverse video by foreground and background colours;
572option B<-rv>. B<False>: regular screen colours [default]; option 667option B<-rv>. B<False>: regular screen colours [default]; option
573B<+rv>. See note in B<COLORS AND GRAPHICS> section. 668B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
574 669
575=item B<jumpScroll:> I<boolean> 670=item B<jumpScroll:> I<boolean>
576 671
577B<True>: specify that jump scrolling should be used. When scrolling 672B<True>: specify that jump scrolling should be used. When receiving lots
578quickly, fewer screen updates are performed [default]; option B<-j>. 673of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
674has been read, resulting in fewer updates while still displaying every
675received line; option B<-j>.
676
579B<False>: specify that smooth scrolling should be used; option B<+j>. 677B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
678force a screen refresh on each new line it received; option B<+j>.
580 679
581=item B<inheritPixmap:> I<boolean> 680=item B<skipScroll:> I<boolean>
582 681
583B<True>: make the background inherit the parent windows' pixmap, giving 682B<True>: (the default) specify that skip scrolling should be used. When
584artificial transparency. B<False>: do not inherit the parent windows' 683receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
585pixmap. 684(around 60 times per second), resulting in far fewer updates. This can
685result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
686option B<-ss>.
687
688B<False>: specify that everything is to be displayed, even
689if the refresh is too fast for the human eye to read anything (or the
690monitor to display anything); option B<+ss>.
691
692=item B<transparent:> I<boolean>
693
694Turn on/off pseudo-transparency by using the root pixmap as background.
695
696B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
697future versions.
586 698
587=item B<fading:> I<number> 699=item B<fading:> I<number>
588 700
589Fade the text by the given percentage when focus is lost; option B<-fade>. 701Fade the text by the given percentage when focus is lost; option B<-fade>.
590 702
593Fade to this colour, when fading is used (see B<fading:>). The default 705Fade to this colour, when fading is used (see B<fading:>). The default
594colour is black; option B<-fadecolor>. 706colour is black; option B<-fadecolor>.
595 707
596=item B<tintColor:> I<colour> 708=item B<tintColor:> I<colour>
597 709
598Tint the transparent background pixmap with the given colour; option 710Tint the transparent background with the given colour. If the RENDER
599B<-tint>. 711extension is not available only black, red, green, yellow, blue,
712magenta, cyan and white tints can be performed server-side. Note that
713a black tint yields a completely black image while a white tint yields
714the image unchanged; option B<-tint>.
600 715
601=item B<shading:> I<number> 716=item B<shading:> I<number>
602 717
603Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
604image in addition to tinting it. 719A value of 100 means no shading; option B<-sh>.
720
721=item B<blendType:> I<string>
722
723Specify background blending type; option B<-blt>.
724
725=item B<blurRadius:> I<number>
726
727Apply gaussian blur with the specified radius to the transparent
728background; option B<-blr>.
729
730=item B<iconFile:> I<file>
731
732Set the application icon pixmap; option B<-icon>.
605 733
606=item B<scrollColor:> I<colour> 734=item B<scrollColor:> I<colour>
607 735
608Use the specified colour for the scrollbar [default #B2B2B2]. 736Use the specified colour for the scrollbar [default #B2B2B2].
609 737
615=item B<borderColor:> I<colour> 743=item B<borderColor:> I<colour>
616 744
617The colour of the border around the text area and between the scrollbar 745The colour of the border around the text area and between the scrollbar
618and the text. 746and the text.
619 747
620=item B<backgroundPixmap:> I<file[;geom]> 748=item B<backgroundPixmap:> I<file[;oplist]>
621 749
622Use the specified XPM file (note the `.xpm' extension is optional) for 750Use the specified image file for the background and also
623the background and also optionally specify its scaling with a geometry 751optionally specify a colon separated list of operations to modify it.
624string B<WxH+X+Y>, in which B<"W" / "H"> specify the 752Supported operations are:
625horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 753
626centre (percent). A scale of 0 displays the image with tiling. A scale 754=over 4
627of 1 displays the image without any scaling. A scale of 2 to 9 755
628specifies an integer number of images in that direction. No image will 756=item B<WxH+X+Y>
629be magnified beyond 10 times its original size. The maximum permitted 757
630scale is 1000. [default 0x0+50+50] 758sets scale and position. B<"W" / "H"> specify the horizontal/vertical
759scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
760scale of 0 disables scaling. The maximum permitted scale is 1000.
761
762=item B<op=tile>
763
764enables tiling
765
766=item B<op=pscale>
767
768enables proportional scaling
769
770=item B<op=root>
771
772use the position of the terminal window relative to the root window as
773the image offset, simulating a root window background
774
775=back
776
777The default scale and position setting is C<100x100+50+50>.
778Alternatively, a predefined set of templates can be used to achieve
779the most common setups:
780
781=over 4
782
783=item B<style=tiled>
784
785the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
786
787=item B<style=aspect-stretched>
788
789the image is scaled to fill the whole window maintaining the aspect
790ratio and centered. Equivalent to 100x100+50+50:op=pscale
791
792=item B<style=stretched>
793
794the image is scaled to fill the whole window. Equivalent to 100x100
795
796=item B<style=centered>
797
798the image is centered with no scaling. Equivalent to 0x0+50+50
799
800=item B<style=root-tiled>
801
802the image is tiled with no scaling and using 'root' positioning.
803Equivalent to 0x0:op=tile:op=root
804
805=back
806
807If multiple templates are specified the last one wins. Note that a
808template overrides all the scale, position and operations settings.
809
810If used in conjunction with B<-tr> option, the specified pixmap will be
811blended over the transparent background using alpha-blending. If I<afterimage>
812support has been compiled in it is possible to choose other blending
813types with B<-blt "type"> option.
631 814
632=item B<path:> I<path> 815=item B<path:> I<path>
633 816
634Specify the colon-delimited search path for finding XPM files. 817Specify the colon-delimited search path for finding background image files.
635 818
636=item B<font:> I<fontlist> 819=item B<font:> I<fontlist>
637 820
638Select the fonts to be used. This is a comma separated list of font names 821Select the fonts to be used. This is a comma separated list of font names
639that are checked in order when trying to find glyphs for characters. The 822that are checked in order when trying to find glyphs for characters. The
662it is named first) and thus defines the character cell grid to be 9 pixels 845it is named first) and thus defines the character cell grid to be 9 pixels
663wide and 15 pixels high. 846wide and 15 pixels high.
664 847
665The second font is just used to add additional unicode characters not in 848The second font is just used to add additional unicode characters not in
666the base font, likewise the third, which is unfortunately non-bold, but 849the base font, likewise the third, which is unfortunately non-bold, but
667the bold version of the font does contain less characters, so this is a 850the bold version of the font does contain fewer characters, so this is a
668useful supplement. 851useful supplement.
669 852
670The third font is an Xft font with aliasing turned off, and the characters 853The third font is an Xft font with aliasing turned off, and the characters
671are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 854are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
672contains other characters, but we are not interested in them. 855contains other characters, but we are not interested in them.
696text font will being used for the given style. 879text font will being used for the given style.
697 880
698=item B<intensityStyles:> I<boolean> 881=item B<intensityStyles:> I<boolean>
699 882
700When font styles are not enabled, or this option is enabled (B<True>, 883When font styles are not enabled, or this option is enabled (B<True>,
701option B<-is>, the default), bold and italic font styles imply high 884option B<-is>, the default), bold/blink font styles imply high
702intensity foreground/backround colours. Disabling this option (B<False>, 885intensity foreground/background colours. Disabling this option (B<False>,
703option B<+is>) disables this behaviour, the high intensity colours are not 886option B<+is>) disables this behaviour, the high intensity colours are not
704reachable. 887reachable.
705
706=item B<selectstyle:> I<mode>
707
708Set mouse selection style to B<old> which is 2.20, B<oldword> which is
709xterm style with 2.20 old word selection, or anything else which gives
710xterm style selection.
711
712=item B<scrollstyle:> I<mode>
713
714Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
715the author's favourite.
716 888
717=item B<title:> I<string> 889=item B<title:> I<string>
718 890
719Set window title string, the default title is the command-line 891Set window title string, the default title is the command-line
720specified after the B<-e> option, if any, otherwise the application 892specified after the B<-e> option, if any, otherwise the application
729=item B<mapAlert:> I<boolean> 901=item B<mapAlert:> I<boolean>
730 902
731B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 903B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
732de-iconify (map) on receipt of a bell character [default]. 904de-iconify (map) on receipt of a bell character [default].
733 905
906=item B<urgentOnBell:> I<boolean>
907
908B<True>: set the urgency hint for the wm on receipt of a bell character.
909B<False>: do not set the urgency hint [default].
910
911@@RXVT_NAME@@ resets the urgency hint on every focus change.
912
734=item B<visualBell:> I<boolean> 913=item B<visualBell:> I<boolean>
735 914
736B<True>: use visual bell on receipt of a bell character; option B<-vb>. 915B<True>: use visual bell on receipt of a bell character; option B<-vb>.
737B<False>: no visual bell [default]; option B<+vb>. 916B<False>: no visual bell [default]; option B<+vb>.
738 917
759Example: 938Example:
760 939
761 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 940 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762 941
763This creates a new file in your home directory with the screen contents 942This creates a new file in your home directory with the screen contents
764everytime you hit C<Print>. 943every time you hit C<Print>.
944
945=item B<scrollstyle:> I<mode>
946
947Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
948the author's favourite.
949
950=item B<thickness:> I<number>
951
952Set the scrollbar width in pixels.
765 953
766=item B<scrollBar:> I<boolean> 954=item B<scrollBar:> I<boolean>
767 955
768B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 956B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
769disable the scrollbar; option B<+sb>. 957disable the scrollbar; option B<+sb>.
789B<False>: do not scroll to bottom when tty receives output; option 977B<False>: do not scroll to bottom when tty receives output; option
790B<+si>. 978B<+si>.
791 979
792=item B<scrollWithBuffer:> I<boolean> 980=item B<scrollWithBuffer:> I<boolean>
793 981
794B<True>: scroll with scrollback buffer when tty receives new lines (and 982B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
795B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 983try to show the same lines) and B<scrollTtyOutput> is False; option
796with scrollback buffer when tty recieves new lines; option B<+sw>. 984B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
985new lines; option B<+sw>.
797 986
798=item B<scrollTtyKeypress:> I<boolean> 987=item B<scrollTtyKeypress:> I<boolean>
799 988
800B<True>: scroll to bottom when a non-special key is pressed. Special keys 989B<True>: scroll to bottom when a non-special key is pressed. Special keys
801are those which are intercepted by rxvt-unicode for special handling and 990are those which are intercepted by rxvt-unicode for special handling and
832=item B<termName:> I<termname> 1021=item B<termName:> I<termname>
833 1022
834Specifies the terminal type name to be set in the B<TERM> environment 1023Specifies the terminal type name to be set in the B<TERM> environment
835variable; option B<-tn>. 1024variable; option B<-tn>.
836 1025
837=item B<linespace:> I<number> 1026=item B<lineSpace:> I<number>
838 1027
839Specifies number of lines (pixel height) to insert between each row of 1028Specifies number of lines (pixel height) to insert between each row of
840the display [default 0]; option B<-lsp>. 1029the display [default 0]; option B<-lsp>.
841 1030
842=item B<meta8:> I<boolean> 1031=item B<meta8:> I<boolean>
856 1045
857=item B<cursorBlink:> I<boolean> 1046=item B<cursorBlink:> I<boolean>
858 1047
859B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1048B<True>: blink the cursor. B<False>: do not blink the cursor [default];
860option B<-bc>. 1049option B<-bc>.
1050
1051=item B<cursorUnderline:> I<boolean>
1052
1053B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1054option B<-uc>.
861 1055
862=item B<pointerBlank:> I<boolean> 1056=item B<pointerBlank:> I<boolean>
863 1057
864B<True>: blank the pointer when a key is pressed or after a set number 1058B<True>: blank the pointer when a key is pressed or after a set number
865of seconds of inactivity. B<False>: the pointer is always visible 1059of seconds of inactivity. B<False>: the pointer is always visible
879large number (e.g. C<987654321>) to effectively disable the timeout. 1073large number (e.g. C<987654321>) to effectively disable the timeout.
880 1074
881=item B<backspacekey:> I<string> 1075=item B<backspacekey:> I<string>
882 1076
883The string to send when the backspace key is pressed. If set to B<DEC> 1077The string to send when the backspace key is pressed. If set to B<DEC>
884or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1078or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
885(code 8) - which can be reversed with the appropriate DEC private mode 1079(code 8) - which can be reversed with the appropriate DEC private mode
886escape sequence. 1080escape sequence.
887 1081
888=item B<deletekey:> I<string> 1082=item B<deletekey:> I<string>
889 1083
891pressed. If unset it will send the sequence traditionally associated 1085pressed. If unset it will send the sequence traditionally associated
892with the B<Execute> key. 1086with the B<Execute> key.
893 1087
894=item B<cutchars:> I<string> 1088=item B<cutchars:> I<string>
895 1089
896The characters used as delimiters for double-click word selection. The 1090The characters used as delimiters for double-click word selection
897built-in default: 1091(whitespace delimiting is added automatically if resource is given).
898 1092
1093When the perl selection extension is in use (the default if compiled
1094in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1095characters will be created (if the resource exists, otherwise, no regex
1096will be created). In this mode, characters outside ISO-8859-1 can be used.
1097
1098When the selection extension is not used, only ISO-8859-1 characters can
1099be used. If not specified, the built-in default is used:
1100
899B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1101B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
900 1102
901=item B<preeditType:> I<style> 1103=item B<preeditType:> I<style>
902 1104
903B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1105B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
904 1106
952 1154
953Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1155Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
954character is passed through. It may contain escape values as described 1156character is passed through. It may contain escape values as described
955in the entry on B<keysym> following. 1157in the entry on B<keysym> following.
956 1158
957=item B<secondaryScreen:> I<bool> 1159=item B<secondaryScreen:> I<boolean>
958 1160
959Turn on/off secondary screen (default enabled). 1161Turn on/off secondary screen (default enabled).
960 1162
961=item B<secondaryScroll:> I<bool> 1163=item B<secondaryScroll:> I<boolean>
962 1164
963Turn on/off secondary screen scroll (default enabled). If the this 1165Turn on/off secondary screen scroll (default enabled). If this
964option is enabled, scrolls on the secondary screen will change the 1166option is enabled, scrolls on the secondary screen will change the
965scrollback buffer and switching to/from the secondary screen will 1167scrollback buffer and, when secondaryScreen is off, switching
966instead scroll the screen up. 1168to/from the secondary screen will instead scroll the screen up.
967 1169
968=item B<hold>: I<bool> 1170=item B<hold>: I<boolean>
969 1171
970Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1172Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
971will not immediately destroy its window when the program executed within 1173will not immediately destroy its window when the program executed within
972it exits. Instead, it will wait till it is being killed or closed by the 1174it exits. Instead, it will wait till it is being killed or closed by the
973user. 1175user.
1176
1177=item B<chdir>: I<path>
1178
1179Sets the working directory for the shell (or the command specified via
1180B<-e>). The I<path> must be an absolute path and it must exist for
1181@@RXVT_NAME@@ to start. If it isn't specified then the current working
1182directory will be used; option B<-cd>.
974 1183
975=item B<keysym.>I<sym>: I<string> 1184=item B<keysym.>I<sym>: I<string>
976 1185
977Compile I<frills>: Associate I<string> with keysym I<sym>. The 1186Compile I<frills>: Associate I<string> with keysym I<sym>. The
978intervening resource name B<keysym.> cannot be omitted. 1187intervening resource name B<keysym.> cannot be omitted.
992searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1201searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
993omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1202omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
994keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1203keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
995performed in an exact manner; however, the closest match is assured. 1204performed in an exact manner; however, the closest match is assured.
996 1205
997I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1206I<string> may contain escape values (C<\n>: newline, C<\000>: octal
998C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1207number), see RESOURCES in C<man 7 X> for further details.
999C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1000C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1001can start or end with whitespace.
1002
1003Please note that you need to double the C<\> in resource files, as
1004Xlib itself does it's own de-escaping (you can use C<\033> instead of
1005C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1006processing).
1007 1208
1008You can define a range of keysyms in one shot by providing a I<string> 1209You can define a range of keysyms in one shot by providing a I<string>
1009with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1210with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1010should be a character not used by the strings. 1211should be a character not used by the strings.
1011 1212
1012Its usage can be demonstrated by an example: 1213Its usage can be demonstrated by an example:
1013 1214
1014 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1215 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1015 1216
1016The above line is equivalent to the following three lines: 1217The above line is equivalent to the following three lines:
1017 1218
1018 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1219 URxvt.keysym.Meta-Control-0x61: \033<a>
1019 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1220 URxvt.keysym.Meta-Control-0x62: \033<b>
1020 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1221 URxvt.keysym.Meta-Control-0x63: \033<c>
1021 1222
1022If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1223If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1023is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1224is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1024example the following means "change the current locale to C<zh_CN.GBK> 1225example the following means "change the current locale to C<zh_CN.GBK>
1025when Control-Meta-c is being pressed": 1226when Control-Meta-c is being pressed":
1026 1227
1027 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1228 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1028 1229
1029If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1230If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1030is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1231is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1031manpage. For example, the F<selection> extension (activated via 1232manpage. For example, the F<selection> extension (activated via
1032C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1233C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1033 1234
1034 URxvt.keysym.M-C-c: perl:selection:rot13 1235 URxvt.keysym.M-C-c: perl:selection:rot13
1035 1236
1036Due the the large number of modifier combinations, a defined key mapping 1237Due the the large number of modifier combinations, a defined key mapping
1037will match if at I<at least> the specified identifiers are being set, and 1238will match if I<at least> the specified identifiers are being set, and
1038no other key mappings with those and more bits are being defined. That 1239no other key mappings with those and more bits are being defined. That
1039means that defining a key map for C<a> will automatically provide 1240means that defining a key map for C<a> will automatically provide
1040definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1241definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1041mappings themselves. 1242mappings themselves.
1042 1243
1078example, C<default,-selection> will use all the default extension except 1279example, C<default,-selection> will use all the default extension except
1079C<selection>. 1280C<selection>.
1080 1281
1081Extension names can also be followed by an argument in angle brackets 1282Extension names can also be followed by an argument in angle brackets
1082(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1283(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1083searchable scorllback to Alt/Meta-s). Mentioning the same extension 1284searchable scrollback to Alt/Meta-s). Mentioning the same extension
1084multiple times with different arguments will pass multiple arguments to 1285multiple times with different arguments will pass multiple arguments to
1085the extension. 1286the extension.
1086 1287
1087Each extension is looked up in the library directories, loaded if 1288Each extension is looked up in the library directories, loaded if
1088necessary, and bound to the current terminal instance. 1289necessary, and bound to the current terminal instance.
1093all instances, while B<perl-ext> is used for specific instances. 1294all instances, while B<perl-ext> is used for specific instances.
1094 1295
1095=item B<perl-eval>: I<string> 1296=item B<perl-eval>: I<string>
1096 1297
1097Perl code to be evaluated when all extensions have been registered. See 1298Perl code to be evaluated when all extensions have been registered. See
1098the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1299the @@RXVT_NAME@@perl(3) manpage.
1099will be ignored when running setuid/setgid.
1100 1300
1101=item B<perl-lib>: I<path> 1301=item B<perl-lib>: I<path>
1102 1302
1103Colon-separated list of additional directories that hold extension 1303Colon-separated list of additional directories that hold extension
1104scripts. When looking for extensions specified by the C<perl> resource, 1304scripts. When looking for extensions specified by the C<perl> resource,
1105@@RXVT_NAME@@ will first look in these directories and then in 1305@@RXVT_NAME@@ will first look in these directories and then in
1106F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1306F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1107will be ignored when running setuid/setgid.
1108 1307
1109See the @@RXVT_NAME@@perl(3) manpage. 1308See the @@RXVT_NAME@@perl(3) manpage.
1110 1309
1111=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1310=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1112 1311
1124(default: C<M-s>). 1323(default: C<M-s>).
1125 1324
1126=item B<urlLauncher>: I<string> 1325=item B<urlLauncher>: I<string>
1127 1326
1128Specifies the program to be started with a URL argument. Used by the 1327Specifies the program to be started with a URL argument. Used by the
1129C<selection-popup> and C<mark-urls> perl extensions. 1328C<selection-popup> and C<matcher> perl extensions.
1130 1329
1131=item B<transient-for>: I<windowid> 1330=item B<transient-for>: I<windowid>
1132 1331
1133Sets the WM_TRANSIENT_FOR property to the given window iw. 1332Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1333
1334=item B<override-redirect>: I<boolean>
1335
1336Compile I<frills>: Sets override-redirect for the terminal window, making
1337it almost invisible to window managers; option B<-override-redirect>.
1338
1339=item B<iso14755:> I<boolean>
1340
1341Turn on/off ISO 14755 (default enabled).
1342
1343=item B<iso14755_52:> I<boolean>
1344
1345Turn on/off ISO 14755 5.2 mode (default enabled).
1134 1346
1135=back 1347=back
1136 1348
1137=head1 THE SCROLLBAR 1349=head1 THE SCROLLBAR
1138 1350
1157application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1369application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1158(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1370(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1159up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1371up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1160respectively. 1372respectively.
1161 1373
1162=head1 TEXT SELECTION AND INSERTION 1374=head1 THE SELECTION: SELECTING AND PASTING TEXT
1163 1375
1164The behaviour of text selection and insertion mechanism is similar to 1376The behaviour of text selection and insertion/pasting mechanism is similar
1165I<xterm>(1). 1377to I<xterm>(1).
1166 1378
1167=over 4 1379=over 4
1168 1380
1169=item B<Selection>: 1381=item B<Selecting>:
1170 1382
1171Left click at the beginning of the region, drag to the end of the region 1383Left click at the beginning of the region, drag to the end of the region
1172and release; Right click to extend the marked region; Left double-click 1384and release; Right click to extend the marked region; Left double-click
1173to select a word; Left triple-click to select the entire logical line 1385to select a word; Left triple-click to select the entire logical line
1174(which can span multiple screen lines), unless modified by resource 1386(which can span multiple screen lines), unless modified by resource
1178(Compile: I<frills>) will create a rectangular selection instead of a 1390(Compile: I<frills>) will create a rectangular selection instead of a
1179normal one. In this mode, every selected row becomes its own line in the 1391normal one. In this mode, every selected row becomes its own line in the
1180selection, and trailing whitespace is visually underlined and removed from 1392selection, and trailing whitespace is visually underlined and removed from
1181the selection. 1393the selection.
1182 1394
1183=item B<Insertion>: 1395=item B<Pasting>:
1184 1396
1185Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1397Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1186an B<@@RXVT_NAME@@> window causes the current text selection to be 1398window causes the value of the PRIMARY selection (or CLIPBOARD with the
1187inserted as if it had been typed on the keyboard. 1399B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1400
1401Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1402inserted too.
1188 1403
1189=back 1404=back
1190 1405
1191=head1 CHANGING FONTS 1406=head1 CHANGING FONTS
1192 1407
1206 1421
1207=head1 ISO 14755 SUPPORT 1422=head1 ISO 14755 SUPPORT
1208 1423
1209ISO 14755 is a standard for entering and viewing unicode characters 1424ISO 14755 is a standard for entering and viewing unicode characters
1210and character codes using the keyboard. It consists of 4 parts. The 1425and character codes using the keyboard. It consists of 4 parts. The
1211first part is available rxvt-unicode has been compiled with 1426first part is available if rxvt-unicode has been compiled with
1212C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1427C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1213with C<--enable-iso14755>. 1428with C<--enable-iso14755>.
1214 1429
1215=over 4 1430=over 4
1216 1431
1236This mode lets you input characters representing the keycap symbols of 1451This mode lets you input characters representing the keycap symbols of
1237your keyboard, if representable in the current locale encoding. 1452your keyboard, if representable in the current locale encoding.
1238 1453
1239Start by pressing C<Control> and C<Shift> together, then releasing 1454Start by pressing C<Control> and C<Shift> together, then releasing
1240them. The next special key (cursor keys, home etc.) you enter will not 1455them. The next special key (cursor keys, home etc.) you enter will not
1241invoke it's usual function but instead will insert the corresponding 1456invoke its usual function but instead will insert the corresponding
1242keycap symbol. The symbol will only be entered when the key has been 1457keycap symbol. The symbol will only be entered when the key has been
1243released, otherwise pressing e.g. C<Shift> would enter the symbol for 1458released, otherwise pressing e.g. C<Shift> would enter the symbol for
1244C<ISO Level 2 Switch>, although your intention might have been to enter a 1459C<ISO Level 2 Switch>, although your intention might have been to enter a
1245reverse tab (Shift-Tab). 1460reverse tab (Shift-Tab).
1246 1461
1274B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1489B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1275it can be seen via the I<who(1)> command, and can accept messages. To 1490it can be seen via the I<who(1)> command, and can accept messages. To
1276allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1491allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1277on some systems or setgid to root or to some other group on others. 1492on some systems or setgid to root or to some other group on others.
1278 1493
1279=head1 COLORS AND GRAPHICS 1494=head1 COLOURS AND GRAPHICS
1280 1495
1281In addition to the default foreground and background colours, 1496In addition to the default foreground and background colours,
1282B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1497B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1283high-intensity bold/blink versions of the same). Here is a list of the 1498high-intensity (potentially bold/blink) versions of the same, and 72 (or
1284colours with their B<rgb.txt> names. 1499240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1500cube plus a 8 (24) colour greyscale ramp.
1501
1502Here is a list of the ANSI colours with their names.
1285 1503
1286=begin table 1504=begin table
1287 1505
1288 B<color0> (black) = Black 1506 B<color0> (black) = Black
1289 B<color1> (red) = Red3 1507 B<color1> (red) = Red3
1309It is also possible to specify the colour values of B<foreground>, 1527It is also possible to specify the colour values of B<foreground>,
1310B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1528B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1311a number 0-15, as a convenient shorthand to reference the colour name of 1529a number 0-15, as a convenient shorthand to reference the colour name of
1312color0-color15. 1530color0-color15.
1313 1531
1532The following text gives values for the standard 88 colour mode (and
1533values for the 256 colour mode in parentheses).
1534
1535The RGB cube uses indices 16..79 (16..231) using the following formulas:
1536
1537 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1538 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1539
1540The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1541steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1542the RGB cube.
1543
1544Together, all those colours implement the 88 (256) colour xterm
1545colours. Only the first 16 can be changed using resources currently, the
1546rest can only be changed via command sequences ("escape codes").
1547
1548Applications are advised to use terminfo or command sequences to discover
1549number and RGB values of all colours (yes, you can query this...).
1550
1314Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1551Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1315always swapping the foreground/background colours. This is in contrast to 1552always swapping the foreground/background colours. This is in contrast to
1316I<xterm>(1) where the colours are only swapped if they have not otherwise 1553I<xterm>(1) where the colours are only swapped if they have not otherwise
1317been specified. For example, 1554been specified. For example,
1318 1555
1556 @@RXVT_NAME@@ -fg Black -bg White -rv
1557
1558would yield White on Black, while on I<xterm>(1) it would yield Black on
1559White.
1560
1561=head2 ALPHA CHANNEL SUPPORT
1562
1563If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1564their act together, rxvt-unicode will do it's own alpha channel management:
1565
1566You can prefix any colour with an opaqueness percentage enclosed in
1567brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1568(0-100) that specifies the opacity of the colour, where C<0> is completely
1569transparent and C<100> is completely opaque. For example, C<[50]red> is a
1570half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1571is the recommended format to specify transparency values, and works with
1572all ways to specify a colour.
1573
1574For complete control, rxvt-unicode also supports
1575C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1576specifications, where the additional C<aaaa> component specifies opacity
1577(alpha) values. The minimum value of C<0000> is completely transparent,
1578while C<ffff> is completely opaque). The two example colours from
1579earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1580C<rgba:0000/ff00/0000/f332>.
1581
1582You probably need to specify B<"-depth 32">, too, to force a visual with
1583alpha channels, and have the luck that your X-server uses ARGB pixel
1584layout, as X is far from just supporting ARGB visuals out of the box, and
1585rxvt-unicode just fudges around.
1586
1587For example, the following selects an almost completely transparent black
1588background, and an almost opaque pink foreground:
1589
1590 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1591
1592When not using a background image, then the interpretation of the
1593alpha channel is up to your compositing manager (most interpret it as
1594transparency of course).
1595
1596When using a background pixmap or pseudo-transparency, then the background
1597colour will always behave as if it were completely transparent (so the
1598background image shows instead), regardless of how it was specified, while
1599other colours will either be transparent as specified (the background
1600image will show through) on servers supporting the RENDER extension, or
1601fully opaque on servers not supporting the RENDER EXTENSION.
1602
1603Please note that due to bugs in Xft, specifying alpha values might result
1604in garbage being displayed when the X-server does not support the RENDER
1605extension.
1606
1607=head1 ENVIRONMENT
1608
1609B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1610
1319=over 4 1611=over 4
1320 1612
1321=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1322
1323would yield White on Black, while on I<xterm>(1) it would yield Black
1324on White.
1325
1326=back
1327
1328=head1 ENVIRONMENT
1329
1330B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1331
1332=over 4
1333
1334=item B<TERM> 1613=item B<TERM>
1335 1614
1336Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1615Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1337resources or on the commandline. 1616resources or on the command line.
1338 1617
1339=item B<COLORTERM> 1618=item B<COLORTERM>
1340 1619
1341Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1620Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1342compiled with XPM support, and optionally with the added extension 1621compiled with background image support, and optionally with the added
1343C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1622extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1623screen.
1344 1624
1345=item B<COLORFGBG> 1625=item B<COLORFGBG>
1346 1626
1347Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1627Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1348the colour code used as default foreground/text colour (or the string 1628the colour code used as default foreground/text colour (or the string
1349C<default> to indicate that the default-colour escape sequence is to be 1629C<default> to indicate that the default-colour escape sequence is to be
1350used), C<bg> is the colour code used as default background colour (or the 1630used), C<bg> is the colour code used as default background colour (or the
1351string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1631string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1352was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1632was compiled with background image support. Libraries like C<ncurses>
1353(and do) use this information to optimize screen output. 1633and C<slang> can (and do) use this information to optimize screen output.
1354 1634
1355=item B<WINDOWID> 1635=item B<WINDOWID>
1356 1636
1357Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1637Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1358window, which usually has subwindows for the scrollbar, the terminal 1638window, which usually has subwindows for the scrollbar, the terminal
1364C<--with-terminfo=PATH>. 1644C<--with-terminfo=PATH>.
1365 1645
1366=item B<DISPLAY> 1646=item B<DISPLAY>
1367 1647
1368Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1648Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1369display in it's child processes. 1649display in its child processes if C<-display> isn't used to override. It
1650defaults to C<:0> if it doesn't exist.
1370 1651
1371=item B<SHELL> 1652=item B<SHELL>
1372 1653
1373The shell to be used for command execution, defaults to C</bin/sh>. 1654The shell to be used for command execution, defaults to C</bin/sh>.
1374
1375=item B<RXVTPATH>
1376
1377The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1378files.
1379
1380=item B<PATH>
1381
1382Used in the same way as C<RXVTPATH>.
1383 1655
1384=item B<RXVT_SOCKET> 1656=item B<RXVT_SOCKET>
1385 1657
1386The unix domain socket path used by @@RXVT_NAME@@c(1) and 1658The unix domain socket path used by @@RXVT_NAME@@c(1) and
1387@@RXVT_NAME@@d(1). 1659@@RXVT_NAME@@d(1).
1388 1660
1389Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1661Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1390 1662
1391=item B<HOME> 1663=item B<HOME>
1392 1664
1393Used to locate the default directory for the unix domain socket for 1665Used to locate the default directory for the unix domain socket for
1394daemon communications and to locate various resource files (such as 1666daemon communications and to locate various resource files (such as
1395C<.Xdefaults>) 1667C<.Xdefaults>)
1396 1668
1397=item B<XAPPLRESDIR> 1669=item B<XAPPLRESDIR>
1398 1670
1399Directory where various X resource files are being located. 1671Directory where application-specific X resource files are located.
1400 1672
1401=item B<XENVIRONMENT> 1673=item B<XENVIRONMENT>
1402 1674
1403If set and accessible, gives the name of a X resource file to be loaded by 1675If set and accessible, gives the name of a X resource file to be loaded by
1404@@RXVT_NAME@@. 1676@@RXVT_NAME@@.
1409 1681
1410=over 4 1682=over 4
1411 1683
1412=item B</usr/lib/X11/rgb.txt> 1684=item B</usr/lib/X11/rgb.txt>
1413 1685
1414Color names. 1686Colour names.
1415 1687
1416=back 1688=back
1417 1689
1418=head1 SEE ALSO 1690=head1 SEE ALSO
1419 1691
1425 1697
1426=item Project Coordinator 1698=item Project Coordinator
1427 1699
1428Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1700Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1429 1701
1430L<http://software.schmorp.de/#rxvt-unicode> 1702L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1431 1703
1432=back 1704=back
1433 1705
1434=head1 AUTHORS 1706=head1 AUTHORS
1435 1707
1457 1729
1458Project Coordinator (changes.txt 2.21a to 2.4.5) 1730Project Coordinator (changes.txt 2.21a to 2.4.5)
1459 1731
1460=item Geoff Wing L<< <gcw@pobox.com> >> 1732=item Geoff Wing L<< <gcw@pobox.com> >>
1461 1733
1462Rewrote screen display and text selection routines. Project Coordinator 1734Rewrote screen display and text selection routines.
1735
1463(changes.txt 2.4.6 - rxvt-unicode) 1736Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1464 1737
1465=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1738=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1466 1739
1467Forked rxvt-unicode, rewrote most of the display code and internal 1740Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1468character handling to store text in unicode, improve xterm 1741extension, random hacks, numerous bugfixes and extensions.
1469compatibility and apply numerous other bugfixes and extensions.
1470 1742
1471Project Coordinator (Changes 1.0 -) 1743Project Coordinator (Changes 1.0 -)
1472 1744
1745=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1746
1747pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1748
1473=back 1749=back
1474 1750

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines