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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.2 by root, Thu Aug 12 21:30:14 2004 UTC

… …
2 2
3rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system) 3rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7B<@@RXVTNAME@@> [options] [-e command [ args ]] 7B<@@RXVT_NAME@@> [options] [-e command [ args ]]
8 8
9=head1 DESCRIPTION 9=head1 DESCRIPTION
10 10
11B<rxvt-unicode>, version B<@@RXVTVERSION@@>, is a colour vt102 terminal 11B<rxvt-unicode>, version B<@@RXVTVERSION@@>, is a colour vt102 terminal
12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17See also @@RXVT_NAME@@(7) for technical reference documentation (escape
18sequences etc.).
19
17=head1 OPTIONS 20=head1 OPTIONS
18 21
19The B<@@RXVTNAME@@> options (mostly a subset of I<xterm>'s) are listed 22The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
20below. In keeping with the smaller-is-better philosophy, options may be 23below. In keeping with the smaller-is-better philosophy, options may be
21eliminated or default values chosen at compile-time, so options and 24eliminated or default values chosen at compile-time, so options and
22defaults listed may not accurately reflect the version installed on 25defaults listed may not accurately reflect the version installed on
23your system. `rxvt -h' gives a list of major compile-time options on 26your system. `rxvt -h' gives a list of major compile-time options on
24the I<Options> line. Option descriptions may be prefixed with which 27the I<Options> line. Option descriptions may be prefixed with which
25compile option each is dependent upon. e.g. `Compile I<XIM>:' requires 28compile option each is dependent upon. e.g. `Compile I<XIM>:' requires
26I<XIM> on the I<Options> line. Note: `rxvt -help' gives a list of all 29I<XIM> on the I<Options> line. Note: `rxvt -help' gives a list of all
27command-line options compiled into your version. 30command-line options compiled into your version.
28 31
29Note that B<@@RXVTNAME@@> permits the resource name to be used as a 32Note that B<@@RXVT_NAME@@> permits the resource name to be used as a
30long-option (--/++ option) so the potential command-line options are 33long-option (--/++ option) so the potential command-line options are
31far greater than those listed. For example: `rxvt --loginShell --color1 34far greater than those listed. For example: `rxvt --loginShell --color1
32Orange'. 35Orange'.
33 36
34The following options are available: 37The following options are available:
… …
219I<termcap(5)> database and should have I<li#> and I<co#> entries; 222I<termcap(5)> database and should have I<li#> and I<co#> entries;
220resource B<termName>. 223resource B<termName>.
221 224
222=item B<-e> I<command [arguments]> 225=item B<-e> I<command [arguments]>
223 226
224Run the command with its command-line arguments in the B<@@RXVTNAME@@> 227Run the command with its command-line arguments in the B<@@RXVT_NAME@@>
225window; also sets the window title and icon name to be the basename of 228window; also sets the window title and icon name to be the basename of
226the program being executed if neither I<-title> (I<-T>) nor I<-n> are 229the program being executed if neither I<-title> (I<-T>) nor I<-n> are
227given on the command line. If this option is used, it must be the last 230given on the command line. If this option is used, it must be the last
228on the command-line. If there is no B<-e> option then the default is to 231on the command-line. If there is no B<-e> option then the default is to
229run the program specified by the B<SHELL> environment variable or, 232run the program specified by the B<SHELL> environment variable or,
… …
291 294
292=back 295=back
293 296
294=head1 RESOURCES (available also as long-options) 297=head1 RESOURCES (available also as long-options)
295 298
296Note: `@@RXVTNAME@@ --help' gives a list of all resources (long 299Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
297options) compiled into your version. 300options) compiled into your version.
298 301
299There are two different methods that @@RXVTNAME@@ can use to get the 302There are two different methods that @@RXVT_NAME@@ can use to get the
300Xresource data: using the X libraries (Xrm*-functions) or internal 303Xresource data: using the X libraries (Xrm*-functions) or internal
301Xresources reader (B<~/.Xdefaults>). For the first method (ie. 304Xresources reader (B<~/.Xdefaults>). For the first method (ie.
302B<@@RXVTNAME@@ -h> lists B<XGetDefaults>), you can set and change the 305B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
303resources using X11 tools like B<xset>. Many distribution do also load 306resources using X11 tools like B<xset>. Many distribution do also load
304settings from the B<~/.Xresources> file when X starts. 307settings from the B<~/.Xresources> file when X starts.
305 308
306If compiled with internal Xresources support (i.e. B<@@RXVTNAME@@ -h> 309If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
307lists B<.Xdefaults>) then B<@@RXVTNAME@@> accepts application defaults 310lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
308set in XAPPLOADDIR/URxvt (compile-time defined: usually 311set in XAPPLOADDIR/URxvt (compile-time defined: usually
309B</usr/lib/X11/app-defaults/URxvt>) and resources set in 312B</usr/lib/X11/app-defaults/URxvt>) and resources set in
310B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 313B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
311Note that when reading X resources, B<@@RXVTNAME@@> recognizes two 314Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two
312class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 315class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows
313resources common to both B<@@RXVTNAME@@> and the original I<rxvt> to be 316resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be
314easily configured, while the class name B<URxvt> allows resources 317easily configured, while the class name B<URxvt> allows resources
315unique to B<@@RXVTNAME@@>, notably colours and key-handling, to be 318unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be
316shared between different B<@@RXVTNAME@@> configurations. If no 319shared between different B<@@RXVT_NAME@@> configurations. If no
317resources are specified, suitable defaults will be used. Command-line 320resources are specified, suitable defaults will be used. Command-line
318arguments can be used to override resource settings. The following 321arguments can be used to override resource settings. The following
319resources are allowed: 322resources are allowed:
320 323
321=over 4 324=over 4
… …
462xterm style with 2.20 old word selection, or anything else which gives 465xterm style with 2.20 old word selection, or anything else which gives
463xterm style selection. 466xterm style selection.
464 467
465=item B<scrollstyle:> I<mode> 468=item B<scrollstyle:> I<mode>
466 469
467Set scrollbar style to B<@@RXVTNAME@@>, B<rxvt>, B<plain>, B<next> or 470Set scrollbar style to B<@@RXVT_NAME@@>, B<rxvt>, B<plain>, B<next> or
468B<xterm> 471B<xterm>
469 472
470=item B<title:> I<string> 473=item B<title:> I<string>
471 474
472Set window title string, the default title is the command-line 475Set window title string, the default title is the command-line
… …
703 706
704=back 707=back
705 708
706=head1 THE SCROLLBAR 709=head1 THE SCROLLBAR
707 710
708Lines of text that scroll off the top of the B<@@RXVTNAME@@> window 711Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
709(resource: B<saveLines>) and can be scrolled back using the scrollbar 712(resource: B<saveLines>) and can be scrolled back using the scrollbar
710or by keystrokes. The normal B<@@RXVTNAME@@> scrollbar has arrows and 713or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and
711its behaviour is fairly intuitive. The B<xterm-scrollbar> is without 714its behaviour is fairly intuitive. The B<xterm-scrollbar> is without
712arrows and its behaviour mimics that of I<xterm> 715arrows and its behaviour mimics that of I<xterm>
713 716
714Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>. 717Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.
715Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>. 718Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>.
… …
743line. 746line.
744 747
745=item B<Insertion>: 748=item B<Insertion>:
746 749
747Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 750Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
748an B<@@RXVTNAME@@> window causes the current text selection to be 751an B<@@RXVT_NAME@@> window causes the current text selection to be
749inserted as if it had been typed on the keyboard. 752inserted as if it had been typed on the keyboard.
750 753
751=back 754=back
752 755
753=head1 CHANGING FONTS 756=head1 CHANGING FONTS
… …
757B<Shift-KP_Subtract>. Or, alternatively (if enabled) with 760B<Shift-KP_Subtract>. Or, alternatively (if enabled) with
758B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the 761B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the
759actual key can be selected using resources 762actual key can be selected using resources
760B<smallfont_key>/B<bigfont_key>. 763B<smallfont_key>/B<bigfont_key>.
761 764
765=head1 ISO 14755 SUPPORT
766
767Partial ISO 14755-support is implemented. that means that pressing
768
769Section 5.1: Control and Shift together enters unicode input
770mode. Entering hex digits composes a Unicode character, pressing space or
771releasing the modifiers commits the keycode and every other key cancels
772the current input character.
773
774Section 5.2: Pressing and immediately releasing Control and Shift together
775enters keycap entry mode for the next key: pressing a function key (tab,
776return etc..) will enter the unicode character corresponding to the given
777key.
778
762=head1 LOGIN STAMP 779=head1 LOGIN STAMP
763 780
764B<@@RXVTNAME@@> tries to write an entry into the I<utmp>(5) file so 781B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so
765that it can be seen via the I<who(1)> command, and can accept messages. 782that it can be seen via the I<who(1)> command, and can accept messages.
766To allow this feature, B<@@RXVTNAME@@> must be installed setuid root on 783To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on
767some systems. 784some systems.
768 785
769=head1 COLORS AND GRAPHICS 786=head1 COLORS AND GRAPHICS
770 787
771In addition to the default foreground and background colours, 788In addition to the default foreground and background colours,
772B<@@RXVTNAME@@> can display up to 16 colours (8 ANSI colours plus 789B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
773high-intensity bold/blink versions of the same). Here is a list of the 790high-intensity bold/blink versions of the same). Here is a list of the
774colours with their B<rgb.txt> names. 791colours with their B<rgb.txt> names.
775 792
776=begin table 793=begin table
777 794
… …
815 832
816=back 833=back
817 834
818=head1 ENVIRONMENT 835=head1 ENVIRONMENT
819 836
820B<@@RXVTNAME@@> sets the environment variables B<TERM>, B<COLORTERM> 837B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
821and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 838and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
822window id number of the B<@@RXVTNAME@@> window and it also uses and 839window id number of the B<@@RXVT_NAME@@> window and it also uses and
823sets the environment variable B<DISPLAY> to specify which display 840sets the environment variable B<DISPLAY> to specify which display
824terminal to use. B<@@RXVTNAME@@> uses the environment variables 841terminal to use. B<@@RXVT_NAME@@> uses the environment variables
825B<RXVTPATH> and B<PATH> to find XPM files. 842B<RXVTPATH> and B<PATH> to find XPM files.
826 843
827=head1 FILES 844=head1 FILES
828 845
829=over 4 846=over 4
… …
850 867
851Cursor change support is not yet implemented. 868Cursor change support is not yet implemented.
852 869
853Click-and-drag doesn't work with X11 mouse report overriding. 870Click-and-drag doesn't work with X11 mouse report overriding.
854 871
855=head1 FTP LOCATION
856
857rxvt-+@@RXVTVERSION@@.tar.gz can be found at the following ftp sites L<@@RXVTFTPSITE@@>(@@RXVTFTPSITE@@)
858
859=head1 CURRENT PROJECT COORDINATOR 872=head1 CURRENT PROJECT COORDINATOR
860 873
861=over 4 874=over 4
862 875
863=item Project Coordinator 876=item Project Coordinator
864 877
865@@RXVTMAINT@@ L<@@RXVTMAINTEMAIL@@> 878@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@>
866 879
867=item Web page maintainter 880=item Web page maintainter
868 881
869@@RXVTWEBMAINT@@ L<@@RXVTWEBMAINTEMAIL@@> 882@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
870 883
871L<@@RXVTWEBPAGE@@>(@@RXVTWEBPAGE@@) 884L<@@RXVT_WEBPAGE@@>
872 885
873=back 886=back
874 887
875=head1 AUTHORS 888=head1 AUTHORS
876 889

Diff Legend

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