*** empty log message ***
[dana/urxvt.git] / README.configure
1 --enable-everything
2         add support for all non-multichoice options listed in "./configure
3         --help".  Note that unlike other enable options this is order
4         dependant.  You can specify this and then disable options which
5         this enables by _following_ this with the appropriate commands.
6 --enable-xft
7         add support for xft (anti-aliases, among others) fonts. xft fonts are
8         slower and require lots of memory, but as long as you don't use them,
9         you don't pay for them.
10 --with-codesets=NAME,...
11         compile in support for additional codeset groups:
12         jp      common japanese encodings
13         jp_ext  rarely used but big japanese encodings
14         kr      korean encodings
15         cn      common chinese encodings
16         cn_ext  rarely used but very big chinese encodigs
17         all     all of the above
18 --enable-xim
19         add support for XIM (X Input Method) protocol. This allows using
20         alternative input methods (e.g. kinput2) and will also correctly
21         set up the input for people using dead keys or compose keys.
22 --enable-unicode3
23         enable support for unicode codepoints above 65535 (the basic
24         multilingual page). This increases storage requirements per character
25         from 2 to 4 bytes and is not too useful as font support in X11 and Xft
26         is largely missing, although cut & paste will work correctly, as will
27         displaying, if you have the right font(s).
28 --enable-fallback(=CLASS)
29         when reading resource settings, also read settings for class CLASS
30         (default: Rxvt). To disable resource fallback use --disable-fallback.
31 --with-res-name=NAME
32         use the given name (default: urxvt) as default application name
33         when reading resources.  Specify --with-res-name=rxvt to replace
34         rxvt.
35 --with-res-class=CLASS
36         use the given class (default: URxvt) as default application class
37         when reading resources.  Specify --with-res-class=Rxvt to replace
38         rxvt.
39 --enable-utmp
40         write user and tty to utmp file (used by programs like ``w'') at
41         start of rxvt execution and delete information when rxvt exits.
42 --enable-wtmp
43         write user and tty to wtmp file (used by programs like ``last'') at
44         start of rxvt execution and write logout when rxvt exits.  This
45         option requires --enable-utmp to also be specified.
46 --enable-lastlog
47         write user and tty to lastlog file (used by programs like
48         ``lastlogin'') at start of rxvt execution.  This option requires
49         --enable-utmp to also be specified.
50 --enable-xpm-background
51         add support for XPM background pixmaps
52 --enable-transparency
53         add support for inheriting parent backgrounds thus giving a fake
54         transparency to the term
55 --enable-menubar
56         add support for our menu bar system (this interacts badly with
57         dynamic locale switching currently)
58 --enable-rxvt-scroll
59         add support for the original rxvt scrollbar
60 --enable-next-scroll
61         add support for a NeXT-like scrollbar
62 --enable-xterm-scroll
63         add support for an Xterm-like scrollbar
64 --enable-plain-scroll
65         add support for a very unobtrusive, plain-looking scrollbar that
66         is the favourite of the rxvt-unicode author, having used it for
67         many years.
68 --enable-half-shadow
69         make shadows on the scrollbar only half the normal width & height.
70         only applicable to rxvt scrollbars
71 --enable-ttygid
72         change tty device setting to group "tty" - only use this if
73         your system uses this type of security
74 --disable-backspace-key
75         disable any handling of the backspace key by us - let the X server
76         do it
77 --disable-delete-key
78         disable any handling of the delete key by us - let the X server
79         do it
80 --disable-resources
81         remove all resources checking
82 --enable-xgetdefault
83         make resources checking via XGetDefault() instead of our small
84         version which only checks ~/.Xdefaults, or if that doesn't exist
85         then ~/.Xresources
86 --enable-strings
87         add support for our possibly faster memset() function and other
88         various routines, overriding your system's versions which may
89         have been hand-crafted in assembly or may require extra libraries
90         to link in. (this breaks ANSI-C rules and has problems on many
91         GNU/Linux systems).
92 --disable-swapscreen
93         remove support for swap screen
94 --enable-frills
95         add support for some lesser used features
96 --enable-linespace
97         add support to provide user specified line spacing between text rows
98 --enable-keepscrolling
99         add support for continual scrolling of the display when you hold
100         the mouse button down on a scrollbar arrow
101 --enable-mousewheel
102         add support for scrolling via mouse wheel or buttons 4 & 5
103 --enable-slipwheeling
104         add support for continual scrolling (using the mouse wheel as an
105         accelerator) while the control key is held down.  This option
106         requires --enable-mousewheel to also be specified.
107 --enable-old-selection
108         remove support for reverting the mouse selection style to that
109         of v2.20 (and prior)
110 --disable-new-selection
111         remove support for mouse selection style like that of xterm
112 --enable-dmalloc
113         use Gray Watson's malloc - which is good for debugging
114         See  http://www.letters.com/dmalloc/  for details
115         If you use either this or the next option, you may need to
116         edit src/Makefile after compiling to point DINCLUDE and DLIB to
117         the right places.
118         You can only use either this option and the following (should
119         you use either) 
120 --enable-dlmalloc
121         use Doug Lea's malloc - which is good for a production version
122         See  http://g.oswego.edu/dl/html/malloc.html  for details
123 --enable-smart-resize
124         add smart growth/shrink behaviour when changing font size
125         via from hot keys.  This should keep in a fixed position the
126         rxvt corner which is closest to a corner of the screen
127 --enable-256-color
128         add support for 256 colours rather than the base 16 colours
129 --enable-cursor-blink
130         add support for a blinking cursor
131 --enable-pointer-blank
132         add support to have the pointer disappear when typing or inactive
133 --with-name=NAME
134         set the basename for the installed binaries (default: urxvt, resulting
135         in urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt.
136 --with-term=NAME
137         change the environmental variable for the terminal to NAME
138         (default "rxvt")
139 --with-terminfo=PATH
140         change the environmental variable for the path to the terminfo
141         tree to PATH
142 --with-x
143         use the X Window System (pretty much default, eh?)
144 --with-xpm-includes=DIR
145         look for the XPM includes in DIR
146 --with-xpm-library=DIR
147         look for the XPM library in DIR
148 --with-xpm
149         not needed - define via --enable-xpm-background
150