-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathrxvt.htm
More file actions
2609 lines (1953 loc) · 91.2 KB
/
rxvt.htm
File metadata and controls
2609 lines (1953 loc) · 91.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!-- Creator : groff version 1.22.4 -->
<!-- CreationDate: Fri Aug 16 20:36:43 2019 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title>urxvt</title>
<!-- Bronto custom css --> <style type="text/css"> p { margin-top: 0; margin-bottom: 0; vertical-align: top; font-family: 'Noto Serif', serif; font-size: large } a { font-family: 'Noto Sans', serif; font-size: large } pre { margin-top: 0; margin-bottom: 0; vertical-align: top; font-size: large } table { margin-top: 0; margin-bottom: 0; vertical-align: top } h1 { text-align: center; font-family: 'Noto Serif', serif; font-size: xx-large } h2 { font-family: 'Noto Sans', sans; } hr { border-top: 1px solid black; visibility: hidden; } a:link { text-decoration: none; } a:visited { text-decoration: none; } a:hover { text-decoration: underline; } a:active { text-decoration: underline; } body { background-color: #F5F5F5; color: #111111; line-height: 1.6; } </style> </head>
<body>
<h1 align="center">urxvt</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#FREQUENTLY ASKED QUESTIONS">FREQUENTLY ASKED QUESTIONS</a><br>
<a href="#RXVT-UNICODE VS. RXVT">RXVT-UNICODE VS. RXVT</a><br>
<a href="#OPTIONS">OPTIONS</a><br>
<a href="#RESOURCES">RESOURCES</a><br>
<a href="#BACKGROUND IMAGE OPTIONS AND RESOURCES">BACKGROUND IMAGE OPTIONS AND RESOURCES</a><br>
<a href="#THE SCROLLBAR">THE SCROLLBAR</a><br>
<a href="#MOUSE REPORTING">MOUSE REPORTING</a><br>
<a href="#THE SELECTION: SELECTING AND PASTING TEXT">THE SELECTION: SELECTING AND PASTING TEXT</a><br>
<a href="#CHANGING FONTS">CHANGING FONTS</a><br>
<a href="#ISO 14755 SUPPORT">ISO 14755 SUPPORT</a><br>
<a href="#LOGIN STAMP">LOGIN STAMP</a><br>
<a href="#COLOURS AND GRAPHICS">COLOURS AND GRAPHICS</a><br>
<a href="#ENVIRONMENT">ENVIRONMENT</a><br>
<a href="#FILES">FILES</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<a href="#CURRENT PROJECT COORDINATOR">CURRENT PROJECT COORDINATOR</a><br>
<a href="#AUTHORS">AUTHORS</a><br>
<hr>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">rxvt-unicode -
(ouR XVT, unicode), a VT102 emulator for the X window
system</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>urxvt</b>
[options] [-e command [ args ]]</p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>rxvt-unicode</b>,
version <b>9.22</b>, is a colour vt102 terminal emulator
intended as an <i>xterm</i>(1) replacement for users who do
not require features such as Tektronix 4014 emulation and
toolkit-style configurability. As a result,
<b>rxvt-unicode</b> uses much less swap space -- a
significant advantage on a machine serving many X
sessions.</p>
<p style="margin-left:11%; margin-top: 1em">This document
is also available on the World-Wide-Web at
<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.</p>
<h2>FREQUENTLY ASKED QUESTIONS
<a name="FREQUENTLY ASKED QUESTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">See urxvt(7)
(try "man 7 urxvt") for a list of frequently asked
questions and answer to them and some common problems. That
document is also accessible on the World-Wide-Web at
<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.</p>
<h2>RXVT-UNICODE VS. RXVT
<a name="RXVT-UNICODE VS. RXVT"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Unlike the
original rxvt, <b>rxvt-unicode</b> stores all text in
Unicode internally. That means it can store and display most
scripts in the world. Being a terminal emulator, however,
some things are very difficult, especially cursive scripts
such as arabic, vertically written scripts like mongolian or
scripts requiring extremely complex combining rules, like
tibetan or devanagari. Don’t expect pretty output when
using these scripts. Most other scripts, latin, cyrillic,
kanji, thai etc. should work fine, though. A somewhat
difficult case are right-to-left scripts, such as hebrew:
<b>rxvt-unicode</b> adopts the view that bidirectional
algorithms belong in the application, not the terminal
emulator (too many things -- such as cursor-movement while
editing -- break otherwise), but that might change.</p>
<p style="margin-left:11%; margin-top: 1em">If you are
looking for a terminal that supports more exotic scripts,
let me recommend "mlterm", which is a very user
friendly, lean and clean terminal emulator. In fact, the
reason rxvt-unicode was born was solely because the author
couldn’t get "mlterm" to use one font for
latin1 and another for japanese.</p>
<p style="margin-left:11%; margin-top: 1em">Therefore
another design rationale was the use of multiple fonts to
display characters: The idea of a single unicode font which
many other programs force onto its users never made sense to
me: You should be able to choose any font for any script
freely.</p>
<p style="margin-left:11%; margin-top: 1em">Apart from
that, rxvt-unicode is also much better internationalised
than its predecessor, supports things such as
<small>XFT</small> and <small>ISO 14755</small> that are
handy in i18n-environments, is faster, and has a lot bugs
less than the original rxvt. This all in addition to dozens
of other small improvements.</p>
<p style="margin-left:11%; margin-top: 1em">It is still
faithfully following the original rxvt idea of being lean
and nice on resources: for example, you can still configure
rxvt-unicode without most of its features to get a lean
binary. It also comes with a client/daemon pair that lets
you open any number of terminal windows from within a single
process, which makes startup time very fast and drastically
reduces memory usage. See urxvtd(1) (daemon) and urxvtc(1)
(client).</p>
<p style="margin-left:11%; margin-top: 1em">It also makes
technical information about escape sequences (which have
been extended) more accessible: see urxvt(7) for technical
reference documentation (escape sequences etc.).</p>
<h2>OPTIONS
<a name="OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">The
<b>urxvt</b> options (mostly a subset of
<i>xterm</i>’s) are listed below. In keeping with the
smaller-is-better philosophy, options may be eliminated or
default values chosen at compile-time, so options and
defaults listed may not accurately reflect the version
installed on your system. ’urxvt -h’ gives a
list of major compile-time options on the <i>Options</i>
line. Option descriptions may be prefixed with which compile
option each is dependent upon. e.g. ’Compile
<i><small>XIM</small></i> :’ requires
<i><small>XIM</small></i> on the <i>Options</i> line. Note:
’urxvt -help’ gives a list of all command-line
options compiled into your version.</p>
<p style="margin-left:11%; margin-top: 1em">Note that
<b>urxvt</b> permits the resource name to be used as a
long-option (--/++ option) so the potential command-line
options are far greater than those listed. For example:
’urxvt --loginShell --color1 Orange’.</p>
<p style="margin-left:11%; margin-top: 1em">The following
options are available: <b><br>
-help</b>, <b>--help</b></p>
<p style="margin-left:17%;">Print out a message describing
available options.</p>
<p style="margin-left:11%;"><b>-display</b>
<i>displayname</i></p>
<p style="margin-left:17%;">Attempt to open a window on the
named X display (the older form <b>-d</b> is still
respected. but deprecated). In the absence of this option,
the display specified by the <b><small>DISPLAY</small></b>
environment variable is used.</p>
<p style="margin-left:11%;"><b>-depth</b>
<i>bitdepth</i></p>
<p style="margin-left:17%;">Compile <i>frills</i>: Attempt
to find a visual with the given bit depth; resource
<b>depth</b>.</p>
<p style="margin-left:17%; margin-top: 1em">[Please note
that many X servers (and libXft) are buggy with respect to
"-depth 32" and/or alpha channels, and will cause
all sorts of graphical corruption. This is harmless, but we
can’t do anything about this, so watch out]</p>
<p style="margin-left:11%;"><b>-visual</b>
<i>visualID</i></p>
<p style="margin-left:17%;">Compile <i>frills</i>: Use the
given visual (see e.g. "xdpyinfo" for possible
visual ids) instead of the default, and also allocate a
private colormap. All visual types except for DirectColor
are supported.</p>
<p style="margin-left:11%;"><b>-geometry</b>
<i>geom</i></p>
<p style="margin-left:17%;">Window geometry (<b>-g</b>
still respected); resource <b>geometry</b>.</p>
<p style="margin-left:11%;"><b>-rv</b>|<b>+rv</b></p>
<p style="margin-left:17%;">Turn on/off simulated reverse
video; resource <b>reverseVideo</b>.</p>
<p style="margin-left:11%;"><b>-j</b>|<b>+j</b></p>
<p style="margin-left:17%;">Turn on/off jump scrolling
(allow multiple lines per refresh); resource
<b>jumpScroll</b>.</p>
<p style="margin-left:11%;"><b>-ss</b>|<b>+ss</b></p>
<p style="margin-left:17%;">Turn on/off skip scrolling
(allow multiple screens per refresh); resource
<b>skipScroll</b>.</p>
<p style="margin-left:11%;"><b>-fade</b> <i>number</i></p>
<p style="margin-left:17%;">Fade the text by the given
percentage when focus is lost. Small values fade a little
only, 100 completely replaces all colours by the fade
colour; resource <b>fading</b>.</p>
<p style="margin-left:11%;"><b>-fadecolor</b>
<i>colour</i></p>
<p style="margin-left:17%;">Fade to this colour when fading
is used (see <b>-fade</b>). The default colour is opaque
black. resource <b>fadeColor</b>.</p>
<p style="margin-left:11%;"><b>-icon</b> <i>file</i></p>
<p style="margin-left:17%;">Compile <i>pixbuf</i>: Use the
specified image as application icon. This is used by many
window managers, taskbars and pagers to represent the
application window; resource <i>iconFile</i>.</p>
<p style="margin-left:11%;"><b>-bg</b> <i>colour</i></p>
<p style="margin-left:17%;">Window background colour;
resource <b>background</b>.</p>
<p style="margin-left:11%;"><b>-fg</b> <i>colour</i></p>
<p style="margin-left:17%;">Window foreground colour;
resource <b>foreground</b>.</p>
<p style="margin-left:11%;"><b>-cr</b> <i>colour</i></p>
<p style="margin-left:17%;">The cursor colour; resource
<b>cursorColor</b>.</p>
<p style="margin-left:11%;"><b>-pr</b> <i>colour</i></p>
<p style="margin-left:17%;">The mouse pointer foreground
colour; resource <b>pointerColor</b>.</p>
<p style="margin-left:11%;"><b>-pr2</b> <i>colour</i></p>
<p style="margin-left:17%;">The mouse pointer background
colour; resource <b>pointerColor2</b>.</p>
<p style="margin-left:11%;"><b>-bd</b> <i>colour</i></p>
<p style="margin-left:17%;">The colour of the border around
the text area and between the scrollbar and the text;
resource <b>borderColor</b>.</p>
<p style="margin-left:11%;"><b>-fn</b> <i>fontlist</i></p>
<p style="margin-left:17%;">Select the fonts to be used.
This is a comma separated list of font names that are
checked in order when trying to find glyphs for characters.
The first font defines the cell size for characters; other
fonts might be smaller, but not (in general) larger. A
(hopefully) reasonable default font list is always appended
to it. See resource <b>font</b> for more details.</p>
<p style="margin-left:17%; margin-top: 1em">In short, to
specify an X11 core font, just specify its name or prefix it
with "x:". To specify an XFT-font, you need to
prefix it with "xft:", e.g.:</p>
<p style="margin-left:17%; margin-top: 1em">urxvt -fn
"xft:Bitstream Vera Sans Mono:pixelsize=15" <br>
urxvt -fn "9x15bold,xft:Bitstream Vera Sans
Mono"</p>
<p style="margin-left:17%; margin-top: 1em">See also the
question "How does rxvt-unicode choose fonts?" in
the <small>FAQ</small> section of urxvt(7).</p>
<p style="margin-left:11%;"><b>-fb</b> <i>fontlist</i></p>
<p style="margin-left:17%;">Compile <i>font-styles</i>: The
bold font list to use when <b>bold</b> characters are to be
printed. See resource <b>boldFont</b> for details.</p>
<p style="margin-left:11%;"><b>-fi</b> <i>fontlist</i></p>
<p style="margin-left:17%;">Compile <i>font-styles</i>: The
italic font list to use when <i>italic</i> characters are to
be printed. See resource <b>italicFont</b> for details.</p>
<p style="margin-left:11%;"><b>-fbi</b> <i>fontlist</i></p>
<p style="margin-left:17%;">Compile <i>font-styles</i>: The
bold italic font list to use when <b><i>bold italic</i></b>
characters are to be printed. See resource
<b>boldItalicFont</b> for details.</p>
<p style="margin-left:11%;"><b>-is</b>|<b>+is</b></p>
<p style="margin-left:17%;">Compile <i>font-styles</i>:
Bold/Blink font styles imply high intensity
foreground/background (default). See resource
<b>intensityStyles</b> for details.</p>
<p style="margin-left:11%;"><b>-name</b> <i>name</i></p>
<p style="margin-left:17%;">Specify the application name
under which resources are to be obtained, rather than the
default executable file name. Name should not contain
’.’ or ’*’ characters. Also sets the
icon and title name.</p>
<p style="margin-left:11%;"><b>-ls</b>|<b>+ls</b></p>
<p style="margin-left:17%;">Start as a
login-shell/sub-shell; resource <b>loginShell</b>.</p>
<p style="margin-left:11%;"><b>-mc</b>
<i>milliseconds</i></p>
<p style="margin-left:17%;">Specify the maximum time
between multi-click selections.</p>
<p style="margin-left:11%;"><b>-ut</b>|<b>+ut</b></p>
<p style="margin-left:17%;">Compile <i>utmp</i>:
Inhibit/enable writing a utmp entry; resource
<b>utmpInhibit</b>.</p>
<p style="margin-left:11%;"><b>-vb</b>|<b>+vb</b></p>
<p style="margin-left:17%;">Turn on/off visual bell on
receipt of a bell character; resource <b>visualBell</b>.</p>
<p style="margin-left:11%;"><b>-sb</b>|<b>+sb</b></p>
<p style="margin-left:17%;">Turn on/off scrollbar; resource
<b>scrollBar</b>.</p>
<p style="margin-left:11%;"><b>-sr</b>|<b>+sr</b></p>
<p style="margin-left:17%;">Put scrollbar on right/left;
resource <b>scrollBar_right</b>.</p>
<p style="margin-left:11%;"><b>-st</b>|<b>+st</b></p>
<p style="margin-left:17%;">Display rxvt (non XTerm/NeXT)
scrollbar without/with a trough; resource
<b>scrollBar_floating</b>.</p>
<p style="margin-left:11%;"><b>-si</b>|<b>+si</b></p>
<p style="margin-left:17%;">Turn on/off scroll-to-bottom on
<small>TTY</small> output inhibit; resource
<b>scrollTtyOutput</b> has opposite effect.</p>
<p style="margin-left:11%;"><b>-sk</b>|<b>+sk</b></p>
<p style="margin-left:17%;">Turn on/off scroll-to-bottom on
keypress; resource <b>scrollTtyKeypress</b>.</p>
<p style="margin-left:11%;"><b>-sw</b>|<b>+sw</b></p>
<p style="margin-left:17%;">Turn on/off scrolling with the
scrollback buffer as new lines appear. This only takes
effect if <b>-si</b> is also given; resource
<b>scrollWithBuffer</b>.</p>
<p style="margin-left:11%;"><b>-ptab</b>|<b>+ptab</b></p>
<p style="margin-left:17%;">If enabled (default),
"Horizontal Tab" characters are being stored as
actual wide characters in the screen buffer, which makes it
possible to select and paste them. Since a horizontal tab is
a cursor movement and not an actual glyph, this can
sometimes be visually annoying as the cursor on a tab
character is displayed as a wide cursor; resource
<b>pastableTabs</b>.</p>
<p style="margin-left:11%;"><b>-bc</b>|<b>+bc</b></p>
<p style="margin-left:17%;">Blink the cursor; resource
<b>cursorBlink</b>.</p>
<p style="margin-left:11%;"><b>-uc</b>|<b>+uc</b></p>
<p style="margin-left:17%;">Make the cursor underlined;
resource <b>cursorUnderline</b>.</p>
<p style="margin-left:11%;"><b>-iconic</b></p>
<p style="margin-left:17%;">Start iconified, if the window
manager supports that option. Alternative form is
<b>-ic</b>.</p>
<p style="margin-left:11%;"><b>-sl</b> <i>number</i></p>
<p style="margin-left:17%;">Save <i>number</i> lines in the
scrollback buffer. See resource entry for limits; resource
<b>saveLines</b>.</p>
<p style="margin-left:11%;"><b>-b</b> <i>number</i></p>
<p style="margin-left:17%;">Compile <i>frills</i>: Internal
border of <i>number</i> pixels. See resource entry for
limits; resource <b>internalBorder</b>.</p>
<p style="margin-left:11%;"><b>-w</b> <i>number</i></p>
<p style="margin-left:17%;">Compile <i>frills</i>: External
border of <i>number</i> pixels. Also, <b>-bw</b> and
<b>-borderwidth</b>. See resource entry for limits; resource
<b>externalBorder</b>.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p><b>-bl</b></p></td>
<td width="2%"></td>
<td width="83%">
<p>Compile <i>frills</i>: Set <small>MWM</small> hints to
request a borderless window, i.e. if honoured by the
<small>WM,</small> the rxvt-unicode window will not have
window decorations; resource <b>borderLess</b>. If the
window manager does not support <small>MWM</small> hints
(e.g. kwin), enables override-redirect mode.</p></td></tr>
</table>
<p style="margin-left:11%;"><b>-override-redirect</b></p>
<p style="margin-left:17%;">Compile <i>frills</i>: Sets
override-redirect on the window; resource
<b>override-redirect</b>.</p>
<p style="margin-left:11%;"><b>-dockapp</b></p>
<p style="margin-left:17%;">Sets the initial state of the
window to WithdrawnState, which makes window managers that
support this extension treat it as a dockapp.</p>
<p style="margin-left:11%;"><b>-sbg</b></p>
<p style="margin-left:17%;">Compile <i>frills</i>: Disable
the usage of the built-in block graphics/line drawing
characters and just rely on what the specified fonts
provide. Use this if you have a good font and want to use
its block graphic glyphs; resource
<b>skipBuiltinGlyphs</b>.</p>
<p style="margin-left:11%;"><b>-lsp</b> <i>number</i></p>
<p style="margin-left:17%;">Compile <i>frills</i>: Lines
(pixel height) to insert between each row of the display.
Useful to work around font rendering problems; resource
<b>lineSpace</b>.</p>
<p style="margin-left:11%;"><b>-letsp</b> <i>number</i></p>
<p style="margin-left:17%;">Compile <i>frills</i>: Amount
to adjust the computed character width by to control overall
letter spacing. Negative values will tighten up the letter
spacing, positive values will space letters out more. Useful
to work around odd font metrics; resource
<b>letterSpace</b>.</p>
<p style="margin-left:11%;"><b>-tn</b> <i>termname</i></p>
<p style="margin-left:17%;">This option specifies the name
of the terminal type to be set in the
<b><small>TERM</small></b> environment variable. This
terminal type must exist in the
<b><i>termcap</i></b><i>(5)</i> database and should have
<i>li#</i> and <i>co#</i> entries; resource
<b>termName</b>.</p>
<p style="margin-left:11%;"><b>-e</b> <i>command
[arguments]</i></p>
<p style="margin-left:17%;">Run the command with its
command-line arguments in the <b>urxvt</b> window; also sets
the window title and icon name to be the basename of the
program being executed if neither <i>-title</i> (<i>-T</i>)
nor <i>-n</i> are given on the command line. If this option
is used, it must be the last on the command-line. If there
is no <b>-e</b> option then the default is to run the
program specified by the <b><small>SHELL</small></b>
environment variable or, failing that,
<b><i>sh</i></b><i>(1)</i>.</p>
<p style="margin-left:17%; margin-top: 1em">Please note
that you must specify a program with arguments. If you want
to run shell commands, you have to specify the shell, like
this:</p>
<p style="margin-left:17%; margin-top: 1em">urxvt -e sh -c
"shell commands"</p>
<p style="margin-left:11%;"><b>-title</b> <i>text</i></p>
<p style="margin-left:17%;">Window title (<b>-T</b> still
respected); the default title is the basename of the program
specified after the <b>-e</b> option, if any, otherwise the
application name; resource <b>title</b>.</p>
<p style="margin-left:11%;"><b>-n</b> <i>text</i></p>
<p style="margin-left:17%;">Icon name; the default name is
the basename of the program specified after the <b>-e</b>
option, if any, otherwise the application name; resource
<b>iconName</b>.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p><b>-C</b></p></td>
<td width="3%"></td>
<td width="49%">
<p>Capture system console messages.</p></td>
<td width="34%">
</td></tr>
</table>
<p style="margin-left:11%;"><b>-pt</b> <i>style</i></p>
<p style="margin-left:17%;">Compile
<i><small>XIM</small></i> : input style for input method;
<b>OverTheSpot</b>, <b>OffTheSpot</b>, <b>Root</b>; resource
<b>preeditType</b>.</p>
<p style="margin-left:17%; margin-top: 1em">If the perl
extension "xim-onthespot" is used (which is the
default), then additionally the "OnTheSpot"
preedit type is available.</p>
<p style="margin-left:11%;"><b>-im</b> <i>text</i></p>
<p style="margin-left:17%;">Compile
<i><small>XIM</small></i> : input method name. resource
<b>inputMethod</b>.</p>
<p style="margin-left:11%;"><b>-imlocale</b>
<i>string</i></p>
<p style="margin-left:17%;">The locale to use for opening
the <small>IM.</small> You can use an "LC_CTYPE"
of e.g. "de_DE.UTF-8" for normal text processing
but "ja_JP.EUC-JP" for the input extension to be
able to input japanese characters while staying in another
locale. resource <b>imLocale</b>.</p>
<p style="margin-left:11%;"><b>-imfont</b>
<i>fontset</i></p>
<p style="margin-left:17%;">Set the font set to use for the
X Input Method, see resource <b>imFont</b> for more
info.</p>
<p style="margin-left:11%;"><b>-tcw</b></p>
<p style="margin-left:17%;">Change the meaning of
triple-click selection with the left mouse button. Only
effective when the original (non-perl) selection code is
in-use. Instead of selecting a full line it will extend the
selection to the end of the logical line only. resource
<b>tripleclickwords</b>.</p>
<p style="margin-left:11%;"><b>-insecure</b></p>
<p style="margin-left:17%;">Enable "insecure"
mode, which currently enables most of the escape sequences
that echo strings. See the resource <b>insecure</b> for more
info.</p>
<p style="margin-left:11%;"><b>-mod</b> <i>modifier</i></p>
<p style="margin-left:17%;">Override detection of Meta
modifier with specified key: <b>alt</b>, <b>meta</b>,
<b>hyper</b>, <b>super</b>, <b>mod1</b>, <b>mod2</b>,
<b>mod3</b>, <b>mod4</b>, <b>mod5</b>; resource
<i>modifier</i>.</p>
<p style="margin-left:11%;"><b>-ssc</b>|<b>+ssc</b></p>
<p style="margin-left:17%;">Turn on/off secondary screen
(default enabled); resource <b>secondaryScreen</b>.</p>
<p style="margin-left:11%;"><b>-ssr</b>|<b>+ssr</b></p>
<p style="margin-left:17%;">Turn on/off secondary screen
scroll (default enabled); resource
<b>secondaryScroll</b>.</p>
<p style="margin-left:11%;"><b>-hold</b>|<b>+hold</b></p>
<p style="margin-left:17%;">Turn on/off hold window after
exit support. If enabled, urxvt will not immediately destroy
its window when the program executed within it exits.
Instead, it will wait till it is being killed or closed by
the user; resource <b>hold</b>.</p>
<p style="margin-left:11%;"><b>-cd</b> <i>path</i></p>
<p style="margin-left:17%;">Sets the working directory for
the shell (or the command specified via <b>-e</b>). The
<i>path</i> must be an absolute path and it must exist for
urxvt to start; resource <b>chdir</b>.</p>
<p style="margin-left:11%;"><b>-xrm</b> <i>string</i></p>
<p style="margin-left:17%;">Works like the X Toolkit option
of the same name, by adding the <i>string</i> as if it were
specified in a resource file. Resource values specified this
way take precedence over all other resource
specifications.</p>
<p style="margin-left:17%; margin-top: 1em">Note that you
need to use the <i>same</i> syntax as in the .Xdefaults
file, e.g. "*.background: black". Also note that
all urxvt-specific options can be specified as long-options
on the commandline, so use of <b>-xrm</b> is mostly limited
to cases where you want to specify other resources (e.g. for
input methods) or for compatibility with other programs.</p>
<p style="margin-left:11%;"><b>-keysym.</b><i>sym
string</i></p>
<p style="margin-left:17%;">Remap a key symbol. See
resource <b>keysym</b>.</p>
<p style="margin-left:11%;"><b>-embed</b>
<i>windowid</i></p>
<p style="margin-left:17%;">Tells urxvt to embed its
windows into an already-existing window, which enables
applications to easily embed a terminal.</p>
<p style="margin-left:17%; margin-top: 1em">Right now,
urxvt will first unmap/map the specified window, so it
shouldn’t be a top-level window. urxvt will also
reconfigure it quite a bit, so don’t expect it to keep
some specific state. It’s best to create an extra
subwindow for urxvt and leave it alone.</p>
<p style="margin-left:17%; margin-top: 1em">The window will
not be destroyed when urxvt exits.</p>
<p style="margin-left:17%; margin-top: 1em">It might be
useful to know that urxvt will not close file descriptors
passed to it (except for stdin/out/err, of course), so you
can use file descriptors to communicate with the programs
within the terminal. This works regardless of whether the
"-embed" option was used or not.</p>
<p style="margin-left:17%; margin-top: 1em">Here is a short
Gtk2-perl snippet that illustrates how this option can be
used (a longer example is in <i>doc/embed</i>):</p>
<p style="margin-left:17%; margin-top: 1em">my $rxvt = new
Gtk2::Socket; <br>
$rxvt->signal_connect_after (realize => sub { <br>
my $xid = $_[0]->window->get_xid; <br>
system "urxvt -embed $xid &"; <br>
});</p>
<p style="margin-left:11%;"><b>-pty-fd</b> <i>file
descriptor</i></p>
<p style="margin-left:17%;">Tells urxvt <small>NOT</small>
to execute any commands or create a new pty/tty pair but
instead use the given file descriptor as the tty master.
This is useful if you want to drive urxvt as a generic
terminal emulator without having to run a program within
it.</p>
<p style="margin-left:17%; margin-top: 1em">If this switch
is given, urxvt will not create any utmp/wtmp entries and
will not tinker with pty/tty permissions - you have to do
that yourself if you want that.</p>
<p style="margin-left:17%; margin-top: 1em">As an extremely
special case, specifying "-1" will completely
suppress pty/tty operations, which is probably only useful
in conjunction with some perl extension that manages the
terminal.</p>
<p style="margin-left:17%; margin-top: 1em">Here is a
example in perl that illustrates how this option can be used
(a longer example is in <i>doc/pty-fd</i>):</p>
<p style="margin-left:17%; margin-top: 1em">use IO::Pty;
<br>
use Fcntl; <br>
my $pty = new IO::Pty; <br>
fcntl $pty, F_SETFD, 0; # clear close-on-exec <br>
system "urxvt -pty-fd " . (fileno $pty) .
"&"; <br>
close $pty; <br>
# now communicate with rxvt <br>
my $slave = $pty->slave; <br>
while (<$slave>) { print $slave "got
<$_>\n" }</p>
<p style="margin-left:11%;"><b>-pe</b> <i>string</i></p>
<p style="margin-left:17%;">Comma-separated list of perl
extension scripts to use (or not to use) in this terminal
instance. See resource <b>perl-ext</b> for details.</p>
<h2>RESOURCES
<a name="RESOURCES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Note:
’urxvt --help’ gives a list of all resources
(long options) compiled into your version. All resources are
also available as long-options.</p>
<p style="margin-left:11%; margin-top: 1em">You can set and
change the resources using X11 tools like <b>xrdb</b>. Many
distribution do also load settings from the
<b>~/.Xresources</b> file when X starts. urxvt will consult
the following files/resources in order, with later settings
overwriting earlier ones:</p>
<p style="margin-left:11%; margin-top: 1em">1. app-defaults
file in $XAPPLRESDIR <br>
2. $HOME/.Xdefaults <br>
3. RESOURCE_MANAGER property on root-window of screen 0 <br>
4. SCREEN_RESOURCES property on root-window of the current
screen <br>
5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
<br>
6. resources specified via -xrm on the commandline</p>
<p style="margin-left:11%; margin-top: 1em">Note that when
reading X resources, <b>urxvt</b> recognizes two class
names: <b>Rxvt</b> and <b>URxvt</b>. The class name
<b>Rxvt</b> allows resources common to both <b>urxvt</b> and
the original <i>rxvt</i> to be easily configured, while the
class name <b>URxvt</b> allows resources unique to
<b>urxvt</b>, to be shared between different <b>urxvt</b>
configurations. If no resources are specified, suitable
defaults will be used. Command-line arguments can be used to
override resource settings. The following resources are
supported (you might want to check the urxvt<b>perl</b>(3)
manpage for additional settings by perl extensions not
documented here): <b><br>
depth:</b> <i>bitdepth</i></p>
<p style="margin-left:17%;">Compile <i>xft</i>: Attempt to
find a visual with the given bit depth; option
<b>-depth</b>.</p>
<p style="margin-left:11%;"><b>buffered:</b>
<i>boolean</i></p>
<p style="margin-left:17%;">Compile <i>xft</i>: Turn on/off
double-buffering for xft (default enabled). On some
card/driver combination enabling it slightly decreases
performance, on most it greatly helps it. The slowdown is
small, so it should normally be enabled.</p>
<p style="margin-left:11%;"><b>geometry:</b>
<i>geom</i></p>
<p style="margin-left:17%;">Create the window with the
specified X window geometry [default 80x24]; option
<b>-geometry</b>.</p>
<p style="margin-left:11%;"><b>background:</b>
<i>colour</i></p>
<p style="margin-left:17%;">Use the specified colour as the
window’s background colour [default White]; option
<b>-bg</b>.</p>
<p style="margin-left:11%;"><b>foreground:</b>
<i>colour</i></p>
<p style="margin-left:17%;">Use the specified colour as the
window’s foreground colour [default Black]; option
<b>-fg</b>.</p>
<p style="margin-left:11%;"><b>color</b><i>n</i><b>:</b>
<i>colour</i></p>
<p style="margin-left:17%;">Use the specified colour for
the colour value <i>n</i>, where 0-7 corresponds to
low-intensity (normal) colours and 8-15 corresponds to
high-intensity (bold = bright foreground, blink = bright
background) colours. The canonical names are as follows:
0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta,
6=cyan, 7=white, but the actual colour names used are listed
in the <b><small>COLOURS AND GRAPHICS</small></b>
section.</p>
<p style="margin-left:17%; margin-top: 1em">Colours higher
than 15 cannot be set using resources (yet), but can be
changed using an escape command (see urxvt(7)).</p>
<p style="margin-left:17%; margin-top: 1em">Colours 16-79
form a standard 4x4x4 colour cube (the same as xterm with 88
colour support). Colours 80-87 are evenly spaces grey
steps.</p>
<p style="margin-left:11%;"><b>colorBD:</b> <i>colour</i>
<b><br>
colorIT:</b> <i>colour</i></p>
<p style="margin-left:17%;">Use the specified colour to
display bold or italic characters when the foreground colour
is the default. If font styles are not available (Compile
<i>styles</i>) and this option is unset, reverse video is
used instead.</p>
<p style="margin-left:11%;"><b>colorUL:</b>
<i>colour</i></p>
<p style="margin-left:17%;">Use the specified colour to
display underlined characters when the foreground colour is
the default.</p>
<p style="margin-left:11%;"><b>underlineColor:</b>
<i>colour</i></p>
<p style="margin-left:17%;">If set, use the specified
colour as the colour for the underline itself. If unset, use
the foreground colour.</p>
<p style="margin-left:11%;"><b>highlightColor:</b>
<i>colour</i></p>
<p style="margin-left:17%;">If set, use the specified
colour as the background for highlighted characters. If
unset, use reverse video.</p>
<p style="margin-left:11%;"><b>highlightTextColor:</b>
<i>colour</i></p>
<p style="margin-left:17%;">If set and highlightColor is
set, use the specified colour as the foreground for
highlighted characters.</p>
<p style="margin-left:11%;"><b>cursorColor:</b>
<i>colour</i></p>
<p style="margin-left:17%;">Use the specified colour for
the cursor. The default is to use the foreground colour;
option <b>-cr</b>.</p>
<p style="margin-left:11%;"><b>cursorColor2:</b>
<i>colour</i></p>
<p style="margin-left:17%;">Use the specified colour for
the colour of the cursor text. For this to take effect,
<b>cursorColor</b> must also be specified. The default is to
use the background colour.</p>
<p style="margin-left:11%;"><b>reverseVideo:</b>
<i>boolean</i></p>
<p style="margin-left:17%;"><b>True</b>: simulate reverse
video by foreground and background colours; option
<b>-rv</b>. <b>False</b>: regular screen colours [default];
option <b>+rv</b>. See note in <b><small>COLOURS AND
GRAPHICS</small></b> section.</p>
<p style="margin-left:11%;"><b>jumpScroll:</b>
<i>boolean</i></p>
<p style="margin-left:17%;"><b>True</b>: specify that jump
scrolling should be used. When receiving lots of lines,
urxvt will only scroll once a whole screen height of lines
has been read, resulting in fewer updates while still
displaying every received line; option <b>-j</b>.</p>
<p style="margin-left:17%; margin-top: 1em"><b>False</b>:
specify that smooth scrolling should be used. urxvt will
force a screen refresh on each new line it received; option
<b>+j</b>.</p>
<p style="margin-left:11%;"><b>skipScroll:</b>
<i>boolean</i></p>
<p style="margin-left:17%;"><b>True</b>: (the default)
specify that skip scrolling should be used. When receiving
lots of lines, urxvt will only scroll once in a while
(around 60 times per second), resulting in far fewer
updates. This can result in urxvt not ever displaying some
of the lines it receives; option <b>-ss</b>.</p>
<p style="margin-left:17%; margin-top: 1em"><b>False</b>:
specify that everything is to be displayed, even if the
refresh is too fast for the human eye to read anything (or
the monitor to display anything); option <b>+ss</b>.</p>
<p style="margin-left:11%;"><b>fading:</b>
<i>number</i></p>
<p style="margin-left:17%;">Fade the text by the given
percentage when focus is lost; option <b>-fade</b>.</p>
<p style="margin-left:11%;"><b>fadeColor:</b>
<i>colour</i></p>
<p style="margin-left:17%;">Fade to this colour, when
fading is used (see <b>fading:</b>). The default colour is
black; option <b>-fadecolor</b>.</p>
<p style="margin-left:11%;"><b>iconFile:</b>
<i>file</i></p>
<p style="margin-left:17%;">Set the application icon
pixmap; option <b>-icon</b>.</p>
<p style="margin-left:11%;"><b>scrollColor:</b>
<i>colour</i></p>
<p style="margin-left:17%;">Use the specified colour for
the scrollbar [default #B2B2B2].</p>
<p style="margin-left:11%;"><b>troughColor:</b>
<i>colour</i></p>
<p style="margin-left:17%;">Use the specified colour for
the scrollbar’s trough area [default #969696]. Only
relevant for rxvt (non XTerm/NeXT) scrollbar.</p>
<p style="margin-left:11%;"><b>borderColor:</b>
<i>colour</i></p>
<p style="margin-left:17%;">The colour of the border around
the text area and between the scrollbar and the text.</p>
<p style="margin-left:11%;"><b>font:</b>
<i>fontlist</i></p>
<p style="margin-left:17%;">Select the fonts to be used.
This is a comma separated list of font names that are
checked in order when trying to find glyphs for characters.
The first font defines the cell size for characters; other
fonts might be smaller, but not (in general) larger. A
(hopefully) reasonable default font list is always appended
to it; option <b>-fn</b>.</p>
<p style="margin-left:17%; margin-top: 1em">Each font can
either be a standard X11 core font ( <small>XLFD</small> )
name, with optional prefix "x:" or a Xft font
(Compile <i>xft</i>), prefixed with "xft:".</p>