moved from dev to prod
This commit is contained in:
root
264
tools/highwire/html/help/c-CF.htm
Normal file
264
tools/highwire/html/help/c-CF.htm
Normal file
@@ -0,0 +1,264 @@
|
||||
<HTML
|
||||
<HEAD><TITLE>HighWire Help: Configuration</TITLE>
|
||||
<STYLE type="text/css">
|
||||
<!--
|
||||
h2 { color:yellow; background-color:dodgerblue;
|
||||
text-indent:1em; text-decoration:underline; white-space:nowrap }
|
||||
-->
|
||||
</STYLE>
|
||||
</HEAD><BODY bgcolor="#EEEEEE">
|
||||
|
||||
<H1 style="color:yellow; background-color:dodgerblue;
|
||||
text-indent:1em; text-decoration:underline; white-space:nowrap">
|
||||
Configuring HighWire</H1>
|
||||
<P align="justify">
|
||||
At startup, HighWire tries to load the <TT>highwire.cfg</TT> configuration file.
|
||||
In case the environment variable <TT>$HOME</TT> is set it will first try to load
|
||||
it from <TT>$HOME/defaults/highwire.cfg</TT>. If that fails it will then try to
|
||||
load it from <TT>$HOME/highwire.cfg</TT> and if still still fails (or
|
||||
<TT>$HOME</TT> is not defined at all) HighWire will finally try to load the file
|
||||
from its starting directory.
|
||||
<P align="justify">
|
||||
The configuration file has a simple structured <I>(yet)</I>:<BR>
|
||||
Lines starting with a '<TT>#</TT>' are ignored in general (to be precise,
|
||||
everything after a '<TT>#</TT>' is ignored) and empty lines are ignored as well.
|
||||
Furthermore, leading and trailing white spaces (blanks, tabs,
|
||||
<TT>cr</TT>/<TT>lf</TT>... that is) are also ignored in general. A valid line
|
||||
consists of:<BR>
|
||||
<TT> <I>variable</I> = <I>value</I><BR>
|
||||
|
||||
<P>
|
||||
<B>Variables sorted alphabetically:</B><FONT size="1">
|
||||
<TT><UL style="list-style-type: none;">
|
||||
<LI> B </TT>
|
||||
<NOBR>• <A href="#Fnt+Hdr"><TT>BOLD_HEADER</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Fnt+Hdr"><TT>BOLD_ITALIC_HEADER</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Fnt+Nrm"><TT>BOLD_ITALIC_NORMAL</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Fnt+Tty"><TT>BOLD_ITALIC_TELETYPE</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Fnt+Nrm"><TT>BOLD_NORMAL</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Fnt+Tty"><TT>BOLD_TELETYPE</TT></A></NOBR>
|
||||
<P><TT>
|
||||
<LI> C </TT>
|
||||
<NOBR>• <A href="#Cctl"><TT>CACHEDIR</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Cctl"><TT>CACHEDSK</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Cctl"><TT>CACHEMEM</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Cnct"><TT>COOKIES</TT></A></NOBR>
|
||||
<P><TT>
|
||||
<LI> D </TT>
|
||||
<NOBR>• <A href="#Rndr"><TT>DFLT_BACKGND</TT></A></NOBR>
|
||||
<P><TT>
|
||||
<LI> F </TT>
|
||||
<NOBR>• <A href="#Fnt+Pnt"><TT>FONT_MINSIZE</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Fnt+Pnt"><TT>FONT_SIZE</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Rndr" ><TT>FORCE_FRAMECTRL</TT></A></NOBR>
|
||||
<P><TT>
|
||||
<LI> H </TT>
|
||||
<NOBR>• <A href="#Fnt+Hdr"><TT>HEADER</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Cnct"><TT>HTTP_PROXY</TT></A></NOBR>
|
||||
<P><TT>
|
||||
<LI> I </TT>
|
||||
<NOBR>• <A href="#GUI" ><TT>INFOBAR</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Fnt+Hdr"><TT>ITALIC_HEADER</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Fnt+Nrm"><TT>ITALIC_NORMAL</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Fnt+Tty"><TT>ITALIC_TELETYPE</TT></A></NOBR>
|
||||
<P><TT>
|
||||
<LI> L </TT>
|
||||
<NOBR>• <A href="#Dbgg"><TT>LOCAL_WEB</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Dbgg"><TT>LOGGING</TT></A></NOBR>
|
||||
<P><TT>
|
||||
<LI> N </TT>
|
||||
<NOBR>• <A href="#Fnt+Nrm"><TT>NORMAL</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Rndr" ><TT>NO_IMAGE</TT></A></NOBR>
|
||||
<P><TT>
|
||||
<LI> R </TT>
|
||||
<NOBR>• <A href="#Cnct"><TT>RESTRICT_HOST</TT></A></NOBR>
|
||||
<P><TT>
|
||||
<LI> S </TT>
|
||||
<NOBR>• <A href="#Rndr"><TT>START_PAGE</TT></A></NOBR>
|
||||
<P><TT>
|
||||
<LI> T </TT>
|
||||
<NOBR>• <A href="#Fnt+Tty"><TT>TELETYPE</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Cnct"><TT>TIMEOUT_CONNECT</TT></A></NOBR>
|
||||
<NOBR>• <A href="#Cnct"><TT>TIMEOUT_HEADER</TT></A></NOBR>
|
||||
</UL></FONT>
|
||||
|
||||
|
||||
<!----------------------------------------------------------------------------->
|
||||
<H2><A name="Wind">GUI Stuff:</A></H2>
|
||||
<DL>
|
||||
<DT><TT><B>INFOBAR</B> = [0..5]</TT>
|
||||
<DD>Controls the appearance of the windows' infobars. The value means:<NOBR>
|
||||
<BR> <TT>0</TT>: no infobar drawn at all
|
||||
<BR> <TT>1</TT>: only AES infobar (traditional GEM)
|
||||
<BR> <TT>2</TT>: only output to the hslider area
|
||||
<BR> <TT>3</TT>: both methods above
|
||||
<BR> <TT>4</TT>: application widget infobar, no realtime resizing
|
||||
possible
|
||||
<BR> <TT>5</TT>: both AES and application widget infobar.
|
||||
<BR></NOBR>
|
||||
The default setting is <TT>4</TT>.
|
||||
</DL>
|
||||
|
||||
|
||||
<!----------------------------------------------------------------------------->
|
||||
<H2><A name="Font">Font Setting:</A></H2>
|
||||
<P align="justify">
|
||||
The value for ALL font variables is the index number of the VDI. There are
|
||||
four necessary values for each of the font variables, these are plain, italic,
|
||||
bold and bold italic. The default values are <TT>5031</TT>, <TT>5032</TT>,
|
||||
<TT>5033</TT>, <TT>5034</TT> (Baskerville Speedo font).
|
||||
<DL>
|
||||
<DT><A name="Fnt+Nrm"></A>
|
||||
<B><TT>NORMAL</TT></B>, <B><TT>BOLD_NORMAL</TT></B>,
|
||||
<B><TT>ITALIC_NORMAL</TT></B>, <B><TT>BOLD_ITALIC_NORMAL</TT></B>
|
||||
<DD>This is the font that the normal text will be displayed with.
|
||||
<BR>
|
||||
<DT><A name="Fnt+Hdr"></A>
|
||||
<B><TT>HEADER</TT></B>, <B><TT>BOLD_HEADER</TT></B>,
|
||||
<B><TT>ITALIC_HEADER</TT></B>, <B><TT>BOLD_ITALIC_HEADER</TT></B>
|
||||
<DD>The font that headers will be displayed with.
|
||||
<BR>
|
||||
<DT><A name="Fnt+Tty"></A>
|
||||
<B><TT>TELETYPE</TT></B>, <B><TT>BOLD_TELETYPE</TT></B>,
|
||||
<B><TT>ITALIC_TELETYPE</TT></B>,<B><TT>BOLD_ITALIC_TELETYPE</TT></B>
|
||||
<DD>Font used for <CODE><PRE></CODE> and <CODE><TT></CODE> tags as
|
||||
well as for plain text files.
|
||||
<BR>
|
||||
<DT><A name="Fnt+Pnt"></A>
|
||||
<B><TT>FONT_SIZE</TT></B>
|
||||
<DD>Defines the base font size in points for normal font height (as of
|
||||
<CODE><FONT SIZE="3"></CODE>). Usefull values are <TT>10..14</TT>.
|
||||
<DT><B><TT>FONT_MINSIZE</TT></B>
|
||||
<DD>Set the minimum height in points that a font should have at least, eg. for
|
||||
<CODE><FONT SIZE="1"></CODE> tags.
|
||||
</DL>
|
||||
|
||||
|
||||
<!----------------------------------------------------------------------------->
|
||||
<H2><A name="Rndr">Parser/Renderer:</A></H2>
|
||||
<DL>
|
||||
<DT><TT><B>DFLT_BACKGND</B> = <I><colour></I></TT>
|
||||
<DD>Sets the default background colour for pages that have none defined. The
|
||||
value can either be a decimal number <TT>0..255</TT> to use the VDI colour
|
||||
map, a hexadecimal number of the form <TT>0xRRGGBB</TT> as a direct colour
|
||||
value or a text as used in HTML. The three examples below mean all the same
|
||||
colour:<TT>
|
||||
<BR> DFLT_BACKGND = 8
|
||||
<BR> DFLT_BACKGND = 0xC0C0C0
|
||||
<BR> DFLT_BACKGND = silver
|
||||
</TT>
|
||||
<BR>
|
||||
<DT><TT><B>FORCE_FRAMECTRL</B> = [0|1]</TT>
|
||||
<DD>If set to a non-zero value, the attributes <CODE>NORESIZE</CODE> and
|
||||
<CODE>SCROLLING</CODE> of frames and framesets are ignored. Also setting
|
||||
frame borders to zero will be prevented. This makes some mal-designed
|
||||
pages more useable.<BR>
|
||||
This setting can be changed at runtime in the <A href="c-MB.htm#Optn"
|
||||
>Menu Options</A>.
|
||||
<BR>
|
||||
<DT><TT><B>NO_IMAGE</B> = [0|1]</TT>
|
||||
<DD>If set to a non-zero value, images won't be displayed but the text from
|
||||
their <CODE>ALT</CODE> attribute will be used instead (if given).<BR>
|
||||
This setting can be changed at runtime in the <A href="c-MB.htm#Optn"
|
||||
>Menu Options</A>.
|
||||
<BR>
|
||||
<DT><TT><B>START_PAGE</B> = <I><URL></I></TT>
|
||||
<DD>Defines what HTML file shall be displayed at startup.
|
||||
</DL>
|
||||
|
||||
|
||||
<!----------------------------------------------------------------------------->
|
||||
<H2><A name="Cctl">Cache Control:</A></H2>
|
||||
<DL>
|
||||
<DT><TT><B>CACHEDIR</B> = <I><absolute path></I></TT>
|
||||
<DD>To allow HighWire to save visited pages for later revisites it is necessary
|
||||
to define a directory for storage. This might be something like:<TT>
|
||||
<BR> CACHEDIR = C:\TMP\
|
||||
<BR> CACHEDIR = D:\HIGHWIRE\CACHE.DIR\
|
||||
<BR> CACHEDIR = U:\ram\
|
||||
</TT><BR><I><B>Note:</B> The last example might need plenty of ram!</I>
|
||||
<BR>
|
||||
<DT><TT><B>CACHEDSK</B> = <I><kilobytes></I> [<I><num files></I>]</TT>
|
||||
<DD>Set the maximum usage of disk space for storing cache files and optionally
|
||||
the maximum number of files to use. Examples:<TT>
|
||||
<BR> CACHEDSK = 8192
|
||||
#</TT><I> use 8MB disk space</I><TT>
|
||||
<BR> CACHEDSK = 4096 300
|
||||
#</TT><I> use 4MB disk space, but not more than in 300 files</I>
|
||||
<BR>If not set here HighWire will use only a sparingly maximum of 2MB
|
||||
space andd 200 files.
|
||||
<BR>
|
||||
<DT><TT><B>CACHEMEM</B> = <I><kilobytes></I></TT>
|
||||
<DD>Sets the maximum amout in kilobytes for images cached in memory. This
|
||||
value affects only these images which aren't used anymore (default is 100k).
|
||||
</DL>
|
||||
|
||||
|
||||
<!----------------------------------------------------------------------------->
|
||||
<H2><A name="Cnct">Connection Control:</A></H2>
|
||||
<DL>
|
||||
<DT><TT><B>TIMEOUT_CONNECT</B> = n</TT>
|
||||
<DD>Number of seconds Highwire shall wait for a connection to get established.
|
||||
After this time a connection try will be seen as timed out. The default
|
||||
value is one second.
|
||||
<DT><TT><B>RETRY_HEADER</B> = n</TT>
|
||||
<DD>Definines how often HighWire tries to load a page or some other data. The
|
||||
default value is three times.
|
||||
<DT><TT><B>TIMEOUT_HEADER</B> = txt [, gfx]</TT>
|
||||
<DD><font color=red><TT><B><I>- TO BE ADDED -</I></B></TT></FONT>
|
||||
<BR>
|
||||
<DT><TT><B>COOKIES</B> = [0|1]</TT>
|
||||
<DD>The general Cookie handling policy can be set either to allow
|
||||
<nobr>(<TT>= 1</TT>)</nobr> or to disallow <nobr>(<TT>= 0</TT>)</nobr>. The
|
||||
default is to disallow cookies.
|
||||
<BR>
|
||||
This setting can be changed at runtime in the <A href="c-MB.htm#Optn"
|
||||
>Menu Options</A>.
|
||||
<BR>
|
||||
<DT><TT><B>RESTRICT_HOST</B> = <I><flags></I> <I><host or domain></I></TT>
|
||||
<DD>Instructs HighWire to refrain from certain HTTP actions to a particular
|
||||
server or a whole domain. If the second parameter starts with a dot
|
||||
("<TT>.</TT>") it will be interpreted as a domain otherwise it's assumed to
|
||||
be as fully qualified host name. Note that there must never be a "http://"
|
||||
befor the host name!
|
||||
<BR>
|
||||
The first argument <I><flags></I> defines the type(s) of action(s).
|
||||
There are two flags available:
|
||||
<BR><TT> C</TT>: </A>don't accept cookies from this
|
||||
server or domain nor send any back
|
||||
<BR><TT> I</TT>: </A>don't load images from this
|
||||
server or domain
|
||||
<BR>Flags may be combined and this variable can be used multiple times for
|
||||
several hosts or domains. Here are some examples:<TT>
|
||||
<BR> RESTRICT_HOST = C .mindshare.de
|
||||
|
||||
#</TT><I> no cookies from this doamin</I><TT>
|
||||
<BR> RESTRICT_HOST = I adserver2.mindshare.de
|
||||
#</TT><I> no images from this server</I><TT>
|
||||
<BR> RESTRICT_HOST = CI .doubleclick.net
|
||||
|
||||
#</TT><I> neither images nor cookies allowed</I>
|
||||
<BR>
|
||||
<DT><TT><B>HTTP_PROXY</B> = <I><proxy-ip></I> <I><port></I></TT>
|
||||
<DD>Defines a proxy server and its port for web access.
|
||||
</DL>
|
||||
|
||||
|
||||
<!----------------------------------------------------------------------------->
|
||||
<H2><A name="Dbgg">Debugging:</A></H2>
|
||||
<DL>
|
||||
<DT><TT><B>LOCAL_WEB</B> = <I><absolute path></I></TT>
|
||||
<DD><font color=red><TT><B><I>- TO BE ADDED -</I></B></TT></FONT>
|
||||
<DT><TT><B>LOGGING</B> = [0|1]</TT>
|
||||
<DD>If set to a non-zero value, HighWire will spit lots of debug messages to
|
||||
<TT>stdout</TT>.<BR>
|
||||
<I><B>Note:</B> If you haven't installed any console window (T-Con,
|
||||
TosWin2, ...) this will lead to several text lines written over the screen.
|
||||
</I><BR>
|
||||
This setting can be changed at runtime in the <A href="c-MB.htm#Optn"
|
||||
>Menu Options</A>.
|
||||
</DL>
|
||||
|
||||
|
||||
<P><A href="#">Goto top</A>
|
||||
</BODY></HTML>
|
||||
Reference in New Issue
Block a user