~ubuntu-branches/ubuntu/dapper/rxvt-unicode/dapper

« back to all changes in this revision

Viewing changes to doc/rxvt.7.html

  • Committer: Bazaar Package Importer
  • Author(s): Eduard Bloch
  • Date: 2006-01-16 16:51:28 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20060116165128-dmz1wi3x3e17gu43
Tags: 7.0-1
* New upstream release
  + autodetection of (incorrect) Latin1 in pure UTF-8 environment works
    again (closes: #347718)
* removed the font name preset, automatic selection works acceptably well

Show diffs side-by-side

added added

removed removed

Lines of Context:
75
75
<hr />
76
76
<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1>
77
77
<dl>
 
78
<dt><strong><a name="item_the_new_selection_selects_pieces_that_are_too_big_">The new selection selects pieces that are too big, how can I select
 
79
single words?</a></strong><br />
 
80
</dt>
 
81
<dd>
 
82
Yes. For example, if you want to select alphanumeric words, you can use
 
83
the following resource:
 
84
</dd>
 
85
<dd>
 
86
<pre>
 
87
   URxvt.selection.pattern-0: ([[:word:]]+)</pre>
 
88
</dd>
 
89
<dd>
 
90
<p>If you click more than twice, the selection will be extended
 
91
more and more.</p>
 
92
</dd>
 
93
<dd>
 
94
<p>To get a selection that is very similar to the old code, try this pattern:</p>
 
95
</dd>
 
96
<dd>
 
97
<pre>
 
98
   URxvt.selection.pattern-0: ([^&quot;&amp;'()*,;&lt;=&gt;?@[\\\\]^`{|})]+)</pre>
 
99
</dd>
 
100
<dd>
 
101
<p>Please also note that the <em>LeftClick Shift-LeftClik</em> combination also
 
102
selects words like the old code.</p>
 
103
</dd>
 
104
<p></p>
 
105
<dt><strong><a name="item_i_don_27t_like_the_new_selection_2fpopups_2fhotkey">I don't like the new selection/popups/hotkeys/perl, how do I
 
106
change/disable it?</a></strong><br />
 
107
</dt>
 
108
<dd>
 
109
You can disable the perl extension completely by setting the
 
110
<strong>perl-ext-common</strong> resource to the empty string, which also keeps
 
111
rxvt-unicode from initialising perl, saving memory.
 
112
</dd>
 
113
<dd>
 
114
<p>If you only want to disable specific features, you first have to
 
115
identify which perl extension is responsible. For this, read the section
 
116
<strong>PREPACKAGED EXTENSIONS</strong> in the <code>urxvtperl(3)</code> manpage. For
 
117
example, to disable the <strong>selection-popup</strong> and <strong>option-popup</strong>, specify
 
118
this <strong>perl-ext-common</strong> resource:</p>
 
119
</dd>
 
120
<dd>
 
121
<pre>
 
122
   URxvt.perl-ext-common: default,-selection-popup,-option-popup</pre>
 
123
</dd>
 
124
<dd>
 
125
<p>This will keep the default extensions, but disable the two popup
 
126
extensions. Some extensions can also be configured, for example,
 
127
scrollback search mode is triggered by <strong>M-s</strong>. You can move it to any
 
128
other combination either by setting the <strong>searchable-scrollback</strong> resource:</p>
 
129
</dd>
 
130
<dd>
 
131
<pre>
 
132
   URxvt.searchable-scrollback: CM-s</pre>
 
133
</dd>
 
134
<p></p>
78
135
<dt><strong><a name="item_isn_27t_rxvt_supposed_to_be_small_3f_don_27t_all_t">Isn't rxvt supposed to be small? Don't all those features bloat?</a></strong><br />
79
136
</dt>
80
137
<dd>
122
179
<p>Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
123
180
still fares rather well. And compared to some monsters like gnome-terminal
124
181
(21152k + extra 4204k in separate processes) or konsole (22200k + extra
125
 
43180k in daemons that stay around after exit, plus half aminute of
 
182
43180k in daemons that stay around after exit, plus half a minute of
126
183
startup time, including the hundreds of warnings it spits out), it fares
127
184
extremely well *g*.</p>
128
185
</dd>
187
244
<dd>
188
245
The version number is displayed with the usage (-h). Also the escape
189
246
sequence <code>ESC [ 8 n</code> sets the window title to the version number. When
190
 
using the rxvtc client, the version displayed is that of the
 
247
using the urxvtc client, the version displayed is that of the
191
248
daemon.
192
249
</dd>
193
250
<p></p>
210
267
might encounter the same issue.</p>
211
268
</dd>
212
269
<p></p>
 
270
<dt><strong><a name="item_i_am_maintaining_rxvt_2dunicode_for_distribution_2">I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?</a></strong><br />
 
271
</dt>
 
272
<dd>
 
273
You should build one binary with the default options. <em>configure</em>
 
274
now enables most useful options, and the trend goes to making them
 
275
runtime-switchable, too, so there is usually no drawback to enbaling them,
 
276
except higher disk and possibly memory usage. The perl interpreter should
 
277
be enabled, as important functionality (menus, selection, likely more in
 
278
the future) depends on it.
 
279
</dd>
 
280
<dd>
 
281
<p>You should not overwrite the <code>perl-ext-common</code> snd <code>perl-ext</code> resources
 
282
system-wide (except maybe with <code>defaults</code>). This will result in useful
 
283
behaviour. If your distribution aims at low memory, add an empty
 
284
<code>perl-ext-common</code> resource to the app-defaults file. This will keep the
 
285
perl interpreter disabled until the user enables it.</p>
 
286
</dd>
 
287
<dd>
 
288
<p>If you can/want build more binaries, I recommend building a minimal
 
289
one with <code>--disable-everything</code> (very useful) and a maximal one with
 
290
<a href="#item__2d_2denable_2deverything"><code>--enable-everything</code></a> (less useful, it will be very big due to a lot of
 
291
encodings built-in that increase download times and are rarely used).</p>
 
292
</dd>
 
293
<p></p>
 
294
<dt><strong><a name="item_i_need_to_make_it_setuid_2fsetgid_to_support_utmp_">I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?</a></strong><br />
 
295
</dt>
 
296
<dd>
 
297
Likely not. While I honestly try to make it secure, and am probably not
 
298
bad at it, I think it is simply unreasonable to expect all of freetype
 
299
+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
 
300
secure. Also, rxvt-unicode disables some options when it detects that it
 
301
runs setuid or setgid, which is not nice. Besides, with the embedded perl
 
302
interpreter the possibility for security problems easily multiplies.
 
303
</dd>
 
304
<dd>
 
305
<p>Elevated privileges are only required for utmp and pty operations on some
 
306
systems (for example, GNU/Linux doesn't need any extra privileges for
 
307
ptys, but some need it for utmp support). It is planned to mvoe this into
 
308
a forked handler process, but this is not yet done.</p>
 
309
</dd>
 
310
<dd>
 
311
<p>So, while setuid/setgid operation is supported and not a problem on your
 
312
typical single-user-no-other-logins unix desktop, always remember that
 
313
its an awful lot of code, most of which isn't checked for security issues
 
314
regularly.</p>
 
315
</dd>
 
316
<p></p>
213
317
<dt><strong><a name="item_when_i_log_2din_to_another_system_it_tells_me_abou">When I log-in to another system it tells me about missing terminfo data?</a></strong><br />
214
318
</dt>
215
319
<dd>
256
360
<code>enacs=\E[0@</code> and try again.
257
361
</dd>
258
362
<p></p>
259
 
<dt><strong><a name="item_bash_27s_readline_does_not_work_correctly_under_rx"><code>bash</code>'s readline does not work correctly under rxvt.</a></strong><br />
 
363
<dt><strong><a name="item_bash_27s_readline_does_not_work_correctly_under_ur"><code>bash</code>'s readline does not work correctly under urxvt.</a></strong><br />
260
364
</dt>
261
365
<dt><strong><a name="item_i_need_a_termcap_file_entry_2e">I need a termcap file entry.</a></strong><br />
262
366
</dt>
420
524
</dd>
421
525
<dd>
422
526
<pre>
423
 
   rxvt -fn basefont,font2,font3...</pre>
 
527
   urxvt -fn basefont,font2,font3...</pre>
424
528
</dd>
425
529
<dd>
426
530
<p>When rxvt-unicode sees a character, it will first look at the base
804
908
some editors prematurely may leave the mouse in mouse report mode. I've
805
909
heard that tcsh may use mouse reporting unless it otherwise specified. A
806
910
quick check is to see if cut/paste works when the Alt or Shift keys are
807
 
depressed. See <code>rxvt(7)</code>
 
911
depressed.
808
912
</dd>
809
913
<p></p>
810
914
<dt><strong><a name="item_what_27s_with_this_bold_2fblink_stuff_3f">What's with this bold/blink stuff?</a></strong><br />
888
992
   URxvt.color15:      #e1dddd</pre>
889
993
</dd>
890
994
<p></p>
891
 
<dt><strong><a name="item_how_can_i_start_rxvtd_in_a_race_2dfree_way_3f">How can I start rxvtd in a race-free way?</a></strong><br />
 
995
<dt><strong><a name="item_how_can_i_start_urxvtd_in_a_race_2dfree_way_3f">How can I start urxvtd in a race-free way?</a></strong><br />
892
996
</dt>
893
997
<dd>
894
 
Try <code>rxvtd -f -o</code>, which tells rxvtd to open the
 
998
Try <code>urxvtd -f -o</code>, which tells urxvtd to open the
895
999
display, create the listening socket and then fork.
896
1000
</dd>
897
1001
<p></p>
922
1026
<pre>
923
1027
   # use Backspace = ^H
924
1028
   $ stty erase ^H
925
 
   $ rxvt</pre>
 
1029
   $ urxvt</pre>
926
1030
</dd>
927
1031
<dd>
928
1032
<pre>
929
1033
   # use Backspace = ^?
930
1034
   $ stty erase ^?
931
 
   $ rxvt</pre>
 
1035
   $ urxvt</pre>
932
1036
</dd>
933
1037
<dd>
934
 
<p>Toggle with <code>ESC [ 36 h</code> / <code>ESC [ 36 l</code> as documented in rxvt(7).</p>
 
1038
<p>Toggle with <code>ESC [ 36 h</code> / <code>ESC [ 36 l</code>.</p>
935
1039
</dd>
936
1040
<dd>
937
1041
<p>For an existing rxvt-unicode:</p>
979
1083
use the `keysym' resource to alter the keystrings associated with keysyms.
980
1084
</dd>
981
1085
<dd>
982
 
<p>Here's an example for a URxvt session started using <code>rxvt -name URxvt</code></p>
 
1086
<p>Here's an example for a URxvt session started using <code>urxvt -name URxvt</code></p>
983
1087
</dd>
984
1088
<dd>
985
1089
<pre>
1861
1965
<tr><td>Ps = 12</td><td>Change colour of text cursor foreground to Pt</td></tr>
1862
1966
<tr><td>Ps = 13</td><td>Change colour of mouse foreground to Pt</td></tr>
1863
1967
<tr><td>Ps = 17</td><td>Change colour of highlight characters to Pt</td></tr>
1864
 
<tr><td>Ps = 18</td><td>Change colour of bold characters to Pt</td></tr>
1865
 
<tr><td>Ps = 19</td><td>Change colour of underlined characters to Pt</td></tr>
 
1968
<tr><td>Ps = 18</td><td>Change colour of bold characters to Pt [deprecated, see 706]</td></tr>
 
1969
<tr><td>Ps = 19</td><td>Change colour of underlined characters to Pt [deprecated, see 707]</td></tr>
1866
1970
<tr><td>Ps = 20</td><td>Change default background to Pt</td></tr>
1867
1971
<tr><td>Ps = 39</td><td>Change default foreground colour to Pt.</td></tr>
1868
1972
<tr><td>Ps = 46</td><td>Change Log File to Pt unimplemented</td></tr>
1873
1977
<tr><td>Ps = 703</td><td>Menubar command Pt (Compile menubar).</td></tr>
1874
1978
<tr><td>Ps = 704</td><td>Change colour of italic characters to Pt</td></tr>
1875
1979
<tr><td>Ps = 705</td><td>Change background pixmap tint colour to Pt (Compile transparency).</td></tr>
 
1980
<tr><td>Ps = 706</td><td>Change colour of bold characters to Pt</td></tr>
 
1981
<tr><td>Ps = 707</td><td>Change colour of underlined characters to Pt</td></tr>
1876
1982
<tr><td>Ps = 710</td><td>Set normal fontset to Pt. Same as Ps = 50.</td></tr>
1877
1983
<tr><td>Ps = 711</td><td>Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr>
1878
1984
<tr><td>Ps = 712</td><td>Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr>
2799
2905
--enable-utmp to also be specified.
2800
2906
</dd>
2801
2907
<p></p>
2802
 
<dt><strong><a name="item_background">--enable-xpm-background (default: off)</a></strong><br />
 
2908
<dt><strong><a name="item_background">--enable-xpm-background (default: on)</a></strong><br />
2803
2909
</dt>
2804
2910
<dd>
2805
2911
Add support for XPM background pixmaps.
2806
2912
</dd>
2807
2913
<p></p>
2808
 
<dt><strong><a name="item_transparency">--enable-transparency (default: off)</a></strong><br />
 
2914
<dt><strong><a name="item_transparency">--enable-transparency (default: on)</a></strong><br />
2809
2915
</dt>
2810
2916
<dd>
2811
2917
Add support for inheriting parent backgrounds thus giving a fake
2824
2930
Add support for tinting of transparent backgrounds (requires <code>--enable-transparency</code>).
2825
2931
</dd>
2826
2932
<p></p>
2827
 
<dt><strong><a name="item_menubar">--enable-menubar (default: off)</a></strong><br />
 
2933
<dt><strong><a name="item_menubar">--enable-menubar (default: off) [DEPRECATED]</a></strong><br />
2828
2934
</dt>
2829
2935
<dd>
2830
 
Add support for our menu bar system (this interacts badly with
2831
 
dynamic locale switching currently).
 
2936
Add support for our menu bar system (this interacts badly with dynamic
 
2937
locale switching currently). This option is DEPRECATED and will be removed
 
2938
in the future.
2832
2939
</dd>
2833
2940
<p></p>
2834
2941
<dt><strong><a name="item_scroll">--enable-rxvt-scroll (default: on)</a></strong><br />
2890
2997
Removes any support for resource checking.
2891
2998
</dd>
2892
2999
<p></p>
2893
 
<dt><strong><a name="item__2d_2denable_2dxgetdefault">--enable-xgetdefault</a></strong><br />
2894
 
</dt>
2895
 
<dd>
2896
 
Make resources checking via <code>XGetDefault()</code> instead of our small
2897
 
version which only checks ~/.Xdefaults, or if that doesn't exist then
2898
 
~/.Xresources.
2899
 
</dd>
2900
 
<dd>
2901
 
<p>Please note that nowadays, things like XIM will automatically pull in and
2902
 
use the full X resource manager, so the overhead of using it might be very
2903
 
small, if nonexistant.</p>
2904
 
</dd>
2905
 
<p></p>
2906
3000
<dt><strong><a name="item_strings">--enable-strings (default: off)</a></strong><br />
2907
3001
</dt>
2908
3002
<dd>
2954
3048
<dt><strong><a name="item_iso14755">--enable-iso14755 (default: on)</a></strong><br />
2955
3049
</dt>
2956
3050
<dd>
2957
 
Enable extended ISO 14755 support (see rxvt(1), or
 
3051
Enable extended ISO 14755 support (see urxvt(1), or
2958
3052
<em>doc/rxvt.1.txt</em>). Basic support (section 5.1) is enabled by
2959
3053
<code>--enable-frills</code>, while support for 5.2, 5.3 and 5.4 is enabled with
2960
3054
this switch.
3024
3118
<dt><strong><a name="item_perl">--enable-perl (default: off)</a></strong><br />
3025
3119
</dt>
3026
3120
<dd>
3027
 
Enable an embedded perl interpreter. See the <strong>rxvtperl(3)</strong>
 
3121
Enable an embedded perl interpreter. See the <strong>urxvtperl(3)</strong>
3028
3122
manpage (<em>doc/rxvtperl.txt</em>) for more info on this feature, or the files
3029
3123
in <em>src/perl-ext/</em> for the extensions that are installed by default. The
3030
3124
perl interpreter that is used can be specified via the <code>PERL</code> environment