… | |
… | |
4 | <head> |
4 | <head> |
5 | <title>rxvt-unicode (ouR XVT, unicode)</title> |
5 | <title>rxvt-unicode (ouR XVT, unicode)</title> |
6 | <meta name="description" content="Pod documentation for rxvt-unicode (ouR XVT, unicode)" /> |
6 | <meta name="description" content="Pod documentation for rxvt-unicode (ouR XVT, unicode)" /> |
7 | <meta name="inputfile" content="<standard input>" /> |
7 | <meta name="inputfile" content="<standard input>" /> |
8 | <meta name="outputfile" content="<standard output>" /> |
8 | <meta name="outputfile" content="<standard output>" /> |
9 | <meta name="created" content="Sat Oct 27 14:07:34 2007" /> |
9 | <meta name="created" content="Mon Nov 19 13:01:50 2007" /> |
10 | <meta name="generator" content="Pod::Xhtml 1.57" /> |
10 | <meta name="generator" content="Pod::Xhtml 1.57" /> |
11 | <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> |
11 | <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> |
12 | <body> |
12 | <body> |
13 | <div class="pod"> |
13 | <div class="pod"> |
14 | <!-- INDEX START --> |
14 | <!-- INDEX START --> |
… | |
… | |
45 | <p>rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)</p> |
45 | <p>rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)</p> |
46 | |
46 | |
47 | </div> |
47 | </div> |
48 | <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
48 | <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
49 | <div id="SYNOPSIS_CONTENT"> |
49 | <div id="SYNOPSIS_CONTENT"> |
50 | <p><strong>urxvt</strong> [options] [-e command [ args ]]</p> |
50 | <p><strong>rxvt</strong> [options] [-e command [ args ]]</p> |
51 | |
51 | |
52 | </div> |
52 | </div> |
53 | <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
53 | <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
54 | <div id="DESCRIPTION_CONTENT"> |
54 | <div id="DESCRIPTION_CONTENT"> |
55 | <p><strong>rxvt-unicode</strong>, version <strong>8.4</strong>, is a colour vt102 terminal |
55 | <p><strong>rxvt-unicode</strong>, version <strong>8.4</strong>, is a colour vt102 terminal |
… | |
… | |
59 | a significant advantage on a machine serving many X sessions.</p> |
59 | a significant advantage on a machine serving many X sessions.</p> |
60 | |
60 | |
61 | </div> |
61 | </div> |
62 | <h1 id="FREQUENTLY_ASKED_QUESTIONS">FREQUENTLY ASKED QUESTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
62 | <h1 id="FREQUENTLY_ASKED_QUESTIONS">FREQUENTLY ASKED QUESTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
63 | <div id="FREQUENTLY_ASKED_QUESTIONS_CONTENT"> |
63 | <div id="FREQUENTLY_ASKED_QUESTIONS_CONTENT"> |
64 | <p>See urxvt(7) (try <code>man 7 urxvt</code>) for a list of |
64 | <p>See rxvt(7) (try <code>man 7 rxvt</code>) for a list of |
65 | frequently asked questions and answer to them and some common |
65 | frequently asked questions and answer to them and some common |
66 | problems. That document is also accessible on the World-Wide-Web at |
66 | problems. That document is also accessible on the World-Wide-Web at |
67 | <a href="http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html">http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html</a>.</p> |
67 | <a href="http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html">http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html</a>.</p> |
68 | |
68 | |
69 | </div> |
69 | </div> |
… | |
… | |
97 | <p>It is still faithfully following the original rxvt idea of being lean |
97 | <p>It is still faithfully following the original rxvt idea of being lean |
98 | and nice on resources: for example, you can still configure rxvt-unicode |
98 | and nice on resources: for example, you can still configure rxvt-unicode |
99 | without most of its features to get a lean binary. It also comes with |
99 | without most of its features to get a lean binary. It also comes with |
100 | a client/daemon pair that lets you open any number of terminal windows |
100 | a client/daemon pair that lets you open any number of terminal windows |
101 | from within a single process, which makes startup time very fast and |
101 | from within a single process, which makes startup time very fast and |
102 | drastically reduces memory usage. See urxvtd(1) (daemon) and |
102 | drastically reduces memory usage. See rxvtd(1) (daemon) and |
103 | urxvtc(1) (client).</p> |
103 | rxvtc(1) (client).</p> |
104 | <p>It also makes technical information about escape sequences (which have |
104 | <p>It also makes technical information about escape sequences (which have |
105 | been extended) more accessible: see urxvt(7) for technical |
105 | been extended) more accessible: see rxvt(7) for technical |
106 | reference documentation (escape sequences etc.).</p> |
106 | reference documentation (escape sequences etc.).</p> |
107 | |
107 | |
108 | </div> |
108 | </div> |
109 | <h1 id="OPTIONS">OPTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
109 | <h1 id="OPTIONS">OPTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
110 | <div id="OPTIONS_CONTENT"> |
110 | <div id="OPTIONS_CONTENT"> |
111 | <p>The <strong>urxvt</strong> options (mostly a subset of <i>xterm</i>'s) are listed |
111 | <p>The <strong>rxvt</strong> options (mostly a subset of <i>xterm</i>'s) are listed |
112 | below. In keeping with the smaller-is-better philosophy, options may be |
112 | below. In keeping with the smaller-is-better philosophy, options may be |
113 | eliminated or default values chosen at compile-time, so options and |
113 | eliminated or default values chosen at compile-time, so options and |
114 | defaults listed may not accurately reflect the version installed on |
114 | defaults listed may not accurately reflect the version installed on |
115 | your system. `urxvt -h' gives a list of major compile-time options on |
115 | your system. `rxvt -h' gives a list of major compile-time options on |
116 | the <i>Options</i> line. Option descriptions may be prefixed with which |
116 | the <i>Options</i> line. Option descriptions may be prefixed with which |
117 | compile option each is dependent upon. e.g. `Compile <i>XIM</i>:' requires |
117 | compile option each is dependent upon. e.g. `Compile <i>XIM</i>:' requires |
118 | <i>XIM</i> on the <i>Options</i> line. Note: `urxvt -help' gives a list of all |
118 | <i>XIM</i> on the <i>Options</i> line. Note: `rxvt -help' gives a list of all |
119 | command-line options compiled into your version.</p> |
119 | command-line options compiled into your version.</p> |
120 | <p>Note that <strong>urxvt</strong> permits the resource name to be used as a |
120 | <p>Note that <strong>rxvt</strong> permits the resource name to be used as a |
121 | long-option (--/++ option) so the potential command-line options are |
121 | long-option (--/++ option) so the potential command-line options are |
122 | far greater than those listed. For example: `urxvt --loginShell --color1 |
122 | far greater than those listed. For example: `rxvt --loginShell --color1 |
123 | Orange'.</p> |
123 | Orange'.</p> |
124 | <p>The following options are available:</p> |
124 | <p>The following options are available:</p> |
125 | <dl> |
125 | <dl> |
126 | <dt><strong>-help</strong>, <strong>--help</strong></dt> |
126 | <dt><strong>-help</strong>, <strong>--help</strong></dt> |
127 | <dd> |
127 | <dd> |
… | |
… | |
156 | </dd> |
156 | </dd> |
157 | <dt><strong>-tr</strong>|<strong>+tr</strong></dt> |
157 | <dt><strong>-tr</strong>|<strong>+tr</strong></dt> |
158 | <dd> |
158 | <dd> |
159 | <p>Turn on/off illusion of a transparent window background. Obsolete form of it is |
159 | <p>Turn on/off illusion of a transparent window background. Obsolete form of it is |
160 | <strong>-ip</strong> and it should not be used anymore; resource <strong>transparent</strong>.</p> |
160 | <strong>-ip</strong> and it should not be used anymore; resource <strong>transparent</strong>.</p> |
161 | <p><i>Please note that old resource name of <strong>inheritPixmap</strong> is obsolete and should be |
161 | <p><i>Please note that old resource name of <strong>inheritPixmap</strong> is obsolete and should be |
162 | changed to <strong>transparent</strong>. Backwards compatibility support for <strong>inheritPixmap</strong> will |
162 | changed to <strong>transparent</strong>. Backwards compatibility support for <strong>inheritPixmap</strong> will |
163 | be phased out in future versions of rxvt!</i></p> |
163 | be phased out in future versions of rxvt!</i></p> |
164 | <p><i>Please address all transparency related issues to Sasha Vasko at |
164 | <p><i>Please address all transparency related issues to Sasha Vasko at |
165 | sasha@aftercode.net. Read the FAQ (man 7 urxvt)!</i></p> |
165 | sasha@aftercode.net. Read the FAQ (man 7 rxvt)!</i></p> |
166 | </dd> |
166 | </dd> |
167 | <dt><strong>-fade</strong> <i>number</i></dt> |
167 | <dt><strong>-fade</strong> <i>number</i></dt> |
168 | <dd> |
168 | <dd> |
169 | <p>Fade the text by the given percentage when focus is lost. Small values |
169 | <p>Fade the text by the given percentage when focus is lost. Small values |
170 | fade a little only, 100 completely replaces all colours by the fade |
170 | fade a little only, 100 completely replaces all colours by the fade |
… | |
… | |
181 | transparency is enabled with <strong>-tr</strong>. This only works for |
181 | transparency is enabled with <strong>-tr</strong>. This only works for |
182 | non-tiled backgrounds, currently. See also the <strong>-sh</strong> option that can be |
182 | non-tiled backgrounds, currently. See also the <strong>-sh</strong> option that can be |
183 | used to brighten or darken the image in addition to tinting it. |
183 | used to brighten or darken the image in addition to tinting it. |
184 | Please note that certain tint colours can be applied on the server-side, |
184 | Please note that certain tint colours can be applied on the server-side, |
185 | thus yielding performance gain of two orders of magnitude. These colours are: |
185 | thus yielding performance gain of two orders of magnitude. These colours are: |
186 | blue, red, green, cyan, magenta, yellow, and those close to them; resource |
186 | blue, red, green, cyan, magenta, yellow, and those close to them. Also |
|
|
187 | pure black and pure white colors essentially mean no tinting; resource |
187 | <i>tintColor</i>. Example:</p> |
188 | <i>tintColor</i>. Example:</p> |
188 | <pre> urxvt -tr -tint blue -sh 40 |
189 | <pre> rxvt -tr -tint blue -sh 40 |
189 | |
190 | |
190 | </pre> |
191 | </pre> |
191 | </dd> |
192 | </dd> |
192 | <dt><strong>-sh</strong> <i>number</i></dt> |
193 | <dt><strong>-sh</strong> <i>number</i></dt> |
193 | <dd> |
194 | <dd> |
194 | <p>Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
195 | <p>Darken (0 .. 100) or lighten (100 .. 200) the transparent |
195 | background image in addition to (or instead of) tinting it; |
196 | background image in addition to (or instead of) tinting it; |
196 | resource <i>shading</i>.</p> |
197 | resource <i>shading</i>.</p> |
197 | </dd> |
198 | </dd> |
198 | <dt><strong>-blt</strong> <i>string</i></dt> |
199 | <dt><strong>-blt</strong> <i>string</i></dt> |
199 | <dd> |
200 | <dd> |
… | |
… | |
220 | </dd> |
221 | </dd> |
221 | <dt><strong>-fg</strong> <i>colour</i></dt> |
222 | <dt><strong>-fg</strong> <i>colour</i></dt> |
222 | <dd> |
223 | <dd> |
223 | <p>Window foreground colour; resource <strong>foreground</strong>.</p> |
224 | <p>Window foreground colour; resource <strong>foreground</strong>.</p> |
224 | </dd> |
225 | </dd> |
225 | <dt><strong>-pixmap</strong> <i>file[;geom]</i></dt> |
226 | <dt><strong>-pixmap</strong> <i>file[;geom[:op1][:op2][...]]</i></dt> |
226 | <dd> |
227 | <dd> |
227 | <p>Compile <i>afterimage</i>: Specify image file for the background and also |
228 | <p>Compile <i>afterimage</i>: Specify image file for the background and also |
228 | optionally specify its scaling with a geometry string. Note you may need to |
229 | optionally specify its scaling with a geometry string. Note you may need to |
229 | add quotes to avoid special shell interpretation of the <code>;</code> in the |
230 | add quotes to avoid special shell interpretation of the <code>;</code> in the |
230 | command-line; for more details see resource <strong>backgroundPixmap</strong>.</p> |
231 | command-line; for more details see resource <strong>backgroundPixmap</strong>.</p> |
231 | </dd> |
232 | </dd> |
232 | <dt><strong>-cr</strong> <i>colour</i></dt> |
233 | <dt><strong>-cr</strong> <i>colour</i></dt> |
… | |
… | |
254 | smaller, but not (in general) larger. A (hopefully) reasonable default |
255 | smaller, but not (in general) larger. A (hopefully) reasonable default |
255 | font list is always appended to it. See resource <strong>font</strong> for more details.</p> |
256 | font list is always appended to it. See resource <strong>font</strong> for more details.</p> |
256 | <p>In short, to specify an X11 core font, just specify its name or prefix it |
257 | <p>In short, to specify an X11 core font, just specify its name or prefix it |
257 | with <code>x:</code>. To specify an XFT-font, you need to prefix it with <code>xft:</code>, |
258 | with <code>x:</code>. To specify an XFT-font, you need to prefix it with <code>xft:</code>, |
258 | e.g.:</p> |
259 | e.g.:</p> |
259 | <pre> urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
260 | <pre> rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
260 | urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
261 | rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
261 | |
262 | |
262 | </pre> |
263 | </pre> |
263 | <p>See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
264 | <p>See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
264 | section of urxvt(7).</p> |
265 | section of rxvt(7).</p> |
265 | </dd> |
266 | </dd> |
266 | <dt><strong>-fb</strong> <i>fontlist</i></dt> |
267 | <dt><strong>-fb</strong> <i>fontlist</i></dt> |
267 | <dd> |
268 | <dd> |
268 | <p>Compile <i>font-styles</i>: The bold font list to use when <strong>bold</strong> characters |
269 | <p>Compile <i>font-styles</i>: The bold font list to use when <strong>bold</strong> characters |
269 | are to be printed. See resource <strong>boldFont</strong> for details.</p> |
270 | are to be printed. See resource <strong>boldFont</strong> for details.</p> |
… | |
… | |
398 | <i>termcap(5)</i> database and should have <i>li#</i> and <i>co#</i> entries; |
399 | <i>termcap(5)</i> database and should have <i>li#</i> and <i>co#</i> entries; |
399 | resource <strong>termName</strong>.</p> |
400 | resource <strong>termName</strong>.</p> |
400 | </dd> |
401 | </dd> |
401 | <dt><strong>-e</strong> <i>command [arguments]</i></dt> |
402 | <dt><strong>-e</strong> <i>command [arguments]</i></dt> |
402 | <dd> |
403 | <dd> |
403 | <p>Run the command with its command-line arguments in the <strong>urxvt</strong> |
404 | <p>Run the command with its command-line arguments in the <strong>rxvt</strong> |
404 | window; also sets the window title and icon name to be the basename of |
405 | window; also sets the window title and icon name to be the basename of |
405 | the program being executed if neither <i>-title</i> (<i>-T</i>) nor <i>-n</i> are |
406 | the program being executed if neither <i>-title</i> (<i>-T</i>) nor <i>-n</i> are |
406 | given on the command line. If this option is used, it must be the last |
407 | given on the command line. If this option is used, it must be the last |
407 | on the command-line. If there is no <strong>-e</strong> option then the default is to |
408 | on the command-line. If there is no <strong>-e</strong> option then the default is to |
408 | run the program specified by the <strong>SHELL</strong> environment variable or, |
409 | run the program specified by the <strong>SHELL</strong> environment variable or, |
409 | failing that, <i>sh(1)</i>.</p> |
410 | failing that, <i>sh(1)</i>.</p> |
410 | <p>Please note that you must specify a program with arguments. If you want to |
411 | <p>Please note that you must specify a program with arguments. If you want to |
411 | run shell commands, you have to specify the shell, like this:</p> |
412 | run shell commands, you have to specify the shell, like this:</p> |
412 | <pre> urxvt -e sh -c "shell commands" |
413 | <pre> rxvt -e sh -c "shell commands" |
413 | |
414 | |
414 | </pre> |
415 | </pre> |
415 | </dd> |
416 | </dd> |
416 | <dt><strong>-title</strong> <i>text</i></dt> |
417 | <dt><strong>-title</strong> <i>text</i></dt> |
417 | <dd> |
418 | <dd> |
… | |
… | |
479 | <p>Turn on/off secondary screen scroll (default enabled); resource |
480 | <p>Turn on/off secondary screen scroll (default enabled); resource |
480 | <strong>secondaryScroll</strong>.</p> |
481 | <strong>secondaryScroll</strong>.</p> |
481 | </dd> |
482 | </dd> |
482 | <dt><strong>-hold</strong>|<strong>+hold</strong></dt> |
483 | <dt><strong>-hold</strong>|<strong>+hold</strong></dt> |
483 | <dd> |
484 | <dd> |
484 | <p>Turn on/off hold window after exit support. If enabled, urxvt |
485 | <p>Turn on/off hold window after exit support. If enabled, rxvt |
485 | will not immediately destroy its window when the program executed within |
486 | will not immediately destroy its window when the program executed within |
486 | it exits. Instead, it will wait till it is being killed or closed by the |
487 | it exits. Instead, it will wait till it is being killed or closed by the |
487 | user; resource <strong>hold</strong>.</p> |
488 | user; resource <strong>hold</strong>.</p> |
488 | </dd> |
489 | </dd> |
489 | <dt><strong>-keysym.</strong><i>sym</i> <i>string</i></dt> |
490 | <dt><strong>-keysym.</strong><i>sym</i> <i>string</i></dt> |
490 | <dd> |
491 | <dd> |
491 | <p>Remap a key symbol. See resource <strong>keysym</strong>.</p> |
492 | <p>Remap a key symbol. See resource <strong>keysym</strong>.</p> |
492 | </dd> |
493 | </dd> |
493 | <dt><strong>-embed</strong> <i>windowid</i></dt> |
494 | <dt><strong>-embed</strong> <i>windowid</i></dt> |
494 | <dd> |
495 | <dd> |
495 | <p>Tells urxvt to embed its windows into an already-existing window, |
496 | <p>Tells rxvt to embed its windows into an already-existing window, |
496 | which enables applications to easily embed a terminal.</p> |
497 | which enables applications to easily embed a terminal.</p> |
497 | <p>Right now, urxvt will first unmap/map the specified window, so it |
498 | <p>Right now, rxvt will first unmap/map the specified window, so it |
498 | shouldn't be a top-level window. urxvt will also reconfigure it |
499 | shouldn't be a top-level window. rxvt will also reconfigure it |
499 | quite a bit, so don't expect it to keep some specific state. It's best to |
500 | quite a bit, so don't expect it to keep some specific state. It's best to |
500 | create an extra subwindow for urxvt and leave it alone.</p> |
501 | create an extra subwindow for rxvt and leave it alone.</p> |
501 | <p>The window will not be destroyed when urxvt exits.</p> |
502 | <p>The window will not be destroyed when rxvt exits.</p> |
502 | <p>It might be useful to know that urxvt will not close file |
503 | <p>It might be useful to know that rxvt will not close file |
503 | descriptors passed to it (except for stdin/out/err, of course), so you |
504 | descriptors passed to it (except for stdin/out/err, of course), so you |
504 | can use file descriptors to communicate with the programs within the |
505 | can use file descriptors to communicate with the programs within the |
505 | terminal. This works regardless of whether the <code>-embed</code> option was used or |
506 | terminal. This works regardless of whether the <code>-embed</code> option was used or |
506 | not.</p> |
507 | not.</p> |
507 | <p>Here is a short Gtk2-perl snippet that illustrates how this option can be |
508 | <p>Here is a short Gtk2-perl snippet that illustrates how this option can be |
508 | used (a longer example is in <cite>doc/embed</cite>):</p> |
509 | used (a longer example is in <cite>doc/embed</cite>):</p> |
509 | <pre> my $rxvt = new Gtk2::Socket; |
510 | <pre> my $rxvt = new Gtk2::Socket; |
510 | $rxvt->signal_connect_after (realize => sub { |
511 | $rxvt->signal_connect_after (realize => sub { |
511 | my $xid = $_[0]->window->get_xid; |
512 | my $xid = $_[0]->window->get_xid; |
512 | system "urxvt -embed $xid &"; |
513 | system "rxvt -embed $xid &"; |
513 | }); |
514 | }); |
514 | |
515 | |
515 | </pre> |
516 | </pre> |
516 | </dd> |
517 | </dd> |
517 | <dt><strong>-pty-fd</strong> <i>file descriptor</i></dt> |
518 | <dt><strong>-pty-fd</strong> <i>file descriptor</i></dt> |
518 | <dd> |
519 | <dd> |
519 | <p>Tells urxvt NOT to execute any commands or create a new pty/tty |
520 | <p>Tells rxvt NOT to execute any commands or create a new pty/tty |
520 | pair but instead use the given file descriptor as the tty master. This is |
521 | pair but instead use the given file descriptor as the tty master. This is |
521 | useful if you want to drive urxvt as a generic terminal emulator |
522 | useful if you want to drive rxvt as a generic terminal emulator |
522 | without having to run a program within it.</p> |
523 | without having to run a program within it.</p> |
523 | <p>If this switch is given, urxvt will not create any utmp/wtmp |
524 | <p>If this switch is given, rxvt will not create any utmp/wtmp |
524 | entries and will not tinker with pty/tty permissions - you have to do that |
525 | entries and will not tinker with pty/tty permissions - you have to do that |
525 | yourself if you want that.</p> |
526 | yourself if you want that.</p> |
526 | <p>As an extremely special case, specifying <code>-1</code> will completely suppress |
527 | <p>As an extremely special case, specifying <code>-1</code> will completely suppress |
527 | pty/tty operations.</p> |
528 | pty/tty operations.</p> |
528 | <p>Here is a example in perl that illustrates how this option can be used (a |
529 | <p>Here is a example in perl that illustrates how this option can be used (a |
… | |
… | |
530 | <pre> use IO::Pty; |
531 | <pre> use IO::Pty; |
531 | use Fcntl; |
532 | use Fcntl; |
532 | |
533 | |
533 | my $pty = new IO::Pty; |
534 | my $pty = new IO::Pty; |
534 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
535 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
535 | system "urxvt -pty-fd " . (fileno $pty) . "&"; |
536 | system "rxvt -pty-fd " . (fileno $pty) . "&"; |
536 | close $pty; |
537 | close $pty; |
537 | |
538 | |
538 | # now communicate with rxvt |
539 | # now communicate with rxvt |
539 | my $slave = $pty->slave; |
540 | my $slave = $pty->slave; |
540 | while (<$slave>) { print $slave "got <$_>\n" } |
541 | while (<$slave>) { print $slave "got <$_>\n" } |
… | |
… | |
549 | </dl> |
550 | </dl> |
550 | |
551 | |
551 | </div> |
552 | </div> |
552 | <h1 id="RESOURCES_available_also_as_long_opt">RESOURCES (available also as long-options)</h1><p><a href="#TOP" class="toplink">Top</a></p> |
553 | <h1 id="RESOURCES_available_also_as_long_opt">RESOURCES (available also as long-options)</h1><p><a href="#TOP" class="toplink">Top</a></p> |
553 | <div id="RESOURCES_available_also_as_long_opt-2"> |
554 | <div id="RESOURCES_available_also_as_long_opt-2"> |
554 | <p>Note: `urxvt --help' gives a list of all resources (long |
555 | <p>Note: `rxvt --help' gives a list of all resources (long |
555 | options) compiled into your version.</p> |
556 | options) compiled into your version.</p> |
556 | <p>You can set and change the resources using X11 tools like <strong>xrdb</strong>. Many |
557 | <p>You can set and change the resources using X11 tools like <strong>xrdb</strong>. Many |
557 | distribution do also load settings from the <strong>~/.Xresources</strong> file when X |
558 | distribution do also load settings from the <strong>~/.Xresources</strong> file when X |
558 | starts. urxvt will consult the following files/resources in order, |
559 | starts. rxvt will consult the following files/resources in order, |
559 | with later settings overwriting earlier ones:</p> |
560 | with later settings overwriting earlier ones:</p> |
560 | <pre> 1. system-wide app-defaults file, either locale-dependent OR global |
561 | <pre> 1. system-wide app-defaults file, either locale-dependent OR global |
561 | 2. app-defaults file in $XAPPLRESDIR |
562 | 2. app-defaults file in $XAPPLRESDIR |
562 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
563 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
563 | 4. SCREEN_RESOURCES for the current screen |
564 | 4. SCREEN_RESOURCES for the current screen |
564 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
565 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
565 | |
566 | |
566 | </pre> |
567 | </pre> |
567 | <p>Note that when reading X resources, <strong>urxvt</strong> recognizes two class |
568 | <p>Note that when reading X resources, <strong>rxvt</strong> recognizes two class |
568 | names: <strong>Rxvt</strong> and <strong>URxvt</strong>. The class name <strong>Rxvt</strong> allows resources |
569 | names: <strong>Rxvt</strong> and <strong>URxvt</strong>. The class name <strong>Rxvt</strong> allows resources |
569 | common to both <strong>urxvt</strong> and the original <i>rxvt</i> to be easily |
570 | common to both <strong>rxvt</strong> and the original <i>rxvt</i> to be easily |
570 | configured, while the class name <strong>URxvt</strong> allows resources unique to |
571 | configured, while the class name <strong>URxvt</strong> allows resources unique to |
571 | <strong>urxvt</strong>, to be shared between different <strong>urxvt</strong> |
572 | <strong>rxvt</strong>, to be shared between different <strong>rxvt</strong> |
572 | configurations. If no resources are specified, suitable defaults will |
573 | configurations. If no resources are specified, suitable defaults will |
573 | be used. Command-line arguments can be used to override resource |
574 | be used. Command-line arguments can be used to override resource |
574 | settings. The following resources are supported (you might want to |
575 | settings. The following resources are supported (you might want to |
575 | check the urxvtperl(3) manpage for additional settings by perl |
576 | check the rxvtperl(3) manpage for additional settings by perl |
576 | extensions not documented here):</p> |
577 | extensions not documented here):</p> |
577 | <dl> |
578 | <dl> |
578 | <dt><strong>depth:</strong> <i>bitdepth</i></dt> |
579 | <dt><strong>depth:</strong> <i>bitdepth</i></dt> |
579 | <dd> |
580 | <dd> |
580 | <p>Compile <i>xft</i>: Attempt to find a visual with the given bit depth; |
581 | <p>Compile <i>xft</i>: Attempt to find a visual with the given bit depth; |
… | |
… | |
602 | high-intensity (bold = bright foreground, blink = bright background) |
603 | high-intensity (bold = bright foreground, blink = bright background) |
603 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
604 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
604 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
605 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
605 | names used are listed in the <strong>COLORS AND GRAPHICS</strong> section.</p> |
606 | names used are listed in the <strong>COLORS AND GRAPHICS</strong> section.</p> |
606 | <p>Colours higher than 15 cannot be set using resources (yet), but can be |
607 | <p>Colours higher than 15 cannot be set using resources (yet), but can be |
607 | changed using an escape command (see urxvt(7)).</p> |
608 | changed using an escape command (see rxvt(7)).</p> |
608 | <p>Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
609 | <p>Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
609 | 88 colour support). Colours 80-87 are evenly spaces grey steps.</p> |
610 | 88 colour support). Colours 80-87 are evenly spaces grey steps.</p> |
610 | </dd> |
611 | </dd> |
611 | <dt><strong>colorBD:</strong> <i>colour</i></dt> |
612 | <dt><strong>colorBD:</strong> <i>colour</i></dt> |
612 | <dt><strong>colorIT:</strong> <i>colour</i></dt> |
613 | <dt><strong>colorIT:</strong> <i>colour</i></dt> |
… | |
… | |
648 | <strong>+rv</strong>. See note in <strong>COLORS AND GRAPHICS</strong> section.</p> |
649 | <strong>+rv</strong>. See note in <strong>COLORS AND GRAPHICS</strong> section.</p> |
649 | </dd> |
650 | </dd> |
650 | <dt><strong>jumpScroll:</strong> <i>boolean</i></dt> |
651 | <dt><strong>jumpScroll:</strong> <i>boolean</i></dt> |
651 | <dd> |
652 | <dd> |
652 | <p><strong>True</strong>: specify that jump scrolling should be used. When receiving lots |
653 | <p><strong>True</strong>: specify that jump scrolling should be used. When receiving lots |
653 | of lines, urxvt will only scroll once a whole screen height of lines |
654 | of lines, rxvt will only scroll once a whole screen height of lines |
654 | has been read, resulting in fewer updates while still displaying every |
655 | has been read, resulting in fewer updates while still displaying every |
655 | received line; option <strong>-j</strong>.</p> |
656 | received line; option <strong>-j</strong>.</p> |
656 | <p><strong>False</strong>: specify that smooth scrolling should be used. urxvt will |
657 | <p><strong>False</strong>: specify that smooth scrolling should be used. rxvt will |
657 | force a screen refresh on each new line it received; option <strong>+j</strong>.</p> |
658 | force a screen refresh on each new line it received; option <strong>+j</strong>.</p> |
658 | </dd> |
659 | </dd> |
659 | <dt><strong>skipScroll:</strong> <i>boolean</i></dt> |
660 | <dt><strong>skipScroll:</strong> <i>boolean</i></dt> |
660 | <dd> |
661 | <dd> |
661 | <p><strong>True</strong>: (the default) specify that skip scrolling should be used. When |
662 | <p><strong>True</strong>: (the default) specify that skip scrolling should be used. When |
662 | receiving lots of lines, urxvt will only scroll once in a while |
663 | receiving lots of lines, rxvt will only scroll once in a while |
663 | (around 60 times per second), resulting in far fewer updates. This can |
664 | (around 60 times per second), resulting in far fewer updates. This can |
664 | result in urxvt not ever displaying some of the lines it receives; |
665 | result in rxvt not ever displaying some of the lines it receives; |
665 | option <strong>-ss</strong>.</p> |
666 | option <strong>-ss</strong>.</p> |
666 | <p><strong>False</strong>: specify that everything is to be displayed, even |
667 | <p><strong>False</strong>: specify that everything is to be displayed, even |
667 | if the refresh is too fast for the human eye to read anything (or the |
668 | if the refresh is too fast for the human eye to read anything (or the |
668 | monitor to display anything); option <strong>+ss</strong>.</p> |
669 | monitor to display anything); option <strong>+ss</strong>.</p> |
669 | </dd> |
670 | </dd> |
… | |
… | |
698 | <dd> |
699 | <dd> |
699 | <p>Specify background blending type; option <strong>-blt</strong>.</p> |
700 | <p>Specify background blending type; option <strong>-blt</strong>.</p> |
700 | </dd> |
701 | </dd> |
701 | <dt><strong>blurRadius:</strong> <i>number</i></dt> |
702 | <dt><strong>blurRadius:</strong> <i>number</i></dt> |
702 | <dd> |
703 | <dd> |
703 | <p>Apply Gaussian Blurr with the specified radius to the transparent |
704 | <p>Apply Gaussian Blurr with the specified radius to the transparent |
704 | background image; option <strong>-blr</strong>.</p> |
705 | background image; option <strong>-blr</strong>.</p> |
705 | </dd> |
706 | </dd> |
706 | <dt><strong>scrollColor:</strong> <i>colour</i></dt> |
707 | <dt><strong>scrollColor:</strong> <i>colour</i></dt> |
707 | <dd> |
708 | <dd> |
708 | <p>Use the specified colour for the scrollbar [default #B2B2B2].</p> |
709 | <p>Use the specified colour for the scrollbar [default #B2B2B2].</p> |
… | |
… | |
715 | <dt><strong>borderColor:</strong> <i>colour</i></dt> |
716 | <dt><strong>borderColor:</strong> <i>colour</i></dt> |
716 | <dd> |
717 | <dd> |
717 | <p>The colour of the border around the text area and between the scrollbar |
718 | <p>The colour of the border around the text area and between the scrollbar |
718 | and the text.</p> |
719 | and the text.</p> |
719 | </dd> |
720 | </dd> |
720 | <dt><strong>backgroundPixmap:</strong> <i>file[;geom]</i></dt> |
721 | <dt><strong>backgroundPixmap:</strong> <i>file[;geom[:op1][:op2][...]]</i></dt> |
721 | <dd> |
722 | <dd> |
722 | <p>Use the specified image file for the background and also optionally |
723 | <p>Use the specified image file for the background and also |
723 | specify its scaling with a geometry string <strong>WxH+X+Y</strong>, |
724 | optionally specify its scaling with a geometry string <strong>WxH+X+Y</strong>, |
724 | in which <strong>"W" / "H"</strong> specify the horizontal/vertical scale (percent), |
725 | (default <code>0x0+50+50</code>) in which <strong>"W" / "H"</strong> specify the |
725 | and <strong>"X" / "Y"</strong> locate the image centre (percent). |
726 | horizontal/vertical scale (percent), and <strong>"X" / "Y"</strong> locate the image |
726 | A scale of 0 displays the image with tiling. A scale of 1 displays the |
727 | centre (percent). A scale of 0 displays the image with tiling. A scale |
727 | image without any scaling. A scale of 2 to 9 specifies an integer |
728 | of 1 displays the image without any scaling. A scale of 2 to 9 specifies |
728 | number of images in that direction. No image will be magnified beyond |
729 | an integer number of images in that direction. No image will be magnified |
729 | 10 times its original size. The maximum permitted scale is 1000. |
730 | beyond 10 times its original size. The maximum permitted scale is 1000. |
730 | Special string of <strong>"auto"</strong> used as a geometry will cause image to be |
731 | Additional operations can be specified after colon <strong>:op1:op2...</strong>. |
731 | automatically scaled to match window size. |
732 | Supported operations are:</p> |
|
|
733 | <pre> tile force background image to be tiled and not scaled. Equivalent to 0x0, |
|
|
734 | propscale will scale image keeping proportions, |
|
|
735 | auto will scale image to match window size. Equivalent to 100x100; |
|
|
736 | hscale will scale image horizontally to the window size; |
|
|
737 | vscale will scale image vertically to the window size; |
|
|
738 | scale will scale image to match window size; |
|
|
739 | root will tile image as if it was a root window background, auto-adjusting |
|
|
740 | whenever terminal window moves. |
|
|
741 | |
|
|
742 | </pre> |
732 | If used in conjunction with <strong>-tr</strong> option - specified pixmap will be |
743 | <p>If used in conjunction with <strong>-tr</strong> option, the specified pixmap will be |
733 | blended over transparency image using either alpha-blending, or any |
744 | blended over transparency image using either alpha-blending, or any |
734 | other blending type, specified with <strong>-blt "type"</strong> option. |
745 | other blending type, specified with <strong>-blt "type"</strong> option.</p> |
735 | [default 0x0+50+50]</p> |
|
|
736 | </dd> |
746 | </dd> |
737 | <dt><strong>path:</strong> <i>path</i></dt> |
747 | <dt><strong>path:</strong> <i>path</i></dt> |
738 | <dd> |
748 | <dd> |
739 | <p>Specify the colon-delimited search path for finding background image files.</p> |
749 | <p>Specify the colon-delimited search path for finding background image files.</p> |
740 | </dd> |
750 | </dd> |
… | |
… | |
992 | <dt><strong>cutchars:</strong> <i>string</i></dt> |
1002 | <dt><strong>cutchars:</strong> <i>string</i></dt> |
993 | <dd> |
1003 | <dd> |
994 | <p>The characters used as delimiters for double-click word selection |
1004 | <p>The characters used as delimiters for double-click word selection |
995 | (whitespace delimiting is added automatically if resource is given).</p> |
1005 | (whitespace delimiting is added automatically if resource is given).</p> |
996 | <p>When the perl selection extension is in use (the default if compiled |
1006 | <p>When the perl selection extension is in use (the default if compiled |
997 | in, see the urxvtperl(3) manpage), a suitable regex using these |
1007 | in, see the rxvtperl(3) manpage), a suitable regex using these |
998 | characters will be created (if the resource exists, otherwise, no regex |
1008 | characters will be created (if the resource exists, otherwise, no regex |
999 | will be created). In this mode, characters outside ISO-8859-1 can be used.</p> |
1009 | will be created). In this mode, characters outside ISO-8859-1 can be used.</p> |
1000 | <p>When the selection extension is not used, only ISO-8859-1 characters can |
1010 | <p>When the selection extension is not used, only ISO-8859-1 characters can |
1001 | be used. If not specified, the built-in default is used:</p> |
1011 | be used. If not specified, the built-in default is used:</p> |
1002 | <p><strong>BACKSLASH `"'&()*,;<=>?@[]{|}</strong></p> |
1012 | <p><strong>BACKSLASH `"'&()*,;<=>?@[]^{|}</strong></p> |
1003 | </dd> |
1013 | </dd> |
1004 | <dt><strong>preeditType:</strong> <i>style</i></dt> |
1014 | <dt><strong>preeditType:</strong> <i>style</i></dt> |
1005 | <dd> |
1015 | <dd> |
1006 | <p><strong>OverTheSpot</strong>, <strong>OffTheSpot</strong>, <strong>Root</strong>; option <strong>-pt</strong>.</p> |
1016 | <p><strong>OverTheSpot</strong>, <strong>OffTheSpot</strong>, <strong>Root</strong>; option <strong>-pt</strong>.</p> |
1007 | </dd> |
1017 | </dd> |
… | |
… | |
1019 | <dt><strong>imFont:</strong> <i>fontset</i></dt> |
1029 | <dt><strong>imFont:</strong> <i>fontset</i></dt> |
1020 | <dd> |
1030 | <dd> |
1021 | <p>Specify the font-set used for XIM styles <code>OverTheSpot</code> or |
1031 | <p>Specify the font-set used for XIM styles <code>OverTheSpot</code> or |
1022 | <code>OffTheSpot</code>. It must be a standard X font set (XLFD patterns separated |
1032 | <code>OffTheSpot</code>. It must be a standard X font set (XLFD patterns separated |
1023 | by commas), i.e. it's not in the same format as the other font lists used |
1033 | by commas), i.e. it's not in the same format as the other font lists used |
1024 | in urxvt. The default will be set-up to chose *any* suitable found |
1034 | in rxvt. The default will be set-up to chose *any* suitable found |
1025 | found, preferably one or two pixels differing in size to the base font. |
1035 | found, preferably one or two pixels differing in size to the base font. |
1026 | option <strong>-imfont</strong>.</p> |
1036 | option <strong>-imfont</strong>.</p> |
1027 | </dd> |
1037 | </dd> |
1028 | <dt><strong>tripleclickwords:</strong> <i>boolean</i></dt> |
1038 | <dt><strong>tripleclickwords:</strong> <i>boolean</i></dt> |
1029 | <dd> |
1039 | <dd> |
… | |
… | |
1067 | scrollback buffer and switching to/from the secondary screen will |
1077 | scrollback buffer and switching to/from the secondary screen will |
1068 | instead scroll the screen up.</p> |
1078 | instead scroll the screen up.</p> |
1069 | </dd> |
1079 | </dd> |
1070 | <dt><strong>hold</strong>: <i>boolean</i></dt> |
1080 | <dt><strong>hold</strong>: <i>boolean</i></dt> |
1071 | <dd> |
1081 | <dd> |
1072 | <p>Turn on/off hold window after exit support. If enabled, urxvt |
1082 | <p>Turn on/off hold window after exit support. If enabled, rxvt |
1073 | will not immediately destroy its window when the program executed within |
1083 | will not immediately destroy its window when the program executed within |
1074 | it exits. Instead, it will wait till it is being killed or closed by the |
1084 | it exits. Instead, it will wait till it is being killed or closed by the |
1075 | user.</p> |
1085 | user.</p> |
1076 | </dd> |
1086 | </dd> |
1077 | <dt><strong>keysym.</strong><i>sym</i>: <i>string</i></dt> |
1087 | <dt><strong>keysym.</strong><i>sym</i>: <i>string</i></dt> |
… | |
… | |
1106 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
1116 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
1107 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
1117 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
1108 | |
1118 | |
1109 | </pre> |
1119 | </pre> |
1110 | <p>If <i>string</i> takes the form of <code>command:STRING</code>, the specified <strong>STRING</strong> |
1120 | <p>If <i>string</i> takes the form of <code>command:STRING</code>, the specified <strong>STRING</strong> |
1111 | is interpreted and executed as urxvt's control sequence. For |
1121 | is interpreted and executed as rxvt's control sequence. For |
1112 | example the following means "change the current locale to <code>zh_CN.GBK</code> |
1122 | example the following means "change the current locale to <code>zh_CN.GBK</code> |
1113 | when Control-Meta-c is being pressed":</p> |
1123 | when Control-Meta-c is being pressed":</p> |
1114 | <pre> URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1124 | <pre> URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1115 | |
1125 | |
1116 | </pre> |
1126 | </pre> |
1117 | <p>If <i>string</i> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong> |
1127 | <p>If <i>string</i> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong> |
1118 | is passed to the <code>on_keyboard_command</code> perl handler. See the urxvtperl(3) |
1128 | is passed to the <code>on_keyboard_command</code> perl handler. See the rxvtperl(3) |
1119 | manpage. For example, the <cite>selection</cite> extension (activated via |
1129 | manpage. For example, the <cite>selection</cite> extension (activated via |
1120 | <code>urxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p> |
1130 | <code>rxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p> |
1121 | <pre> URxvt.keysym.M-C-c: perl:selection:rot13 |
1131 | <pre> URxvt.keysym.M-C-c: perl:selection:rot13 |
1122 | |
1132 | |
1123 | </pre> |
1133 | </pre> |
1124 | <p>Due the the large number of modifier combinations, a defined key mapping |
1134 | <p>Due the the large number of modifier combinations, a defined key mapping |
1125 | will match if at <i>at least</i> the specified identifiers are being set, and |
1135 | will match if at <i>at least</i> the specified identifiers are being set, and |
1126 | no other key mappings with those and more bits are being defined. That |
1136 | no other key mappings with those and more bits are being defined. That |
1127 | means that defining a key map for <code>a</code> will automatically provide |
1137 | means that defining a key map for <code>a</code> will automatically provide |
1128 | definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined |
1138 | definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined |
1129 | mappings themselves.</p> |
1139 | mappings themselves.</p> |
1130 | <p>Unfortunately, this will override built-in key mappings. For example |
1140 | <p>Unfortunately, this will override built-in key mappings. For example |
1131 | if you overwrite the <code>Insert</code> key you will disable urxvt's |
1141 | if you overwrite the <code>Insert</code> key you will disable rxvt's |
1132 | <code>Shift-Insert</code> mapping. To re-enable that, you can poke "holes" into the |
1142 | <code>Shift-Insert</code> mapping. To re-enable that, you can poke "holes" into the |
1133 | user-defined keymap using the <code>builtin:</code> replacement:</p> |
1143 | user-defined keymap using the <code>builtin:</code> replacement:</p> |
1134 | <pre> URxvt.keysym.Insert: <my insert key sequence> |
1144 | <pre> URxvt.keysym.Insert: <my insert key sequence> |
1135 | URxvt.keysym.S-Insert: builtin: |
1145 | URxvt.keysym.S-Insert: builtin: |
1136 | |
1146 | |
… | |
… | |
1143 | font-switching at runtime:</p> |
1153 | font-switching at runtime:</p> |
1144 | <pre> URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
1154 | <pre> URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
1145 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
1155 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
1146 | |
1156 | |
1147 | </pre> |
1157 | </pre> |
1148 | <p>Other things are possible, e.g. resizing (see urxvt(7) for more |
1158 | <p>Other things are possible, e.g. resizing (see rxvt(7) for more |
1149 | info):</p> |
1159 | info):</p> |
1150 | <pre> URxvt.keysym.M-C-3: command:\033[8;25;80t |
1160 | <pre> URxvt.keysym.M-C-3: command:\033[8;25;80t |
1151 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1161 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1152 | |
1162 | |
1153 | </pre> |
1163 | </pre> |
… | |
… | |
1175 | all instances, while <strong>perl-ext</strong> is used for specific instances.</p> |
1185 | all instances, while <strong>perl-ext</strong> is used for specific instances.</p> |
1176 | </dd> |
1186 | </dd> |
1177 | <dt><strong>perl-eval</strong>: <i>string</i></dt> |
1187 | <dt><strong>perl-eval</strong>: <i>string</i></dt> |
1178 | <dd> |
1188 | <dd> |
1179 | <p>Perl code to be evaluated when all extensions have been registered. See |
1189 | <p>Perl code to be evaluated when all extensions have been registered. See |
1180 | the urxvtperl(3) manpage. Due to security reasons, this resource |
1190 | the rxvtperl(3) manpage. Due to security reasons, this resource |
1181 | will be ignored when running setuid/setgid.</p> |
1191 | will be ignored when running setuid/setgid.</p> |
1182 | </dd> |
1192 | </dd> |
1183 | <dt><strong>perl-lib</strong>: <i>path</i></dt> |
1193 | <dt><strong>perl-lib</strong>: <i>path</i></dt> |
1184 | <dd> |
1194 | <dd> |
1185 | <p>Colon-separated list of additional directories that hold extension |
1195 | <p>Colon-separated list of additional directories that hold extension |
1186 | scripts. When looking for extensions specified by the <code>perl</code> resource, |
1196 | scripts. When looking for extensions specified by the <code>perl</code> resource, |
1187 | urxvt will first look in these directories and then in |
1197 | rxvt will first look in these directories and then in |
1188 | <cite>/usr/local/lib/urxvt/perl/</cite>. Due to security reasons, this resource |
1198 | <cite>/opt/rxvt/lib/urxvt/perl/</cite>. Due to security reasons, this resource |
1189 | will be ignored when running setuid/setgid.</p> |
1199 | will be ignored when running setuid/setgid.</p> |
1190 | <p>See the urxvtperl(3) manpage.</p> |
1200 | <p>See the rxvtperl(3) manpage.</p> |
1191 | </dd> |
1201 | </dd> |
1192 | <dt><strong>selection.pattern-<i>idx</i></strong>: <i>perl-regex</i></dt> |
1202 | <dt><strong>selection.pattern-<i>idx</i></strong>: <i>perl-regex</i></dt> |
1193 | <dd> |
1203 | <dd> |
1194 | <p>Additional selection patterns, see the urxvtperl(3) manpage for |
1204 | <p>Additional selection patterns, see the rxvtperl(3) manpage for |
1195 | details.</p> |
1205 | details.</p> |
1196 | </dd> |
1206 | </dd> |
1197 | <dt><strong>selection-autotransform.<i>idx</i></strong>: <i>perl-transform</i></dt> |
1207 | <dt><strong>selection-autotransform.<i>idx</i></strong>: <i>perl-transform</i></dt> |
1198 | <dd> |
1208 | <dd> |
1199 | <p>Selection auto-transform patterns, see the urxvtperl(3) manpage |
1209 | <p>Selection auto-transform patterns, see the rxvtperl(3) manpage |
1200 | for details.</p> |
1210 | for details.</p> |
1201 | </dd> |
1211 | </dd> |
1202 | <dt><strong>searchable-scrollback:</strong> <i>keysym</i></dt> |
1212 | <dt><strong>searchable-scrollback:</strong> <i>keysym</i></dt> |
1203 | <dd> |
1213 | <dd> |
1204 | <p>Sets the hotkey that starts the incremental scrollback buffer search |
1214 | <p>Sets the hotkey that starts the incremental scrollback buffer search |
… | |
… | |
1225 | </dl> |
1235 | </dl> |
1226 | |
1236 | |
1227 | </div> |
1237 | </div> |
1228 | <h1 id="THE_SCROLLBAR">THE SCROLLBAR</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1238 | <h1 id="THE_SCROLLBAR">THE SCROLLBAR</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1229 | <div id="THE_SCROLLBAR_CONTENT"> |
1239 | <div id="THE_SCROLLBAR_CONTENT"> |
1230 | <p>Lines of text that scroll off the top of the <strong>urxvt</strong> window |
1240 | <p>Lines of text that scroll off the top of the <strong>rxvt</strong> window |
1231 | (resource: <strong>saveLines</strong>) and can be scrolled back using the scrollbar |
1241 | (resource: <strong>saveLines</strong>) and can be scrolled back using the scrollbar |
1232 | or by keystrokes. The normal <strong>urxvt</strong> scrollbar has arrows and |
1242 | or by keystrokes. The normal <strong>rxvt</strong> scrollbar has arrows and |
1233 | its behaviour is fairly intuitive. The <strong>xterm-scrollbar</strong> is without |
1243 | its behaviour is fairly intuitive. The <strong>xterm-scrollbar</strong> is without |
1234 | arrows and its behaviour mimics that of <i>xterm</i></p> |
1244 | arrows and its behaviour mimics that of <i>xterm</i></p> |
1235 | <p>Scroll down with <strong>Button1</strong> (<strong>xterm-scrollbar</strong>) or <strong>Shift-Next</strong>. |
1245 | <p>Scroll down with <strong>Button1</strong> (<strong>xterm-scrollbar</strong>) or <strong>Shift-Next</strong>. |
1236 | Scroll up with <strong>Button3</strong> (<strong>xterm-scrollbar</strong>) or <strong>Shift-Prior</strong>. |
1246 | Scroll up with <strong>Button3</strong> (<strong>xterm-scrollbar</strong>) or <strong>Shift-Prior</strong>. |
1237 | Continuous scroll with <strong>Button2</strong>.</p> |
1247 | Continuous scroll with <strong>Button2</strong>.</p> |
… | |
… | |
1268 | selection, and trailing whitespace is visually underlined and removed from |
1278 | selection, and trailing whitespace is visually underlined and removed from |
1269 | the selection.</p> |
1279 | the selection.</p> |
1270 | </dd> |
1280 | </dd> |
1271 | <dt><strong>Pasting</strong>:</dt> |
1281 | <dt><strong>Pasting</strong>:</dt> |
1272 | <dd> |
1282 | <dd> |
1273 | <p>Pressing and releasing the Middle mouse button in an <strong>urxvt</strong> |
1283 | <p>Pressing and releasing the Middle mouse button in an <strong>rxvt</strong> |
1274 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1284 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1275 | <strong>Meta</strong> modifier) to be inserted as if it had been typed on the keyboard.</p> |
1285 | <strong>Meta</strong> modifier) to be inserted as if it had been typed on the keyboard.</p> |
1276 | <p>Pressing <strong>Shift-Insert</strong> causes the value of the PRIMARY selection to be |
1286 | <p>Pressing <strong>Shift-Insert</strong> causes the value of the PRIMARY selection to be |
1277 | inserted too.</p> |
1287 | inserted too.</p> |
1278 | </dd> |
1288 | </dd> |
… | |
… | |
1353 | both scenario A and B of ISO 14755, including part 5.2.</p> |
1363 | both scenario A and B of ISO 14755, including part 5.2.</p> |
1354 | |
1364 | |
1355 | </div> |
1365 | </div> |
1356 | <h1 id="LOGIN_STAMP">LOGIN STAMP</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1366 | <h1 id="LOGIN_STAMP">LOGIN STAMP</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1357 | <div id="LOGIN_STAMP_CONTENT"> |
1367 | <div id="LOGIN_STAMP_CONTENT"> |
1358 | <p><strong>urxvt</strong> tries to write an entry into the <i>utmp</i>(5) file so that |
1368 | <p><strong>rxvt</strong> tries to write an entry into the <i>utmp</i>(5) file so that |
1359 | it can be seen via the <i>who(1)</i> command, and can accept messages. To |
1369 | it can be seen via the <i>who(1)</i> command, and can accept messages. To |
1360 | allow this feature, <strong>urxvt</strong> may need to be installed setuid root |
1370 | allow this feature, <strong>rxvt</strong> may need to be installed setuid root |
1361 | on some systems or setgid to root or to some other group on others.</p> |
1371 | on some systems or setgid to root or to some other group on others.</p> |
1362 | |
1372 | |
1363 | </div> |
1373 | </div> |
1364 | <h1 id="COLORS_AND_GRAPHICS">COLORS AND GRAPHICS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1374 | <h1 id="COLORS_AND_GRAPHICS">COLORS AND GRAPHICS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1365 | <div id="COLORS_AND_GRAPHICS_CONTENT"> |
1375 | <div id="COLORS_AND_GRAPHICS_CONTENT"> |
1366 | <p>In addition to the default foreground and background colours, |
1376 | <p>In addition to the default foreground and background colours, |
1367 | <strong>urxvt</strong> can display up to 16 colours (8 ANSI colours plus |
1377 | <strong>rxvt</strong> can display up to 16 colours (8 ANSI colours plus |
1368 | high-intensity bold/blink versions of the same). Here is a list of the |
1378 | high-intensity bold/blink versions of the same). Here is a list of the |
1369 | colours with their names.</p> |
1379 | colours with their names.</p> |
1370 | <table><tr><td>color0</td><td>(black)</td><td>= Black</td></tr><tr><td>color1</td><td>(red)</td><td>= Red3</td></tr><tr><td>color2</td><td>(green)</td><td>= Green3</td></tr><tr><td>color3</td><td>(yellow)</td><td>= Yellow3</td></tr><tr><td>color4</td><td>(blue)</td><td>= Blue3</td></tr><tr><td>color5</td><td>(magenta)</td><td>= Magenta3</td></tr><tr><td>color6</td><td>(cyan)</td><td>= Cyan3</td></tr><tr><td>color7</td><td>(white)</td><td>= AntiqueWhite</td></tr><tr><td>color8</td><td>(bright black)</td><td>= Grey25</td></tr><tr><td>color9</td><td>(bright red)</td><td>= Red</td></tr><tr><td>color10</td><td>(bright green)</td><td>= Green</td></tr><tr><td>color11</td><td>(bright yellow)</td><td>= Yellow</td></tr><tr><td>color12</td><td>(bright blue)</td><td>= Blue</td></tr><tr><td>color13</td><td>(bright magenta)</td><td>= Magenta</td></tr><tr><td>color14</td><td>(bright cyan)</td><td>= Cyan</td></tr><tr><td>color15</td><td>(bright white)</td><td>= White</td></tr><tr><td>foreground</td><td></td><td>= Black</td></tr><tr><td>background</td><td></td><td>= White</td></tr></table><p>It is also possible to specify the colour values of <strong>foreground</strong>, |
1380 | <table><tr><td>color0</td><td>(black)</td><td>= Black</td></tr><tr><td>color1</td><td>(red)</td><td>= Red3</td></tr><tr><td>color2</td><td>(green)</td><td>= Green3</td></tr><tr><td>color3</td><td>(yellow)</td><td>= Yellow3</td></tr><tr><td>color4</td><td>(blue)</td><td>= Blue3</td></tr><tr><td>color5</td><td>(magenta)</td><td>= Magenta3</td></tr><tr><td>color6</td><td>(cyan)</td><td>= Cyan3</td></tr><tr><td>color7</td><td>(white)</td><td>= AntiqueWhite</td></tr><tr><td>color8</td><td>(bright black)</td><td>= Grey25</td></tr><tr><td>color9</td><td>(bright red)</td><td>= Red</td></tr><tr><td>color10</td><td>(bright green)</td><td>= Green</td></tr><tr><td>color11</td><td>(bright yellow)</td><td>= Yellow</td></tr><tr><td>color12</td><td>(bright blue)</td><td>= Blue</td></tr><tr><td>color13</td><td>(bright magenta)</td><td>= Magenta</td></tr><tr><td>color14</td><td>(bright cyan)</td><td>= Cyan</td></tr><tr><td>color15</td><td>(bright white)</td><td>= White</td></tr><tr><td>foreground</td><td></td><td>= Black</td></tr><tr><td>background</td><td></td><td>= White</td></tr></table><p>It is also possible to specify the colour values of <strong>foreground</strong>, |
1371 | <strong>background</strong>, <strong>cursorColor</strong>, <strong>cursorColor2</strong>, <strong>colorBD</strong>, <strong>colorUL</strong> as |
1381 | <strong>background</strong>, <strong>cursorColor</strong>, <strong>cursorColor2</strong>, <strong>colorBD</strong>, <strong>colorUL</strong> as |
1372 | a number 0-15, as a convenient shorthand to reference the colour name of |
1382 | a number 0-15, as a convenient shorthand to reference the colour name of |
1373 | color0-color15.</p> |
1383 | color0-color15.</p> |
1374 | <p>In addition to the colours defined above, urxvt offers an |
1384 | <p>In addition to the colours defined above, rxvt offers an |
1375 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
1385 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
1376 | consist of a 4*4*4 RGB colour cube (i.e. <i>index = r * 16 + g * 4 + b + |
1386 | consist of a 4*4*4 RGB colour cube (i.e. <i>index = r * 16 + g * 4 + b + |
1377 | 16</i>), followed by 8 additional shades of gray (with indices 80 to 87).</p> |
1387 | 16</i>), followed by 8 additional shades of gray (with indices 80 to 87).</p> |
1378 | <p>Together, all those colours implement the 88 colour xterm colours. Only |
1388 | <p>Together, all those colours implement the 88 colour xterm colours. Only |
1379 | the first 16 can be changed using resources currently, the rest can only |
1389 | the first 16 can be changed using resources currently, the rest can only |
… | |
… | |
1381 | <p>Note that <strong>-rv</strong> (<strong>"reverseVideo: True"</strong>) simulates reverse video by |
1391 | <p>Note that <strong>-rv</strong> (<strong>"reverseVideo: True"</strong>) simulates reverse video by |
1382 | always swapping the foreground/background colours. This is in contrast to |
1392 | always swapping the foreground/background colours. This is in contrast to |
1383 | <i>xterm</i>(1) where the colours are only swapped if they have not otherwise |
1393 | <i>xterm</i>(1) where the colours are only swapped if they have not otherwise |
1384 | been specified. For example,</p> |
1394 | been specified. For example,</p> |
1385 | <dl> |
1395 | <dl> |
1386 | <dt><strong>urxvt -fg Black -bg White -rv</strong></dt> |
1396 | <dt><strong>rxvt -fg Black -bg White -rv</strong></dt> |
1387 | <dd> |
1397 | <dd> |
1388 | <p>would yield White on Black, while on <i>xterm</i>(1) it would yield Black |
1398 | <p>would yield White on Black, while on <i>xterm</i>(1) it would yield Black |
1389 | on White.</p> |
1399 | on White.</p> |
1390 | </dd> |
1400 | </dd> |
1391 | </dl> |
1401 | </dl> |
… | |
… | |
1405 | <p>You probably need to specify <strong>"-depth 32"</strong>, too, and have the luck that |
1415 | <p>You probably need to specify <strong>"-depth 32"</strong>, too, and have the luck that |
1406 | your X-server uses ARGB pixel layout, as X is far from just supporting |
1416 | your X-server uses ARGB pixel layout, as X is far from just supporting |
1407 | ARGB visuals out of the box, and rxvt-unicode just fudges around.</p> |
1417 | ARGB visuals out of the box, and rxvt-unicode just fudges around.</p> |
1408 | <p>For example, the following selects an almost completely transparent red |
1418 | <p>For example, the following selects an almost completely transparent red |
1409 | background, and an almost opaque pink foreground:</p> |
1419 | background, and an almost opaque pink foreground:</p> |
1410 | <pre> urxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
1420 | <pre> rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
1411 | |
1421 | |
1412 | </pre> |
1422 | </pre> |
1413 | <p><i>Please note that transparency of any kind if completely unsupported by |
1423 | <p><i>Please note that transparency of any kind if completely unsupported by |
1414 | the author. Don't bug him with installation questions!</i></p> |
1424 | the author. Don't bug him with installation questions!</i></p> |
1415 | |
1425 | |
1416 | </div> |
1426 | </div> |
1417 | <h1 id="ENVIRONMENT">ENVIRONMENT</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1427 | <h1 id="ENVIRONMENT">ENVIRONMENT</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1418 | <div id="ENVIRONMENT_CONTENT"> |
1428 | <div id="ENVIRONMENT_CONTENT"> |
1419 | <p><strong>urxvt</strong> sets and/or uses the following environment variables:</p> |
1429 | <p><strong>rxvt</strong> sets and/or uses the following environment variables:</p> |
1420 | <dl> |
1430 | <dl> |
1421 | <dt><strong>TERM</strong></dt> |
1431 | <dt><strong>TERM</strong></dt> |
1422 | <dd> |
1432 | <dd> |
1423 | <p>Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via |
1433 | <p>Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via |
1424 | resources or on the command line.</p> |
1434 | resources or on the command line.</p> |
1425 | </dd> |
1435 | </dd> |
1426 | <dt><strong>COLORTERM</strong></dt> |
1436 | <dt><strong>COLORTERM</strong></dt> |
1427 | <dd> |
1437 | <dd> |
1428 | <p>Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on whether urxvt was |
1438 | <p>Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on whether rxvt was |
1429 | compiled with background image support, and optionally with the added |
1439 | compiled with background image support, and optionally with the added |
1430 | extension <code>-mono</code> to indicate that rxvt-unicode runs on a monochrome |
1440 | extension <code>-mono</code> to indicate that rxvt-unicode runs on a monochrome |
1431 | screen.</p> |
1441 | screen.</p> |
1432 | </dd> |
1442 | </dd> |
1433 | <dt><strong>COLORFGBG</strong></dt> |
1443 | <dt><strong>COLORFGBG</strong></dt> |
1434 | <dd> |
1444 | <dd> |
1435 | <p>Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is |
1445 | <p>Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is |
1436 | the colour code used as default foreground/text colour (or the string |
1446 | the colour code used as default foreground/text colour (or the string |
1437 | <code>default</code> to indicate that the default-colour escape sequence is to be |
1447 | <code>default</code> to indicate that the default-colour escape sequence is to be |
1438 | used), <code>bg</code> is the colour code used as default background colour (or the |
1448 | used), <code>bg</code> is the colour code used as default background colour (or the |
1439 | string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if urxvt |
1449 | string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt |
1440 | was compiled with background image support. Libraries like <code>ncurses</code> |
1450 | was compiled with background image support. Libraries like <code>ncurses</code> |
1441 | and <code>slang</code> can (and do) use this information to optimize screen output.</p> |
1451 | and <code>slang</code> can (and do) use this information to optimize screen output.</p> |
1442 | </dd> |
1452 | </dd> |
1443 | <dt><strong>WINDOWID</strong></dt> |
1453 | <dt><strong>WINDOWID</strong></dt> |
1444 | <dd> |
1454 | <dd> |
1445 | <p>Set to the (decimal) X Window ID of the urxvt window (the toplevel |
1455 | <p>Set to the (decimal) X Window ID of the rxvt window (the toplevel |
1446 | window, which usually has subwindows for the scrollbar, the terminal |
1456 | window, which usually has subwindows for the scrollbar, the terminal |
1447 | window and so on).</p> |
1457 | window and so on).</p> |
1448 | </dd> |
1458 | </dd> |
1449 | <dt><strong>TERMINFO</strong></dt> |
1459 | <dt><strong>TERMINFO</strong></dt> |
1450 | <dd> |
1460 | <dd> |
1451 | <p>Set to the terminfo directory iff urxvt was configured with |
1461 | <p>Set to the terminfo directory iff rxvt was configured with |
1452 | <code>--with-terminfo=PATH</code>.</p> |
1462 | <code>--with-terminfo=PATH</code>.</p> |
1453 | </dd> |
1463 | </dd> |
1454 | <dt><strong>DISPLAY</strong></dt> |
1464 | <dt><strong>DISPLAY</strong></dt> |
1455 | <dd> |
1465 | <dd> |
1456 | <p>Used by urxvt to connect to the display and set to the correct |
1466 | <p>Used by rxvt to connect to the display and set to the correct |
1457 | display in its child processes.</p> |
1467 | display in its child processes.</p> |
1458 | </dd> |
1468 | </dd> |
1459 | <dt><strong>SHELL</strong></dt> |
1469 | <dt><strong>SHELL</strong></dt> |
1460 | <dd> |
1470 | <dd> |
1461 | <p>The shell to be used for command execution, defaults to <code>/bin/sh</code>.</p> |
1471 | <p>The shell to be used for command execution, defaults to <code>/bin/sh</code>.</p> |
1462 | </dd> |
1472 | </dd> |
1463 | <dt><strong>RXVT_SOCKET</strong></dt> |
1473 | <dt><strong>RXVT_SOCKET</strong></dt> |
1464 | <dd> |
1474 | <dd> |
1465 | <p>The unix domain socket path used by urxvtc(1) and |
1475 | <p>The unix domain socket path used by rxvtc(1) and |
1466 | urxvtd(1).</p> |
1476 | rxvtd(1).</p> |
1467 | <p>Default <cite>$HOME/.rxvt-unicode-<i><nodename</i></cite>.</p> |
1477 | <p>Default <cite>$HOME/.rxvt-unicode-<i><nodename</i></cite>.</p> |
1468 | </dd> |
1478 | </dd> |
1469 | <dt><strong>HOME</strong></dt> |
1479 | <dt><strong>HOME</strong></dt> |
1470 | <dd> |
1480 | <dd> |
1471 | <p>Used to locate the default directory for the unix domain socket for |
1481 | <p>Used to locate the default directory for the unix domain socket for |
… | |
… | |
1477 | <p>Directory where various X resource files are being located.</p> |
1487 | <p>Directory where various X resource files are being located.</p> |
1478 | </dd> |
1488 | </dd> |
1479 | <dt><strong>XENVIRONMENT</strong></dt> |
1489 | <dt><strong>XENVIRONMENT</strong></dt> |
1480 | <dd> |
1490 | <dd> |
1481 | <p>If set and accessible, gives the name of a X resource file to be loaded by |
1491 | <p>If set and accessible, gives the name of a X resource file to be loaded by |
1482 | urxvt.</p> |
1492 | rxvt.</p> |
1483 | </dd> |
1493 | </dd> |
1484 | </dl> |
1494 | </dl> |
1485 | |
1495 | |
1486 | </div> |
1496 | </div> |
1487 | <h1 id="FILES">FILES</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1497 | <h1 id="FILES">FILES</h1><p><a href="#TOP" class="toplink">Top</a></p> |
… | |
… | |
1494 | </dl> |
1504 | </dl> |
1495 | |
1505 | |
1496 | </div> |
1506 | </div> |
1497 | <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1507 | <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1498 | <div id="SEE_ALSO_CONTENT"> |
1508 | <div id="SEE_ALSO_CONTENT"> |
1499 | <p>urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)</p> |
1509 | <p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)</p> |
1500 | |
1510 | |
1501 | </div> |
1511 | </div> |
1502 | <h1 id="CURRENT_PROJECT_COORDINATOR">CURRENT PROJECT COORDINATOR</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1512 | <h1 id="CURRENT_PROJECT_COORDINATOR">CURRENT PROJECT COORDINATOR</h1><p><a href="#TOP" class="toplink">Top</a></p> |
1503 | <div id="CURRENT_PROJECT_COORDINATOR_CONTENT"> |
1513 | <div id="CURRENT_PROJECT_COORDINATOR_CONTENT"> |
1504 | <dl> |
1514 | <dl> |