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

Comparing rxvt-unicode/doc/rxvt.1.man.in (file contents):
Revision 1.17 by root, Wed Feb 16 22:16:30 2005 UTC vs.
Revision 1.35 by root, Tue Jan 3 23:41:37 2006 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 1" 131.IX Title "rxvt 1"
132.TH rxvt 1 "2005-02-16" "5.2" "RXVT-UNICODE" 132.TH rxvt 1 "2006-01-04" "6.2" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) 134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]] 137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
… …
223.IX Item "-rv|+rv" 223.IX Item "-rv|+rv"
224Turn on/off simulated reverse video; resource \fBreverseVideo\fR. 224Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
225.IP "\fB\-j\fR|\fB+j\fR" 4 225.IP "\fB\-j\fR|\fB+j\fR" 4
226.IX Item "-j|+j" 226.IX Item "-j|+j"
227Turn on/off jump scrolling; resource \fBjumpScroll\fR. 227Turn on/off jump scrolling; resource \fBjumpScroll\fR.
228.IP "\fB\-ip\fR|\fB+ip\fR" 4 228.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4
229.IX Item "-ip|+ip" 229.IX Item "-ip|+ip | -tr|+tr"
230Turn on/off inheriting parent window's pixmap. Alternative form is 230Turn on/off inheriting parent window's pixmap. Alternative form is
231\&\fB\-tr\fR; resource \fBinheritPixmap\fR. 231\&\fB\-tr\fR; resource \fBinheritPixmap\fR.
232.IP "\fB\-fade\fR \fInumber\fR" 4 232.IP "\fB\-fade\fR \fInumber\fR" 4
233.IX Item "-fade number" 233.IX Item "-fade number"
234Fade the text by the given percentage when focus is lost. resource \fBfading\fR. 234Fade the text by the given percentage when focus is lost. Small values
235fade a little only, 100 completely replaces all colours by the fade
236colour; resource \fBfading\fR.
237.IP "\fB\-fadecolor\fR \fIcolour\fR" 4
238.IX Item "-fadecolor colour"
239Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
240is black. resource \fBfadeColor\fR.
235.IP "\fB\-tint\fR \fIcolour\fR" 4 241.IP "\fB\-tint\fR \fIcolour\fR" 4
236.IX Item "-tint colour" 242.IX Item "-tint colour"
237Tint the transparent background pixmap with the given colour when 243Tint the transparent background pixmap with the given colour when
238transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. See also the \fB\-sh\fR 244transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for
239option that can be used to brighten or darken the image in addition to 245non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
240tinting it. 246used to brighten or darken the image in addition to tinting it; resource
247\&\fItintColor\fR. Example:
248.Sp
249.Vb 1
250\& @@RXVT_NAME@@ -tr -tint blue -sh 40
251.Ve
241.IP "\fB\-sh\fR" 4 252.IP "\fB\-sh\fR" 4
242.IX Item "-sh" 253.IX Item "-sh"
243\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 254\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent
244background image in addition to tinting it (i.e. \fB\-tint\fR must be 255background image in addition to tinting it (i.e. \fB\-tint\fR must be
245specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR). 256specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR).
… …
287.Sp 298.Sp
288See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 299See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0
289section of @@RXVT_NAME@@(7). 300section of @@RXVT_NAME@@(7).
290.IP "\fB\-fb\fR \fIfontlist\fR" 4 301.IP "\fB\-fb\fR \fIfontlist\fR" 4
291.IX Item "-fb fontlist" 302.IX Item "-fb fontlist"
292Compile font\-styles: The bold font list to use when bold characters are to 303Compile font\-styles: The bold font list to use when \fBbold\fR characters are to
293be printed. See resource \fBboldFont\fR for details. 304be printed. See resource \fBboldFont\fR for details.
294.IP "\fB\-fi\fR \fIfontlist\fR" 4 305.IP "\fB\-fi\fR \fIfontlist\fR" 4
295.IX Item "-fi fontlist" 306.IX Item "-fi fontlist"
296Compile font\-styles: The italic font list to use when bold characters are to 307Compile font\-styles: The italic font list to use when \fIitalic\fR characters are to
297be printed. See resource \fBitalicFont\fR for details. 308be printed. See resource \fBitalicFont\fR for details.
298.IP "\fB\-fbi\fR \fIfontlist\fR" 4 309.IP "\fB\-fbi\fR \fIfontlist\fR" 4
299.IX Item "-fbi fontlist" 310.IX Item "-fbi fontlist"
300Compile font\-styles: The bold italic font list to use when bold characters are to 311Compile font\-styles: The bold italic font list to use when \fB\f(BIbold
301be printed. See resource \fBboldItalicFont\fR for details. 312italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR
313for details.
314.IP "\fB\-is\fR|\fB+is\fR" 4
315.IX Item "-is|+is"
316Compile font\-styles: Bold/Italic font styles imply high intensity
317foreground/background (default). See resource \fBintensityStyles\fR for
318details.
302.IP "\fB\-name\fR \fIname\fR" 4 319.IP "\fB\-name\fR \fIname\fR" 4
303.IX Item "-name name" 320.IX Item "-name name"
304Specify the application name under which resources are to be obtained, 321Specify the application name under which resources are to be obtained,
305rather than the default executable file name. Name should not contain 322rather than the default executable file name. Name should not contain
306`.' or `*' characters. Also sets the icon and title name. 323`.' or `*' characters. Also sets the icon and title name.
… …
334.IP "\fB\-sr\fR|\fB+sr\fR" 4 351.IP "\fB\-sr\fR|\fB+sr\fR" 4
335.IX Item "-sr|+sr" 352.IX Item "-sr|+sr"
336Put scrollbar on right/left; resource \fBscrollBar_right\fR. 353Put scrollbar on right/left; resource \fBscrollBar_right\fR.
337.IP "\fB\-st\fR|\fB+st\fR" 4 354.IP "\fB\-st\fR|\fB+st\fR" 4
338.IX Item "-st|+st" 355.IX Item "-st|+st"
339Display normal (non XTerm/NeXT) scrollbar without/with a trough; 356Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
340resource \fBscrollBar_floating\fR. 357resource \fBscrollBar_floating\fR.
341.IP "\fB\-ptab\fR|\fB+ptab\fR" 4 358.IP "\fB\-ptab\fR|\fB+ptab\fR" 4
342.IX Item "-ptab|+ptab" 359.IX Item "-ptab|+ptab"
343If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as 360If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
344actual wide characters in the screen buffer, which makes it possible to 361actual wide characters in the screen buffer, which makes it possible to
… …
388the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are 405the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are
389given on the command line. If this option is used, it must be the last 406given on the command line. If this option is used, it must be the last
390on the command\-line. If there is no \fB\-e\fR option then the default is to 407on the command\-line. If there is no \fB\-e\fR option then the default is to
391run the program specified by the \fB\s-1SHELL\s0\fR environment variable or, 408run the program specified by the \fB\s-1SHELL\s0\fR environment variable or,
392failing that, \fI\fIsh\fI\|(1)\fR. 409failing that, \fI\fIsh\fI\|(1)\fR.
410.Sp
411Please note that you must specify a program with arguments. If you want to
412run shell commands, you have to specify the shell, like this:
413.Sp
414.Vb 1
415\& @@RXVT_NAME@@ -e sh -c "shell commands"
416.Ve
393.IP "\fB\-title\fR \fItext\fR" 4 417.IP "\fB\-title\fR \fItext\fR" 4
394.IX Item "-title text" 418.IX Item "-title text"
395Window title (\fB\-T\fR still respected); the default title is the basename 419Window title (\fB\-T\fR still respected); the default title is the basename
396of the program specified after the \fB\-e\fR option, if any, otherwise the 420of the program specified after the \fB\-e\fR option, if any, otherwise the
397application name; resource \fBtitle\fR. 421application name; resource \fBtitle\fR.
… …
441\&\fBsecondaryScreen\fR. 465\&\fBsecondaryScreen\fR.
442.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 466.IP "\fB\-ssr\fR|\fB+ssr\fR" 4
443.IX Item "-ssr|+ssr" 467.IX Item "-ssr|+ssr"
444Turn on/off secondary screen scroll (default enabled); resource 468Turn on/off secondary screen scroll (default enabled); resource
445\&\fBsecondaryScroll\fR. 469\&\fBsecondaryScroll\fR.
470.IP "\fB\-hold\fR|\fB+hold\fR" 4
471.IX Item "-hold|+hold"
472Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
473will not immediately destroy its window when the program executed within
474it exits. Instead, it will wait till it is being killed or closed by the
475user; resource \fBhold\fR.
446.IP "\fB\-keysym.\fR\fIsym\fR: \fIstring\fR" 4 476.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
447.IX Item "-keysym.sym: string" 477.IX Item "-keysym.sym string"
448Remap a key symbol. See resource \fBkeysym\fR. 478Remap a key symbol. See resource \fBkeysym\fR.
449.IP "\fB\-embed\fR: \fIwindowid\fR" 4 479.IP "\fB\-embed\fR \fIwindowid\fR" 4
450.IX Item "-embed: windowid" 480.IX Item "-embed windowid"
451Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 481Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
452which enables applications to easily embed a terminal. 482which enables applications to easily embed a terminal.
453.Sp 483.Sp
454Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 484Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
455shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 485shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
… …
461It might be useful to know that @@RXVT_NAME@@ will not close file 491It might be useful to know that @@RXVT_NAME@@ will not close file
462descriptors passed to it (except for stdin/out/err, of course), so you 492descriptors passed to it (except for stdin/out/err, of course), so you
463can use file descriptors to communicate with the programs within the 493can use file descriptors to communicate with the programs within the
464terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or 494terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or
465not. 495not.
496.Sp
497Here is a short Gtk2\-perl snippet that illustrates how this option can be
498used (a longer example is in \fIdoc/embed\fR):
499.Sp
500.Vb 5
501\& my $rxvt = new Gtk2::Socket;
502\& $rxvt->signal_connect_after (realize => sub {
503\& my $xid = $_[0]->window->get_xid;
504\& system "@@RXVT_NAME@@ -embed $xid &";
505\& });
506.Ve
507.IP "\fB\-pty\-fd\fR \fIfileno\fR" 4
508.IX Item "-pty-fd fileno"
509Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
510pair but instead use the given filehandle as the tty master. This is
511useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
512without having to run a program within it.
513.Sp
514If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
515entries and will not tinker with pty/tty permissions \- you have to do that
516yourself if you want that.
517.Sp
518Here is a example in perl that illustrates how this option can be used (a
519longer example is in \fIdoc/pty\-fd\fR):
520.Sp
521.Vb 2
522\& use IO::Pty;
523\& use Fcntl;
524.Ve
525.Sp
526.Vb 4
527\& my $pty = new IO::Pty;
528\& fcntl $pty, F_SETFD, 0; # clear close-on-exec
529\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
530\& close $pty;
531.Ve
532.Sp
533.Vb 3
534\& # now communicate with rxvt
535\& my $slave = $pty->slave;
536\& while (<$slave>) { print $slave "got <$_>\en" }
537.Ve
538.IP "\fB\-pe\fR \fIstring\fR" 4
539.IX Item "-pe string"
540Colon-separated list of perl extension scripts to use in this terminal instance. See resource \fBperl-ext\fR.
466.SH "RESOURCES (available also as long\-options)" 541.SH "RESOURCES (available also as long\-options)"
467.IX Header "RESOURCES (available also as long-options)" 542.IX Header "RESOURCES (available also as long-options)"
468Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 543Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
469options) compiled into your version. 544options) compiled into your version.
470.PP 545.PP
… …
570\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 645\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
571artificial transparency. \fBFalse\fR: do not inherit the parent windows' 646artificial transparency. \fBFalse\fR: do not inherit the parent windows'
572pixmap. 647pixmap.
573.IP "\fBfading:\fR \fInumber\fR" 4 648.IP "\fBfading:\fR \fInumber\fR" 4
574.IX Item "fading: number" 649.IX Item "fading: number"
575Fade the text by the given percentage when focus is lost. 650Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
651.IP "\fBfadeColor:\fR \fIcolour\fR" 4
652.IX Item "fadeColor: colour"
653Fade to this colour, when fading is used (see \fBfading:\fR). The default
654colour is black; option \fB\-fadecolor\fR.
576.IP "\fBtintColor:\fR \fIcolour\fR" 4 655.IP "\fBtintColor:\fR \fIcolour\fR" 4
577.IX Item "tintColor: colour" 656.IX Item "tintColor: colour"
578Tint the transparent background pixmap with the given colour. 657Tint the transparent background pixmap with the given colour; option
658\&\fB\-tint\fR.
579.IP "\fBshading:\fR \fInumber\fR" 4 659.IP "\fBshading:\fR \fInumber\fR" 4
580.IX Item "shading: number" 660.IX Item "shading: number"
581Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background 661Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background
582image in addition to tinting it. 662image in addition to tinting it.
583.IP "\fBscrollColor:\fR \fIcolour\fR" 4 663.IP "\fBscrollColor:\fR \fIcolour\fR" 4
584.IX Item "scrollColor: colour" 664.IX Item "scrollColor: colour"
585Use the specified colour for the scrollbar [default #B2B2B2]. 665Use the specified colour for the scrollbar [default #B2B2B2].
586.IP "\fBtroughColor:\fR \fIcolour\fR" 4 666.IP "\fBtroughColor:\fR \fIcolour\fR" 4
587.IX Item "troughColor: colour" 667.IX Item "troughColor: colour"
588Use the specified colour for the scrollbar's trough area [default 668Use the specified colour for the scrollbar's trough area [default
589#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 669#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
590.IP "\fBborderColor:\fR \fIcolour\fR" 4 670.IP "\fBborderColor:\fR \fIcolour\fR" 4
591.IX Item "borderColor: colour" 671.IX Item "borderColor: colour"
592The colour of the border around the text area and between the scrollbar 672The colour of the border around the text area and between the scrollbar
593and the text. 673and the text.
594.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 674.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
… …
616.IX Item "font: fontlist" 696.IX Item "font: fontlist"
617Select the fonts to be used. This is a comma separated list of font 697Select the fonts to be used. This is a comma separated list of font
618names that are used in turn when trying to display Unicode characters. 698names that are used in turn when trying to display Unicode characters.
619The first font defines the cell size for characters; other fonts might 699The first font defines the cell size for characters; other fonts might
620be smaller, but not larger. A reasonable default font list is always 700be smaller, but not larger. A reasonable default font list is always
621appended to it. option \fB\-fn\fR. 701appended to it; option \fB\-fn\fR.
622.Sp 702.Sp
623Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with 703Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with
624optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR. 704optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR.
625.Sp 705.Sp
626In addition, each font can be prefixed with additional hints and 706In addition, each font can be prefixed with additional hints and
… …
674\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is 754\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is
675not possible, replacement fonts of the desired shape will be tried. 755not possible, replacement fonts of the desired shape will be tried.
676.Sp 756.Sp
677If set, but empty, then this specific style is disabled and the normal 757If set, but empty, then this specific style is disabled and the normal
678text font will being used for the given style. 758text font will being used for the given style.
759.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
760.IX Item "intensityStyles: boolean"
761When font styles are not enabled, or this option is enabled (\fBTrue\fR,
762option \fB\-is\fR, the default), bold and italic font styles imply high
763intensity foreground/backround colours. Disabling this option (\fBFalse\fR,
764option \fB+is\fR) disables this behaviour, the high intensity colours are not
765reachable.
679.IP "\fBselectstyle:\fR \fImode\fR" 4 766.IP "\fBselectstyle:\fR \fImode\fR" 4
680.IX Item "selectstyle: mode" 767.IX Item "selectstyle: mode"
681Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is 768Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is
682xterm style with 2.20 old word selection, or anything else which gives 769xterm style with 2.20 old word selection, or anything else which gives
683xterm style selection. 770xterm style selection.
684.IP "\fBscrollstyle:\fR \fImode\fR" 4 771.IP "\fBscrollstyle:\fR \fImode\fR" 4
685.IX Item "scrollstyle: mode" 772.IX Item "scrollstyle: mode"
686Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is 773Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
687the author's favourite.. 774the author's favourite.
688.IP "\fBtitle:\fR \fIstring\fR" 4 775.IP "\fBtitle:\fR \fIstring\fR" 4
689.IX Item "title: string" 776.IX Item "title: string"
690Set window title string, the default title is the command-line 777Set window title string, the default title is the command-line
691specified after the \fB\-e\fR option, if any, otherwise the application 778specified after the \fB\-e\fR option, if any, otherwise the application
692name; option \fB\-title\fR. 779name; option \fB\-title\fR.
… …
716.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 803.IP "\fBprint\-pipe:\fR \fIstring\fR" 4
717.IX Item "print-pipe: string" 804.IX Item "print-pipe: string"
718Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use 805Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use
719\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or 806\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or
720\&\fBShift-Print\fR to include the scrollback as well. 807\&\fBShift-Print\fR to include the scrollback as well.
808.Sp
809The string will be interpreted as if typed into the shell as\-is.
810.Sp
811Example:
812.Sp
813.Vb 1
814\& URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
815.Ve
816.Sp
817This creates a new file in your home directory with the screen contents
818everytime you hit \f(CW\*(C`Print\*(C'\fR.
721.IP "\fBscrollBar:\fR \fIboolean\fR" 4 819.IP "\fBscrollBar:\fR \fIboolean\fR" 4
722.IX Item "scrollBar: boolean" 820.IX Item "scrollBar: boolean"
723\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: 821\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
724disable the scrollbar; option \fB+sb\fR. 822disable the scrollbar; option \fB+sb\fR.
725.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 823.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
… …
801.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 899.IP "\fBpointerColor2:\fR \fIcolour\fR" 4
802.IX Item "pointerColor2: colour" 900.IX Item "pointerColor2: colour"
803Mouse pointer background colour. 901Mouse pointer background colour.
804.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 902.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
805.IX Item "pointerBlankDelay: number" 903.IX Item "pointerBlankDelay: number"
806Specifies number of seconds before blanking the pointer [default 2]. 904Specifies number of seconds before blanking the pointer [default 2]. Use a
905large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
807.IP "\fBbackspacekey:\fR \fIstring\fR" 4 906.IP "\fBbackspacekey:\fR \fIstring\fR" 4
808.IX Item "backspacekey: string" 907.IX Item "backspacekey: string"
809The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR 908The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR
810or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR 909or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR
811(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode 910(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
… …
830.IP "\fBimLocale:\fR \fIname\fR" 4 929.IP "\fBimLocale:\fR \fIname\fR" 4
831.IX Item "imLocale: name" 930.IX Item "imLocale: name"
832The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g. 931The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
833\&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the 932\&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the
834input extension to be able to input japanese characters while staying in 933input extension to be able to input japanese characters while staying in
835another locale. option \fB\-imlocale\fR. 934another locale; option \fB\-imlocale\fR.
836.IP "\fBimFont:\fR \fIfontset\fR" 4 935.IP "\fBimFont:\fR \fIfontset\fR" 4
837.IX Item "imFont: fontset" 936.IX Item "imFont: fontset"
838Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or 937Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
839\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated 938\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
840by commas), i.e. it's not in the same format as the other font lists used 939by commas), i.e. it's not in the same format as the other font lists used
… …
843option \fB\-imfont\fR. 942option \fB\-imfont\fR.
844.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4 943.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
845.IX Item "tripleclickwords: boolean" 944.IX Item "tripleclickwords: boolean"
846Change the meaning of triple-click selection with the left mouse 945Change the meaning of triple-click selection with the left mouse
847button. Instead of selecting a full line it will extend the selection to 946button. Instead of selecting a full line it will extend the selection to
848the end of the logical line only. option \fB\-tcw\fR. 947the end of the logical line only; option \fB\-tcw\fR.
849.IP "\fBinsecure:\fR \fIboolean\fR" 4 948.IP "\fBinsecure:\fR \fIboolean\fR" 4
850.IX Item "insecure: boolean" 949.IX Item "insecure: boolean"
851Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 950Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
852echo arbitrary strings like the icon name or the locale. This could be 951echo arbitrary strings like the icon name or the locale. This could be
853abused if somebody gets 8\-bit\-clean access to your display, whether 952abused if somebody gets 8\-bit\-clean access to your display, whether
854throuh a mail client displaying mail bodies unfiltered or though 953through a mail client displaying mail bodies unfiltered or through
855\&\fIwrite\fR\|(1). Therefore, these sequences are disabled by default. (Note 954\&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
856that other terminals, including xterm, have these sequences 955default. (Note that many other terminals, including xterm, have these
857enabled by default). You can enable them by setting this boolean 956sequences enabled by default, which doesn't make it safer, though).
858resource or specifying \fB\-insecure\fR as an option. At the moment, this 957.Sp
859enabled display\-answer, locale, findfont, icon label and window title 958You can enable them by setting this boolean resource or specifying
860requests as well as dynamic menubar dispatch. 959\&\fB\-insecure\fR as an option. At the moment, this enables display\-answer,
960locale, findfont, icon label and window title requests as well as dynamic
961menubar dispatch.
861.IP "\fBmodifier:\fR \fImodifier\fR" 4 962.IP "\fBmodifier:\fR \fImodifier\fR" 4
862.IX Item "modifier: modifier" 963.IX Item "modifier: modifier"
863Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR, 964Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR,
864\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option 965\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
865\&\fB\-mod\fR. 966\&\fB\-mod\fR.
… …
875.IX Item "secondaryScroll: bool" 976.IX Item "secondaryScroll: bool"
876Turn on/off secondary screen scroll (default enabled). If the this 977Turn on/off secondary screen scroll (default enabled). If the this
877option is enabled, scrolls on the secondary screen will change the 978option is enabled, scrolls on the secondary screen will change the
878scrollback buffer and switching to/from the secondary screen will 979scrollback buffer and switching to/from the secondary screen will
879instead scroll the screen up. 980instead scroll the screen up.
981.IP "\fBhold\fR: \fIbool\fR" 4
982.IX Item "hold: bool"
983Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
984will not immediately destroy its window when the program executed within
985it exits. Instead, it will wait till it is being killed or closed by the
986user.
880.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 987.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
881.IX Item "keysym.sym: string" 988.IX Item "keysym.sym: string"
882Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The 989Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
883intervening resource name \fBkeysym.\fR cannot be omitted. 990intervening resource name \fBkeysym.\fR cannot be omitted.
884.Sp 991.Sp
… …
935.Sp 1042.Sp
936.Vb 1 1043.Vb 1
937\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 1044\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
938.Ve 1045.Ve
939.Sp 1046.Sp
1047If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1048is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1049manpage. For example, the \fIselection\fR extension (activated via
1050\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1051.Sp
1052.Vb 1
1053\& URxvt.keysym.M-C-c: perl:selection:rot13
1054.Ve
1055.Sp
1056Due the the large number of modifier combinations, a defined key mapping
1057will match if at \fIat least\fR the specified identifiers are being set, and
1058no other key mappings with those and more bits are being defined. That
1059means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
1060definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
1061mappings themselves.
1062.Sp
1063Unfortunately, this will override built-in key mappings. For example
1064if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
1065\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1066user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1067.Sp
1068.Vb 2
1069\& URxvt.keysym.Insert: <my insert key sequence>
1070\& URxvt.keysym.S-Insert: builtin:
1071.Ve
1072.Sp
1073The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1074of modifiers. The second line re-establishes the default mapping for
1075\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1076.Sp
940The following example will map Control\-Meta\-1 and Control\-Meta\-2 to 1077The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
941the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited 1078the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
942font-switching at runtime: 1079font-switching at runtime:
943.Sp 1080.Sp
944.Vb 2 1081.Vb 2
… …
951.Sp 1088.Sp
952.Vb 2 1089.Vb 2
953\& URxvt.keysym.M-C-3: command:\e033[8;25;80t 1090\& URxvt.keysym.M-C-3: command:\e033[8;25;80t
954\& URxvt.keysym.M-C-4: command:\e033[8;48;110t 1091\& URxvt.keysym.M-C-4: command:\e033[8;48;110t
955.Ve 1092.Ve
1093.IP "\fBperl-ext\fR: \fIstring\fR" 4
1094.IX Item "perl-ext: string"
1095Colon-separated list of perl extension scripts to use in this terminal
1096instance. Each extension is looked up in the library directories, loaded
1097if necessary, and bound to the current terminal instance. If this resource
1098is empty or missing, then the perl interpreter will not be initialized;
1099option \fB\-pe\fR.
1100.IP "\fBperl-eval\fR: \fIstring\fR" 4
1101.IX Item "perl-eval: string"
1102Perl code to be evaluated when all extensions have been registered. See the
1103@@RXVT_NAME@@\fIperl\fR\|(3) manpage.
1104.IP "\fBperl-lib\fR: \fIpath\fR" 4
1105.IX Item "perl-lib: path"
1106Colon-separated list of additional directories that hold extension
1107scripts. When looking for extensions specified by the \f(CW\*(C`perl\*(C'\fR resource,
1108@@RXVT_NAME@@ will first look in these directories and then in
1109\&\fI@@RXVT_LIBDIR@@/urxvt/perl/\fR.
1110.Sp
1111See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage.
956.SH "THE SCROLLBAR" 1112.SH "THE SCROLLBAR"
957.IX Header "THE SCROLLBAR" 1113.IX Header "THE SCROLLBAR"
958Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1114Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
959(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1115(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
960or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1116or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
… …
987to select a word; Left triple-click to select the entire logical line 1143to select a word; Left triple-click to select the entire logical line
988(which can span multiple screen lines), unless modified by resource 1144(which can span multiple screen lines), unless modified by resource
989\&\fBtripleclickwords\fR. 1145\&\fBtripleclickwords\fR.
990.Sp 1146.Sp
991Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 1147Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys)
992(Compile: \fIfrills\fR) will create a rectangular selection instead of a normal 1148(Compile: \fIfrills\fR) will create a rectangular selection instead of a
993one. 1149normal one. In this mode, every selected row becomes its own line in the
1150selection, and trailing whitespace is visually underlined and removed from
1151the selection.
994.IP "\fBInsertion\fR:" 4 1152.IP "\fBInsertion\fR:" 4
995.IX Item "Insertion:" 1153.IX Item "Insertion:"
996Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in 1154Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in
997an \fB@@RXVT_NAME@@\fR window causes the current text selection to be 1155an \fB@@RXVT_NAME@@\fR window causes the current text selection to be
998inserted as if it had been typed on the keyboard. 1156inserted as if it had been typed on the keyboard.
… …
1003.PP 1161.PP
1004You can, however, switch fonts at runtime using escape sequences (and 1162You can, however, switch fonts at runtime using escape sequences (and
1005therefore using the menubar), e.g.: 1163therefore using the menubar), e.g.:
1006.PP 1164.PP
1007.Vb 1 1165.Vb 1
1008\& printf '\ee]701;%s\e007' "9x15bold,xft:Kochi Gothic" 1166\& printf '\ee]710;%s\e007' "9x15bold,xft:Kochi Gothic"
1009.Ve 1167.Ve
1010.PP 1168.PP
1011rxvt-unicode will automatically re-apply these fonts to the output so far. 1169rxvt-unicode will automatically re-apply these fonts to the output so far.
1012.SH "ISO 14755 SUPPORT" 1170.SH "ISO 14755 SUPPORT"
1013.IX Header "ISO 14755 SUPPORT" 1171.IX Header "ISO 14755 SUPPORT"
… …
1160.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4 1318.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1161.IX Item "RXVT_SOCKET" 1319.IX Item "RXVT_SOCKET"
1162The unix domain socket path used by @@RXVT_NAME@@c(1) and 1320The unix domain socket path used by @@RXVT_NAME@@c(1) and
1163@@RXVT_NAME@@d(1). 1321@@RXVT_NAME@@d(1).
1164.Sp 1322.Sp
1165Default \f(CW\*(C`$HOME/.rxvt\-unicode\-<nodename\*(C'\fR. 1323Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR.
1166.IP "\fB\s-1HOME\s0\fR" 4 1324.IP "\fB\s-1HOME\s0\fR" 4
1167.IX Item "HOME" 1325.IX Item "HOME"
1168Used to locate the default directory for the unix domain socket for 1326Used to locate the default directory for the unix domain socket for
1169daemon communications and to locate various resource files (such as 1327daemon communications and to locate various resource files (such as
1170\&\f(CW\*(C`.Xdefaults\*(C'\fR) 1328\&\f(CW\*(C`.Xdefaults\*(C'\fR)
… …
1180.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1338.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1181.IX Item "/usr/lib/X11/rgb.txt" 1339.IX Item "/usr/lib/X11/rgb.txt"
1182Color names. 1340Color names.
1183.SH "SEE ALSO" 1341.SH "SEE ALSO"
1184.IX Header "SEE ALSO" 1342.IX Header "SEE ALSO"
1185@@RXVT_NAME@@(7), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5) 1343@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5)
1186.SH "BUGS"
1187.IX Header "BUGS"
1188Check the \s-1BUGS\s0 file for an up-to-date list.
1189.PP
1190Cursor change support is not yet implemented.
1191.PP
1192Click-and-drag doesn't work with X11 mouse report overriding.
1193.SH "CURRENT PROJECT COORDINATOR" 1344.SH "CURRENT PROJECT COORDINATOR"
1194.IX Header "CURRENT PROJECT COORDINATOR" 1345.IX Header "CURRENT PROJECT COORDINATOR"
1195.IP "Project Coordinator" 4 1346.IP "Project Coordinator" 4
1196.IX Item "Project Coordinator" 1347.IX Item "Project Coordinator"
1197Marc A. Lehmann <rxvt\-unicode@schmorp.de> 1348Marc A. Lehmann <rxvt\-unicode@schmorp.de>

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines