*** empty log message ***
[dana/urxvt.git] / doc / rxvt.7.pod
index 266ed67..58bad11 100644 (file)
@@ -1,3 +1,25 @@
+=head1 NAME
+
+RXVT TECHNICAL REFERENCE - command sequences and background information
+
+=head1 SYNOPSIS
+
+   # set a new font set
+   printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
+
+   # change the locale and tell rxvt-unicode about it
+   export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
+
+   # set window title
+   printf '\33]2;%s\007' "new window title"
+
+=head1 DESCRIPTION
+
+The rest of this document describes various technical aspects of
+B<rxvt-unicode>. First the description of supported command sequences,
+followed by menu and pixmap support and last by a description of all
+features selectable at C<configure> time.
+
 =head1 RXVT TECHNICAL REFERENCE
 
 =head1 Definitions
@@ -151,11 +173,11 @@ Invoke the G2 Character Set (LS2)
 
 Invoke the G3 Character Set (LS3)
 
-=item B<< C<ESC>(C<C> >>
+=item B<< C<ESC> ( C> >>
 
 Designate G0 Character Set (ISO 2022), see below for values of C<C>.
 
-=item B<< C<ESC>)C<C> >>
+=item B<< C<ESC> ) C> >>
 
 Designate G1 Character Set (ISO 2022), see below for values of C<C>.
 
@@ -332,21 +354,22 @@ Tab Clear (TBC)
 
 =end table
 
+=item B<< C<ESC [ Pm h> >>
+
+Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
+
 =item B<< C<ESC [ Ps i> >>
 
-Printing
+Printing. See also the C<print-pipe> resource.
 
 =begin table
 
+       B<< C<Ps = 0> >>        print screen (MC0)
        B<< C<Ps = 4> >>        disable transparent print mode (MC4)
-       B<< C<Ps = 5> >>        enable transparent print mode (MC5) I<unimplemented>
+       B<< C<Ps = 5> >>        enable transparent print mode (MC5)
 
 =end table
 
-=item B<< C<ESC [ Pm h> >>
-
-Set Mode (SM). See next sequence for description of C<Pm>.
-
 =item B<< C<ESC [ Pm l> >>
 
 Reset Mode (RM)
@@ -381,12 +404,12 @@ Character Attributes (SGR)
 
        B<< C<Ps = 0> >>        Normal (default)
        B<< C<Ps = 1 / 21> >>   On / Off Bold (bright fg)
-       B<< C<Ps = 3 / 23> >>   On / Off Italic (NYI)
+       B<< C<Ps = 3 / 23> >>   On / Off Italic
        B<< C<Ps = 4 / 24> >>   On / Off Underline
        B<< C<Ps = 5 / 25> >>   On / Off Slow Blink (bright bg)
        B<< C<Ps = 6 / 26> >>   On / Off Rapid Blink (bright bg)
-       B<< C<Ps = 7 / 27> >>   On / Off Invisible (NYI)
-       B<< C<Ps = 8 / 27> >>   On / Off Inverse
+       B<< C<Ps = 7 / 27> >>   On / Off Inverse
+       B<< C<Ps = 8 / 27> >>   On / Off Invisible (NYI)
        B<< C<Ps = 30 / 40> >>  fg/bg Black
        B<< C<Ps = 31 / 41> >>  fg/bg Red
        B<< C<Ps = 32 / 42> >>  fg/bg Green
@@ -394,6 +417,7 @@ Character Attributes (SGR)
        B<< C<Ps = 34 / 44> >>  fg/bg Blue
        B<< C<Ps = 35 / 45> >>  fg/bg Magenta
        B<< C<Ps = 36 / 46> >>  fg/bg Cyan
+       B<< C<Ps = 38;5 / 48;5> >>      set fg/bg to color #m (ISO 8613-6)
        B<< C<Ps = 37 / 47> >>  fg/bg White
        B<< C<Ps = 39 / 49> >>  fg/bg Default
        B<< C<Ps = 90 / 100> >> fg/bg Bright Black
@@ -747,8 +771,13 @@ B<octet> can be escaped by prefixing it with SYN (0x16, ^V).
        B<< C<Ps = 50> >>       Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
        B<< C<Ps = 55> >>       Log all scrollback buffer and all of screen to B<< C<Pt> >>
        B<< C<Ps = 701> >>      Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension)
-       B<< C<Ps = 702> >>      find font for character, used for debugging (@@RXVT_NAME@@ extension)
-       B<< C<Ps = 703> >>      menubar command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVT_NAME@@ extension)
+       B<< C<Ps = 703> >>      Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension)
+       B<< C<Ps = 704> >>      Change colour of italic characters to B<< C<Pt> >>
+       B<< C<Ps = 705> >>      Change background pixmap tint colour to B<< C<Pt> >>
+       B<< C<Ps = 710> >>      Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
+       B<< C<Ps = 711> >>      Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
+       B<< C<Ps = 712> >>      Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
+       B<< C<Ps = 713> >>      Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
 
 =end table
 
@@ -1435,13 +1464,19 @@ Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
 slower and require lots of memory, but as long as you don't use them, you
 don't pay for them.
 
+=item --enable-font-styles
+
+Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
+styles. The fonts can be set manually or automatically.
+
 =item --with-codesets=NAME,...
 
-Compile in support for additional codeset (encoding) groups. These codeset
-tables are currently only used for driving X11 core fonts, they are not
-required for Xft fonts. Compiling them in will make your binary bigger
-(together about 700kB), but it doesn't increase memory usage unless you
-use an X11 font requiring one of these encodings.
+Compile in support for additional codeset (encoding) groups (eu, vn are
+always compiled in, which includes most 8-bit character sets). These
+codeset tables are currently only used for driving X11 core fonts, they
+are not required for Xft fonts. Compiling them in will make your binary
+bigger (together about 700kB), but it doesn't increase memory usage unless
+you use an X11 font requiring one of these encodings.
 
 =begin table
 
@@ -1662,13 +1697,6 @@ Add smart growth/shrink behaviour when changing font size via from hot
 keys. This should keep in a fixed position the rxvt corner which is
 closest to a corner of the screen.
 
-=item --enable-256-color
-
-Add support for 256 colours rather than the base 16 colours.
-
-This option will likely go away in the future. Speak up if you don't want
-this.
-
 =item --enable-cursor-blink
 
 Add support for a blinking cursor.