Blame docs/README.defines

Packit f574b8
-- $LynxId: README.defines,v 1.19 2018/03/11 22:48:09 tom Exp $
Packit f574b8
Packit f574b8
This file lists preprocessor macros (symbols) which are tested in the
Packit f574b8
code (typically with ifdef).
Packit f574b8
Packit f574b8
Does not include
Packit f574b8
- symbols defined and documented in userdefs.h
Packit f574b8
- symbols expected to be set by compiler to indicate system type or
Packit f574b8
  compiler features
Packit f574b8
- many symbols set and used only in connection with the ./configure
Packit f574b8
  mechanism - the full and current list can be found in config.hin
Packit f574b8
  (as a template) or, after running ./configure, in lynx_cfg.h.
Packit f574b8
- most symbols and macros defined in the source code
Packit f574b8
Packit f574b8
***Not complete.***
Packit f574b8
Packit f574b8
A. Symbols primarily to enable compilation on specific systems
Packit f574b8
==============================================================
Packit f574b8
See also under B for things needed by some systems.
Packit f574b8
Packit f574b8
# if you have an SVR4 system with the "type any key" problem, try defining
Packit f574b8
#
Packit f574b8
# -DSVR4_BSDSELECT
Packit f574b8
Packit f574b8
---
Packit f574b8
Ports have been added for Win32 (95/NT) and 386 DOS computers with a
Packit f574b8
packet driver.  I created four new defines to accomplish this.
Packit f574b8
	_WINDOWS Defined for Win32 specific code (Mostly TCP related)
Packit f574b8
	DJGPP    Defined for 386 specific code (Mostly TCP related)
Packit f574b8
	DOSPATH  Defined for any DOS'ish computer
Packit f574b8
	NOSIGHUP Defined for computers not supporting sighup signal calls.
Packit f574b8
-- Wayne Buttles lynx-port@fdisk.com
Packit f574b8
Packit f574b8
Added for 8+3 filesystems (DOS):
Packit f574b8
	FNAMES_8_3  also defined in userdefs.h if __DJGPP__
Packit f574b8
Packit f574b8
* incorporate changes for win32 by Hiroyuki Senshu <senshu@shonai-cit.ac.jp>
Packit f574b8
  (SH) from
Packit f574b8
    ftp://crab.it.osha.sut.ac.jp/pub/Win32/develope/senshu/Lynx/
Packit f574b8
  Most changes are ifdef'd
Packit f574b8
    #define _WIN_CC=    .... for Windows C Compiler
Packit f574b8
    #define CJK_EX      .... CJK EXtension
Packit f574b8
    #define SH_EX       .... Senshu Hiroyuki EXtension
Packit f574b8
    #define WIN_EX      .... Windows EXtension
Packit f574b8
Packit f574b8
Packit f574b8
B. Symbols to enable or disable specific features, mostly
Packit f574b8
=========================================================
Packit f574b8
Note that some of these may be only usable on some system types,
Packit f574b8
most were originally for UNIX.
Packit f574b8
Packit f574b8
Network related, specific protocols
Packit f574b8
-----------------------------------
Packit f574b8
# -DSOCKS          For making a SOCKSified lynx.
Packit f574b8
       			see comments in makefile.in
Packit f574b8
Packit f574b8
Related to DirEd code - probably only usable for UNIX or similar
Packit f574b8
----------------------------------------------------------------
Packit f574b8
# -DDIRED_SUPPORT  (see INSTALLATION, Section II-1c)
Packit f574b8
# -DOK_GZIP        (see INSTALLATION, Section II-1c)
Packit f574b8
# -DOK_OVERRIDE    (see INSTALLATION, Section II-1c)
Packit f574b8
# -DOK_PERMIT      (see INSTALLATION, Section II-1c)
Packit f574b8
# -DOK_TAR         (see INSTALLATION, Section II-1c)
Packit f574b8
# -DOK_UUDECODE    (see INSTALLATION, Section II-1c)
Packit f574b8
# -DOK_ZIP         (see INSTALLATION, Section II-1c)
Packit f574b8
# -DOK_INSTALL     to enable dired menu "Install" function
Packit f574b8
# -DARCHIVE_ONLY   (see INSTALLATION, Section II-1c)
Packit f574b8
# -DNO_CHANGE_EXECUTE_PERMS (see INSTALLATION, Section II-1c)
Packit f574b8
# -DCANT_EDIT_UNWRITABLE_FILES (see LYEdit.c - always in effect for VMS)
Packit f574b8
Packit f574b8
Related to formatting of local directory listings
Packit f574b8
-------------------------------------------------
Packit f574b8
# -DLONG_LIST      (see INSTALLATION, Section II-1c)
Packit f574b8
# -DNO_PARENT_DIR_REFERENCE (see INSTALLATION, Section II-1c)
Packit f574b8
Packit f574b8
Related to screen display
Packit f574b8
-------------------------
Packit f574b8
Using curses or ncurses library:
Packit f574b8
# -DNCURSES        (see INSTALLATION, Section II-1c)
Packit f574b8
# -DFANCY_CURSES   whether curses lib supports more than very basic stuff
Packit f574b8
                   for UNIX handled by ./configure, for VMS defined in code
