Debian Codegraph @

docs/README.defines

raw
1 -- $LynxId: README.defines,v 1.20 2019/07/31 23:06:09 tom Exp $
2
3 This file lists preprocessor macros (symbols) which are tested in the
4 code (typically with ifdef).
5
6 Does not include
7 - symbols defined and documented in userdefs.h
8 - symbols expected to be set by compiler to indicate system type or
9 compiler features
10 - many symbols set and used only in connection with the ./configure
11 mechanism - the full and current list can be found in config.hin
12 (as a template) or, after running ./configure, in lynx_cfg.h.
13 - most symbols and macros defined in the source code
14
15 ***Not complete.***
16
17 A. Symbols primarily to enable compilation on specific systems
18 ==============================================================
19 See also under B for things needed by some systems.
20
21 # if you have an SVR4 system with the "type any key" problem, try defining
22 #
23 # -DSVR4_BSDSELECT
24
25 ---
26 Ports have been added for Win32 (95/NT) and 386 DOS computers with a
27 packet driver. I created four new defines to accomplish this.
28 _WINDOWS Defined for Win32 specific code (Mostly TCP related)
29 DJGPP Defined for 386 specific code (Mostly TCP related)
30 DOSPATH Defined for any DOS'ish computer
31 NOSIGHUP Defined for computers not supporting sighup signal calls.
32 -- Wayne Buttles [email protected]
33
34 Added for 8+3 filesystems (DOS):
35 FNAMES_8_3 also defined in userdefs.h if __DJGPP__
36
37 * incorporate changes for win32 by Hiroyuki Senshu <[email protected]>
38 (SH) from
39 ftp://crab.it.osha.sut.ac.jp/pub/Win32/develope/senshu/Lynx/
40 Most changes are ifdef'd
41 #define _WIN_CC= .... for Windows C Compiler
42 #define CJK_EX .... CJK EXtension
43 #define SH_EX .... Senshu Hiroyuki EXtension
44 #define WIN_EX .... Windows EXtension
45
46
47 B. Symbols to enable or disable specific features, mostly
48 =========================================================
49 Note that some of these may be only usable on some system types,
50 most were originally for UNIX.
51
52 Network related, specific protocols
53 -----------------------------------
54 # -DSOCKS For making a SOCKSified lynx.
55 see comments in makefile.in
56
57 Related to DirEd code - probably only usable for UNIX or similar
58 ----------------------------------------------------------------
59 # -DDIRED_SUPPORT (see INSTALLATION, Section II-1c)
60 # -DOK_GZIP (see INSTALLATION, Section II-1c)
61 # -DOK_OVERRIDE (see INSTALLATION, Section II-1c)
62 # -DOK_PERMIT (see INSTALLATION, Section II-1c)
63 # -DOK_TAR (see INSTALLATION, Section II-1c)
64 # -DOK_UUDECODE (see INSTALLATION, Section II-1c)
65 # -DOK_ZIP (see INSTALLATION, Section II-1c)
66 # -DOK_INSTALL to enable dired menu "Install" function
67 # -DARCHIVE_ONLY (see INSTALLATION, Section II-1c)
68 # -DNO_CHANGE_EXECUTE_PERMS (see INSTALLATION, Section II-1c)
69 # -DCANT_EDIT_UNWRITABLE_FILES (see LYEdit.c - always in effect for VMS)
70
71 Related to formatting of local directory listings
72 -------------------------------------------------
73 # -DLONG_LIST (see INSTALLATION, Section II-1c)
74 # -DNO_PARENT_DIR_REFERENCE (see INSTALLATION, Section II-1c)
75
76 Related to screen display
77 -------------------------
78 Using curses or ncurses library:
79 # -DNCURSES (see INSTALLATION, Section II-1c)
80 # -DFANCY_CURSES whether curses lib supports more than very basic stuff
81 for UNIX handled by ./configure, for VMS defined in code
82 # -DNO_KEYPAD (old) or HAVE_KEYPAD (new) whether curses lib uses keypad().
83 for UNIX handled by ./configure, may be set in HTUtils.h
84 # -DCOLOR_CURSES whether curses lib supports color (in the right way).
85 for UNIX handled by ./configure
86 # -DUSE_COLOR_STYLE (see INSTALLATION, Section II-1c) needs SVr4 curses
87 # -DUNDERLINE_LINKS Define if you want links underlined instead of bold.
88 # -DNO_SIZECHANGE (old) or HAVE_SIZECHANGE (new) whether using code to detect
89 new size after size changes of the terminal (window).
90 for UNIX handled by ./configure, may be set in HTUtils.h
91 # -DUSE_SCROLLBAR supports scrollbar when built with ncurses
92 # -DWIDEC_CURSES whether curses lib supports wide/multibyte characters.
93
94 Using slang library:
95 # -DUSE_SLANG (see INSTALLATION, Section II-1c)
96
97 Other general
98 -------------
99 # -DIGNORE_CTRL_C Define if Control-C shouldn't exit lynx.
100 # -DINACTIVE_INPUT_STYLE_VH Different style for showing inactive text fields
101 # -DNO_DUMP_WITH_BACKSPACES Disables -with_backspaces code
102 # -DNO_RULES Disables code for CERN-style rules files
103
104 Untested
105 --------
106 # -DNO_EXTENDED_HTMLDTD Disable some "SortaSGML" code, see SGML.c
107 # -DWIND_DOWN_STACK Aggressive handling of end tags for "TagSoup", SGML.c
108
109 C. Secondary symbols
110 ====================
111 Some macros that are not primary, i.e. they are normally automatically
112 set or unset in the code based on other macros (including those from
113 ./configure), but it may be sometimes useful to set them differently.
114 They may directly affect several source files. Filenames show where
115 they are set. Normally installers shouldn't have to care about these
116 symbols.
117
118 COOKIE_FILE LYMain.c default cookie file in HOME dir
119 SHOW_WHEREIS_TARGETS LYCurses.h whereis search highlighting
120 USE_KEYMAPS LYCurses.h use of .lynx-keymaps files
121
122 D. Symbols defined locally to modify some behavior
123 ==================================================
124 Defined in the source files to which they apply. Only filenames are listed,
125 the files would have to be read and edited anyway to change the definition.
126 Normally installers shouldn't have to care about any of these symbols.
127
128 ADVANCED_INFO LYShowInfo.c
129 ALLOW_PROXY_HEAD LYUtils.c
130 CHECK_FREE_MEM GridText.c
131 CLEAN_URLS HTParse.c
132 DEBUG_HOSTENT HTTCP.c
133 DEBUG_HOSTENT_CHILD HTTCP.c
134 DEFAULT_INVCHECK_BV LYCookie.c
135 DUPLICATE_ANCHOR_NAME_WORKAROUND HTAnchor.c
136 EXTENDED_OPTION_LOGIC LYMain.c
137 EXTENDED_STARTFILE_RECALL LYMain.c
138 OPTNAME_ALLOW_DASHES LYMain.c
139 OVERLAP HTNews.c
140 RESTRICT_NM_ALLOW_DASHES LYUtils.c
141 SOCKET_DEBUG_TRACE HTTCP.c
142 TRADITIONAL_SUFFIXES HTInit.c
143 USE_XHDR HTNews.c
144 max_cookies_buffer LYCookie.c
145 max_cookies_domain LYCookie.c
146 max_cookies_global LYCookie.c
147 reverse_mailcap HTInit.c