Packit f574b8
# -DNO_KEYPAD (old) or HAVE_KEYPAD (new)   whether curses lib uses keypad().
Packit f574b8
                   for UNIX handled by ./configure, may be set in HTUtils.h
Packit f574b8
# -DCOLOR_CURSES    whether curses lib supports color (in the right way).
Packit f574b8
                   for UNIX handled by ./configure
Packit f574b8
# -DUSE_COLOR_STYLE (see INSTALLATION, Section II-1c) needs SVr4 curses
Packit f574b8
# -DUNDERLINE_LINKS  Define if you want links underlined instead of bold.
Packit f574b8
# -DNO_SIZECHANGE (old) or HAVE_SIZECHANGE (new) whether using code to detect
Packit f574b8
                   new size after size changes of the terminal (window).
Packit f574b8
                   for UNIX handled by ./configure, may be set in HTUtils.h
Packit f574b8
# -DUSE_SCROLLBAR  supports scrollbar when built with ncurses
Packit f574b8
# -DWIDEC_CURSES   whether curses lib supports wide/multibyte characters.
Packit f574b8
Packit f574b8
Using slang library:
Packit f574b8
# -DUSE_SLANG      (see INSTALLATION, Section II-1c)
Packit f574b8
Packit f574b8
Other general
Packit f574b8
-------------
Packit f574b8
# -DIGNORE_CTRL_C  Define if Control-C shouldn't exit lynx.
Packit f574b8
# -DINACTIVE_INPUT_STYLE_VH  Different style for showing inactive text fields
Packit f574b8
# -DNO_DUMP_WITH_BACKSPACES Disables -with_backspaces code
Packit f574b8
# -DNO_RULES	   Disables code for CERN-style rules files
Packit f574b8
# -DUSE_VASPRINT   Use vasprintf() function
Packit f574b8
Packit f574b8
Untested
Packit f574b8
--------
Packit f574b8
# -DNO_EXTENDED_HTMLDTD	Disable some "SortaSGML" code, see SGML.c
Packit f574b8
# -DWIND_DOWN_STACK Aggressive handling of end tags for "TagSoup", SGML.c
Packit f574b8
Packit f574b8
C. Secondary symbols
Packit f574b8
====================
Packit f574b8
Some macros that are not primary, i.e. they are normally automatically
Packit f574b8
set or unset in the code based on other macros (including those from
Packit f574b8
./configure), but it may be sometimes useful to set them differently.
Packit f574b8
They may directly affect several source files.  Filenames show where
Packit f574b8
they are set.  Normally installers shouldn't have to care about these
Packit f574b8
symbols.
Packit f574b8
Packit f574b8
COOKIE_FILE		LYMain.c	default cookie file in HOME dir
Packit f574b8
SHOW_WHEREIS_TARGETS	LYCurses.h	whereis search highlighting
Packit f574b8
USE_KEYMAPS		LYCurses.h	use of .lynx-keymaps files
Packit f574b8
Packit f574b8
D. Symbols defined locally to modify some behavior
Packit f574b8
==================================================
Packit f574b8
Defined in the source files to which they apply.  Only filenames are listed,
Packit f574b8
the files would have to be read and edited anyway to change the definition.
Packit f574b8
Normally installers shouldn't have to care about any of these symbols.
Packit f574b8
Packit f574b8
ADVANCED_INFO				LYShowInfo.c
Packit f574b8
ALLOW_PROXY_HEAD			LYUtils.c
Packit f574b8
CHECK_FREE_MEM				GridText.c
Packit f574b8
CLEAN_URLS				HTParse.c
Packit f574b8
DEBUG_HOSTENT				HTTCP.c
Packit f574b8
DEBUG_HOSTENT_CHILD			HTTCP.c
Packit f574b8
DEFAULT_INVCHECK_BV			LYCookie.c
Packit f574b8
DUPLICATE_ANCHOR_NAME_WORKAROUND	HTAnchor.c
Packit f574b8
EXTENDED_OPTION_LOGIC			LYMain.c
Packit f574b8
EXTENDED_STARTFILE_RECALL		LYMain.c
Packit f574b8
OPTNAME_ALLOW_DASHES			LYMain.c
Packit f574b8
OVERLAP					HTNews.c
Packit f574b8
RESTRICT_NM_ALLOW_DASHES		LYUtils.c
Packit f574b8
SOCKET_DEBUG_TRACE			HTTCP.c
Packit f574b8
TRADITIONAL_SUFFIXES			HTInit.c
Packit f574b8
USE_XHDR				HTNews.c
Packit f574b8
max_cookies_buffer			LYCookie.c
Packit f574b8
max_cookies_domain			LYCookie.c
Packit f574b8
max_cookies_global			LYCookie.c
Packit f574b8
reverse_mailcap				HTInit.c