summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorVincent Sanders <vince@kyllikki.org>2017-06-09 16:28:55 (GMT)
committer Vincent Sanders <vince@kyllikki.org>2017-06-09 16:30:00 (GMT)
commit703427a48612bf98fba599dfcd6e91485efd5b77 (patch)
treebc9df49dd3de746b738aac3ba88c204d9ab0051b /docs
parenta8348f3bc930151bd9aa184c8372c6af0c782730 (diff)
downloadnetsurf-703427a48612bf98fba599dfcd6e91485efd5b77.tar.gz
netsurf-703427a48612bf98fba599dfcd6e91485efd5b77.tar.bz2
Update documentation removing junk and moving to markdown for most text files
Diffstat (limited to 'docs')
-rw-r--r--docs/Doxyfile2388
-rw-r--r--docs/PACKAGING-GTK97
-rw-r--r--docs/UnimplementedJavascript.txt1798
-rw-r--r--docs/building-AmigaCross.md83
-rw-r--r--docs/building-AmigaOS.md129
-rw-r--r--docs/building-Framebuffer.md350
-rw-r--r--docs/building-GTK.md239
-rw-r--r--docs/building-Haiku.md146
-rw-r--r--docs/building-Windows.md203
-rw-r--r--docs/core-window-interface.md677
-rw-r--r--docs/env.sh320
-rwxr-xr-xdocs/gource.sh71
-rw-r--r--docs/ideas/cache.txt178
-rw-r--r--docs/ideas/css-engine.txt381
-rw-r--r--docs/ideas/render-library.txt121
-rw-r--r--docs/mainpage.md91
-rw-r--r--docs/netsurf-fb.1362
-rw-r--r--docs/netsurf-gtk.1281
-rw-r--r--docs/netsurf-libraries.md51
-rw-r--r--docs/netsurf-options.md241
-rw-r--r--docs/quick-start.md111
-rw-r--r--docs/source-object-backing-store.md204
-rw-r--r--docs/unit-testing166
-rw-r--r--docs/updating-duktape.md29
-rw-r--r--docs/using-framebuffer.md207
-rw-r--r--docs/using-monkey.md318
26 files changed, 9242 insertions, 0 deletions
diff --git a/docs/Doxyfile b/docs/Doxyfile
new file mode 100644
index 0000000..f106693
--- a/dev/null
+++ b/docs/Doxyfile
@@ -0,0 +1,2388 @@
+# Doxyfile 1.8.8
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single hash (#) is considered a comment and will be ignored.
+# The format is:
+# TAG = value [value, ...]
+# For lists, items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (\" \").
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all text
+# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
+# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
+# for the list of possible encodings.
+# The default value is: UTF-8.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
+# double-quotes, unless you are using Doxywizard) that should identify the
+# project for which the documentation is generated. This name is used in the
+# title of most generated pages and in a few other places.
+# The default value is: My Project.
+
+PROJECT_NAME = NetSurf
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
+# could be handy for archiving the generated documentation or if some version
+# control system is used.
+
+PROJECT_NUMBER =
+
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer a
+# quick idea about the purpose of the project. Keep the description short.
+
+PROJECT_BRIEF =
+
+# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
+# the documentation. The maximum height of the logo should not exceed 55 pixels
+# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
+# to the output directory.
+
+PROJECT_LOGO =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. If a relative path is
+# entered, it will be relative to the location where doxygen was started. If
+# left blank the current directory will be used.
+
+OUTPUT_DIRECTORY =
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
+# directories (in 2 levels) under the output directory of each output format and
+# will distribute the generated files over these directories. Enabling this
+# option can be useful when feeding doxygen a huge amount of source files, where
+# putting all generated files in the same directory would otherwise causes
+# performance problems for the file system.
+# The default value is: NO.
+
+CREATE_SUBDIRS = NO
+
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
+ALLOW_UNICODE_NAMES = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
+# Ukrainian and Vietnamese.
+# The default value is: English.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
+# descriptions after the members that are listed in the file and class
+# documentation (similar to Javadoc). Set to NO to disable this.
+# The default value is: YES.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
+# description of a member or function before the detailed description
+#
+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+# The default value is: YES.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator that is
+# used to form the text in various listings. Each string in this list, if found
+# as the leading text of the brief description, will be stripped from the text
+# and the result, after processing the whole list, is used as the annotated
+# text. Otherwise, the brief description is used as-is. If left blank, the
+# following values are used ($name is automatically replaced with the name of
+# the entity):The $name class, The $name widget, The $name file, is, provides,
+# specifies, contains, represents, a, an and the.
+
+ABBREVIATE_BRIEF =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# doxygen will generate a detailed section even if there is only a brief
+# description.
+# The default value is: NO.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+# The default value is: NO.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
+# before files name in the file list and in the header files. If set to NO the
+# shortest path that makes the file name unique will be used
+# The default value is: YES.
+
+FULL_PATH_NAMES = YES
+
+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
+# Stripping is only done if one of the specified strings matches the left-hand
+# part of the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the path to
+# strip.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
+# path mentioned in the documentation of a class, which tells the reader which
+# header file to include in order to use a class. If left blank only the name of
+# the header file containing the class definition is used. Otherwise one should
+# specify the list of include paths that are normally passed to the compiler
+# using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
+# less readable) file names. This can be useful is your file systems doesn't
+# support long names like on DOS, Mac, or CD-ROM.
+# The default value is: NO.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
+# first line (until the first dot) of a Javadoc-style comment as the brief
+# description. If set to NO, the Javadoc-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
+
+JAVADOC_AUTOBRIEF = YES
+
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
+# line (until the first dot) of a Qt-style comment as the brief description. If
+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
+# a brief description. This used to be the default behavior. The new default is
+# to treat a multi-line C++ comment block as a detailed description. Set this
+# tag to YES if you prefer the old behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
+# documentation from any documented member that it re-implements.
+# The default value is: YES.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
+# new page for each member. If set to NO, the documentation of a member will be
+# part of the file/class/namespace that contains it.
+# The default value is: NO.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
+# uses this value to replace tabs by spaces in code fragments.
+# Minimum value: 1, maximum value: 16, default value: 4.
+
+TAB_SIZE = 8
+
+# This tag can be used to specify a number of aliases that act as commands in
+# the documentation. An alias has the form:
+# name=value
+# For example adding
+# "sideeffect=@par Side Effects:\n"
+# will allow you to put the command \sideeffect (or @sideeffect) in the
+# documentation, which will result in a user-defined paragraph with heading
+# "Side Effects:". You can put \n's in the value part of an alias to insert
+# newlines.
+
+ALIASES =
+
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding "class=itcl::class"
+# will allow you to use the command class in the itcl::class meaning.
+
+TCL_SUBST =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C. For
+# instance, some of the names that are used will be different. The list of all
+# members will be omitted, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
+# Python sources only. Doxygen will then generate output that is more tailored
+# for that language. For instance, namespaces will be presented as packages,
+# qualified scopes will look different, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources. Doxygen will then generate output that is tailored for Fortran.
+# The default value is: NO.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for VHDL.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it
+# parses. With this tag you can assign which parser to use for a given
+# extension. Doxygen has a built-in mapping, but you can override or extend it
+# using this tag. The format is ext=language, where ext is a file extension, and
+# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
+# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
+# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
+# Fortran. In the later case the parser tries to guess whether the code is fixed
+# or free formatted code, this is the default for Fortran type files), VHDL. For
+# instance to make doxygen treat .inc files as Fortran files (default is PHP),
+# and .f files as C (default is Fortran), use: inc=Fortran f=C.
+#
+# Note For files without extension you can use no_extension as a placeholder.
+#
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
+# the files are not read by doxygen.
+
+EXTENSION_MAPPING =
+
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
+# documentation. See http://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+# The default value is: YES.
+
+MARKDOWN_SUPPORT = YES
+
+# When enabled doxygen tries to link words that correspond to documented
+# classes, or namespaces to their corresponding documentation. Such a link can
+# be prevented in individual cases by by putting a % sign in front of the word
+# or globally by setting AUTOLINK_SUPPORT to NO.
+# The default value is: YES.
+
+AUTOLINK_SUPPORT = YES
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should set this
+# tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string);
+# versus func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+# The default value is: NO.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+# The default value is: NO.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
+# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
+# will parse them like normal C++ but will assume all classes use public instead
+# of private inheritance when no explicit protection keyword is present.
+# The default value is: NO.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate
+# getter and setter methods for a property. Setting this option to YES will make
+# doxygen to replace the get and set methods by a property in the documentation.
+# This will only work if the methods are indeed getting or setting a simple
+# type. If this is not the case, or you want to show the methods anyway, you
+# should set this option to NO.
+# The default value is: YES.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+# The default value is: NO.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES to allow class member groups of the same type
+# (for instance a group of public functions) to be put as a subgroup of that
+# type (e.g. under the Public Functions section). Set it to NO to prevent
+# subgrouping. Alternatively, this can be done per class using the
+# \nosubgrouping command.
+# The default value is: YES.
+
+SUBGROUPING = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# Note that this feature does not work in combination with
+# SEPARATE_MEMBER_PAGES.
+# The default value is: NO.
+
+INLINE_GROUPED_CLASSES = NO
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
+# with only public data fields or simple typedef fields will be shown inline in
+# the documentation of the scope in which they are defined (i.e. file,
+# namespace, or group documentation), provided this scope is documented. If set
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
+# Man pages) or section (for LaTeX and RTF).
+# The default value is: NO.
+
+INLINE_SIMPLE_STRUCTS = NO
+
+# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
+# enum is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically be
+# useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+# The default value is: NO.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
+# cache is used to resolve symbols given their name and scope. Since this can be
+# an expensive process and often the same symbol appears multiple times in the
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
+# doxygen will become slower. If the cache is too large, memory is wasted. The
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
+# symbols. At the end of a run doxygen will report the cache usage and suggest
+# the optimal cache size from a speed point of view.
+# Minimum value: 0, maximum value: 9, default value: 0.
+
+LOOKUP_CACHE_SIZE = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available. Private
+# class members and static file members will be hidden unless the
+# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
+# Note: This will also disable the warnings about undocumented members that are
+# normally produced when WARNINGS is set to YES.
+# The default value is: NO.
+
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
+# be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIVATE = YES
+
+# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
+# scope will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PACKAGE = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
+# included in the documentation.
+# The default value is: NO.
+
+EXTRACT_STATIC = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
+# locally in source files will be included in the documentation. If set to NO
+# only classes defined in header files are included. Does not have any effect
+# for Java sources.
+# The default value is: YES.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local methods,
+# which are defined in the implementation section but not in the interface are
+# included in the documentation. If set to NO only methods in the interface are
+# included.
+# The default value is: NO.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base name of
+# the file that contains the anonymous namespace. By default anonymous namespace
+# are hidden.
+# The default value is: NO.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO these
+# members will be included in the various overviews, but no documentation
+# section is generated. This option has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy. If set
+# to NO these classes will be included in the various overviews. This option has
+# no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
+# (class|struct|union) declarations. If set to NO these declarations will be
+# included in the documentation.
+# The default value is: NO.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
+# documentation blocks found inside the body of a function. If set to NO these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation that is typed after a
+# \internal command is included. If the tag is set to NO then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
+# names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+# The default value is: system dependent.
+
+CASE_SENSE_NAMES = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES the
+# scope will be hidden.
+# The default value is: NO.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
+SHOW_GROUPED_MEMB_INC = NO
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
+# files with double quotes in the documentation rather than with sharp brackets.
+# The default value is: NO.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
+# (detailed) documentation of file and class members alphabetically by member
+# name. If set to NO the members will appear in declaration order.
+# The default value is: YES.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
+# The default value is: NO.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
+# (brief and detailed) documentation of class members so that constructors and
+# destructors are listed first. If set to NO the constructors will appear in the
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
+# member documentation.
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
+# detailed member documentation.
+# The default value is: NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
+# of group names into alphabetical order. If set to NO the group names will
+# appear in their defined order.
+# The default value is: NO.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
+# fully-qualified names, including namespaces. If set to NO, the class list will
+# be sorted only by class name, not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the alphabetical
+# list.
+# The default value is: NO.
+
+SORT_BY_SCOPE_NAME = NO
+
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
+# type resolution of all parameters of a function it will reject a match between
+# the prototype and the implementation of a member function even if there is
+# only one candidate or it is obvious which candidate to choose by doing a
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
+# accept a match between prototype and implementation in such cases.
+# The default value is: NO.
+
+STRICT_PROTO_MATCHING = NO
+
+# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
+# todo list. This list is created by putting \todo commands in the
+# documentation.
+# The default value is: YES.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
+# test list. This list is created by putting \test commands in the
+# documentation.
+# The default value is: YES.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
+# list. This list is created by putting \bug commands in the documentation.
+# The default value is: YES.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
+# the deprecated list. This list is created by putting \deprecated commands in
+# the documentation.
+# The default value is: YES.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
+# ... \endcond blocks.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
+# initial value of a variable or macro / define can have for it to appear in the
+# documentation. If the initializer consists of more lines than specified here
+# it will be hidden. Use a value of 0 to hide initializers completely. The
+# appearance of the value of individual variables and macros / defines can be
+# controlled using \showinitializer or \hideinitializer command in the
+# documentation regardless of this setting.
+# Minimum value: 0, maximum value: 10000, default value: 30.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
+# the bottom of the documentation of classes and structs. If set to YES the list
+# will mention the files that were used to generate the documentation.
+# The default value is: YES.
+
+SHOW_USED_FILES = YES
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
+# will remove the Files entry from the Quick Index and from the Folder Tree View
+# (if specified).
+# The default value is: YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
+# page. This will remove the Namespaces entry from the Quick Index and from the
+# Folder Tree View (if specified).
+# The default value is: YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command command input-file, where command is the value of the
+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
+# by doxygen. Whatever the program writes to standard output is used as the file
+# version. For an example see the documentation.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
+# by doxygen. The layout file controls the global structure of the generated
+# output files in an output format independent way. To create the layout file
+# that represents doxygen's defaults, run doxygen with the -l option. You can
+# optionally specify a file name after the option, if omitted DoxygenLayout.xml
+# will be used as the name of the layout file.
+#
+# Note that if you run doxygen from a directory containing a file called
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
+# tag is left empty.
+
+LAYOUT_FILE =
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
+# the reference definitions. This must be a list of .bib files. The .bib
+# extension is automatically appended if omitted. This requires the bibtex tool
+# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
+# For LaTeX the style of the bibliography can be controlled using
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
+# search path. See also \cite for info how to create references.
+
+CITE_BIB_FILES =
+
+#---------------------------------------------------------------------------
+# Configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated to
+# standard output by doxygen. If QUIET is set to YES this implies that the
+# messages are off.
+# The default value is: NO.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
+# this implies that the warnings are on.
+#
+# Tip: Turn warnings on while writing the documentation.
+# The default value is: YES.
+
+WARNINGS = YES
+
+# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
+# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
+# will automatically be disabled.
+# The default value is: YES.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some parameters
+# in a documented function, or documenting parameters that don't exist or using
+# markup commands wrongly.
+# The default value is: YES.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO doxygen will only warn about wrong or incomplete parameter
+# documentation, but not about the absence of documentation.
+# The default value is: NO.
+
+WARN_NO_PARAMDOC = YES
+
+# The WARN_FORMAT tag determines the format of the warning messages that doxygen
+# can produce. The string should contain the $file, $line, and $text tags, which
+# will be replaced by the file and line number from which the warning originated
+# and the warning text. Optionally the format may contain $version, which will
+# be replaced by the version of the file (if it could be obtained via
+# FILE_VERSION_FILTER)
+# The default value is: $file:$line: $text.
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning and error
+# messages should be written. If left blank the output is written to standard
+# error (stderr).
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag is used to specify the files and/or directories that contain
+# documented source files. You may enter file names like myfile.cpp or
+# directories like /usr/src/myproject. Separate the files or directories with
+# spaces.
+# Note: If this tag is empty the current directory is searched.
+
+INPUT = docs \
+ docs/env.sh \
+ docs/UnimplementedJavascript.txt \
+ frontends/amiga \
+ frontends/amiga/stringview \
+ frontends/atari \
+ frontends/atari/plot \
+ frontends/beos \
+ frontends/framebuffer \
+ frontends/framebuffer/fbtk \
+ frontends/gtk \
+ frontends/monkey \
+ frontends/riscos \
+ frontends/riscos/configure \
+ frontends/riscos/gui \
+ frontends/riscos/content-handlers \
+ frontends/riscos/templates \
+ frontends/riscos/scripts \
+ frontends/windows \
+ include/netsurf \
+ render \
+ desktop \
+ content \
+ content/fetchers \
+ content/handlers/image \
+ content/handlers/css \
+ content/handlers/javascript \
+ content/handlers/javascript/duktape \
+ utils \
+ utils/http
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see: http://www.gnu.org/software/libiconv) for the list of
+# possible encodings.
+# The default value is: UTF-8.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank the
+# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
+# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
+# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
+# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
+# *.qsf, *.as and *.js.
+
+FILE_PATTERNS = *.c \
+ *.h \
+ *.y \
+ *.l \
+ *.cpp \
+ *.m \
+ *.md
+
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
+
+RECURSIVE = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+#
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
+# from the input.
+# The default value is: NO.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories.
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories use the pattern */test/*
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or directories
+# that contain example code fragments that are included (see the \include
+# command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank all
+# files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude commands
+# irrespective of the value of the RECURSIVE tag.
+# The default value is: NO.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or directories
+# that contain images that are to be included in the documentation (see the
+# \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command:
+#
+# <filter> <input-file>
+#
+# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
+# name of an input file. Doxygen will then use the output that the filter
+# program writes to standard output. If FILTER_PATTERNS is specified, this tag
+# will be ignored.
+#
+# Note that the filter must not add or remove lines; it is applied before the
+# code is scanned, but not when the output code is generated. If lines are added
+# or removed, the anchors will not be placed correctly.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form: pattern=filter
+# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
+# patterns match the file name, INPUT_FILTER is applied.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER ) will also be used to filter the input files that are used for
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# The default value is: NO.
+
+FILTER_SOURCE_FILES = NO
+
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
+# it is also possible to disable source filtering for a specific pattern using
+# *.ext= (so without naming a filter).
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
+
+FILTER_SOURCE_PATTERNS =
+
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page
+# (index.html). This can be useful if you have a project on for instance GitHub
+# and want to reuse the introduction page also for the doxygen output.
+
+USE_MDFILE_AS_MAINPAGE = mainpage.md
+
+#---------------------------------------------------------------------------
+# Configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
+# generated. Documented entities will be cross-referenced with these sources.
+#
+# Note: To get rid of all source code in the generated output, make sure that
+# also VERBATIM_HEADERS is set to NO.
+# The default value is: NO.
+
+SOURCE_BROWSER = YES
+
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
+# classes and enums directly into the documentation.
+# The default value is: NO.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
+# special comment blocks from generated source code fragments. Normal C, C++ and
+# Fortran comments will always remain visible.
+# The default value is: YES.
+
+STRIP_CODE_COMMENTS = NO
+
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
+# function all documented functions referencing it will be listed.
+# The default value is: NO.
+
+REFERENCED_BY_RELATION = YES
+
+# If the REFERENCES_RELATION tag is set to YES then for each documented function
+# all documented entities called/used by that function will be listed.
+# The default value is: NO.
+
+REFERENCES_RELATION = YES
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
+# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
+# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
+# link to the documentation.
+# The default value is: YES.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+# source code will show a tooltip with additional information such as prototype,
+# brief description and links to the definition and documentation. Since this
+# will make the HTML file larger and loading of large files a bit slower, you
+# can opt to disable this feature.
+# The default value is: YES.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+SOURCE_TOOLTIPS = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code will
+# point to the HTML generated by the htags(1) tool instead of doxygen built-in
+# source browser. The htags tool is part of GNU's global source tagging system
+# (see http://www.gnu.org/software/global/global.html). You will need version
+# 4.8.6 or higher.
+#
+# To use it do the following:
+# - Install the latest version of global
+# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
+# - Make sure the INPUT points to the root of the source tree
+# - Run doxygen as normal
+#
+# Doxygen will invoke htags (and that will in turn invoke gtags), so these
+# tools must be available from the command line (i.e. in the search path).
+#
+# The result: instead of the source browser generated by doxygen, the links to
+# source code will now point to the output of htags.
+# The default value is: NO.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
+# verbatim copy of the header file for each class for which an include is
+# specified. Set to NO to disable this.
+# See also: Section \class.
+# The default value is: YES.
+
+VERBATIM_HEADERS = YES
+
+# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the
+# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
+# cost of reduced performance. This can be particularly helpful with template
+# rich C++ code for which doxygen's built-in parser lacks the necessary type
+# information.
+# Note: The availability of this option depends on whether or not doxygen was
+# compiled with the --with-libclang option.
+# The default value is: NO.
+
+CLANG_ASSISTED_PARSING = NO
+
+# If clang assisted parsing is enabled you can provide the compiler with command
+# line options that you would normally use when invoking the compiler. Note that
+# the include paths will already be set by doxygen for the files and directories
+# specified with INPUT and INCLUDE_PATH.
+# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
+
+CLANG_OPTIONS =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
+# compounds will be generated. Enable this if the project contains a lot of
+# classes, structs, unions or interfaces.
+# The default value is: YES.
+
+ALPHABETICAL_INDEX = NO
+
+# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
+# which the alphabetical index list will be split.
+# Minimum value: 1, maximum value: 20, default value: 5.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all classes will
+# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
+# can be used to specify a prefix (or a list of prefixes) that should be ignored
+# while generating the index headers.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
+# The default value is: YES.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_OUTPUT = codedocs
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
+# generated HTML page (for example: .htm, .php, .asp).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
+# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
+# sheet that is used by each HTML page. It can be used to fine-tune the look of
+# the HTML output. If left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_STYLESHEET =
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# cascading style sheets that are included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefor more robust against future updates.
+# Doxygen will copy the style sheet files to the output directory.
+# Note: The order of the extra stylesheet files is of importance (e.g. the last
+# stylesheet in the list overrules the setting of the previous ones in the
+# list). For an example see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_STYLESHEET =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_FILES =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the stylesheet and background images according to
+# this color. Hue is specified as an angle on a colorwheel, see
+# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
+# purple, and 360 is red again.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
+# in the HTML output. For a value of 0 the output will use grayscales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting this
+# to NO can help when comparing the output of multiple runs.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_TIMESTAMP = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files will be
+# generated that can be used as input for Apple's Xcode 3 integrated development
+# environment (see: http://developer.apple.com/tools/xcode/), introduced with
+# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
+# Makefile in the HTML output directory. Running make will produce the docset in
+# that directory and running make install will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
+# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
+# for more information.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_DOCSET = NO
+
+# This tag determines the name of the docset feed. A documentation feed provides
+# an umbrella under which multiple documentation sets from a single provider
+# (such as a company or product suite) can be grouped.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# This tag specifies a string that should uniquely identify the documentation
+# set bundle. This should be a reverse domain-name style string, e.g.
+# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
+# Windows.
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_HTMLHELP = NO
+
+# The CHM_FILE tag can be used to specify the file name of the resulting .chm
+# file. You can add a path in front of the file if the result should not be
+# written to the html output directory.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_FILE =
+
+# The HHC_LOCATION tag can be used to specify the location (absolute path
+# including file name) of the HTML help compiler ( hhc.exe). If non-empty
+# doxygen will try to run the HTML help compiler on the generated index.hhp.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+HHC_LOCATION =
+
+# The GENERATE_CHI flag controls if a separate .chi index file is generated (
+# YES) or that it should be included in the master .chm file ( NO).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+GENERATE_CHI = NO
+
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_INDEX_ENCODING =
+
+# The BINARY_TOC flag controls whether a binary table of contents is generated (
+# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
+# enables the Previous and Next buttons.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+TOC_EXPAND = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
+# (.qch) of the generated HTML documentation.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
+# the file name of the resulting .qch file. The path specified is relative to
+# the HTML output folder.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
+# Help Project output. For more information please see Qt Help Project / Virtual
+# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
+# folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_SECT_FILTER_ATTRS =
+
+# The QHG_LOCATION tag can be used to specify the location of Qt's
+# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
+# generated .qhp file.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHG_LOCATION =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they form an Eclipse help plugin. To
+# install this plugin and make it available under the help contents menu in
+# Eclipse, the contents of the directory containing the HTML and XML files needs
+# to be copied into the plugins directory of eclipse. The name of the directory
+# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
+# After copying Eclipse needs to be restarted before the help appears.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the Eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have this
+# name. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+DISABLE_INDEX = NO
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information. If the tag
+# value is set to YES, a side panel will be generated containing a tree-like
+# index structure (just like the one that is generated for HTML Help). For this
+# to work a browser that supports JavaScript, DHTML, CSS and frames is required
+# (i.e. any modern browser). Windows users are probably better off using the
+# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine-tune the look of the index. As an example, the default style
+# sheet generated by doxygen has an example that shows how to put an image at
+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
+# the same information as the tab index, you could consider setting
+# DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_TREEVIEW = NO
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+ENUM_VALUES_PER_LINE = 4
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
+# to set the initial width (in pixels) of the frame in which the tree is shown.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+TREEVIEW_WIDTH = 250
+
+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. When you change the font size after a successful
+# doxygen run you need to manually remove any form_*.png images from the HTML
+# output directory to force them to be regenerated.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_FONTSIZE = 10
+
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are not
+# supported properly for IE 6.0, but are supported on all modern browsers.
+#
+# Note that when changing this option you need to delete any form_*.png files in
+# the HTML output directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_TRANSPARENT = YES
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# http://www.mathjax.org) which uses client side Javascript for the rendering
+# instead of using prerendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+USE_MATHJAX = NO
+
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. See the MathJax site (see:
+# http://docs.mathjax.org/en/latest/output.html) for more details.
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility), NativeMML (i.e. MathML) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from http://www.mathjax.org before deployment.
+# The default value is: http://cdn.mathjax.org/mathjax/latest.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_EXTENSIONS =
+
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
+# the HTML output. The underlying search engine uses javascript and DHTML and
+# should work on any modern browser. Note that when using HTML help
+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
+# there is already a search function so this one should typically be disabled.
+# For large projects the javascript based search engine can be slow, then
+# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
+# search using the keyboard; to jump to the search box use <access key> + S
+# (what the <access key> is depends on the OS and browser, but it is typically
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
+# key> to jump into the search results window, the results can be navigated
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
+# to select a filter and <Enter> or <escape> to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+SEARCHENGINE = NO
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a web server instead of a web client using Javascript. There
+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
+# setting. When disabled, doxygen will generate a PHP script for searching and
+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
+# and searching needs to be provided by external tools. See the section
+# "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SERVER_BASED_SEARCH = NO
+
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
+# search results.
+#
+# Doxygen ships with an example indexer ( doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/).
+#
+# See the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will return the search results when EXTERNAL_SEARCH is enabled.
+#
+# Doxygen ships with an example indexer ( doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/). See the section "External Indexing and
+# Searching" for details.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHENGINE_URL =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
+# The default value is: YES.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked.
+#
+# Note that when enabling USE_PDFLATEX this option is only used for generating
+# bitmaps for formulas in the HTML output, but not in the Makefile that is
+# written to the output directory.
+# The default file is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
+# index for LaTeX.
+# The default file is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used by the
+# printer.
+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
+# 14 inches) and executive (7.25 x 10.5 inches).
+# The default value is: a4.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PAPER_TYPE = a4wide
+
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
+# that should be included in the LaTeX output. To get the times font for
+# instance you can specify
+# EXTRA_PACKAGES=times
+# If left blank no extra packages will be included.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
+# generated LaTeX document. The header should contain everything until the first
+# chapter. If it is left blank doxygen will generate a standard header. See
+# section "Doxygen usage" for information on how to let doxygen write the
+# default header to a separate file.
+#
+# Note: Only use a user-defined header if you know what you are doing! The
+# following commands have a special meaning inside the header: $title,
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
+# $projectbrief, $projectlogo. Doxygen will replace $title with the empy string,
+# for the replacement values of the other commands the user is refered to
+# HTML_HEADER.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HEADER =
+
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
+# generated LaTeX document. The footer should contain everything after the last
+# chapter. If it is left blank doxygen will generate a standard footer. See
+# LATEX_HEADER for more information on how to generate a default footer and what
+# special commands can be used inside the footer.
+#
+# Note: Only use a user-defined footer if you know what you are doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_FOOTER =
+
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_FILES =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
+# contain links (just like the HTML output) instead of page references. This
+# makes the output suitable for online browsing using a PDF viewer.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PDF_HYPERLINKS = NO
+
+# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
+# the PDF file directly from the LaTeX files. Set this option to YES to get a
+# higher quality PDF documentation.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+USE_PDFLATEX = NO
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
+# command to the generated LaTeX files. This will instruct LaTeX to keep running
+# if errors occur, instead of asking the user for help. This option is also used
+# when generating formulas in HTML.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BATCHMODE = NO
+
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HIDE_INDICES = NO
+
+# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
+# code with syntax highlighting in the LaTeX output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_SOURCE_CODE = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. See
+# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
+# The default value is: plain.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BIB_STYLE = plain
+
+#---------------------------------------------------------------------------
+# Configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
+# RTF output is optimized for Word 97 and may not look too pretty with other RTF
+# readers/editors.
+# The default value is: NO.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: rtf.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
+# contain hyperlink fields. The RTF file will contain links (just like the HTML
+# output) instead of page references. This makes the output suitable for online
+# browsing using Word or some other Word compatible readers that support those
+# fields.
+#
+# Note: WordPad (write) and others do not support links.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's config
+# file, i.e. a series of assignments. You only have to provide replacements,
+# missing definitions are set to their default value.
+#
+# See also section "Doxygen usage" for information on how to generate the
+# default style sheet that doxygen normally uses.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an RTF document. Syntax is
+# similar to doxygen's config file. A template extensions file can be generated
+# using doxygen -e rtf extensionFile.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it. A directory man3 will be created inside the directory specified by
+# MAN_OUTPUT.
+# The default directory is: man.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to the generated
+# man pages. In case the manual section does not start with a number, the number
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
+# optional.
+# The default value is: .3.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_EXTENSION = .3
+
+# The MAN_SUBDIR tag determines the name of the directory created within
+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
+# MAN_EXTENSION with the initial . removed.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_SUBDIR =
+
+# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
+# will generate one additional man file for each entity documented in the real
+# man page(s). These additional files only source the real man page, but without
+# them the man command would be unable to find the correct page.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
+# captures the structure of the code including all documentation.
+# The default value is: NO.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_OUTPUT = xml
+
+# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
+# listings (including syntax highlighting and cross-referencing information) to
+# the XML output. Note that enabling this will significantly increase the size
+# of the XML output.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
+
+GENERATE_DOCBOOK = NO
+
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
+# front of it.
+# The default directory is: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_OUTPUT = docbook
+
+# If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the
+# program listings (including syntax highlighting and cross-referencing
+# information) to the DOCBOOK output. Note that enabling this will significantly
+# increase the size of the DOCBOOK output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_PROGRAMLISTING = NO
+
+#---------------------------------------------------------------------------
+# Configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
+# Definitions (see http://autogen.sf.net) file that captures the structure of
+# the code including all documentation. Note that this feature is still
+# experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
+# file that captures the structure of the code including all documentation.
+#
+# Note that this feature is still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
+# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
+# output from the Perl module output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
+# formatted so it can be parsed by a human reader. This is useful if you want to
+# understand what is going on. On the other hand, if this tag is set to NO the
+# size of the Perl module output will be much smaller and Perl will parse it
+# just the same.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file are
+# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
+# so different doxyrules.make files included by the same Makefile don't
+# overwrite each other's variables.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
+# C-preprocessor directives found in the sources and include files.
+# The default value is: YES.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
+# in the source code. If set to NO only conditional compilation will be
+# performed. Macro expansion can be done in a controlled way by setting
+# EXPAND_ONLY_PREDEF to YES.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
+# the macro expansion is limited to the macros specified with the PREDEFINED and
+# EXPAND_AS_DEFINED tags.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES the includes files in the
+# INCLUDE_PATH will be searched if a #include is found.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by the
+# preprocessor.
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will be
+# used.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that are
+# defined before the preprocessor is started (similar to the -D option of e.g.
+# gcc). The argument of the tag is a list of macros of the form: name or
+# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
+# is assumed. To prevent a macro definition from being undefined via #undef or
+# recursively expanded use the := operator instead of the = operator.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+PREDEFINED = gtk \
+ WITH_THEME_INSTALL
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
+# tag can be used to specify a list of macro names that should be expanded. The
+# macro definition that is found in the sources will be used. Use the PREDEFINED
+# tag if you want to use a different macro definition that overrules the
+# definition found in the source code.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
+# remove all references to function-like macros that are alone on a line, have
+# an all uppercase name, and do not end with a semicolon. Such function macros
+# are typically used for boiler-plate code, and will confuse the parser if not
+# removed.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES tag can be used to specify one or more tag files. For each tag
+# file the location of the external documentation should be added. The format of
+# a tag file without this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where loc1 and loc2 can be relative or absolute paths or URLs. See the
+# section "Linking to external documentation" for more information about the use
+# of tag files.
+# Note: Each tag file must have a unique name (where the name does NOT include
+# the path). If a tag file is not located in the directory in which doxygen is
+# run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
+# tag file that is based on the input files it reads. See section "Linking to
+# external documentation" for more information about the usage of tag files.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
+# class index. If set to NO only the inherited external classes will be listed.
+# The default value is: NO.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
+# the modules index. If set to NO, only the current project's groups will be
+# listed.
+# The default value is: YES.
+
+EXTERNAL_GROUPS = YES
+
+# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
+# the related pages index. If set to NO, only the current project's pages will
+# be listed.
+# The default value is: YES.
+
+EXTERNAL_PAGES = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of 'which perl').
+# The default file (with absolute path) is: /usr/bin/perl.
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
+# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
+# NO turns the diagrams off. Note that this option also works with HAVE_DOT
+# disabled, but it is recommended to install and use dot, since it yields more
+# powerful graphs.
+# The default value is: YES.
+
+CLASS_DIAGRAMS = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see:
+# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH =
+
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
+
+DIA_PATH =
+
+# If set to YES, the inheritance and collaboration graphs will hide inheritance
+# and usage relations if the target is undocumented or is not a class.
+# The default value is: YES.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz (see:
+# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
+# Bell Labs. The other options in this section have no effect if this option is
+# set to NO
+# The default value is: YES.
+
+HAVE_DOT = YES
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 doxygen will base this on the number of
+# processors available in the system. You can set it explicitly to a value
+# larger than 0 to get control over the balance between CPU load and processing
+# speed.
+# Minimum value: 0, maximum value: 32, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_NUM_THREADS = 0
+
+# When you want a differently looking font in the dot files that doxygen
+# generates you can specify the font name using DOT_FONTNAME. You need to make
+# sure dot is able to find the font, which can be done by putting it in a
+# standard location or by setting the DOTFONTPATH environment variable or by
+# setting DOT_FONTPATH to the directory containing the font.
+# The default value is: Helvetica.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTNAME = Helvetica
+
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
+# dot graphs.
+# Minimum value: 4, maximum value: 24, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTSIZE = 10
+
+# By default doxygen will tell dot to use the default font as specified with
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
+# the path where dot can find it using this tag.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
+# each documented class showing the direct and indirect inheritance relations.
+# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
+# graph for each documented class showing the direct and indirect implementation
+# dependencies (inheritance, containment, and class references variables) of the
+# class with other documented classes.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LOOK = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LIMIT_NUM_FIELDS = 10
+
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+TEMPLATE_RELATIONS = NO
+
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
+# YES then doxygen will generate a graph for each documented file showing the
+# direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDE_GRAPH = YES
+
+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
+# set to YES then doxygen will generate a graph for each documented file showing
+# the direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable call graphs for selected
+# functions only using the \callgraph command.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALL_GRAPH = YES
+
+# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable caller graphs for selected
+# functions only using the \callergraph command.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALLER_GRAPH = YES
+
+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
+# hierarchy of all classes instead of a textual one.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
+# dependencies a directory has on other directories in a graphical way. The
+# dependency relations are determined by the #include relations between the
+# files in the directories.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot.
+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
+# to make the SVG files visible in IE 9+ (other browsers do not have this
+# requirement).
+# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
+# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
+# gif:cairo:gd, gif:gd, gif:gd:gd and svg.
+# The default value is: png.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_IMAGE_FORMAT = svg
+
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+#
+# Note that this requires a modern browser other than Internet Explorer. Tested
+# and working are Firefox, Chrome, Safari, and Opera.
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
+# the SVG files visible. Older versions of IE do not have SVG support.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INTERACTIVE_SVG = YES
+
+# The DOT_PATH tag can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the \dotfile
+# command).
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOTFILE_DIRS =
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
+
+MSCFILE_DIRS =
+
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
+# contain dia files that are included in the documentation (see the \diafile
+# command).
+
+DIAFILE_DIRS =
+
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
+# path where java can find the plantuml.jar file. If left blank, it is assumed
+# PlantUML is not used or called during a preprocessing step. Doxygen will
+# generate a warning when it encounters a \startuml command in this case and
+# will not generate output for the diagram.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+PLANTUML_JAR_PATH =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
+# that will be shown in the graph. If the number of nodes in a graph becomes
+# larger than this value, doxygen will truncate the graph, which is visualized
+# by representing a node as a red box. Note that doxygen if the number of direct
+# children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
+# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+# Minimum value: 0, maximum value: 10000, default value: 50.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_GRAPH_MAX_NODES = 400
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
+# generated by dot. A depth value of 3 means that only nodes reachable from the
+# root by following a path via at most 3 edges will be shown. Nodes that lay
+# further from the root node will be omitted. Note that setting this option to 1
+# or 2 may greatly reduce the computation time needed for large code bases. Also
+# note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+# Minimum value: 0, maximum value: 1000, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not seem
+# to support this out of the box.
+#
+# Warning: Depending on the platform used, enabling this option may lead to
+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
+# read).
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10) support
+# this, this feature is disabled by default.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_MULTI_TARGETS = YES
+
+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
+# explaining the meaning of the various boxes and arrows in the dot generated
+# graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
+# files that are used to generate the various graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_CLEANUP = YES
diff --git a/docs/PACKAGING-GTK b/docs/PACKAGING-GTK
new file mode 100644
index 0000000..8f67522
--- a/dev/null
+++ b/docs/PACKAGING-GTK
@@ -0,0 +1,97 @@
+--------------------------------------------------------------------------------
+ Packaging suggestions for NetSurf 30 July 2008
+--------------------------------------------------------------------------------
+
+ This document lays out some suggestions for people interested in packaging
+ NetSurf for UNIX-like OSes.
+
+ We consider the Debian (and thus Ubuntu) packages excellent examples to
+ crib from. They do everything right.
+
+
+ Building NetSurf
+==================
+
+ You should change Makefile.config to be specific (rather than rely on AUTO)
+ for the libraries and functionality you want to include. This will help
+ your packages be consistent. Also remember that you can turn off
+ functionality such as PDF export, RISC OS Sprite support, SVG rendering etc.
+ from here should you require a smaller, lighter build.
+
+
+ Launching NetSurf
+===================
+
+ The GTK port of NetSurf requires access to some resources at run time.
+ These are stored in gtk/res/ in the source tree. Some of these files are
+ symlinks into the !NetSurf directory, which is the application container
+ for the native RISC OS build. None of the other files from the !NetSurf
+ directory are required - the symlinks are used only as a way of making
+ checkouts smaller and making sure changes to one set of resources updates
+ the other.
+
+ The binary that the build system produces is called "nsgtk". There is also
+ a shell script called "netsurf" that will set up the environment and launch
+ the nsgtk binary. Do not ship this shell script with your package. It is
+ included only as a convience for launching NetSurf from the build tree.
+ Instead, you should move nsgtk to /usr/bin/netsurf (or wherever your
+ distribution's packaging policy suggests) and copy the contents of
+ gtk/res/ (dereferencing the symlinks, obviously) to /usr/share/netsurf (or
+ wherever your packaging policy suggests).
+
+ You will need to tell NetSurf where to find its run time loaded
+ resources. NetSurf searches three locations by default when trying
+ to load them, in this order:
+
+ 1. ~/.netsurf/
+
+ This entry allows the user some flexibility in changing what
+ resources NetSurf uses by placing resources in their home
+ directory.
+
+ 2. $NETSURFRES/
+
+ This entry allows the user or packager to control resource
+ aquisition through the environment. This entry is how the
+ developer launcher script controls resource location.
+
+ 3. NETSURF_GTK_RES_PATH option
+
+ This location is controlled by the option in Makefile.config
+ (defaulting to ${PREFIX}/share/netsurf/ ). This configuration
+ is the recommended way for packagers to change the location
+ NetSurf finds external resources. The first path element of the
+ NETSURF_GTK_RES_PATH option is used in the install target as
+ the destination for installed resources.
+
+ User agent string
+===================
+
+ You may also want to change NetSurf's user agent string to include the
+ name of your distribution. The user agent string is build by a function
+ kept in utils/useragent.c - you'll want to change the macro called
+ NETSURF_UA_FORMAT_STRING. It's processed via sprintf, so keep that in
+ mind when changing it. The first two printf parameters are major and minor
+ version numbers, the second two are OS name (uname -s) and architecture
+ (uname -m). You might want change this to something like:
+
+ "NetSurf/%d.%d (%s; %s; Debian GNU/Linux)"
+
+ or similar. Please don't be tempted to mention Mozilla or similar - let's
+ let that lie die.
+
+
+ Home page URL
+===============
+
+ If the user hasn't specified a home page URL in their Preferences, NetSurf
+ defaults to a "portal" welcome page at about:netsurf - if you wish to
+ change this, you can do so by overriding the NETSURF_HOMEPAGE URL in
+ Makefile.config.
+
+
+ If you make significant changes to NetSurf in your package, please ask your
+ users to report bugs to your bug tracker, not ours. We'd also be interested
+ in seeing the diffs for these changes - we may be able to integrate them
+ to make your job easier in future.
+
diff --git a/docs/UnimplementedJavascript.txt b/docs/UnimplementedJavascript.txt
new file mode 100644
index 0000000..1b851b8
--- a/dev/null
+++ b/docs/UnimplementedJavascript.txt
@@ -0,0 +1,1798 @@
+/** \page unimplemented Unimplemented javascript bindings
+This is a list of all the binding methods, getters and setters without an implementation in a binding.
+
+method ApplicationCache::abort();\n
+getter ApplicationCache::oncached(user);\n
+setter ApplicationCache::oncached(user);\n
+getter ApplicationCache::onchecking(user);\n
+setter ApplicationCache::onchecking(user);\n
+getter ApplicationCache::ondownloading(user);\n
+setter ApplicationCache::ondownloading(user);\n
+getter ApplicationCache::onerror(user);\n
+setter ApplicationCache::onerror(user);\n
+getter ApplicationCache::onnoupdate(user);\n
+setter ApplicationCache::onnoupdate(user);\n
+getter ApplicationCache::onobsolete(user);\n
+setter ApplicationCache::onobsolete(user);\n
+getter ApplicationCache::onprogress(user);\n
+setter ApplicationCache::onprogress(user);\n
+getter ApplicationCache::onupdateready(user);\n
+setter ApplicationCache::onupdateready(user);\n
+getter ApplicationCache::status(unsigned short);\n
+method ApplicationCache::swapCache();\n
+method ApplicationCache::update();\n
+getter Attr::localName(string);\n
+getter Attr::namespaceURI(string);\n
+getter Attr::name(string);\n
+getter Attr::nodeValue(string);\n
+setter Attr::nodeValue(string);\n
+getter Attr::ownerElement(user);\n
+getter Attr::prefix(string);\n
+getter Attr::specified(boolean);\n
+getter Attr::textContent(string);\n
+setter Attr::textContent(string);\n
+getter Attr::value(string);\n
+setter Attr::value(string);\n
+getter AudioTrack::enabled(boolean);\n
+setter AudioTrack::enabled(boolean);\n
+getter AudioTrack::id(string);\n
+getter AudioTrack::kind(string);\n
+getter AudioTrack::label(string);\n
+getter AudioTrack::language(string);\n
+method AudioTrackList::getTrackById();\n
+getter AudioTrackList::length(unsigned long);\n
+getter AudioTrackList::onaddtrack(user);\n
+setter AudioTrackList::onaddtrack(user);\n
+getter AudioTrackList::onchange(user);\n
+setter AudioTrackList::onchange(user);\n
+getter AudioTrackList::onremovetrack(user);\n
+setter AudioTrackList::onremovetrack(user);\n
+getter AutocompleteErrorEvent::reason(user);\n
+getter BarProp::visible(boolean);\n
+getter BeforeUnloadEvent::returnValue(string);\n
+setter BeforeUnloadEvent::returnValue(string);\n
+method BroadcastChannel::close();\n
+getter BroadcastChannel::name(string);\n
+getter BroadcastChannel::onmessage(user);\n
+setter BroadcastChannel::onmessage(user);\n
+method BroadcastChannel::postMessage();\n
+method CanvasGradient::addColorStop();\n
+method CanvasPattern::setTransform();\n
+method CanvasProxy::setContext();\n
+method CanvasRenderingContext2D::addHitRegion();\n
+method CanvasRenderingContext2D::arc();\n
+method CanvasRenderingContext2D::arcTo();\n
+method CanvasRenderingContext2D::beginPath();\n
+method CanvasRenderingContext2D::bezierCurveTo();\n
+getter CanvasRenderingContext2D::canvas(user);\n
+method CanvasRenderingContext2D::clearHitRegions();\n
+method CanvasRenderingContext2D::clearRect();\n
+method CanvasRenderingContext2D::clip();\n
+method CanvasRenderingContext2D::closePath();\n
+method CanvasRenderingContext2D::commit();\n
+method CanvasRenderingContext2D::createImageData();\n
+method CanvasRenderingContext2D::createLinearGradient();\n
+method CanvasRenderingContext2D::createPattern();\n
+method CanvasRenderingContext2D::createRadialGradient();\n
+getter CanvasRenderingContext2D::currentTransform(user);\n
+setter CanvasRenderingContext2D::currentTransform(user);\n
+getter CanvasRenderingContext2D::direction(string);\n
+setter CanvasRenderingContext2D::direction(string);\n
+method CanvasRenderingContext2D::drawFocusIfNeeded();\n
+method CanvasRenderingContext2D::drawImage();\n
+method CanvasRenderingContext2D::ellipse();\n
+method CanvasRenderingContext2D::fill();\n
+method CanvasRenderingContext2D::fillRect();\n
+getter CanvasRenderingContext2D::fillStyle(multiple);\n
+setter CanvasRenderingContext2D::fillStyle(multiple);\n
+method CanvasRenderingContext2D::fillText();\n
+getter CanvasRenderingContext2D::font(string);\n
+setter CanvasRenderingContext2D::font(string);\n
+method CanvasRenderingContext2D::getImageData();\n
+method CanvasRenderingContext2D::getLineDash();\n
+getter CanvasRenderingContext2D::globalAlpha(double);\n
+setter CanvasRenderingContext2D::globalAlpha(double);\n
+getter CanvasRenderingContext2D::globalCompositeOperation(string);\n
+setter CanvasRenderingContext2D::globalCompositeOperation(string);\n
+getter CanvasRenderingContext2D::height(unsigned long);\n
+setter CanvasRenderingContext2D::height(unsigned long);\n
+getter CanvasRenderingContext2D::imageSmoothingEnabled(boolean);\n
+setter CanvasRenderingContext2D::imageSmoothingEnabled(boolean);\n
+getter CanvasRenderingContext2D::imageSmoothingQuality(user);\n
+setter CanvasRenderingContext2D::imageSmoothingQuality(user);\n
+method CanvasRenderingContext2D::isPointInPath();\n
+method CanvasRenderingContext2D::isPointInStroke();\n
+getter CanvasRenderingContext2D::lineCap(string);\n
+setter CanvasRenderingContext2D::lineCap(string);\n
+getter CanvasRenderingContext2D::lineDashOffset(double);\n
+setter CanvasRenderingContext2D::lineDashOffset(double);\n
+getter CanvasRenderingContext2D::lineJoin(string);\n
+setter CanvasRenderingContext2D::lineJoin(string);\n
+method CanvasRenderingContext2D::lineTo();\n
+getter CanvasRenderingContext2D::lineWidth(double);\n
+setter CanvasRenderingContext2D::lineWidth(double);\n
+method CanvasRenderingContext2D::measureText();\n
+getter CanvasRenderingContext2D::miterLimit(double);\n
+setter CanvasRenderingContext2D::miterLimit(double);\n
+method CanvasRenderingContext2D::moveTo();\n
+method CanvasRenderingContext2D::putImageData();\n
+method CanvasRenderingContext2D::quadraticCurveTo();\n
+method CanvasRenderingContext2D::rect();\n
+method CanvasRenderingContext2D::removeHitRegion();\n
+method CanvasRenderingContext2D::resetClip();\n
+method CanvasRenderingContext2D::resetTransform();\n
+method CanvasRenderingContext2D::restore();\n
+method CanvasRenderingContext2D::rotate();\n
+method CanvasRenderingContext2D::save();\n
+method CanvasRenderingContext2D::scale();\n
+method CanvasRenderingContext2D::scrollPathIntoView();\n
+method CanvasRenderingContext2D::setLineDash();\n
+method CanvasRenderingContext2D::setTransform();\n
+getter CanvasRenderingContext2D::shadowBlur(double);\n
+setter CanvasRenderingContext2D::shadowBlur(double);\n
+getter CanvasRenderingContext2D::shadowColor(string);\n
+setter CanvasRenderingContext2D::shadowColor(string);\n
+getter CanvasRenderingContext2D::shadowOffsetX(double);\n
+setter CanvasRenderingContext2D::shadowOffsetX(double);\n
+getter CanvasRenderingContext2D::shadowOffsetY(double);\n
+setter CanvasRenderingContext2D::shadowOffsetY(double);\n
+method CanvasRenderingContext2D::stroke();\n
+method CanvasRenderingContext2D::strokeRect();\n
+getter CanvasRenderingContext2D::strokeStyle(multiple);\n
+setter CanvasRenderingContext2D::strokeStyle(multiple);\n
+method CanvasRenderingContext2D::strokeText();\n
+getter CanvasRenderingContext2D::textAlign(string);\n
+setter CanvasRenderingContext2D::textAlign(string);\n
+getter CanvasRenderingContext2D::textBaseline(string);\n
+setter CanvasRenderingContext2D::textBaseline(string);\n
+method CanvasRenderingContext2D::transform();\n
+method CanvasRenderingContext2D::translate();\n
+getter CanvasRenderingContext2D::width(unsigned long);\n
+setter CanvasRenderingContext2D::width(unsigned long);\n
+method CharacterData::after();\n
+method CharacterData::appendData();\n
+method CharacterData::before();\n
+getter CharacterData::data(string);\n
+setter CharacterData::data(string);\n
+method CharacterData::deleteData();\n
+method CharacterData::insertData();\n
+getter CharacterData::length(unsigned long);\n
+getter CharacterData::nextElementSibling(user);\n
+getter CharacterData::previousElementSibling(user);\n
+method CharacterData::remove();\n
+method CharacterData::replaceData();\n
+method CharacterData::replaceWith();\n
+method CharacterData::substringData();\n
+getter CloseEvent::code(unsigned short);\n
+getter CloseEvent::reason(string);\n
+getter CloseEvent::wasClean(boolean);\n
+getter CompositionEvent::data(string);\n
+method CompositionEvent::initCompositionEvent();\n
+method CSS::escape();\n
+getter CSSGroupingRule::cssRules(user);\n
+method CSSGroupingRule::deleteRule();\n
+method CSSGroupingRule::insertRule();\n
+getter CSSImportRule::href(string);\n
+getter CSSImportRule::media(user);\n
+getter CSSImportRule::styleSheet(user);\n
+getter CSSMarginRule::name(string);\n
+getter CSSMarginRule::style(user);\n
+getter CSSMediaRule::media(user);\n
+getter CSSNamespaceRule::namespaceURI(string);\n
+getter CSSNamespaceRule::prefix(string);\n
+getter CSSPageRule::selectorText(string);\n
+setter CSSPageRule::selectorText(string);\n
+getter CSSPageRule::style(user);\n
+getter CSSRule::cssText(string);\n
+setter CSSRule::cssText(string);\n
+method CSSRuleList::item();\n
+getter CSSRuleList::length(unsigned long);\n
+getter CSSRule::parentRule(user);\n
+getter CSSRule::parentStyleSheet(user);\n
+getter CSSRule::type(unsigned short);\n
+getter CSSStyleDeclaration::cssFloat(string);\n
+setter CSSStyleDeclaration::cssFloat(string);\n
+getter CSSStyleDeclaration::cssText(string);\n
+setter CSSStyleDeclaration::cssText(string);\n
+getter CSSStyleDeclaration::dashed_attribute(string);\n
+setter CSSStyleDeclaration::dashed_attribute(string);\n
+method CSSStyleDeclaration::getPropertyPriority();\n
+method CSSStyleDeclaration::getPropertyValue();\n
+method CSSStyleDeclaration::item();\n
+getter CSSStyleDeclaration::length(unsigned long);\n
+getter CSSStyleDeclaration::parentRule(user);\n
+method CSSStyleDeclaration::removeProperty();\n
+method CSSStyleDeclaration::setProperty();\n
+method CSSStyleDeclaration::setPropertyPriority();\n
+method CSSStyleDeclaration::setPropertyValue();\n
+getter CSSStyleRule::selectorText(string);\n
+setter CSSStyleRule::selectorText(string);\n
+getter CSSStyleRule::style(user);\n
+getter CSSStyleSheet::cssRules(user);\n
+method CSSStyleSheet::deleteRule();\n
+method CSSStyleSheet::insertRule();\n
+getter CSSStyleSheet::ownerRule(user);\n
+getter CustomEvent::detail(any);\n
+method CustomEvent::initCustomEvent();\n
+method DataTransfer::clearData();\n
+getter DataTransfer::dropEffect(string);\n
+setter DataTransfer::dropEffect(string);\n
+getter DataTransfer::effectAllowed(string);\n
+setter DataTransfer::effectAllowed(string);\n
+getter DataTransfer::files(user);\n
+method DataTransfer::getData();\n
+method DataTransferItem::getAsFile();\n
+method DataTransferItem::getAsString();\n
+getter DataTransferItem::kind(string);\n
+method DataTransferItemList::add();\n
+method DataTransferItemList::clear();\n
+getter DataTransferItemList::length(unsigned long);\n
+method DataTransferItemList::remove();\n
+getter DataTransfer::items(user);\n
+getter DataTransferItem::type(string);\n
+method DataTransfer::setData();\n
+method DataTransfer::setDragImage();\n
+getter DataTransfer::types(string);\n
+getter DedicatedWorkerGlobalScope::onmessage(user);\n
+setter DedicatedWorkerGlobalScope::onmessage(user);\n
+method DedicatedWorkerGlobalScope::postMessage();\n
+getter Document::activeElement(user);\n
+method Document::adoptNode();\n
+getter Document::alinkColor(string);\n
+setter Document::alinkColor(string);\n
+getter Document::all(user);\n
+getter Document::anchors(user);\n
+method Document::append();\n
+getter Document::applets(user);\n
+getter Document::bgColor(string);\n
+setter Document::bgColor(string);\n
+setter Document::body(user);\n
+method Document::captureEvents();\n
+getter Document::characterSet(string);\n
+getter Document::childElementCount(unsigned long);\n
+getter Document::children(user);\n
+method Document::clear();\n
+method Document::close();\n
+getter Document::commands(user);\n
+getter Document::compatMode(string);\n
+getter Document::contentType(string);\n
+setter Document::cookie(string);\n
+method Document::createAttribute();\n
+method Document::createAttributeNS();\n
+method Document::createComment();\n
+method Document::createDocumentFragment();\n
+method Document::createElementNS();\n
+method Document::createEvent();\n
+method Document::createNodeIterator();\n
+method Document::createProcessingInstruction();\n
+method Document::createRange();\n
+method Document::createTreeWalker();\n
+getter Document::cssElementMap(user);\n
+getter Document::currentScript(user);\n
+getter Document::defaultView(user);\n
+getter Document::designMode(string);\n
+setter Document::designMode(string);\n
+getter Document::dir(string);\n
+setter Document::dir(string);\n
+getter Document::doctype(user);\n
+getter Document::documentURI(string);\n
+getter Document::domain(string);\n
+setter Document::domain(string);\n
+getter Document::embeds(user);\n
+method Document::enableStyleSheetsForSet();\n
+method Document::execCommand();\n
+getter Document::fgColor(string);\n
+setter Document::fgColor(string);\n
+getter Document::firstElementChild(user);\n
+getter Document::forms(user);\n
+method DocumentFragment::append();\n
+getter DocumentFragment::childElementCount(unsigned long);\n
+getter DocumentFragment::children(user);\n
+getter DocumentFragment::firstElementChild(user);\n
+method DocumentFragment::getElementById();\n
+getter DocumentFragment::lastElementChild(user);\n
+method DocumentFragment::prepend();\n
+method DocumentFragment::query();\n
+method DocumentFragment::queryAll();\n
+method DocumentFragment::querySelector();\n
+method DocumentFragment::querySelectorAll();\n
+method Document::getElementsByClassName();\n
+method Document::getElementsByName();\n
+method Document::getElementsByTagNameNS();\n
+method Document::hasFocus();\n
+getter Document::images(user);\n
+getter Document::implementation(user);\n
+method Document::importNode();\n
+getter Document::inputEncoding(string);\n
+getter Document::lastElementChild(user);\n
+getter Document::lastModified(string);\n
+getter Document::lastStyleSheetSet(string);\n
+getter Document::linkColor(string);\n
+setter Document::linkColor(string);\n
+getter Document::links(user);\n
+getter Document::onerror(user);\n
+setter Document::onerror(user);\n
+method Document::open();\n
+getter Document::origin(string);\n
+getter Document::plugins(user);\n
+getter Document::preferredStyleSheetSet(string);\n
+method Document::prepend();\n
+method Document::query();\n
+method Document::queryAll();\n
+method Document::queryCommandEnabled();\n
+method Document::queryCommandIndeterm();\n
+method Document::queryCommandState();\n
+method Document::queryCommandSupported();\n
+method Document::queryCommandValue();\n
+method Document::querySelector();\n
+method Document::querySelectorAll();\n
+getter Document::readyState(user);\n
+getter Document::referrer(string);\n
+method Document::releaseEvents();\n
+getter Document::scripts(user);\n
+getter Document::selectedStyleSheetSet(string);\n
+setter Document::selectedStyleSheetSet(string);\n
+getter Document::styleSheetSets(string);\n
+getter Document::styleSheets(user);\n
+getter Document::title(string);\n
+setter Document::title(string);\n
+method DocumentType::after();\n
+method DocumentType::before();\n
+getter DocumentType::name(string);\n
+getter DocumentType::publicId(string);\n
+method DocumentType::remove();\n
+method DocumentType::replaceWith();\n
+getter DocumentType::systemId(string);\n
+getter Document::URL(string);\n
+getter Document::vlinkColor(string);\n
+setter Document::vlinkColor(string);\n
+method DOMImplementation::createDocument();\n
+method DOMImplementation::createDocumentType();\n
+method DOMImplementation::createHTMLDocument();\n
+method DOMImplementation::hasFeature();\n
+method DOMParser::parseFromString();\n
+getter DOMSettableTokenList::value(string);\n
+setter DOMSettableTokenList::value(string);\n
+method DOMTokenList::add();\n
+method DOMTokenList::contains();\n
+method DOMTokenList::item();\n
+getter DOMTokenList::length(unsigned long);\n
+method DOMTokenList::remove();\n
+method DOMTokenList::toggle();\n
+getter DragEvent::dataTransfer(user);\n
+getter DrawingStyle::direction(string);\n
+setter DrawingStyle::direction(string);\n
+getter DrawingStyle::font(string);\n
+setter DrawingStyle::font(string);\n
+method DrawingStyle::getLineDash();\n
+getter DrawingStyle::lineCap(string);\n
+setter DrawingStyle::lineCap(string);\n
+getter DrawingStyle::lineDashOffset(double);\n
+setter DrawingStyle::lineDashOffset(double);\n
+getter DrawingStyle::lineJoin(string);\n
+setter DrawingStyle::lineJoin(string);\n
+getter DrawingStyle::lineWidth(double);\n
+setter DrawingStyle::lineWidth(double);\n
+getter DrawingStyle::miterLimit(double);\n
+setter DrawingStyle::miterLimit(double);\n
+method DrawingStyle::setLineDash();\n
+getter DrawingStyle::textAlign(string);\n
+setter DrawingStyle::textAlign(string);\n
+getter DrawingStyle::textBaseline(string);\n
+setter DrawingStyle::textBaseline(string);\n
+method Element::after();\n
+method Element::append();\n
+getter Element::attributes(user);\n
+method Element::before();\n
+getter Element::cascadedStyle(user);\n
+getter Element::children(user);\n
+getter Element::classList(user);\n
+method Element::closest();\n
+getter Element::defaultStyle(user);\n
+method Element::getAttributeNode();\n
+method Element::getAttributeNodeNS();\n
+method Element::getAttributeNS();\n
+method Element::getElementsByClassName();\n
+method Element::getElementsByTagNameNS();\n
+method Element::hasAttributeNS();\n
+method Element::hasAttributes();\n
+getter Element::innerHTML(string);\n
+setter Element::innerHTML(string);\n
+method Element::insertAdjacentHTML();\n
+getter Element::localName(string);\n
+method Element::matches();\n
+getter Element::namespaceURI(string);\n
+getter Element::outerHTML(string);\n
+setter Element::outerHTML(string);\n
+getter Element::prefix(string);\n
+method Element::prepend();\n
+method Element::pseudo();\n
+method Element::query();\n
+method Element::queryAll();\n
+method Element::querySelector();\n
+method Element::querySelectorAll();\n
+getter Element::rawComputedStyle(user);\n
+method Element::remove();\n
+method Element::removeAttributeNode();\n
+method Element::removeAttributeNS();\n
+method Element::replaceWith();\n
+method Element::setAttributeNode();\n
+method Element::setAttributeNodeNS();\n
+method Element::setAttributeNS();\n
+getter Element::tagName(string);\n
+getter Element::usedStyle(user);\n
+getter ErrorEvent::colno(unsigned long);\n
+getter ErrorEvent::error(any);\n
+getter ErrorEvent::filename(string);\n
+getter ErrorEvent::lineno(unsigned long);\n
+getter ErrorEvent::message(string);\n
+method Event::initEvent();\n
+getter Event::isTrusted(boolean);\n
+method EventListener::handleEvent();\n
+method EventSource::close();\n
+getter EventSource::onerror(user);\n
+setter EventSource::onerror(user);\n
+getter EventSource::onmessage(user);\n
+setter EventSource::onmessage(user);\n
+getter EventSource::onopen(user);\n
+setter EventSource::onopen(user);\n
+getter EventSource::readyState(unsigned short);\n
+getter EventSource::url(string);\n
+getter EventSource::withCredentials(boolean);\n
+getter Event::timeStamp(user);\n
+method External::AddSearchProvider();\n
+method External::IsSearchProviderInstalled();\n
+method FocusEvent::initFocusEvent();\n
+getter FocusEvent::relatedTarget(user);\n
+getter HashChangeEvent::newURL(string);\n
+getter HashChangeEvent::oldURL(string);\n
+method History::back();\n
+method History::forward();\n
+method History::go();\n
+getter History::length(unsigned long);\n
+method History::pushState();\n
+method History::replaceState();\n
+getter History::state(any);\n
+method HTMLAllCollection::item();\n
+getter HTMLAllCollection::length(unsigned long);\n
+method HTMLAllCollection::namedItem();\n
+getter HTMLAnchorElement::download(string);\n
+setter HTMLAnchorElement::download(string);\n
+getter HTMLAnchorElement::hash(user);\n
+setter HTMLAnchorElement::hash(user);\n
+getter HTMLAnchorElement::hostname(user);\n
+setter HTMLAnchorElement::hostname(user);\n
+getter HTMLAnchorElement::host(user);\n
+setter HTMLAnchorElement::host(user);\n
+getter HTMLAnchorElement::href(user);\n
+setter HTMLAnchorElement::href(user);\n
+getter HTMLAnchorElement::origin(user);\n
+getter HTMLAnchorElement::password(user);\n
+setter HTMLAnchorElement::password(user);\n
+getter HTMLAnchorElement::pathname(user);\n
+setter HTMLAnchorElement::pathname(user);\n
+getter HTMLAnchorElement::ping(user);\n
+getter HTMLAnchorElement::port(user);\n
+setter HTMLAnchorElement::port(user);\n
+getter HTMLAnchorElement::protocol(user);\n
+setter HTMLAnchorElement::protocol(user);\n
+getter HTMLAnchorElement::relList(user);\n
+getter HTMLAnchorElement::search(user);\n
+setter HTMLAnchorElement::search(user);\n
+getter HTMLAnchorElement::text(string);\n
+setter HTMLAnchorElement::text(string);\n
+getter HTMLAnchorElement::type(string);\n
+setter HTMLAnchorElement::type(string);\n
+getter HTMLAnchorElement::username(user);\n
+setter HTMLAnchorElement::username(user);\n
+getter HTMLAppletElement::hspace(unsigned long);\n
+setter HTMLAppletElement::hspace(unsigned long);\n
+getter HTMLAppletElement::vspace(unsigned long);\n
+setter HTMLAppletElement::vspace(unsigned long);\n
+getter HTMLAreaElement::download(string);\n
+setter HTMLAreaElement::download(string);\n
+getter HTMLAreaElement::hash(user);\n
+setter HTMLAreaElement::hash(user);\n
+getter HTMLAreaElement::hostname(user);\n
+setter HTMLAreaElement::hostname(user);\n
+getter HTMLAreaElement::host(user);\n
+setter HTMLAreaElement::host(user);\n
+getter HTMLAreaElement::hreflang(string);\n
+setter HTMLAreaElement::hreflang(string);\n
+getter HTMLAreaElement::href(user);\n
+setter HTMLAreaElement::href(user);\n
+getter HTMLAreaElement::origin(user);\n
+getter HTMLAreaElement::password(user);\n
+setter HTMLAreaElement::password(user);\n
+getter HTMLAreaElement::pathname(user);\n
+setter HTMLAreaElement::pathname(user);\n
+getter HTMLAreaElement::ping(user);\n
+getter HTMLAreaElement::port(user);\n
+setter HTMLAreaElement::port(user);\n
+getter HTMLAreaElement::protocol(user);\n
+setter HTMLAreaElement::protocol(user);\n
+getter HTMLAreaElement::relList(user);\n
+getter HTMLAreaElement::rel(string);\n
+setter HTMLAreaElement::rel(string);\n
+getter HTMLAreaElement::search(user);\n
+setter HTMLAreaElement::search(user);\n
+getter HTMLAreaElement::type(string);\n
+setter HTMLAreaElement::type(string);\n
+getter HTMLAreaElement::username(user);\n
+setter HTMLAreaElement::username(user);\n
+getter HTMLBodyElement::onafterprint(user);\n
+setter HTMLBodyElement::onafterprint(user);\n
+getter HTMLBodyElement::onbeforeprint(user);\n
+setter HTMLBodyElement::onbeforeprint(user);\n
+getter HTMLBodyElement::onbeforeunload(user);\n
+setter HTMLBodyElement::onbeforeunload(user);\n
+getter HTMLBodyElement::onhashchange(user);\n
+setter HTMLBodyElement::onhashchange(user);\n
+getter HTMLBodyElement::onlanguagechange(user);\n
+setter HTMLBodyElement::onlanguagechange(user);\n
+getter HTMLBodyElement::onmessage(user);\n
+setter HTMLBodyElement::onmessage(user);\n
+getter HTMLBodyElement::onoffline(user);\n
+setter HTMLBodyElement::onoffline(user);\n
+getter HTMLBodyElement::ononline(user);\n
+setter HTMLBodyElement::ononline(user);\n
+getter HTMLBodyElement::onpagehide(user);\n
+setter HTMLBodyElement::onpagehide(user);\n
+getter HTMLBodyElement::onpageshow(user);\n
+setter HTMLBodyElement::onpageshow(user);\n
+getter HTMLBodyElement::onpopstate(user);\n
+setter HTMLBodyElement::onpopstate(user);\n
+getter HTMLBodyElement::onstorage(user);\n
+setter HTMLBodyElement::onstorage(user);\n
+getter HTMLBodyElement::onunload(user);\n
+setter HTMLBodyElement::onunload(user);\n
+getter HTMLButtonElement::autofocus(boolean);\n
+setter HTMLButtonElement::autofocus(boolean);\n
+method HTMLButtonElement::checkValidity();\n
+getter HTMLButtonElement::formAction(string);\n
+setter HTMLButtonElement::formAction(string);\n
+getter HTMLButtonElement::formEnctype(string);\n
+setter HTMLButtonElement::formEnctype(string);\n
+getter HTMLButtonElement::formMethod(string);\n
+setter HTMLButtonElement::formMethod(string);\n
+getter HTMLButtonElement::formNoValidate(boolean);\n
+setter HTMLButtonElement::formNoValidate(boolean);\n
+getter HTMLButtonElement::formTarget(string);\n
+setter HTMLButtonElement::formTarget(string);\n
+getter HTMLButtonElement::form(user);\n
+getter HTMLButtonElement::labels(user);\n
+getter HTMLButtonElement::menu(user);\n
+setter HTMLButtonElement::menu(user);\n
+method HTMLButtonElement::reportValidity();\n
+method HTMLButtonElement::setCustomValidity();\n
+getter HTMLButtonElement::type(string);\n
+setter HTMLButtonElement::type(string);\n
+getter HTMLButtonElement::validationMessage(string);\n
+getter HTMLButtonElement::validity(user);\n
+getter HTMLButtonElement::willValidate(boolean);\n
+method HTMLCanvasElement::getContext();\n
+getter HTMLCanvasElement::height(unsigned long);\n
+setter HTMLCanvasElement::height(unsigned long);\n
+method HTMLCanvasElement::probablySupportsContext();\n
+method HTMLCanvasElement::setContext();\n
+method HTMLCanvasElement::toBlob();\n
+method HTMLCanvasElement::toDataURL();\n
+method HTMLCanvasElement::transferControlToProxy();\n
+getter HTMLCanvasElement::width(unsigned long);\n
+setter HTMLCanvasElement::width(unsigned long);\n
+method HTMLCollection::item();\n
+getter HTMLCollection::length(unsigned long);\n
+method HTMLCollection::namedItem();\n
+getter HTMLDataElement::value(string);\n
+setter HTMLDataElement::value(string);\n
+getter HTMLDataListElement::options(user);\n
+getter HTMLDetailsElement::open(boolean);\n
+setter HTMLDetailsElement::open(boolean);\n
+method HTMLDialogElement::close();\n
+getter HTMLDialogElement::open(boolean);\n
+setter HTMLDialogElement::open(boolean);\n
+getter HTMLDialogElement::returnValue(string);\n
+setter HTMLDialogElement::returnValue(string);\n
+method HTMLDialogElement::show();\n
+method HTMLDialogElement::showModal();\n
+getter HTMLDirectoryElement::compact(boolean);\n
+setter HTMLDirectoryElement::compact(boolean);\n
+getter HTMLDListElement::compact(boolean);\n
+setter HTMLDListElement::compact(boolean);\n
+getter HTMLElement::accessKeyLabel(string);\n
+getter HTMLElement::accessKey(string);\n
+setter HTMLElement::accessKey(string);\n
+method HTMLElement::blur();\n
+method HTMLElement::click();\n
+getter HTMLElement::commandChecked(boolean);\n
+getter HTMLElement::commandDisabled(boolean);\n
+getter HTMLElement::commandHidden(boolean);\n
+getter HTMLElement::commandIcon(string);\n
+getter HTMLElement::commandLabel(string);\n
+getter HTMLElement::commandType(string);\n
+getter HTMLElement::contentEditable(string);\n
+setter HTMLElement::contentEditable(string);\n
+getter HTMLElement::contextMenu(user);\n
+setter HTMLElement::contextMenu(user);\n
+getter HTMLElement::dataset(user);\n
+getter HTMLElement::draggable(boolean);\n
+setter HTMLElement::draggable(boolean);\n
+getter HTMLElement::dropzone(user);\n
+method HTMLElement::focus();\n
+method HTMLElement::forceSpellCheck();\n
+getter HTMLElement::hidden(boolean);\n
+setter HTMLElement::hidden(boolean);\n
+getter HTMLElement::isContentEditable(boolean);\n
+getter HTMLElement::onerror(user);\n
+setter HTMLElement::onerror(user);\n
+getter HTMLElement::spellcheck(boolean);\n
+setter HTMLElement::spellcheck(boolean);\n
+getter HTMLElement::tabIndex(long);\n
+setter HTMLElement::tabIndex(long);\n
+getter HTMLElement::translate(boolean);\n
+setter HTMLElement::translate(boolean);\n
+getter HTMLEmbedElement::align(string);\n
+setter HTMLEmbedElement::align(string);\n
+method HTMLEmbedElement::getSVGDocument();\n
+getter HTMLEmbedElement::height(string);\n
+setter HTMLEmbedElement::height(string);\n
+getter HTMLEmbedElement::name(string);\n
+setter HTMLEmbedElement::name(string);\n
+getter HTMLEmbedElement::src(string);\n
+setter HTMLEmbedElement::src(string);\n
+getter HTMLEmbedElement::type(string);\n
+setter HTMLEmbedElement::type(string);\n
+getter HTMLEmbedElement::width(string);\n
+setter HTMLEmbedElement::width(string);\n
+method HTMLFieldSetElement::checkValidity();\n
+getter HTMLFieldSetElement::disabled(boolean);\n
+setter HTMLFieldSetElement::disabled(boolean);\n
+getter HTMLFieldSetElement::elements(user);\n
+getter HTMLFieldSetElement::form(user);\n
+getter HTMLFieldSetElement::name(string);\n
+setter HTMLFieldSetElement::name(string);\n
+method HTMLFieldSetElement::reportValidity();\n
+method HTMLFieldSetElement::setCustomValidity();\n
+getter HTMLFieldSetElement::type(string);\n
+getter HTMLFieldSetElement::validationMessage(string);\n
+getter HTMLFieldSetElement::validity(user);\n
+getter HTMLFieldSetElement::willValidate(boolean);\n
+method HTMLFormControlsCollection::namedItem();\n
+getter HTMLFormElement::autocomplete(string);\n
+setter HTMLFormElement::autocomplete(string);\n
+method HTMLFormElement::checkValidity();\n
+getter HTMLFormElement::elements(user);\n
+getter HTMLFormElement::encoding(string);\n
+setter HTMLFormElement::encoding(string);\n
+getter HTMLFormElement::length(long);\n
+getter HTMLFormElement::name(string);\n
+setter HTMLFormElement::name(string);\n
+getter HTMLFormElement::noValidate(boolean);\n
+setter HTMLFormElement::noValidate(boolean);\n
+method HTMLFormElement::reportValidity();\n
+method HTMLFormElement::requestAutocomplete();\n
+method HTMLFormElement::reset();\n
+method HTMLFormElement::submit();\n
+getter HTMLFrameElement::contentDocument(user);\n
+getter HTMLFrameElement::contentWindow(user);\n
+getter HTMLFrameSetElement::onafterprint(user);\n
+setter HTMLFrameSetElement::onafterprint(user);\n
+getter HTMLFrameSetElement::onbeforeprint(user);\n
+setter HTMLFrameSetElement::onbeforeprint(user);\n
+getter HTMLFrameSetElement::onbeforeunload(user);\n
+setter HTMLFrameSetElement::onbeforeunload(user);\n
+getter HTMLFrameSetElement::onhashchange(user);\n
+setter HTMLFrameSetElement::onhashchange(user);\n
+getter HTMLFrameSetElement::onlanguagechange(user);\n
+setter HTMLFrameSetElement::onlanguagechange(user);\n
+getter HTMLFrameSetElement::onmessage(user);\n
+setter HTMLFrameSetElement::onmessage(user);\n
+getter HTMLFrameSetElement::onoffline(user);\n
+setter HTMLFrameSetElement::onoffline(user);\n
+getter HTMLFrameSetElement::ononline(user);\n
+setter HTMLFrameSetElement::ononline(user);\n
+getter HTMLFrameSetElement::onpagehide(user);\n
+setter HTMLFrameSetElement::onpagehide(user);\n
+getter HTMLFrameSetElement::onpageshow(user);\n
+setter HTMLFrameSetElement::onpageshow(user);\n
+getter HTMLFrameSetElement::onpopstate(user);\n
+setter HTMLFrameSetElement::onpopstate(user);\n
+getter HTMLFrameSetElement::onstorage(user);\n
+setter HTMLFrameSetElement::onstorage(user);\n
+getter HTMLFrameSetElement::onunload(user);\n
+setter HTMLFrameSetElement::onunload(user);\n
+getter HTMLHRElement::color(string);\n
+setter HTMLHRElement::color(string);\n
+getter HTMLIFrameElement::allowFullscreen(boolean);\n
+setter HTMLIFrameElement::allowFullscreen(boolean);\n
+getter HTMLIFrameElement::contentDocument(user);\n
+getter HTMLIFrameElement::contentWindow(user);\n
+method HTMLIFrameElement::getSVGDocument();\n
+getter HTMLIFrameElement::sandbox(user);\n
+getter HTMLIFrameElement::seamless(boolean);\n
+setter HTMLIFrameElement::seamless(boolean);\n
+getter HTMLIFrameElement::srcdoc(string);\n
+setter HTMLIFrameElement::srcdoc(string);\n
+getter HTMLImageElement::complete(boolean);\n
+getter HTMLImageElement::crossOrigin(string);\n
+setter HTMLImageElement::crossOrigin(string);\n
+getter HTMLImageElement::currentSrc(string);\n
+getter HTMLImageElement::lowsrc(string);\n
+setter HTMLImageElement::lowsrc(string);\n
+getter HTMLImageElement::naturalHeight(unsigned long);\n
+getter HTMLImageElement::naturalWidth(unsigned long);\n
+getter HTMLImageElement::sizes(string);\n
+setter HTMLImageElement::sizes(string);\n
+getter HTMLImageElement::srcset(string);\n
+setter HTMLImageElement::srcset(string);\n
+getter HTMLInputElement::autocomplete(string);\n
+setter HTMLInputElement::autocomplete(string);\n
+getter HTMLInputElement::autofocus(boolean);\n
+setter HTMLInputElement::autofocus(boolean);\n
+method HTMLInputElement::checkValidity();\n
+getter HTMLInputElement::dirName(string);\n
+setter HTMLInputElement::dirName(string);\n
+getter HTMLInputElement::files(user);\n
+getter HTMLInputElement::formAction(string);\n
+setter HTMLInputElement::formAction(string);\n
+getter HTMLInputElement::formEnctype(string);\n
+setter HTMLInputElement::formEnctype(string);\n
+getter HTMLInputElement::formMethod(string);\n
+setter HTMLInputElement::formMethod(string);\n
+getter HTMLInputElement::formNoValidate(boolean);\n
+setter HTMLInputElement::formNoValidate(boolean);\n
+getter HTMLInputElement::formTarget(string);\n
+setter HTMLInputElement::formTarget(string);\n
+getter HTMLInputElement::form(user);\n
+getter HTMLInputElement::height(unsigned long);\n
+setter HTMLInputElement::height(unsigned long);\n
+getter HTMLInputElement::indeterminate(boolean);\n
+setter HTMLInputElement::indeterminate(boolean);\n
+getter HTMLInputElement::inputMode(string);\n
+setter HTMLInputElement::inputMode(string);\n
+getter HTMLInputElement::labels(user);\n
+getter HTMLInputElement::list(user);\n
+getter HTMLInputElement::max(string);\n
+setter HTMLInputElement::max(string);\n
+getter HTMLInputElement::minLength(long);\n
+setter HTMLInputElement::minLength(long);\n
+getter HTMLInputElement::min(string);\n
+setter HTMLInputElement::min(string);\n
+getter HTMLInputElement::multiple(boolean);\n
+setter HTMLInputElement::multiple(boolean);\n
+getter HTMLInputElement::pattern(string);\n
+setter HTMLInputElement::pattern(string);\n
+getter HTMLInputElement::placeholder(string);\n
+setter HTMLInputElement::placeholder(string);\n
+method HTMLInputElement::reportValidity();\n
+getter HTMLInputElement::required(boolean);\n
+setter HTMLInputElement::required(boolean);\n
+method HTMLInputElement::select();\n
+getter HTMLInputElement::selectionDirection(string);\n
+setter HTMLInputElement::selectionDirection(string);\n
+getter HTMLInputElement::selectionEnd(unsigned long);\n
+setter HTMLInputElement::selectionEnd(unsigned long);\n
+getter HTMLInputElement::selectionStart(unsigned long);\n
+setter HTMLInputElement::selectionStart(unsigned long);\n
+method HTMLInputElement::setCustomValidity();\n
+method HTMLInputElement::setRangeText();\n
+method HTMLInputElement::setSelectionRange();\n
+method HTMLInputElement::stepDown();\n
+getter HTMLInputElement::step(string);\n
+setter HTMLInputElement::step(string);\n
+method HTMLInputElement::stepUp();\n
+setter HTMLInputElement::type(string);\n
+getter HTMLInputElement::validationMessage(string);\n
+getter HTMLInputElement::validity(user);\n
+getter HTMLInputElement::valueAsDate(date);\n
+setter HTMLInputElement::valueAsDate(date);\n
+getter HTMLInputElement::valueAsNumber(double);\n
+setter HTMLInputElement::valueAsNumber(double);\n
+getter HTMLInputElement::valueHigh(double);\n
+setter HTMLInputElement::valueHigh(double);\n
+getter HTMLInputElement::valueLow(double);\n
+setter HTMLInputElement::valueLow(double);\n
+getter HTMLInputElement::width(unsigned long);\n
+setter HTMLInputElement::width(unsigned long);\n
+getter HTMLInputElement::willValidate(boolean);\n
+getter HTMLKeygenElement::autofocus(boolean);\n
+setter HTMLKeygenElement::autofocus(boolean);\n
+getter HTMLKeygenElement::challenge(string);\n
+setter HTMLKeygenElement::challenge(string);\n
+method HTMLKeygenElement::checkValidity();\n
+getter HTMLKeygenElement::disabled(boolean);\n
+setter HTMLKeygenElement::disabled(boolean);\n
+getter HTMLKeygenElement::form(user);\n
+getter HTMLKeygenElement::keytype(string);\n
+setter HTMLKeygenElement::keytype(string);\n
+getter HTMLKeygenElement::labels(user);\n
+getter HTMLKeygenElement::name(string);\n
+setter HTMLKeygenElement::name(string);\n
+method HTMLKeygenElement::reportValidity();\n
+method HTMLKeygenElement::setCustomValidity();\n
+getter HTMLKeygenElement::type(string);\n
+getter HTMLKeygenElement::validationMessage(string);\n
+getter HTMLKeygenElement::validity(user);\n
+getter HTMLKeygenElement::willValidate(boolean);\n
+getter HTMLLabelElement::control(user);\n
+getter HTMLLabelElement::form(user);\n
+getter HTMLLegendElement::form(user);\n
+getter HTMLLinkElement::crossOrigin(string);\n
+setter HTMLLinkElement::crossOrigin(string);\n
+getter HTMLLinkElement::relList(user);\n
+getter HTMLLinkElement::sheet(user);\n
+getter HTMLLinkElement::sizes(user);\n
+getter HTMLMapElement::areas(user);\n
+getter HTMLMarqueeElement::behavior(string);\n
+setter HTMLMarqueeElement::behavior(string);\n
+getter HTMLMarqueeElement::bgColor(string);\n
+setter HTMLMarqueeElement::bgColor(string);\n
+getter HTMLMarqueeElement::direction(string);\n
+setter HTMLMarqueeElement::direction(string);\n
+getter HTMLMarqueeElement::height(string);\n
+setter HTMLMarqueeElement::height(string);\n
+getter HTMLMarqueeElement::hspace(unsigned long);\n
+setter HTMLMarqueeElement::hspace(unsigned long);\n
+getter HTMLMarqueeElement::loop(long);\n
+setter HTMLMarqueeElement::loop(long);\n
+getter HTMLMarqueeElement::onbounce(user);\n
+setter HTMLMarqueeElement::onbounce(user);\n
+getter HTMLMarqueeElement::onfinish(user);\n
+setter HTMLMarqueeElement::onfinish(user);\n
+getter HTMLMarqueeElement::onstart(user);\n
+setter HTMLMarqueeElement::onstart(user);\n
+getter HTMLMarqueeElement::scrollAmount(unsigned long);\n
+setter HTMLMarqueeElement::scrollAmount(unsigned long);\n
+getter HTMLMarqueeElement::scrollDelay(unsigned long);\n
+setter HTMLMarqueeElement::scrollDelay(unsigned long);\n
+method HTMLMarqueeElement::start();\n
+method HTMLMarqueeElement::stop();\n
+getter HTMLMarqueeElement::trueSpeed(boolean);\n
+setter HTMLMarqueeElement::trueSpeed(boolean);\n
+getter HTMLMarqueeElement::vspace(unsigned long);\n
+setter HTMLMarqueeElement::vspace(unsigned long);\n
+getter HTMLMarqueeElement::width(string);\n
+setter HTMLMarqueeElement::width(string);\n
+method HTMLMediaElement::addTextTrack();\n
+getter HTMLMediaElement::audioTracks(user);\n
+getter HTMLMediaElement::autoplay(boolean);\n
+setter HTMLMediaElement::autoplay(boolean);\n
+getter HTMLMediaElement::buffered(user);\n
+method HTMLMediaElement::canPlayType();\n
+getter HTMLMediaElement::controller(user);\n
+setter HTMLMediaElement::controller(user);\n
+getter HTMLMediaElement::controls(boolean);\n
+setter HTMLMediaElement::controls(boolean);\n
+getter HTMLMediaElement::crossOrigin(string);\n
+setter HTMLMediaElement::crossOrigin(string);\n
+getter HTMLMediaElement::currentSrc(string);\n
+getter HTMLMediaElement::currentTime(double);\n
+setter HTMLMediaElement::currentTime(double);\n
+getter HTMLMediaElement::defaultMuted(boolean);\n
+setter HTMLMediaElement::defaultMuted(boolean);\n
+getter HTMLMediaElement::defaultPlaybackRate(double);\n
+setter HTMLMediaElement::defaultPlaybackRate(double);\n
+getter HTMLMediaElement::duration(double);\n
+getter HTMLMediaElement::ended(boolean);\n
+getter HTMLMediaElement::error(user);\n
+method HTMLMediaElement::fastSeek();\n
+method HTMLMediaElement::getStartDate();\n
+method HTMLMediaElement::load();\n
+getter HTMLMediaElement::loop(boolean);\n
+setter HTMLMediaElement::loop(boolean);\n
+getter HTMLMediaElement::mediaGroup(string);\n
+setter HTMLMediaElement::mediaGroup(string);\n
+getter HTMLMediaElement::muted(boolean);\n
+setter HTMLMediaElement::muted(boolean);\n
+getter HTMLMediaElement::networkState(unsigned short);\n
+method HTMLMediaElement::pause();\n
+getter HTMLMediaElement::paused(boolean);\n
+method HTMLMediaElement::play();\n
+getter HTMLMediaElement::playbackRate(double);\n
+setter HTMLMediaElement::playbackRate(double);\n
+getter HTMLMediaElement::played(user);\n
+getter HTMLMediaElement::preload(string);\n
+setter HTMLMediaElement::preload(string);\n
+getter HTMLMediaElement::readyState(unsigned short);\n
+getter HTMLMediaElement::seekable(user);\n
+getter HTMLMediaElement::seeking(boolean);\n
+getter HTMLMediaElement::srcObject(user);\n
+setter HTMLMediaElement::srcObject(user);\n
+getter HTMLMediaElement::src(string);\n
+setter HTMLMediaElement::src(string);\n
+getter HTMLMediaElement::textTracks(user);\n
+getter HTMLMediaElement::videoTracks(user);\n
+getter HTMLMediaElement::volume(double);\n
+setter HTMLMediaElement::volume(double);\n
+getter HTMLMenuElement::label(string);\n
+setter HTMLMenuElement::label(string);\n
+getter HTMLMenuElement::type(string);\n
+setter HTMLMenuElement::type(string);\n
+getter HTMLMenuItemElement::checked(boolean);\n
+setter HTMLMenuItemElement::checked(boolean);\n
+getter HTMLMenuItemElement::command(user);\n
+getter HTMLMenuItemElement::default(boolean);\n
+setter HTMLMenuItemElement::default(boolean);\n
+getter HTMLMenuItemElement::disabled(boolean);\n
+setter HTMLMenuItemElement::disabled(boolean);\n
+getter HTMLMenuItemElement::icon(string);\n
+setter HTMLMenuItemElement::icon(string);\n
+getter HTMLMenuItemElement::label(string);\n
+setter HTMLMenuItemElement::label(string);\n
+getter HTMLMenuItemElement::radiogroup(string);\n
+setter HTMLMenuItemElement::radiogroup(string);\n
+getter HTMLMenuItemElement::type(string);\n
+setter HTMLMenuItemElement::type(string);\n
+getter HTMLMeterElement::high(double);\n
+setter HTMLMeterElement::high(double);\n
+getter HTMLMeterElement::labels(user);\n
+getter HTMLMeterElement::low(double);\n
+setter HTMLMeterElement::low(double);\n
+getter HTMLMeterElement::max(double);\n
+setter HTMLMeterElement::max(double);\n
+getter HTMLMeterElement::min(double);\n
+setter HTMLMeterElement::min(double);\n
+getter HTMLMeterElement::optimum(double);\n
+setter HTMLMeterElement::optimum(double);\n
+getter HTMLMeterElement::value(double);\n
+setter HTMLMeterElement::value(double);\n
+getter HTMLModElement::cite(string);\n
+setter HTMLModElement::cite(string);\n
+getter HTMLModElement::dateTime(string);\n
+setter HTMLModElement::dateTime(string);\n
+method HTMLObjectElement::checkValidity();\n
+getter HTMLObjectElement::contentDocument(user);\n
+getter HTMLObjectElement::contentWindow(user);\n
+getter HTMLObjectElement::form(user);\n
+method HTMLObjectElement::getSVGDocument();\n
+getter HTMLObjectElement::hspace(unsigned long);\n
+setter HTMLObjectElement::hspace(unsigned long);\n
+method HTMLObjectElement::reportValidity();\n
+method HTMLObjectElement::setCustomValidity();\n
+getter HTMLObjectElement::typeMustMatch(boolean);\n
+setter HTMLObjectElement::typeMustMatch(boolean);\n
+getter HTMLObjectElement::validationMessage(string);\n
+getter HTMLObjectElement::validity(user);\n
+getter HTMLObjectElement::vspace(unsigned long);\n
+setter HTMLObjectElement::vspace(unsigned long);\n
+getter HTMLObjectElement::willValidate(boolean);\n
+getter HTMLOListElement::reversed(boolean);\n
+setter HTMLOListElement::reversed(boolean);\n
+getter HTMLOptGroupElement::disabled(boolean);\n
+setter HTMLOptGroupElement::disabled(boolean);\n
+getter HTMLOptGroupElement::label(string);\n
+setter HTMLOptGroupElement::label(string);\n
+getter HTMLOptionElement::form(user);\n
+getter HTMLOptionElement::index(long);\n
+setter HTMLOptionElement::text(string);\n
+method HTMLOptionsCollection::add();\n
+getter HTMLOptionsCollection::length(unsigned long);\n
+setter HTMLOptionsCollection::length(unsigned long);\n
+method HTMLOptionsCollection::remove();\n
+getter HTMLOptionsCollection::selectedIndex(long);\n
+setter HTMLOptionsCollection::selectedIndex(long);\n
+method HTMLOutputElement::checkValidity();\n
+getter HTMLOutputElement::defaultValue(string);\n
+setter HTMLOutputElement::defaultValue(string);\n
+getter HTMLOutputElement::form(user);\n
+getter HTMLOutputElement::htmlFor(user);\n
+getter HTMLOutputElement::labels(user);\n
+getter HTMLOutputElement::name(string);\n
+setter HTMLOutputElement::name(string);\n
+method HTMLOutputElement::reportValidity();\n
+method HTMLOutputElement::setCustomValidity();\n
+getter HTMLOutputElement::type(string);\n
+getter HTMLOutputElement::validationMessage(string);\n
+getter HTMLOutputElement::validity(user);\n
+getter HTMLOutputElement::value(string);\n
+setter HTMLOutputElement::value(string);\n
+getter HTMLOutputElement::willValidate(boolean);\n
+getter HTMLProgressElement::labels(user);\n
+getter HTMLProgressElement::max(double);\n
+setter HTMLProgressElement::max(double);\n
+getter HTMLProgressElement::position(double);\n
+getter HTMLProgressElement::value(double);\n
+setter HTMLProgressElement::value(double);\n
+getter HTMLScriptElement::async(boolean);\n
+setter HTMLScriptElement::async(boolean);\n
+getter HTMLScriptElement::crossOrigin(string);\n
+setter HTMLScriptElement::crossOrigin(string);\n
+getter HTMLScriptElement::nonce(string);\n
+setter HTMLScriptElement::nonce(string);\n
+method HTMLSelectElement::add();\n
+getter HTMLSelectElement::autocomplete(string);\n
+setter HTMLSelectElement::autocomplete(string);\n
+getter HTMLSelectElement::autofocus(boolean);\n
+setter HTMLSelectElement::autofocus(boolean);\n
+method HTMLSelectElement::checkValidity();\n
+getter HTMLSelectElement::form(user);\n
+method HTMLSelectElement::item();\n
+getter HTMLSelectElement::labels(user);\n
+getter HTMLSelectElement::length(unsigned long);\n
+setter HTMLSelectElement::length(unsigned long);\n
+method HTMLSelectElement::namedItem();\n
+getter HTMLSelectElement::options(user);\n
+method HTMLSelectElement::remove();\n
+method HTMLSelectElement::reportValidity();\n
+getter HTMLSelectElement::required(boolean);\n
+setter HTMLSelectElement::required(boolean);\n
+getter HTMLSelectElement::selectedIndex(long);\n
+setter HTMLSelectElement::selectedIndex(long);\n
+getter HTMLSelectElement::selectedOptions(user);\n
+method HTMLSelectElement::setCustomValidity();\n
+getter HTMLSelectElement::size(unsigned long);\n
+setter HTMLSelectElement::size(unsigned long);\n
+getter HTMLSelectElement::validationMessage(string);\n
+getter HTMLSelectElement::validity(user);\n
+getter HTMLSelectElement::willValidate(boolean);\n
+getter HTMLSourceElement::media(string);\n
+setter HTMLSourceElement::media(string);\n
+getter HTMLSourceElement::sizes(string);\n
+setter HTMLSourceElement::sizes(string);\n
+getter HTMLSourceElement::srcset(string);\n
+setter HTMLSourceElement::srcset(string);\n
+getter HTMLSourceElement::src(string);\n
+setter HTMLSourceElement::src(string);\n
+getter HTMLSourceElement::type(string);\n
+setter HTMLSourceElement::type(string);\n
+getter HTMLStyleElement::nonce(string);\n
+setter HTMLStyleElement::nonce(string);\n
+getter HTMLStyleElement::scoped(boolean);\n
+setter HTMLStyleElement::scoped(boolean);\n
+getter HTMLStyleElement::sheet(user);\n
+getter HTMLTableCellElement::headers(user);\n
+getter HTMLTableColElement::span(unsigned long);\n
+setter HTMLTableColElement::span(unsigned long);\n
+getter HTMLTableDataCellElement::abbr(string);\n
+setter HTMLTableDataCellElement::abbr(string);\n
+getter HTMLTableElement::caption(user);\n
+setter HTMLTableElement::caption(user);\n
+method HTMLTableElement::createCaption();\n
+method HTMLTableElement::createTBody();\n
+method HTMLTableElement::createTFoot();\n
+method HTMLTableElement::createTHead();\n
+method HTMLTableElement::deleteCaption();\n
+method HTMLTableElement::deleteRow();\n
+method HTMLTableElement::deleteTFoot();\n
+method HTMLTableElement::deleteTHead();\n
+method HTMLTableElement::insertRow();\n
+getter HTMLTableElement::rows(user);\n
+getter HTMLTableElement::sortable(boolean);\n
+setter HTMLTableElement::sortable(boolean);\n
+method HTMLTableElement::stopSorting();\n
+getter HTMLTableElement::tBodies(user);\n
+getter HTMLTableElement::tFoot(user);\n
+setter HTMLTableElement::tFoot(user);\n
+getter HTMLTableElement::tHead(user);\n
+setter HTMLTableElement::tHead(user);\n
+getter HTMLTableHeaderCellElement::abbr(string);\n
+setter HTMLTableHeaderCellElement::abbr(string);\n
+getter HTMLTableHeaderCellElement::scope(string);\n
+setter HTMLTableHeaderCellElement::scope(string);\n
+method HTMLTableHeaderCellElement::sort();\n
+getter HTMLTableHeaderCellElement::sorted(string);\n
+setter HTMLTableHeaderCellElement::sorted(string);\n
+getter HTMLTableRowElement::cells(user);\n
+method HTMLTableRowElement::deleteCell();\n
+method HTMLTableRowElement::insertCell();\n
+method HTMLTableSectionElement::deleteRow();\n
+method HTMLTableSectionElement::insertRow();\n
+getter HTMLTableSectionElement::rows(user);\n
+getter HTMLTemplateElement::content(user);\n
+getter HTMLTextAreaElement::autocomplete(string);\n
+setter HTMLTextAreaElement::autocomplete(string);\n
+getter HTMLTextAreaElement::autofocus(boolean);\n
+setter HTMLTextAreaElement::autofocus(boolean);\n
+method HTMLTextAreaElement::checkValidity();\n
+getter HTMLTextAreaElement::cols(unsigned long);\n
+setter HTMLTextAreaElement::cols(unsigned long);\n
+getter HTMLTextAreaElement::dirName(string);\n
+setter HTMLTextAreaElement::dirName(string);\n
+getter HTMLTextAreaElement::form(user);\n
+getter HTMLTextAreaElement::inputMode(string);\n
+setter HTMLTextAreaElement::inputMode(string);\n
+getter HTMLTextAreaElement::labels(user);\n
+getter HTMLTextAreaElement::maxLength(long);\n
+setter HTMLTextAreaElement::maxLength(long);\n
+getter HTMLTextAreaElement::minLength(long);\n
+setter HTMLTextAreaElement::minLength(long);\n
+getter HTMLTextAreaElement::placeholder(string);\n
+setter HTMLTextAreaElement::placeholder(string);\n
+method HTMLTextAreaElement::reportValidity();\n
+getter HTMLTextAreaElement::required(boolean);\n
+setter HTMLTextAreaElement::required(boolean);\n
+getter HTMLTextAreaElement::rows(unsigned long);\n
+setter HTMLTextAreaElement::rows(unsigned long);\n
+method HTMLTextAreaElement::select();\n
+getter HTMLTextAreaElement::selectionDirection(string);\n
+setter HTMLTextAreaElement::selectionDirection(string);\n
+getter HTMLTextAreaElement::selectionEnd(unsigned long);\n
+setter HTMLTextAreaElement::selectionEnd(unsigned long);\n
+getter HTMLTextAreaElement::selectionStart(unsigned long);\n
+setter HTMLTextAreaElement::selectionStart(unsigned long);\n
+method HTMLTextAreaElement::setCustomValidity();\n
+method HTMLTextAreaElement::setRangeText();\n
+method HTMLTextAreaElement::setSelectionRange();\n
+getter HTMLTextAreaElement::textLength(unsigned long);\n
+getter HTMLTextAreaElement::validationMessage(string);\n
+getter HTMLTextAreaElement::validity(user);\n
+getter HTMLTextAreaElement::willValidate(boolean);\n
+getter HTMLTextAreaElement::wrap(string);\n
+setter HTMLTextAreaElement::wrap(string);\n
+getter HTMLTimeElement::dateTime(string);\n
+setter HTMLTimeElement::dateTime(string);\n
+getter HTMLTrackElement::default(boolean);\n
+setter HTMLTrackElement::default(boolean);\n
+getter HTMLTrackElement::kind(string);\n
+setter HTMLTrackElement::kind(string);\n
+getter HTMLTrackElement::label(string);\n
+setter HTMLTrackElement::label(string);\n
+getter HTMLTrackElement::readyState(unsigned short);\n
+getter HTMLTrackElement::srclang(string);\n
+setter HTMLTrackElement::srclang(string);\n
+getter HTMLTrackElement::src(string);\n
+setter HTMLTrackElement::src(string);\n
+getter HTMLTrackElement::track(user);\n
+getter HTMLUListElement::compact(boolean);\n
+setter HTMLUListElement::compact(boolean);\n
+getter HTMLUListElement::type(string);\n
+setter HTMLUListElement::type(string);\n
+getter HTMLVideoElement::height(unsigned long);\n
+setter HTMLVideoElement::height(unsigned long);\n
+getter HTMLVideoElement::poster(string);\n
+setter HTMLVideoElement::poster(string);\n
+getter HTMLVideoElement::videoHeight(unsigned long);\n
+getter HTMLVideoElement::videoWidth(unsigned long);\n
+getter HTMLVideoElement::width(unsigned long);\n
+setter HTMLVideoElement::width(unsigned long);\n
+getter ImageBitmap::height(unsigned long);\n
+getter ImageBitmap::width(unsigned long);\n
+getter ImageData::data(user);\n
+getter ImageData::height(unsigned long);\n
+getter ImageData::width(unsigned long);\n
+getter KeyboardEvent::altKey(boolean);\n
+getter KeyboardEvent::charCode(unsigned long);\n
+getter KeyboardEvent::code(string);\n
+getter KeyboardEvent::ctrlKey(boolean);\n
+method KeyboardEvent::getModifierState();\n
+method KeyboardEvent::initKeyboardEvent();\n
+getter KeyboardEvent::isComposing(boolean);\n
+getter KeyboardEvent::keyCode(unsigned long);\n
+getter KeyboardEvent::key(string);\n
+getter KeyboardEvent::location(unsigned long);\n
+getter KeyboardEvent::metaKey(boolean);\n
+getter KeyboardEvent::repeat(boolean);\n
+getter KeyboardEvent::shiftKey(boolean);\n
+getter KeyboardEvent::which(unsigned long);\n
+getter Location::ancestorOrigins(string);\n
+setter Location::hash(user);\n
+setter Location::hostname(user);\n
+setter Location::host(user);\n
+setter Location::password(user);\n
+setter Location::pathname(user);\n
+setter Location::port(user);\n
+setter Location::protocol(user);\n
+setter Location::search(user);\n
+setter Location::username(user);\n
+getter MediaController::buffered(user);\n
+getter MediaController::currentTime(double);\n
+setter MediaController::currentTime(double);\n
+getter MediaController::defaultPlaybackRate(double);\n
+setter MediaController::defaultPlaybackRate(double);\n
+getter MediaController::duration(double);\n
+getter MediaController::muted(boolean);\n
+setter MediaController::muted(boolean);\n
+getter MediaController::oncanplaythrough(user);\n
+setter MediaController::oncanplaythrough(user);\n
+getter MediaController::oncanplay(user);\n
+setter MediaController::oncanplay(user);\n
+getter MediaController::ondurationchange(user);\n
+setter MediaController::ondurationchange(user);\n
+getter MediaController::onemptied(user);\n
+setter MediaController::onemptied(user);\n
+getter MediaController::onended(user);\n
+setter MediaController::onended(user);\n
+getter MediaController::onloadeddata(user);\n
+setter MediaController::onloadeddata(user);\n
+getter MediaController::onloadedmetadata(user);\n
+setter MediaController::onloadedmetadata(user);\n
+getter MediaController::onpause(user);\n
+setter MediaController::onpause(user);\n
+getter MediaController::onplaying(user);\n
+setter MediaController::onplaying(user);\n
+getter MediaController::onplay(user);\n
+setter MediaController::onplay(user);\n
+getter MediaController::onratechange(user);\n
+setter MediaController::onratechange(user);\n
+getter MediaController::ontimeupdate(user);\n
+setter MediaController::ontimeupdate(user);\n
+getter MediaController::onvolumechange(user);\n
+setter MediaController::onvolumechange(user);\n
+getter MediaController::onwaiting(user);\n
+setter MediaController::onwaiting(user);\n
+method MediaController::pause();\n
+getter MediaController::paused(boolean);\n
+method MediaController::play();\n
+getter MediaController::playbackRate(double);\n
+setter MediaController::playbackRate(double);\n
+getter MediaController::playbackState(user);\n
+getter MediaController::played(user);\n
+getter MediaController::readyState(unsigned short);\n
+getter MediaController::seekable(user);\n
+method MediaController::unpause();\n
+getter MediaController::volume(double);\n
+setter MediaController::volume(double);\n
+getter MediaError::code(unsigned short);\n
+method MediaList::appendMedium();\n
+method MediaList::deleteMedium();\n
+method MediaList::item();\n
+getter MediaList::length(unsigned long);\n
+getter MediaList::mediaText(string);\n
+setter MediaList::mediaText(string);\n
+getter MessageChannel::port1(user);\n
+getter MessageChannel::port2(user);\n
+getter MessageEvent::data(any);\n
+method MessageEvent::initMessageEvent();\n
+getter MessageEvent::lastEventId(string);\n
+getter MessageEvent::origin(string);\n
+getter MessageEvent::ports(user);\n
+getter MessageEvent::source(multiple);\n
+method MessagePort::close();\n
+getter MessagePort::onmessage(user);\n
+setter MessagePort::onmessage(user);\n
+method MessagePort::postMessage();\n
+method MessagePort::start();\n
+method MimeTypeArray::item();\n
+getter MimeTypeArray::length(unsigned long);\n
+method MimeTypeArray::namedItem();\n
+getter MimeType::description(string);\n
+getter MimeType::enabledPlugin(user);\n
+getter MimeType::suffixes(string);\n
+getter MimeType::type(string);\n
+getter MouseEvent::altKey(boolean);\n
+getter MouseEvent::button(short);\n
+getter MouseEvent::buttons(unsigned short);\n
+getter MouseEvent::clientX(long);\n
+getter MouseEvent::clientY(long);\n
+getter MouseEvent::ctrlKey(boolean);\n
+method MouseEvent::getModifierState();\n
+method MouseEvent::initMouseEvent();\n
+getter MouseEvent::metaKey(boolean);\n
+getter MouseEvent::region(string);\n
+getter MouseEvent::relatedTarget(user);\n
+getter MouseEvent::screenX(long);\n
+getter MouseEvent::screenY(long);\n
+getter MouseEvent::shiftKey(boolean);\n
+getter MutationEvent::attrChange(unsigned short);\n
+getter MutationEvent::attrName(string);\n
+method MutationEvent::initMutationEvent();\n
+getter MutationEvent::newValue(string);\n
+getter MutationEvent::prevValue(string);\n
+getter MutationEvent::relatedNode(user);\n
+method MutationObserver::disconnect();\n
+method MutationObserver::observe();\n
+method MutationObserver::takeRecords();\n
+getter MutationRecord::addedNodes(user);\n
+getter MutationRecord::attributeNamespace(string);\n
+getter MutationRecord::attributeName(string);\n
+getter MutationRecord::nextSibling(user);\n
+getter MutationRecord::oldValue(string);\n
+getter MutationRecord::previousSibling(user);\n
+getter MutationRecord::removedNodes(user);\n
+getter MutationRecord::target(user);\n
+getter MutationRecord::type(string);\n
+method NamedNodeMap::getNamedItem();\n
+method NamedNodeMap::getNamedItemNS();\n
+method NamedNodeMap::item();\n
+getter NamedNodeMap::length(unsigned long);\n
+method NamedNodeMap::removeNamedItem();\n
+method NamedNodeMap::removeNamedItemNS();\n
+method NamedNodeMap::setNamedItem();\n
+method NamedNodeMap::setNamedItemNS();\n
+method Navigator::isContentHandlerRegistered();\n
+method Navigator::isProtocolHandlerRegistered();\n
+getter Navigator::languages(string);\n
+getter Navigator::language(string);\n
+getter Navigator::mimeTypes(user);\n
+getter Navigator::onLine(boolean);\n
+getter Navigator::plugins(user);\n
+method Navigator::registerContentHandler();\n
+method Navigator::registerProtocolHandler();\n
+method Navigator::unregisterContentHandler();\n
+method Navigator::unregisterProtocolHandler();\n
+method Navigator::yieldForStorageUpdates();\n
+method NodeFilter::acceptNode();\n
+method NodeIterator::detach();\n
+getter NodeIterator::filter(user);\n
+method NodeIterator::nextNode();\n
+getter NodeIterator::pointerBeforeReferenceNode(boolean);\n
+method NodeIterator::previousNode();\n
+getter NodeIterator::referenceNode(user);\n
+getter NodeIterator::root(user);\n
+getter NodeIterator::whatToShow(unsigned long);\n
+getter PageTransitionEvent::persisted(boolean);\n
+method Path2D::addPath();\n
+method Path2D::addPathByStrokingPath();\n
+method Path2D::addPathByStrokingText();\n
+method Path2D::addText();\n
+method Path2D::arc();\n
+method Path2D::arcTo();\n
+method Path2D::bezierCurveTo();\n
+method Path2D::closePath();\n
+method Path2D::ellipse();\n
+method Path2D::lineTo();\n
+method Path2D::moveTo();\n
+method Path2D::quadraticCurveTo();\n
+method Path2D::rect();\n
+method PluginArray::item();\n
+getter PluginArray::length(unsigned long);\n
+method PluginArray::namedItem();\n
+method PluginArray::refresh();\n
+getter Plugin::description(string);\n
+getter Plugin::filename(string);\n
+method Plugin::item();\n
+getter Plugin::length(unsigned long);\n
+method Plugin::namedItem();\n
+getter Plugin::name(string);\n
+getter PopStateEvent::state(any);\n
+getter ProcessingInstruction::sheet(user);\n
+getter ProcessingInstruction::target(string);\n
+getter PseudoElement::cascadedStyle(user);\n
+getter PseudoElement::defaultStyle(user);\n
+getter PseudoElement::rawComputedStyle(user);\n
+getter PseudoElement::usedStyle(user);\n
+getter RadioNodeList::value(string);\n
+setter RadioNodeList::value(string);\n
+method Range::cloneContents();\n
+method Range::cloneRange();\n
+method Range::collapse();\n
+getter Range::collapsed(boolean);\n
+getter Range::commonAncestorContainer(user);\n
+method Range::compareBoundaryPoints();\n
+method Range::comparePoint();\n
+method Range::createContextualFragment();\n
+method Range::deleteContents();\n
+method Range::detach();\n
+getter Range::endContainer(user);\n
+getter Range::endOffset(unsigned long);\n
+method Range::extractContents();\n
+method Range::insertNode();\n
+method Range::intersectsNode();\n
+method Range::isPointInRange();\n
+method Range::selectNode();\n
+method Range::selectNodeContents();\n
+method Range::setEnd();\n
+method Range::setEndAfter();\n
+method Range::setEndBefore();\n
+method Range::setStart();\n
+method Range::setStartAfter();\n
+method Range::setStartBefore();\n
+getter Range::startContainer(user);\n
+getter Range::startOffset(unsigned long);\n
+method Range::surroundContents();\n
+getter RelatedEvent::relatedTarget(user);\n
+getter SharedWorkerGlobalScope::applicationCache(user);\n
+getter SharedWorkerGlobalScope::name(string);\n
+getter SharedWorkerGlobalScope::onconnect(user);\n
+setter SharedWorkerGlobalScope::onconnect(user);\n
+getter SharedWorker::onerror(user);\n
+setter SharedWorker::onerror(user);\n
+getter SharedWorker::port(user);\n
+method Storage::clear();\n
+getter StorageEvent::key(string);\n
+getter StorageEvent::newValue(string);\n
+getter StorageEvent::oldValue(string);\n
+getter StorageEvent::storageArea(user);\n
+getter StorageEvent::url(string);\n
+method Storage::getItem();\n
+method Storage::key();\n
+getter Storage::length(unsigned long);\n
+method Storage::removeItem();\n
+method Storage::setItem();\n
+getter StyleSheet::disabled(boolean);\n
+setter StyleSheet::disabled(boolean);\n
+getter StyleSheet::href(string);\n
+method StyleSheetList::item();\n
+getter StyleSheetList::length(unsigned long);\n
+getter StyleSheet::media(user);\n
+getter StyleSheet::ownerNode(multiple);\n
+getter StyleSheet::parentStyleSheet(user);\n
+getter StyleSheet::title(string);\n
+getter StyleSheet::type(string);\n
+getter SVGElement::style(user);\n
+getter TextMetrics::actualBoundingBoxAscent(double);\n
+getter TextMetrics::actualBoundingBoxDescent(double);\n
+getter TextMetrics::actualBoundingBoxLeft(double);\n
+getter TextMetrics::actualBoundingBoxRight(double);\n
+getter TextMetrics::alphabeticBaseline(double);\n
+getter TextMetrics::emHeightAscent(double);\n
+getter TextMetrics::emHeightDescent(double);\n
+getter TextMetrics::fontBoundingBoxAscent(double);\n
+getter TextMetrics::fontBoundingBoxDescent(double);\n
+getter TextMetrics::hangingBaseline(double);\n
+getter TextMetrics::ideographicBaseline(double);\n
+getter TextMetrics::width(double);\n
+method Text::splitText();\n
+getter TextTrack::activeCues(user);\n
+method TextTrack::addCue();\n
+getter TextTrackCue::endTime(double);\n
+setter TextTrackCue::endTime(double);\n
+getter TextTrackCue::id(string);\n
+setter TextTrackCue::id(string);\n
+method TextTrackCueList::getCueById();\n
+getter TextTrackCueList::length(unsigned long);\n
+getter TextTrackCue::onenter(user);\n
+setter TextTrackCue::onenter(user);\n
+getter TextTrackCue::onexit(user);\n
+setter TextTrackCue::onexit(user);\n
+getter TextTrackCue::pauseOnExit(boolean);\n
+setter TextTrackCue::pauseOnExit(boolean);\n
+getter TextTrackCue::startTime(double);\n
+setter TextTrackCue::startTime(double);\n
+getter TextTrack::cues(user);\n
+getter TextTrackCue::track(user);\n
+getter TextTrack::id(string);\n
+getter TextTrack::inBandMetadataTrackDispatchType(string);\n
+getter TextTrack::kind(user);\n
+getter TextTrack::label(string);\n
+getter TextTrack::language(string);\n
+method TextTrackList::getTrackById();\n
+getter TextTrackList::length(unsigned long);\n
+getter TextTrackList::onaddtrack(user);\n
+setter TextTrackList::onaddtrack(user);\n
+getter TextTrackList::onchange(user);\n
+setter TextTrackList::onchange(user);\n
+getter TextTrackList::onremovetrack(user);\n
+setter TextTrackList::onremovetrack(user);\n
+getter TextTrack::mode(user);\n
+setter TextTrack::mode(user);\n
+getter TextTrack::oncuechange(user);\n
+setter TextTrack::oncuechange(user);\n
+method TextTrack::removeCue();\n
+getter Text::wholeText(string);\n
+method TimeRanges::end();\n
+getter TimeRanges::length(unsigned long);\n
+method TimeRanges::start();\n
+getter Touch::region(string);\n
+getter TrackEvent::track(multiple);\n
+getter TreeWalker::currentNode(user);\n
+setter TreeWalker::currentNode(user);\n
+getter TreeWalker::filter(user);\n
+method TreeWalker::firstChild();\n
+method TreeWalker::lastChild();\n
+method TreeWalker::nextNode();\n
+method TreeWalker::nextSibling();\n
+method TreeWalker::parentNode();\n
+method TreeWalker::previousNode();\n
+method TreeWalker::previousSibling();\n
+getter TreeWalker::root(user);\n
+getter TreeWalker::whatToShow(unsigned long);\n
+getter UIEvent::detail(long);\n
+method UIEvent::initUIEvent();\n
+getter UIEvent::view(user);\n
+method URL::domainToASCII();\n
+method URL::domainToUnicode();\n
+getter URL::hash(user);\n
+setter URL::hash(user);\n
+getter URL::hostname(user);\n
+setter URL::hostname(user);\n
+getter URL::host(user);\n
+setter URL::host(user);\n
+getter URL::href(user);\n
+setter URL::href(user);\n
+getter URL::origin(user);\n
+getter URL::password(user);\n
+setter URL::password(user);\n
+getter URL::pathname(user);\n
+setter URL::pathname(user);\n
+getter URL::port(user);\n
+setter URL::port(user);\n
+getter URL::protocol(user);\n
+setter URL::protocol(user);\n
+method URLSearchParams::append();\n
+method URLSearchParams::delete();\n
+method URLSearchParams::get();\n
+method URLSearchParams::getAll();\n
+method URLSearchParams::has();\n
+method URLSearchParams::set();\n
+getter URL::searchParams(user);\n
+setter URL::searchParams(user);\n
+getter URL::search(user);\n
+setter URL::search(user);\n
+getter URL::username(user);\n
+setter URL::username(user);\n
+getter ValidityState::badInput(boolean);\n
+getter ValidityState::customError(boolean);\n
+getter ValidityState::patternMismatch(boolean);\n
+getter ValidityState::rangeOverflow(boolean);\n
+getter ValidityState::rangeUnderflow(boolean);\n
+getter ValidityState::stepMismatch(boolean);\n
+getter ValidityState::tooLong(boolean);\n
+getter ValidityState::tooShort(boolean);\n
+getter ValidityState::typeMismatch(boolean);\n
+getter ValidityState::valid(boolean);\n
+getter ValidityState::valueMissing(boolean);\n
+getter VideoTrack::id(string);\n
+getter VideoTrack::kind(string);\n
+getter VideoTrack::label(string);\n
+getter VideoTrack::language(string);\n
+method VideoTrackList::getTrackById();\n
+getter VideoTrackList::length(unsigned long);\n
+getter VideoTrackList::onaddtrack(user);\n
+setter VideoTrackList::onaddtrack(user);\n
+getter VideoTrackList::onchange(user);\n
+setter VideoTrackList::onchange(user);\n
+getter VideoTrackList::onremovetrack(user);\n
+setter VideoTrackList::onremovetrack(user);\n
+getter VideoTrackList::selectedIndex(long);\n
+getter VideoTrack::selected(boolean);\n
+setter VideoTrack::selected(boolean);\n
+getter WebSocket::binaryType(user);\n
+setter WebSocket::binaryType(user);\n
+getter WebSocket::bufferedAmount(unsigned long);\n
+method WebSocket::close();\n
+getter WebSocket::extensions(string);\n
+getter WebSocket::onclose(user);\n
+setter WebSocket::onclose(user);\n
+getter WebSocket::onerror(user);\n
+setter WebSocket::onerror(user);\n
+getter WebSocket::onmessage(user);\n
+setter WebSocket::onmessage(user);\n
+getter WebSocket::onopen(user);\n
+setter WebSocket::onopen(user);\n
+getter WebSocket::protocol(string);\n
+getter WebSocket::readyState(unsigned short);\n
+method WebSocket::send();\n
+getter WebSocket::url(string);\n
+getter WheelEvent::deltaMode(unsigned long);\n
+getter WheelEvent::deltaX(double);\n
+getter WheelEvent::deltaY(double);\n
+getter WheelEvent::deltaZ(double);\n
+method WheelEvent::initWheelEvent();\n
+getter Window::applicationCache(user);\n
+method Window::atob();\n
+method Window::blur();\n
+method Window::btoa();\n
+method Window::cancelAnimationFrame();\n
+method Window::captureEvents();\n
+method Window::clearInterval();\n
+method Window::clearTimeout();\n
+method Window::close();\n
+getter Window::closed(boolean);\n
+method Window::confirm();\n
+method Window::createImageBitmap();\n
+getter Window::external(user);\n
+method Window::focus();\n
+getter Window::frameElement(user);\n
+getter Window::frames(user);\n
+method Window::getComputedStyle();\n
+getter Window::history(user);\n
+getter Window::length(unsigned long);\n
+getter Window::localStorage(user);\n
+getter Window::locationbar(user);\n
+getter Window::menubar(user);\n
+getter Window::onabort(user);\n
+setter Window::onabort(user);\n
+getter Window::onafterprint(user);\n
+setter Window::onafterprint(user);\n
+getter Window::onautocompleteerror(user);\n
+setter Window::onautocompleteerror(user);\n
+getter Window::onautocomplete(user);\n
+setter Window::onautocomplete(user);\n
+getter Window::onbeforeprint(user);\n
+setter Window::onbeforeprint(user);\n
+getter Window::onbeforeunload(user);\n
+setter Window::onbeforeunload(user);\n
+getter Window::onblur(user);\n
+setter Window::onblur(user);\n
+getter Window::oncancel(user);\n
+setter Window::oncancel(user);\n
+getter Window::oncanplaythrough(user);\n
+setter Window::oncanplaythrough(user);\n
+getter Window::oncanplay(user);\n
+setter Window::oncanplay(user);\n
+getter Window::onchange(user);\n
+setter Window::onchange(user);\n
+getter Window::onclick(user);\n
+setter Window::onclick(user);\n
+getter Window::onclose(user);\n
+setter Window::onclose(user);\n
+getter Window::oncontextmenu(user);\n
+setter Window::oncontextmenu(user);\n
+getter Window::oncuechange(user);\n
+setter Window::oncuechange(user);\n
+getter Window::ondblclick(user);\n
+setter Window::ondblclick(user);\n
+getter Window::ondragend(user);\n
+setter Window::ondragend(user);\n
+getter Window::ondragenter(user);\n
+setter Window::ondragenter(user);\n
+getter Window::ondragexit(user);\n
+setter Window::ondragexit(user);\n
+getter Window::ondragleave(user);\n
+setter Window::ondragleave(user);\n
+getter Window::ondragover(user);\n
+setter Window::ondragover(user);\n
+getter Window::ondragstart(user);\n
+setter Window::ondragstart(user);\n
+getter Window::ondrag(user);\n
+setter Window::ondrag(user);\n
+getter Window::ondrop(user);\n
+setter Window::ondrop(user);\n
+getter Window::ondurationchange(user);\n
+setter Window::ondurationchange(user);\n
+getter Window::onemptied(user);\n
+setter Window::onemptied(user);\n
+getter Window::onended(user);\n
+setter Window::onended(user);\n
+getter Window::onerror(user);\n
+setter Window::onerror(user);\n
+getter Window::onfocus(user);\n
+setter Window::onfocus(user);\n
+getter Window::onhashchange(user);\n
+setter Window::onhashchange(user);\n
+getter Window::oninput(user);\n
+setter Window::oninput(user);\n
+getter Window::oninvalid(user);\n
+setter Window::oninvalid(user);\n
+getter Window::onkeydown(user);\n
+setter Window::onkeydown(user);\n
+getter Window::onkeypress(user);\n
+setter Window::onkeypress(user);\n
+getter Window::onkeyup(user);\n
+setter Window::onkeyup(user);\n
+getter Window::onlanguagechange(user);\n
+setter Window::onlanguagechange(user);\n
+getter Window::onloadeddata(user);\n
+setter Window::onloadeddata(user);\n
+getter Window::onloadedmetadata(user);\n
+setter Window::onloadedmetadata(user);\n
+getter Window::onloadstart(user);\n
+setter Window::onloadstart(user);\n
+getter Window::onload(user);\n
+setter Window::onload(user);\n
+getter Window::onmessage(user);\n
+setter Window::onmessage(user);\n
+getter Window::onmousedown(user);\n
+setter Window::onmousedown(user);\n
+getter Window::onmouseenter(user);\n
+setter Window::onmouseenter(user);\n
+getter Window::onmouseleave(user);\n
+setter Window::onmouseleave(user);\n
+getter Window::onmousemove(user);\n
+setter Window::onmousemove(user);\n
+getter Window::onmouseout(user);\n
+setter Window::onmouseout(user);\n
+getter Window::onmouseover(user);\n
+setter Window::onmouseover(user);\n
+getter Window::onmouseup(user);\n
+setter Window::onmouseup(user);\n
+getter Window::onoffline(user);\n
+setter Window::onoffline(user);\n
+getter Window::ononline(user);\n
+setter Window::ononline(user);\n
+getter Window::onpagehide(user);\n
+setter Window::onpagehide(user);\n
+getter Window::onpageshow(user);\n
+setter Window::onpageshow(user);\n
+getter Window::onpause(user);\n
+setter Window::onpause(user);\n
+getter Window::onplaying(user);\n
+setter Window::onplaying(user);\n
+getter Window::onplay(user);\n
+setter Window::onplay(user);\n
+getter Window::onpopstate(user);\n
+setter Window::onpopstate(user);\n
+getter Window::onprogress(user);\n
+setter Window::onprogress(user);\n
+getter Window::onratechange(user);\n
+setter Window::onratechange(user);\n
+getter Window::onreset(user);\n
+setter Window::onreset(user);\n
+getter Window::onresize(user);\n
+setter Window::onresize(user);\n
+getter Window::onscroll(user);\n
+setter Window::onscroll(user);\n
+getter Window::onseeked(user);\n
+setter Window::onseeked(user);\n
+getter Window::onseeking(user);\n
+setter Window::onseeking(user);\n
+getter Window::onselect(user);\n
+setter Window::onselect(user);\n
+getter Window::onshow(user);\n
+setter Window::onshow(user);\n
+getter Window::onsort(user);\n
+setter Window::onsort(user);\n
+getter Window::onstalled(user);\n
+setter Window::onstalled(user);\n
+getter Window::onstorage(user);\n
+setter Window::onstorage(user);\n
+getter Window::onsubmit(user);\n
+setter Window::onsubmit(user);\n
+getter Window::onsuspend(user);\n
+setter Window::onsuspend(user);\n
+getter Window::ontimeupdate(user);\n
+setter Window::ontimeupdate(user);\n
+getter Window::ontoggle(user);\n
+setter Window::ontoggle(user);\n
+getter Window::onunload(user);\n
+setter Window::onunload(user);\n
+getter Window::onvolumechange(user);\n
+setter Window::onvolumechange(user);\n
+getter Window::onwaiting(user);\n
+setter Window::onwaiting(user);\n
+getter Window::onwheel(user);\n
+setter Window::onwheel(user);\n
+method Window::open();\n
+getter Window::opener(any);\n
+setter Window::opener(any);\n
+getter Window::parent(user);\n
+getter Window::personalbar(user);\n
+method Window::postMessage();\n
+method Window::print();\n
+method Window::prompt();\n
+method Window::releaseEvents();\n
+method Window::requestAnimationFrame();\n
+getter Window::scrollbars(user);\n
+getter Window::self(user);\n
+getter Window::sessionStorage(user);\n
+method Window::setInterval();\n
+method Window::setTimeout();\n
+method Window::showModalDialog();\n
+getter Window::statusbar(user);\n
+getter Window::status(string);\n
+setter Window::status(string);\n
+method Window::stop();\n
+getter Window::toolbar(user);\n
+getter Window::top(user);\n
+method WorkerGlobalScope::atob();\n
+method WorkerGlobalScope::btoa();\n
+method WorkerGlobalScope::clearInterval();\n
+method WorkerGlobalScope::clearTimeout();\n
+method WorkerGlobalScope::close();\n
+method WorkerGlobalScope::createImageBitmap();\n
+method WorkerGlobalScope::importScripts();\n
+getter WorkerGlobalScope::location(user);\n
+getter WorkerGlobalScope::navigator(user);\n
+getter WorkerGlobalScope::onerror(user);\n
+setter WorkerGlobalScope::onerror(user);\n
+getter WorkerGlobalScope::onlanguagechange(user);\n
+setter WorkerGlobalScope::onlanguagechange(user);\n
+getter WorkerGlobalScope::onoffline(user);\n
+setter WorkerGlobalScope::onoffline(user);\n
+getter WorkerGlobalScope::ononline(user);\n
+setter WorkerGlobalScope::ononline(user);\n
+getter WorkerGlobalScope::self(user);\n
+method WorkerGlobalScope::setInterval();\n
+method WorkerGlobalScope::setTimeout();\n
+getter WorkerLocation::hash(user);\n
+getter WorkerLocation::hostname(user);\n
+getter WorkerLocation::host(user);\n
+getter WorkerLocation::href(user);\n
+getter WorkerLocation::origin(user);\n
+getter WorkerLocation::pathname(user);\n
+getter WorkerLocation::port(user);\n
+getter WorkerLocation::protocol(user);\n
+getter WorkerLocation::search(user);\n
+getter WorkerNavigator::appCodeName(string);\n
+getter WorkerNavigator::appName(string);\n
+getter WorkerNavigator::appVersion(string);\n
+getter WorkerNavigator::languages(string);\n
+getter WorkerNavigator::language(string);\n
+getter WorkerNavigator::onLine(boolean);\n
+getter WorkerNavigator::platform(string);\n
+getter WorkerNavigator::product(string);\n
+getter WorkerNavigator::productSub(string);\n
+method WorkerNavigator::taintEnabled();\n
+getter WorkerNavigator::userAgent(string);\n
+getter WorkerNavigator::vendor(string);\n
+getter WorkerNavigator::vendorSub(string);\n
+getter Worker::onerror(user);\n
+setter Worker::onerror(user);\n
+getter Worker::onmessage(user);\n
+setter Worker::onmessage(user);\n
+method Worker::postMessage();\n
+method Worker::terminate();\n
+method XMLDocument::load();\n
+method XMLSerializer::serializeToString();\n
+*/
diff --git a/docs/building-AmigaCross.md b/docs/building-AmigaCross.md
new file mode 100644
index 0000000..32762cd
--- a/dev/null
+++ b/docs/building-AmigaCross.md
@@ -0,0 +1,83 @@
+to install an Amiga cross-compiler in a Linux distribution, there are instructions at
+
+http://utilitybase.com/article/show/2007/06/23/231/Installing+an+AmigaOS+4+cross+compiler
+
+a more Mac-oriented article [though of potentially general utility] is at
+http://utilitybase.com/article/show/2006/05/21/188/Building+Amiga+OS+4+GCC+Cross+Compiler+for+UNIX%252FMAC
+
+more background at
+http://cross.zerohero.se/os4.html
+
+cross-compile additional libs/tools
+SDK
+http://www.hyperion-entertainment.biz/
+
+newlib
+http://sources.redhat.com/newlib/
+
+clib2
+http://sourceforge.net/projects/clib2/
+
+ixemul
+http://strohmayer.org/sfs/
+
+libnix
+http://sourceforge.net/projects/libnix/
+
+though newlib / clib2 are apparently already included in the ppc-amigaos-gcc tarball
+
+lha utility is debian package lha
+
+then install linked libs in the correct place
+
+[normally /usr/local/amiga]
+so
+sudo chmod --recursive 775 /usr/local/amiga
+sudo chmod --recursive +s /usr/local/amiga
+sudo chown --recursive `whoami` /usr/local/amiga
+sudo chgrp --recursive root /usr/local/amiga
+[mkdir /usr/local/amiga/include]
+
+[may need to set ppc-amigaos-gcc libpaths]
+
+zlib
+download tarball from project homepage, untar in a storage directory /
+download source from your distribution's repository [zlib1g in Ubuntu]
+[cd to top-level directory of zlib containing configure script]
+CC=ppc-amigaos-gcc AR=ppc-amigaos-ar RANLIB=ppc-amigaos-ranlib \
+CFLAGS="-DNO_FSEEKO" ./configure --prefix=/usr/local/amiga
+make
+make install
+
+regex [pre-compiled]
+http://aminet.net/dev/lib/libregex-4.4.3.lha
+
+libcurl
+download the tarball from the project's homepage, untar in a storage directory /
+download source from your distribution's repository
+cd into the directory containing the configure file
+./configure --prefix=/usr/local/amiga --host=ppc-amigaos
+$ make
+[you MUST have either POSIX or glibc strerror_r if strerror_r is found]
+$ make install
+
+alternative
+http://www.aminet.net/dev/lib/libcurl.lha
+
+libiconv [unnecessary as a non-overridable limited version is included in newlib]
+
+openssl
+
+libpng
+
+liblcms
+http://www.aminet.net/dev/lib/liblcms_so.lha
+http://www.aminet.net/dev/lib/liblcms_so.lha
+
+libjpeg
+
+libparserutils
+libhubbub
+libcss
+libnsbmp
+libnsgif
diff --git a/docs/building-AmigaOS.md b/docs/building-AmigaOS.md
new file mode 100644
index 0000000..3f05b9c
--- a/dev/null
+++ b/docs/building-AmigaOS.md
@@ -0,0 +1,129 @@
+--------------------------------------------------------------------------------
+ Build Instructions for AmigaOS NetSurf 02 May 2014
+--------------------------------------------------------------------------------
+
+ This document provides instructions for building the AmigaOS version of
+ NetSurf and provides guidance on obtaining NetSurf's build dependencies.
+
+ AmigaOS NetSurf has been tested on AmigaOS 4.0 July 2007 Update and AmigaOS
+ 4.1. It will require modification for AmigaOS 3.9 or earlier, or other
+ Amiga-like platforms.
+
+ AmigaOS NetSurf will build against newlib by default, building against
+ clib2 has not been tested.
+
+
+ Building and executing NetSurf
+================================
+
+ First of all, you should examine the contents of Makefile.defaults
+ and enable and disable relevant features as you see fit by creating
+ a Makefile.config. Some of these options can be automatically
+ detected and used, although it is better to explicitly enable or
+ disable options.
+
+ You should then obtain NetSurf's dependencies, keeping in mind which options
+ you have enabled in the configuration file. See the next section for
+ specifics.
+
+ Once done, to build AmigaOS NetSurf on OS4, simply run:
+
+ 1> gmake
+
+ If that produces errors, you probably don't have some of NetSurf's build
+ dependencies installed. See "Obtaining NetSurf's dependencies" below, or turn
+ off the complaining features in a Makefile.config.
+
+ Running NetSurf from the build tree requires some setup:
+
+ 1> makelink resources amiga/resources force
+ 1> copy amiga/resources/themes/default/NetSurf.info NetSurf.info
+
+ It should then be possible to run NetSurf by executing NetSurf from the
+ Shell or by double-clicking on the icon.
+
+
+ Obtaining NetSurf's build dependencies
+========================================
+
+ Many of NetSurf's dependencies are included with the OS4 SDK or available
+ from Aminet or OS4Depot. The remainder must be built manually.
+
+ The NetSurf project's libraries
+---------------------------------
+
+ The NetSurf project has developed several libraries which are required by
+ the browser. To fetch each of these libraries, run the appropriate commands
+ from the Docs/LIBRARIES file.
+
+ To build and install these libraries, simply enter each of their directories
+ and run:
+
+ 1> gmake PREFIX=/path/to/buildsystem
+
+ The path MUST be in UNIX format and point to directory containing "share".
+
+ | Note: Building libsvgtiny requires gperf, which is available from Aminet:
+ |
+ | http://www.aminet.net/package/dev/c/gperf
+
+
+ cURL
+------
+
+ A version of libcurl built for newlib is available from Aminet
+
+ http://www.os4depot.net/share/development/library/misc/libcurl.lha
+
+
+
+ libpng
+--------
+
+ NetSurf uses libPNG to display PNG files.
+ It builds without any problems on OS4, or available from OS4Depot:
+
+ http://www.os4depot.net/share/development/library/graphics/libpng.lha
+
+
+ OpenSSL
+---------
+
+ NetSurf uses OpenSSL for encrypted transfers.
+
+ http://www.os4depot.net/share/development/library/misc/libopenssl.lha
+
+
+ Libharu
+---------
+
+ NetSurf can use Haru PDF to enable PDF export. Haru PDF can be obtained
+ from http://libharu.org/. We require libharu 2.2 or later.
+
+ | Note: libharu cannot be auto-detected by the Makefile. If you wish to
+ | enable it, do so by creating a Makefile.config file.
+
+
+ libregex
+----------
+
+ A version of the regular expression library can be obtained from Aminet:
+
+ http://www.aminet.net/package/dev/lib/libregex-4.4.3
+
+
+ openurl.library
+-----------------
+
+ The AmigaOS mailto: URL support uses openurl.library, this and the includes
+ can be obtained from Aminet:
+
+ http://www.aminet.net/package/comm/www/OpenURL-OS4
+
+
+ Spidermonkey
+--------------
+
+ Experimental Javascript support requires Spidermonkey. The patches to
+ build v1.7 are available from the NetSurf toolchains Git repository.
+
diff --git a/docs/building-Framebuffer.md b/docs/building-Framebuffer.md
new file mode 100644
index 0000000..3c8858a
--- a/dev/null
+++ b/docs/building-Framebuffer.md
@@ -0,0 +1,350 @@
+--------------------------------------------------------------------------------
+ Build Instructions for Framebuffer NetSurf 16 March 2014
+--------------------------------------------------------------------------------
+
+ This document provides instructions for building the Framebuffer version of
+ NetSurf and provides guidance on obtaining NetSurf's build dependencies.
+
+ Framebuffer NetSurf has been tested on Ubuntu and Debian.
+
+ Depending on the framebuffer frontend selected the build may need specific
+ libraries installed, e.g. the SDL port requires SDL1.2 or later
+
+ There are two ways to get NetSurf building. The QUICK-START (recommended),
+ and the manual build. Whichever you choose, you should read both the
+ "Fonts", and "Selecting a frontend and appropriate options" sections below.
+
+
+ Quick Start
+=============
+
+ See the QUICK-START document, which provides a simple environment with
+ which you can fetch, build and install NetSurf and its dependencies.
+
+ The QUICK-START is the recommended way to build NetSurf.
+
+
+ Manual building
+=================
+
+ If you can't follow the quick start instructions, you will have to build
+ NetSurf manually. The instructions for doing this are given below.
+
+
+ Obtaining the build dependencies
+----------------------------------
+
+ Many of NetSurf's dependencies are packaged on various operating systems.
+ The remainder must be installed manually. Currently, some of the libraries
+ developed as part of the NetSurf project have not had official releases.
+ Hopefully they will soon be released with downloadable tarballs and packaged
+ in common distros. For now, you'll have to make do with Git checkouts.
+
+ Package installation
+ --------------------
+
+ Debian-like OS:
+
+ $ apt-get install libcurl3-dev libpng-dev
+
+ Recent OS versions might need libcurl4-dev instead of libcurl3-dev but
+ note that when it has not been built with OpenSSL, the SSL_CTX is not
+ available and results that certification details won't be presented in case
+ they are invalid. But as this is currently unimplemented in the Framebuffer
+ flavour of NetSurf, this won't make a difference at all.
+
+ Fedora:
+
+ $ yum install curl-devel libpng-devel lcms-devel
+
+ Other:
+
+ You'll need to install the development resources for libcurl3 and libpng.
+
+
+ Preparing your workspace
+--------------------------
+
+ NetSurf has a number of libraries which must be built in-order and
+ installed into your workspace. Each library depends on a core build
+ system which NetSurf projects use. This build system relies on the
+ presence of things like pkg-config to find libraries and also certain
+ environment variables in order to work correctly.
+
+ Assuming you are preparing a workspace in /home/netsurf/workspace then
+ the following steps will set you up:
+
+ Make the workspace directory and change to it
+ ---------------------------------------------
+
+ $ mkdir -p ${HOME}/netsurf/workspace
+ $ cd ${HOME}/netsurf/workspace
+
+ Make the temporary install space
+ --------------------------------
+
+ $ mkdir inst
+
+ Make an environment script
+ --------------------------
+ $ cat > env.sh <<'EOF'
+ export PKG_CONFIG_PATH=${HOME}/netsurf/workspace/inst/lib/pkgconfig::
+ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${HOME}/netsurf/workspace/inst/lib
+ export PREFIX=${HOME}/netsurf/workspace/inst
+ EOF
+
+ Change to workspace and source the environment
+ ----------------------------------------------
+
+ Whenever you wish to start development in a new shell, run the following:
+
+ $ cd ${HOME}/netsurf/workspace
+ $ source env.sh
+
+ From here on, any commands in this document assume you have sourced your
+ shell environment.
+
+
+ The NetSurf project's libraries
+---------------------------------
+
+ The NetSurf project has developed several libraries which are required by
+ the browser. These are:
+
+ BuildSystem -- Shared build system, needed to build the other libraries
+ LibParserUtils -- Parser building utility functions
+ LibWapcaplet -- String internment
+ Hubbub -- HTML5 compliant HTML parser
+ LibCSS -- CSS parser and selection engine
+ LibNSGIF -- GIF format image decoder
+ LibNSBMP -- BMP and ICO format image decoder
+ LibROSprite -- RISC OS Sprite format image decoder
+ LibNSFB -- Framebuffer abstraction
+
+ To fetch each of these libraries, run the appropriate commands from the
+ Docs/LIBRARIES file.
+
+ To build and install these libraries, simply enter each of their directories
+ and run:
+
+ $ make install
+
+ | Note: We advise enabling iconv() support in libparserutils, which vastly
+ | increases the number of supported character sets. To do this,
+ | create a file called Makefile.config.override in the libparserutils
+ | directory, containing the following line:
+ |
+ | CFLAGS += -DWITH_ICONV_FILTER
+ |
+ | For more information, consult the libparserutils README file.
+
+
+ Getting the NetSurf source
+----------------------------
+
+ From your workspace directory, run the following command to get the NetSurf
+ source:
+
+ $ git clone git://git.netsurf-browser.org/netsurf.git
+
+ And change to the 'netsurf' directory:
+
+ $ cd netsurf
+
+
+ Building and executing NetSurf
+--------------------------------
+
+ First of all, you should examine the contents of Makefile.defaults
+ and enable and disable relevant features as you see fit in a
+ Makefile.config file. Some of these options can be automatically
+ detected and used, and where this is the case they are set to such.
+ Others cannot be automatically detected from the Makefile, so you
+ will either need to install the dependencies, or set them to NO.
+
+ You should then obtain NetSurf's dependencies, keeping in mind which options
+ you have enabled in the configuration file. See the "Obtaining NetSurf's
+ dependencies" section for specifics.
+
+ Once done, to build Framebuffer NetSurf on a UNIX-like platform, simply run:
+
+ $ make TARGET=framebuffer
+
+ If that produces errors, you probably don't have some of NetSurf's build
+ dependencies installed. See "Obtaining NetSurf's dependencies" below.
+ Or turn off the complaining features in your Makefile.config. You may
+ need to "make clean" before attempting to build after installing the
+ dependencies.
+
+ Run NetSurf by executing the "nsfb" program:
+
+ $ ./nsfb
+
+ | Note: NetSurf uses certain resources at run time. In order to find these
+ | resources, it searches three locations:
+ |
+ | 1. ~/.netsurf/
+ | 2. $NETSURFRES/
+ | 3. /usr/share/netsurf/
+ |
+ | In the build tree, the resources are located at
+ |
+ | framebuffer/res
+ |
+ | Setting $NETSURFRES to point at the resources in the build tree
+ | will enable you to run NetSurf from here without installation.
+ | To do this, run:
+ |
+ | export NETSURFRES=`pwd`/framebuffer/res
+
+
+ Fonts
+=======
+
+ The framebuffer port currently has two choices for font
+ handling. The font handler may be selected at compile time by using
+ the NETSURF_FB_FONTLIB configuration key. Currently supported values
+ are internal and freetype
+
+ Internal
+----------
+
+ The internal font system has a single built in monospaced face with
+ CP467 encoding. The internal font plotter requires no additional
+ resources and is very fast, it is also aesthetically unappealing.
+
+ Freetype
+----------
+
+ The freetype font system (freetype version 2 API is used) has
+ support for a number of different font file formats and faces. The
+ framebuffer font handler takes advantage of the freetype library
+ caching system to give good performance.
+
+ The font glyphs are, by default, rendered as 256 level transparency
+ which gives excellent visual results even on small font sizes.
+
+ The default font is the DejaVu trutype font set. The default path they
+ are sourced from is /usr/share/fonts/truetype/ttf-dejavu/ .
+
+ The compiled in default paths may be altered by setting values in
+ the user configuration makefile Makefile.config. These values must
+ be set to the absolute path of the relevant font file including its
+ .ttf extension. The variables are:
+
+ NETSURF_FB_FONT_SANS_SERIF
+ NETSURF_FB_FONT_SANS_SERIF_BOLD
+ NETSURF_FB_FONT_SANS_SERIF_ITALIC
+ NETSURF_FB_FONT_SANS_SERIF_ITALIC_BOLD
+ NETSURF_FB_FONT_SERIF
+ NETSURF_FB_FONT_SERIF_BOLD
+ NETSURF_FB_FONT_MONOSPACE
+ NETSURF_FB_FONT_MONOSPACE_BOLD
+ NETSURF_FB_FONT_CURSIVE
+ NETSURF_FB_FONT_FANTASY
+
+ The font selection may be changed by placing truetype font files
+ in the resources path. The resource files will be the generic names
+ sans_serif.ttf, sans_serif_bold.ttf etc.
+
+ The font system is configured at runtime by several options. The
+ fb_font_monochrome option causes the renderer to use monochrome
+ glyph rendering which is faster to plot but slower to render and
+ much less visually appealing.
+
+ The remaining seven options control the files to be used for font faces.
+
+ fb_face_sans_serif - The sans serif face
+ fb_face_sans_serif_bold - The bold sans serif face
+ fb_face_sans_serif_italic - The italic sans serif face
+ fb_face_sans_serif_italic_bold - The bold italic sans serif face.
+ fb_face_serif - The serif font
+ fb_serif_bold - The bold serif font
+ fb_face_monospace - The monospaced font
+ fb_face_monospace_bold - The bold monospaced font
+ fb_face_cursive - The cursive font
+ fb_face_fantasy - The fantasy font
+
+ Old Freetype
+--------------
+
+ The framebuffer port Freetype font implementation was constructed
+ using a modern version of the library (2.3.5) to use versions 2.2.1
+ and prior the following patch is necessary.
+
+
+Index: framebuffer/font_freetype.c
+===================================================================
+--- framebuffer/font_freetype.c (revision 6750)
++++ framebuffer/font_freetype.c (working copy)
+@@ -311,6 +311,7 @@
+ FT_Glyph glyph;
+ FT_Error error;
+ fb_faceid_t *fb_face;
++ FTC_ImageTypeRec trec;
+
+ fb_fill_scalar(style, &srec);
+
+@@ -318,15 +319,24 @@
+
+ glyph_index = FTC_CMapCache_Lookup(ft_cmap_cache, srec.face_id, fb_face->cidx, ucs4);
+
+- error = FTC_ImageCache_LookupScaler(ft_image_cache,
+- &srec,
+- FT_LOAD_RENDER |
+- FT_LOAD_FORCE_AUTOHINT |
+- ft_load_type,
+- glyph_index,
+- &glyph,
+- NULL);
+
++ trec.face_id = srec.face_id;
++ if (srec.pixel) {
++ trec.width = srec.width;
++ trec.height = srec.height;
++ } else {
++ /* Convert from 1/64 pts to pixels */
++ trec.width = srec.width * css_screen_dpi / 64 / srec.x_res;
++ trec.height = srec.height * css_screen_dpi / 64 / srec.y_res;
++ }
++ trec.flags = FT_LOAD_RENDER | FT_LOAD_FORCE_AUTOHINT | ft_load_type;
++
++ error = FTC_ImageCache_Lookup(ft_image_cache,
++ &trec,
++ glyph_index,
++ &glyph,
++ NULL);
++
+ return glyph;
+ }
+
+
+ Selecting a frontend and appropriate options
+==============================================
+
+ The framebuffer port interfaces to its input and output devices
+ using the NetSurf Framebuffer library (libnsfb). This library
+ provides an abstraction layer to input and output devices.
+
+ The surface used by libnsfb is selected by using the -f switch to
+ NetSurf when executed. A surface in this context is simply the
+ combination of input and output devices.
+
+ A surface output device may be any linearly mapped area of
+ memory. The framebuffer may be treated as values at 32, 16 or 8 bits
+ per pixel. The input device is typically selected to complement the
+ output device and is completely specific to the surface.
+
+ There are several configuration options which may influence the
+ framebuffer surfaces. These are:
+
+ fb_refresh - The refresh rate (for physical displays)
+ fb_depth - The depth (in bits per pixel) of the framebuffer
+ window_width - The width of the framebuffer
+ window_height - The height of the framebuffer
+
+ The defaults are for 800 by 600 pixels at 16bpp and 70Hz refresh rate.
+
+ The documentation of libnsfb should be consulted for futher
+ information about supported frontends and their configuration.
+
diff --git a/docs/building-GTK.md b/docs/building-GTK.md
new file mode 100644
index 0000000..4ac0fc8
--- a/dev/null
+++ b/docs/building-GTK.md
@@ -0,0 +1,239 @@
+--------------------------------------------------------------------------------
+ Build Instructions for GTK NetSurf 16 March 2014
+--------------------------------------------------------------------------------
+
+ This document provides instructions for building the GTK version of NetSurf
+ and provides guidance on obtaining NetSurf's build dependencies.
+
+ GTK NetSurf has been tested on Debian, Ubuntu, Fedora 8, FreeBSD, NetBSD and
+ Solaris 10. NetSurf requires at minimum GTK 2.12.
+
+
+ Quick Start
+=============
+
+ See the QUICK-START document, which provides a simple environment with
+ which you can fetch, build and install NetSurf and its dependencies.
+
+ The QUICK-START is the recommended way to build NetSurf.
+
+
+ Manual building
+=================
+
+ If you can't follow the quick start instructions, you will have to build
+ NetSurf manually. The instructions for doing this are given below.
+
+
+ Obtaining the build dependencies
+----------------------------------
+
+ Many of NetSurf's dependencies are packaged on various operating systems.
+ The remainder must be installed manually. Currently, some of the libraries
+ developed as part of the NetSurf project have not had official releases.
+ Hopefully they will soon be released with downloadable tarballs and packaged
+ in common distros. For now, you'll have to make do with Git checkouts.
+
+ Package installation
+ --------------------
+
+ Debian-like OS:
+
+ $ apt-get install libgtk2.0-dev libcurl3-dev libpng-dev
+ $ apt-get install librsvg2-dev libjpeg-dev
+
+ If you want to build with gtk 3 replace libgtk2.0-dev with libgtk-3-dev
+
+ Recent OS versions might need libcurl4-dev instead of libcurl3-dev but
+ note that when it has not been built with OpenSSL, the SSL_CTX is not
+ available and results that certification details won't be presented in case
+ they are invalid. But as this is currently unimplemented in the GTK
+ flavour of NetSurf, this won't make a difference at all.
+
+ For experimental javascript support the mozilla spiermonkey library
+ is required:
+
+ $ apt-get install libmozjs-dev
+
+ Fedora:
+
+ $ yum install curl-devel libpng-devel
+ $ yum install librsvg2-devel expat-devel
+
+ Other:
+
+ You'll need to install the development resources for libglade2, libcurl3,
+ libpng and librsvg.
+
+ Libharu
+ -------
+
+ NetSurf can use Haru PDF to enable PDF export. Haru PDF can be obtained
+ from http://libharu.org/. We require libharu 2.2 or later.
+
+ | Note: libharu cannot be auto-detected by the Makefile. If you wish to
+ | enable it, do so by creating a Makefile.config file.
+
+
+ Preparing your workspace
+--------------------------
+
+ NetSurf has a number of libraries which must be built in-order and
+ installed into your workspace. Each library depends on a core build
+ system which NetSurf projects use. This build system relies on the
+ presence of things like pkg-config to find libraries and also certain
+ environment variables in order to work correctly.
+
+ Assuming you are preparing a workspace in /home/netsurf/workspace then
+ the following steps will set you up:
+
+ Make the workspace directory and change to it
+ ---------------------------------------------
+
+ $ mkdir -p ${HOME}/netsurf/workspace
+ $ cd ${HOME}/netsurf/workspace
+
+ Make the temporary install space
+ --------------------------------
+
+ $ mkdir inst
+
+ Make an environment script
+ --------------------------
+ $ cat > env.sh <<'EOF'
+ export PKG_CONFIG_PATH=${HOME}/netsurf/workspace/inst/lib/pkgconfig::
+ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${HOME}/netsurf/workspace/inst/lib
+ export PREFIX=${HOME}/netsurf/workspace/inst
+ EOF
+
+ Change to workspace and source the environment
+ ----------------------------------------------
+
+ Whenever you wish to start development in a new shell, run the following:
+
+ $ cd ${HOME}/netsurf/workspace
+ $ source env.sh
+
+ From here on, any commands in this document assume you have sourced your
+ shell environment.
+
+
+ The NetSurf project's libraries
+---------------------------------
+
+ The NetSurf project has developed several libraries which are required by
+ the browser. These are:
+
+ BuildSystem -- Shared build system, needed to build the other libraries
+ LibParserUtils -- Parser building utility functions
+ LibWapcaplet -- String internment
+ Hubbub -- HTML5 compliant HTML parser
+ LibCSS -- CSS parser and selection engine
+ LibNSGIF -- GIF format image decoder
+ LibNSBMP -- BMP and ICO format image decoder
+ LibROSprite -- RISC OS Sprite format image decoder
+
+ To fetch each of these libraries, run the appropriate commands from the
+ Docs/LIBRARIES file, from within your workspace directory.
+
+ To build and install these libraries, simply enter each of their directories
+ and run:
+
+ $ make install
+
+ | Note: We advise enabling iconv() support in libparserutils, which vastly
+ | increases the number of supported character sets. To do this,
+ | create a file called Makefile.config.override in the libparserutils
+ | directory, containing the following line:
+ |
+ | CFLAGS += -DWITH_ICONV_FILTER
+ |
+ | For more information, consult the libparserutils README file.
+
+ Now you should have all the NetSurf project libraries built and installed.
+
+
+ Getting the NetSurf source
+----------------------------
+
+ From your workspace directory, run the following command to get the NetSurf
+ source:
+
+ $ git clone git://git.netsurf-browser.org/netsurf.git
+
+ And change to the 'netsurf' directory:
+
+ $ cd netsurf
+
+ Building and executing NetSurf
+--------------------------------
+
+ First of all, you should examine the options in Makefile.defaults
+ and gtk/Makefile.defaults and enable and disable relevant features
+ as you see fit by editing a Makefile.config file.
+
+ Some of these options can be automatically detected and used, and
+ where this is the case they are set to such. Others cannot be
+ automatically detected from the Makefile, so you will either need to
+ install the dependencies, or set them to NO.
+
+ You should then obtain NetSurf's dependencies, keeping in mind which options
+ you have enabled in the configuration file. See the next section for
+ specifics.
+
+ Once done, to build GTK NetSurf on a UNIX-like platform, simply run:
+
+ $ make
+
+ If that produces errors, you probably don't have some of NetSurf's
+ build dependencies installed. See "Obtaining NetSurf's dependencies"
+ below. Or turn off the complaining features in a Makefile.config
+ file. You may need to "make clean" before attempting to build after
+ installing the dependencies.
+
+ Run NetSurf by executing the "test-nsgtk" shell script:
+
+ $ ./test-nsgtk
+
+ This script makes it easy to run the nsgtk binary from the build tree. It
+ sets up some environment variables which enable NetSurf to find its
+ resources.
+
+ Builtin resources
+-------------------
+
+ There are numerous resources that accompany NetSurf, such as the
+ image files for icons, cursors and the ui builder files that
+ construct the browsers interface.
+
+ Some of these resources can be compiled into the browser executable
+ removing the need to install these resources separately. The GLib
+ library on which GTK is based provides this functionality to
+ NetSurf.
+
+ Up until GLib version 2.32 only the GDK pixbuf could be integrated
+ in this way and is controlled with the NETSURF_USE_INLINE_PIXBUF
+ variable (set in makefile.config).
+
+ Glib version 2.32 and later integrated support for any file to be a
+ resource while depreciating the old inline pixbuf interface. NetSurf
+ gtk executables can integrate many resources using this interface,
+ configuration is controlled with the NETSURF_USE_GRESOURCE variable.
+
+ Loading from file is the fallback if a resource has not been
+ compiled in, because of this if both of these features are
+ unavailable (or disabled) NetSurf will automatically fall back to
+ loading all its resources from files.
+
+ The resource initialisation within the browser ensures it can access
+ all the resources at start time, however it does not verify the
+ resources are valid so failures could still occur subsequently. This
+ is especially true for file based resources as they can become
+ inaccessible after initialisation.
+
+
+ Note for packagers
+====================
+
+ If you are packaging NetSurf, see the PACKAGING-GTK document.
+
diff --git a/docs/building-Haiku.md b/docs/building-Haiku.md
new file mode 100644
index 0000000..8642861
--- a/dev/null
+++ b/docs/building-Haiku.md
@@ -0,0 +1,146 @@
+--------------------------------------------------------------------------------
+ Build Instructions for BeOS and Haiku NetSurf 13 February 2010
+--------------------------------------------------------------------------------
+
+ This document provides instructions for building the BeOS and Haiku version
+ of NetSurf and provides guidance on obtaining NetSurf's build dependencies.
+
+ BeOS NetSurf has been tested on Zeta and Haiku only for now. There are still some
+ issues to sort out for other BeOS versions.
+
+ Quick Start
+=============
+
+ See the QUICK-START document, which provides a simple environment with
+ which you can fetch, build and install NetSurf and its dependencies.
+
+ The QUICK-START is the recommended way to build NetSurf for Haiku. BeOS needs too much manual
+ hacking to be built this way.
+
+
+ Manual building
+================================
+
+ To build NetSurf on a BeOS, provided you have the relevant
+ build dependencies installed, simply run:
+
+ $ make
+
+ If that produces errors, you probably don't have some of NetSurf's build
+ dependencies installed. See "Obtaining NetSurf's dependencies" below. You
+ may need to "make clean" before attempting to build after installing the
+ dependencies. Also note BeOS has an old make command that won't work, see
+ below.
+
+
+ Obtaining NetSurf's dependencies
+==================================
+
+ Many of NetSurf's dependencies are either installed or available for BeOS and
+ Haiku. The remainder must be installed manually.
+
+ The NetSurf project's libraries
+---------------------------------
+
+ The NetSurf project has developed several libraries which are required by
+ the browser. These are:
+
+ BuildSystem -- Shared build system, needed to build the other libraries
+ LibParserUtils -- Parser building utility functions
+ LibWapcaplet -- String internment
+ Hubbub -- HTML5 compliant HTML parser
+ LibCSS -- CSS parser and selection engine
+ LibNSGIF -- GIF format image decoder
+ LibNSBMP -- BMP and ICO format image decoder
+ LibROSprite -- RISC OS Sprite format image decoder
+
+ To fetch each of these libraries, run the appropriate commands from the
+ Docs/LIBRARIES file, from within your workspace directory.
+
+ To build and install these libraries, simply enter each of their directories
+ and run:
+
+ $ make install
+
+ | Note: We advise enabling iconv() support in libparserutils, which vastly
+ | increases the number of supported character sets. To do this,
+ | create a file called Makefile.config.override in the libparserutils
+ | directory, containing the following line:
+ |
+ | CFLAGS += -DWITH_ICONV_FILTER
+ |
+ | For more information, consult the libparserutils README file.
+
+ TODO: add some more here.
+
+ Additional requirements for BeOS
+==================================
+
+ On Haiku, other libraries and tools are either shipped with the system or available through the
+ package repositories. For BeOS based systems, you will need to install and update all the
+ required tools, as described below.
+
+ rc
+----
+
+ Building NetSurf needs the Haiku resource compiler (rc), that allows
+ importing files from resource definitions (.rdef).
+
+ $ cd <haiku-trunk-directory>
+ $ TARGET_PLATFORM=r5 jam -q rc
+ $ cp generated/objects/dano/x86/release/tools/rc/rc /boot/home/config/bin/
+
+
+ GNU make 3.81
+---------------
+
+ BeOS has an old make tool, which won't work when building NetSurf.
+ Haiku has 3.81 which is the one that works. For BeOS, one has to replace
+ the original make with one built from the Haiku tree, or install it as gmake:
+
+ $ cd <haiku-trunk-directory>
+ $ TARGET_PLATFORM=r5 jam -q make
+ $ cp generated/objects/r5/x86/release/bin/make/make /boot/home/config/bin/gmake
+
+
+ cURL
+------
+
+ NetSurf uses cURL to fetch files from the network.
+ There is a patch against the official version on HaikuPorts.
+
+ TODO
+
+
+ libpng
+--------
+
+ NetSurf uses libPNG to display PNG files.
+ It should build just fine on BeOS.
+
+
+ libjpeg
+---------
+
+ NetSurf uses libjpeg to display JPEG files.
+ It should already be available in your dev kit.
+
+
+ OpenSSL
+----------
+
+ NetSurf uses OpenSSL for encrypted transfers.
+
+
+ General requirements
+----------------------
+
+ There is currently an issue on stdbool.h (unsigned char bool vs enum bool)
+ which needs to be fixed, for now one can use the Haiku version of the header
+ and copy it over the gcc-provided one.
+ $ cd <haiku-trunk-directory>
+ $ cp headers/build/gcc-2.95.3/stdbool.h /boot/develop/tools/gnupro/lib/gcc-lib/i586-pc-beos/2.95.3-beos-060710/include/stdbool.h
+
+
+ NetSurf might build on BeOS R5 but probably won't work on anything else than
+ BONE.
diff --git a/docs/building-Windows.md b/docs/building-Windows.md
new file mode 100644
index 0000000..dc6769f
--- a/dev/null
+++ b/docs/building-Windows.md
@@ -0,0 +1,203 @@
+--------------------------------------------------------------------------------
+ Build Instructions for Windows NetSurf 13 February 2010
+--------------------------------------------------------------------------------
+
+ This document provides instructions for building the Windows version
+ of NetSurf and provides guidance on obtaining NetSurf's build
+ dependencies.
+
+ Windows NetSurf has been tested on Wine and Vista.
+
+
+ Building and executing NetSurf
+================================
+
+ The windows netsurf port uses the MinGW (Minimal GNU on Windows)
+ system as its build infrastructure. This allows the normal netsurf
+ build process to be used.
+
+ The method outlined here to create executables cross compiles
+ windows executable from a Linux OS host.
+
+ First of all, you should examine the contents of Makefile.defaults
+ and enable and disable relevant features as you see fit by creating
+ a Makefile.config file. Some of these options can be automatically
+ detected and used, and where this is the case they are set to such.
+ Others cannot be automatically detected from the Makefile, so you
+ will either need to install the dependencies, or set them to NO.
+
+ You should then obtain NetSurf's dependencies, keeping in mind which
+ options you have enabled in the configuration file. See the next
+ section for specifics.
+
+ Once done, to build windows NetSurf on a UNIX-like platform, simply run:
+
+ $ export MINGW_PREFIX=i586-mingw32msvc-
+ $ export MINGW_INSTALL_ENV=/usr/i586-mingw32msvc/
+ $ make TARGET=windows
+
+ If that produces errors, you probably don't have some of NetSurf's
+ build dependencies installed. See "Obtaining NetSurf's dependencies"
+ below. Or turn off the complaining features in a Makefile.config
+ file. You may need to "make clean" before attempting to build after
+ installing the dependencies.
+
+ You will need the libgnurx-0.dll from /usr/i586-mingw32msvc/bin/
+ copied next to the exe and the windows/res directory available, also
+ next to the executable.
+
+ Run NetSurf by executing it:
+
+ $ wine NetSurf.exe
+
+ The staticaly linked binary which is generated may be several
+ megabytes in size, this can be reduced by stripping the binary.
+
+ $ i586-mingw32msvc-strip NetSurf.exe
+
+
+ Obtaining NetSurf's build dependencies
+========================================
+
+ Package installation
+----------------------
+
+ Debian-based OS:
+
+ The mingw cross compilation tools are required. These can be
+ installed as pakages on Debian/Ubuntu systems:
+
+ $ sudo apt-get install mingw32 mingw32-binutils mingw32-runtime
+
+ These provide a suitable set of compilers and headers including the win32 API.
+
+ The includes and associated libraries are installed in
+ /usr/i586-mingw32msvc/ Which is where the build system will include
+ files from by default. The packages at time of writing only target
+ 32bit windows builds.
+
+ Other:
+
+ For other OS the apropriate packages and environment must be installed.
+
+ pkg-config
+------------
+
+ A pkg-config wrapper script is required to make things easier
+
+cat > /usr/i586-mingw32msvc/bin/pkg-config <<EOF
+#!/bin/bash
+export PKG_CONFIG_LIBDIR=/usr/i586-mingw32msvc/lib/pkgconfig
+/usr/bin/pkg-config $*
+EOF
+
+
+ Base libraries
+----------------
+
+ Unlike other OS the base libraries and their dependancies need to be
+ built and installed.
+
+ The instructions given here assume you will be installing on a
+ Debian derived OS using the mingw32 packages. The libraries should
+ be unpacked and built from a suitable temporary directory.
+
+ zlib:
+
+ $ apt-get source zlib1g
+ $ cd zlib-1.2.3.3.dfsg
+ $ CC=i586-mingw32msvc-gcc AR=i586-mingw32msvc-ar RANLIB=i586-mingw32msvc-ranlib CFLAGS="-DNO_FSEEKO" ./configure --prefix=/usr/i586-mingw32msvc/
+ $ make
+ $ sudo make install
+
+ libiconv:
+
+ $ wget http://ftp.gnu.org/pub/gnu/libiconv/libiconv-1.13.1.tar.gz
+ $ tar -zxf libiconv-1.13.1.tar.gz
+ $ cd libiconv-1.13.1
+ $ ./configure --prefix=/usr/i586-mingw32msvc/ --host=i586-mingw32msvc --disable-shared
+ $ make
+ $ sudo make install
+
+ regex:
+
+ $ wget http://kent.dl.sourceforge.net/project/mingw/Other/UserContributed/regex/mingw-regex-2.5.1/mingw-libgnurx-2.5.1-src.tar.gz
+ $ tar -zxf mingw-libgnurx-2.5.1-src.tar.gz
+ $ cd mingw-libgnurx-2.5.1
+ $ ./configure --prefix=/usr/i586-mingw32msvc/ --host=i586-mingw32msvc
+ $ make
+ $ sudo make install
+
+ openssl:
+
+ $ wget http://www.openssl.org/source/openssl-1.0.0a.tar.gz
+ $ tar -zxf openssl-1.0.0a.tar.gz
+ $ cd openssl-1.0.0a
+ $ PATH=/usr/i586-mingw32msvc/bin/:$PATH ./Configure no-shared disable-capieng --prefix=/usr/i586-mingw32msvc/ mingw
+ $ PATH=/usr/i586-mingw32msvc/bin/:$PATH make CC=i586-mingw32msvc-gcc RANLIB=i586-mingw32msvc-ranlib
+ $ sudo make install
+
+ libcurl:
+
+ $ wget http://curl.haxx.se/download/curl-7.26.0.tar.gz
+ $ tar -zxf curl-7.26.0.tar.gz
+ $ cd curl-7.26.0
+ $ LDFLAGS=-mwindows ./configure --prefix=/usr/i586-mingw32msvc/ --host=i586-mingw32msvc --disable-shared --disable-ldap --without-random
+ $ make
+ $ sudo make install
+
+ libpng:
+
+ $ wget http://kent.dl.sourceforge.net/project/libpng/libpng14/1.4.12/libpng-1.4.12.tar.gz
+ $ tar -zxf libpng-1.4.12.tar.gz
+ $ cd libpng-1.4.12
+ $ ./configure --prefix=/usr/i586-mingw32msvc/ --host=i586-mingw32msvc
+ $ make
+ $ sudo make install
+
+ libjpeg:
+
+ $ wget http://www.ijg.org/files/jpegsrc.v8d.tar.gz
+ $ tar -zxf jpegsrc.v8d.tar.gz
+ $ cd jpeg-8d
+ $ ./configure --prefix=/usr/i586-mingw32msvc/ --host=i586-mingw32msvc --disable-shared
+ $ make
+ $ sudo make install
+
+ The NetSurf project's libraries
+---------------------------------
+
+ The NetSurf project has developed several libraries which are required by
+ the browser. These are:
+
+ LibParserUtils -- Parser building utility functions
+ LibWapcaplet -- String internment
+ Hubbub -- HTML5 compliant HTML parser
+ LibCSS -- CSS parser and selection engine
+ LibNSGIF -- GIF format image decoder
+ LibNSBMP -- BMP and ICO format image decoder
+ LibROSprite -- RISC OS Sprite format image decoder
+
+ To fetch each of these libraries, run the appropriate commands from the
+ Docs/LIBRARIES file.
+
+ To build and install these libraries.
+
+ Ensure the MINGW_INSTALL_ENV variable is correctly set.
+
+ $ export MINGW_INSTALL_ENV=/usr/i586-mingw32msvc/
+
+ Then simply enter each of their directories and run:
+
+ $ make TARGET=windows PREFIX=/usr/i586-mingw32msvc/
+ $ sudo make TARGET=windows PREFIX=/usr/i586-mingw32msvc/ install
+
+ Resources
+-----------
+
+ The windows resources may be rebuilt. Currently there is 1 object
+ file included in the Git distribution of NetSurf that could be
+ manually compiled
+
+ $ cd windows/res
+ $ i586-mingw32msvc-windres resource.rc -O coff -o resource.o
diff --git a/docs/core-window-interface.md b/docs/core-window-interface.md
new file mode 100644
index 0000000..09c2999
--- a/dev/null
+++ b/docs/core-window-interface.md
@@ -0,0 +1,677 @@
+Core Window Interface
+=====================
+
+The NetSurf core provides an optional API to frontend implementations
+which allows a number of "standard" window content interfaces to be
+provided.
+
+The currently available user interfaces are:
+
+ - Cookies
+ - Global history
+ - Hotlist
+ - SSL certificate view
+ - local history
+
+Although not currently included in future additional user interfaces
+will be available for the main browser render.
+
+To be clear these are generic implementations of this functionality
+that any frontend may use. Frontends are free to implement these
+interfaces in any manner as they see fit, the corewindow interface
+simply provides a default.
+
+core window API
+---------------
+
+The API is fairly simple and simply involves passing a callback table
+and context pointer to the interface element being constructed.
+
+The header that defines the callback interface is netsurf/core_window.h
+
+The callback table contains five function pointer interfaces which the
+frontend must implement for the core.
+
+ - invalidate
+ invalidate an area of a window
+
+ - update_size
+ Update the limits of the window
+
+ - scroll_visible
+ Scroll the window to make area visible
+
+ - get_window_dimensions
+ Get window viewport dimensions
+
+ - drag_status
+ Inform corewindow owner of drag status
+
+Each callback will be passed the context pointer for the corewindow
+instance and the relevant additional information necessary to perform
+the operation.
+
+Each exported user interface element wraps this generic interface with
+a concrete implementation. For example the SSL certificate viewer is
+initialised with:
+
+ nserror sslcert_viewer_init(struct core_window_callback_table *cw_t,
+ void *core_window_handle,
+ struct sslcert_session_data *ssl_d);
+
+This call creates a context which will display and navigate the ssl
+session data passed. The frontend must service the callbacks from the
+core to provide the necessary interactions with the frontend windowing
+system.
+
+These actions should ideally use the standard frontend window
+processing. So for the GTK frontend when the core calls the invalidate
+operation it simply marks the area passed as damaged (using
+gtk_widget_queue_draw_area()) and lets the standard expose event cause
+the redraw to occur.
+
+If the frontend needs to redraw an area of a window (perhaps an expose
+event occurred or the window has had an area marked as invalid) it
+must call the core window API wrappers implementation which will
+perform the plot operations required to update an area of the window.
+
+e.g in the case of ssl certificate viewer
+
+ void sslcert_viewer_redraw(struct sslcert_session_data *ssl_d,
+ int x, int y, struct rect *clip,
+ const struct redraw_context *ctx);
+
+would perform the plot operations for that SSL data window.
+
+Usage
+-----
+
+The usage pattern that is expected is for a frontend to create a core
+window implementation that implements the necessary five API in a
+generic way and allows the frontend to provide the specific
+specialisation for each of the user interface elements it wishes to
+use (cookies, SSL viewer etc).
+
+The GTK frontend for example:
+
+has source corewindow.[ch] which implement the five core callbacks
+using generic GTK operations (invalidate calls
+gtk_widget_queue_draw_area() etc.) and then provides additional
+operations on a GTK drawing area object to attach expose event
+processing, keypress processing etc.
+
+The GTK corewindow (not to be confused with the core window API
+itself, this is purely the gtk wrapper) is used by ssl_cert.c which
+creates a nsgtk_crtvrfy_window structure containing the
+nsgtk_corewindow structure. It attaches actual GTK window handles to
+this structure and populates elements of nsgtk_corewindow and then
+calls sslcert_viewer_init() directly.
+
+frontend skeleton
+-----------------
+
+An example core window implementation for a frontend ssl certificate
+viewer is presented here. This implements the suggested usage above
+and provides generic corewindow helpers.
+
+
+frontends/example/corewindow.h
+------------------------------
+
+ /*
+ * Copyright 2016 Vincent Sanders <vince@netsurf-browser.org>
+ *
+ * This file is part of NetSurf, http://www.netsurf-browser.org/
+ *
+ * NetSurf is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * NetSurf is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+ #ifndef EXAMPLE_COREWINDOW_H
+ #define EXAMPLE_COREWINDOW_H
+
+ #include "netsurf/core_window.h"
+
+ /**
+ * example core window state
+ */
+ struct example_corewindow {
+
+
+ /*
+ * Any variables common to any frontend window would go here.
+ * e.g. drawing area handles, toolkit pointers or other state
+ */
+ example_toolkit_widget *tk_widget;
+
+
+
+ /** drag status set by core */
+ core_window_drag_status drag_staus;
+
+ /** table of callbacks for core window operations */
+ struct core_window_callback_table *cb_table;
+
+ /**
+ * callback to draw on drawable area of example core window
+ *
+ * \param example_cw The example core window structure.
+ * \param r The rectangle of the window that needs updating.
+ * \return NSERROR_OK on success otherwise apropriate error code
+ */
+ nserror (*draw)(struct example_corewindow *example_cw, struct rect *r);
+
+ /**
+ * callback for keypress on example core window
+ *
+ * \param example_cw The example core window structure.
+ * \param nskey The netsurf key code.
+ * \return NSERROR_OK if key processed,
+ * NSERROR_NOT_IMPLEMENTED if key not processed
+ * otherwise apropriate error code
+ */
+ nserror (*key)(struct example_corewindow *example_cw, uint32_t nskey);
+
+ /**
+ * callback for mouse event on example core window
+ *
+ * \param example_cw The example core window structure.
+ * \param mouse_state mouse state
+ * \param x location of event
+ * \param y location of event
+ * \return NSERROR_OK on sucess otherwise apropriate error code.
+ */
+ nserror (*mouse)(struct example_corewindow *example_cw, browser_mouse_state mouse_state, int x, int y);
+ };
+
+ /**
+ * initialise elements of example core window.
+ *
+ * As a pre-requisite the draw, key and mouse callbacks must be defined
+ *
+ * \param example_cw A example core window structure to initialise
+ * \return NSERROR_OK on successful initialisation otherwise error code.
+ */
+ nserror example_corewindow_init(struct example_corewindow *example_cw);
+
+ /**
+ * finalise elements of example core window.
+ *
+ * \param example_cw A example core window structure to initialise
+ * \return NSERROR_OK on successful finalisation otherwise error code.
+ */
+ nserror example_corewindow_fini(struct example_corewindow *example_cw);
+
+ #endif
+
+frontends/example/corewindow.c
+------------------------------
+
+ /*
+ * Copyright 2016 Vincent Sanders <vince@netsurf-browser.org>
+ *
+ * This file is part of NetSurf, http://www.netsurf-browser.org/
+ *
+ * NetSurf is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * NetSurf is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+ /**
+ * file
+ * EXAMPLE generic core window interface.
+ *
+ * Provides interface for core renderers to the example toolkit drawable area.
+ *
+ * This module is an object that must be encapsulated. Client users
+ * should embed a struct example_corewindow at the beginning of their
+ * context for this display surface, fill in relevant data and then
+ * call example_corewindow_init()
+ *
+ * The example core window structure requires the callback for draw, key and
+ * mouse operations.
+ */
+
+ #include <assert.h>
+ #include <string.h>
+ #include <math.h>
+
+ #include "utils/log.h"
+ #include "utils/utils.h"
+ #include "utils/messages.h"
+ #include "utils/utf8.h"
+ #include "netsurf/keypress.h"
+ #include "netsurf/mouse.h"
+ #include "netsurf/plot_style.h"
+
+ /* extremely likely there will be additional headers required in a real frontend */
+ #include "example/corewindow.h"
+
+
+ /* toolkit event handlers that do generic things and call internal callbacks */
+
+
+ static bool
+ example_cw_mouse_press_event(toolkit_widget *widget, toolkit_button bt, int x, int y, void *ctx)
+ {
+ struct example_corewindow *example_cw = (struct example_corewindow *)ctx;
+
+ example_cw->mouse(example_cw, state, x, y);
+
+ return true;
+ }
+
+ static bool
+ example_cw_keyrelease_event(toolkit_widget *widget, void *ctx)
+ {
+ struct example_corewindow *example_cw = (struct example_corewindow *)ctx;
+
+ example_cw->key(example_cw, keycode);
+
+ return true;
+ }
+
+
+
+ /* signal handler for toolkit window redraw */
+ static bool
+ example_cw_draw_event(toolkit_widget *widget,
+ toolkit_area *tk_area,
+ void *ctx)
+ {
+ struct example_corewindow *example_cw = (struct example_corewindow *)ctx;
+ struct rect clip;
+
+ clip.x0 = tk_area.x;
+ clip.y0 = tk_area.y;
+ clip.x1 = tk_area.width;
+ clip.y1 = tk_area.height;
+
+ example_cw->draw(example_cw, &clip);
+
+ return true;
+ }
+
+
+ /**
+ * callback from core to request a redraw
+ */
+ static nserror
+ example_cw_invalidate(struct core_window *cw, const struct rect *r)
+ {
+ struct example_corewindow *example_cw = (struct example_corewindow *)cw;
+
+ toolkit_widget_queue_draw_area(example_cw->widget,
+ r->x0, r->y0,
+ r->x1 - r->x0, r->y1 - r->y0);
+ }
+
+
+ static void
+ example_cw_update_size(struct core_window *cw, int width, int height)
+ {
+ struct example_corewindow *example_cw = (struct example_corewindow *)cw;
+
+ toolkit_widget_set_size_request(EXAMPLE_WIDGET(example_cw->drawing_area),
+ width, height);
+ }
+
+
+ static void
+ example_cw_scroll_visible(struct core_window *cw, const struct rect *r)
+ {
+ struct example_corewindow *example_cw = (struct example_corewindow *)cw;
+
+ toolkit_scroll_widget(example_cw->widget, r);
+ }
+
+
+ static void
+ example_cw_get_window_dimensions(struct core_window *cw, int *width, int *height)
+ {
+ struct example_corewindow *example_cw = (struct example_corewindow *)cw;
+
+ *width = toolkit_get_widget_width(example_cw->widget);
+ *height = toolkit_get_widget_height(example_cw->widget);
+ }
+
+
+ static void
+ example_cw_drag_status(struct core_window *cw, core_window_drag_status ds)
+ {
+ struct example_corewindow *example_cw = (struct example_corewindow *)cw;
+ example_cw->drag_staus = ds;
+ }
+
+
+ struct core_window_callback_table example_cw_cb_table = {
+ .invalidate = example_cw_invalidate,
+ .update_size = example_cw_update_size,
+ .scroll_visible = example_cw_scroll_visible,
+ .get_window_dimensions = example_cw_get_window_dimensions,
+ .drag_status = example_cw_drag_status
+ };
+
+ /* exported function documented example/corewindow.h */
+ nserror example_corewindow_init(struct example_corewindow *example_cw)
+ {
+ /* setup the core window callback table */
+ example_cw->cb_table = &example_cw_cb_table;
+
+ /* frontend toolkit specific method of causing example_cw_draw_event to be called when a drawing operation is required */
+ toolkit_connect_draw_event(example_cw->tk_widget,
+ example_cw_draw_event,
+ example_cw);
+
+ /* frontend toolkit specific method of causing example_cw_button_press_event to be called when a button press occours */
+ toolkit_connect_button_press_event(example_cw->tk_widget,
+ example_cw_button_press_event,
+ example_cw);
+
+ /* frontend toolkit specific method of causing example_cw_button_release_event to be called when a button release occours */
+ toolkit_connect_button_release_event(example_cw->tk_widget,
+ example_cw_button_release_event,
+ example_cw);
+
+ /* frontend toolkit specific method of causing example_cw_motion_notify_event to be called when there is motion over the widget */
+ toolkit_connect_motion_event(example_cw->tk_widget,
+ example_cw_motion_notify_event,
+ example_cw);
+
+ /* frontend toolkit specific method of causing example_cw_key_press_event to be called when a key press occours */
+ toolkit_connect_button_press_event(example_cw->tk_widget,
+ example_cw_key_press_event,
+ example_cw);
+
+ /* frontend toolkit specific method of causing example_cw_key_release_event to be called when a key release occours */
+ toolkit_connect_button_release_event(example_cw->tk_widget,
+ example_cw_key_release_event,
+ example_cw);
+
+
+ return NSERROR_OK;
+ }
+
+ /* exported interface documented in example/corewindow.h */
+ nserror example_corewindow_fini(struct example_corewindow *example_cw)
+ {
+ return NSERROR_OK;
+ }
+
+
+frontends/example/ssl_cert.h
+----------------------------
+
+ /*
+ * Copyright 2016 Vincent Sanders <vince@netsurf-browser.org>
+ *
+ * This file is part of NetSurf, http://www.netsurf-browser.org/
+ *
+ * NetSurf is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * NetSurf is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+ #ifndef NETSURF_EXAMPLE_SSL_CERT_H
+ #define NETSURF_EXAMPLE_SSL_CERT_H 1
+
+ struct nsurl;
+ struct ssl_cert_info;
+
+ /**
+ * Prompt the user to verify a certificate with issuse.
+ *
+ * \param url The URL being verified.
+ * \param certs The certificate to be verified
+ * \param num The number of certificates to be verified.
+ * \param cb Callback upon user decision.
+ * \param cbpw Context pointer passed to cb
+ * \return NSERROR_OK or error code if prompt creation failed.
+ */
+ nserror example_cert_verify(struct nsurl *url, const struct ssl_cert_info *certs, unsigned long num, nserror (*cb)(bool proceed, void *pw), void *cbpw);
+
+ #endif
+
+frontends/example/ssl_cert.c
+----------------------------
+
+ /*
+ * Copyright 2015 Vincent Sanders <vince@netsurf-browser.org>
+ *
+ * This file is part of NetSurf, http://www.netsurf-browser.org/
+ *
+ * NetSurf is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * NetSurf is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+ /**
+ * file
+ * Implementation of example certificate viewing using example core windows.
+ */
+
+ #include <stdint.h>
+ #include <stdlib.h>
+
+ #include "utils/log.h"
+ #include "netsurf/keypress.h"
+ #include "netsurf/plotters.h"
+ #include "desktop/sslcert_viewer.h"
+
+ #include "example/corewindow.h"
+
+
+ /**
+ * EXAMPLE certificate viewing window context
+ */
+ struct example_crtvrfy_window {
+ /** example core window context */
+ struct example_corewindow core;
+
+ /** SSL certificate viewer context data */
+ struct sslcert_session_data *ssl_data;
+ };
+
+ /**
+ * destroy a previously created certificate view
+ */
+ static nserror example_crtvrfy_destroy(struct example_crtvrfy_window *crtvrfy_win)
+ {
+ nserror res;
+
+ res = sslcert_viewer_fini(crtvrfy_win->ssl_data);
+ if (res == NSERROR_OK) {
+ res = example_corewindow_fini(&crtvrfy_win->core);
+ toolkit_windown_destroy(crtvrfy_win->window);
+ free(crtvrfy_win);
+ }
+ return res;
+ }
+
+ static void
+ example_crtvrfy_accept(ExampleButton *w, gpointer data)
+ {
+ struct example_crtvrfy_window *crtvrfy_win;
+ crtvrfy_win = (struct example_crtvrfy_window *)data;
+
+ sslcert_viewer_accept(crtvrfy_win->ssl_data);
+
+ example_crtvrfy_destroy(crtvrfy_win);
+ }
+
+ static void
+ example_crtvrfy_reject(ExampleWidget *w, gpointer data)
+ {
+ struct example_crtvrfy_window *crtvrfy_win;
+ crtvrfy_win = (struct example_crtvrfy_window *)data;
+
+ sslcert_viewer_reject(crtvrfy_win->ssl_data);
+
+ example_crtvrfy_destroy(crtvrfy_win);
+ }
+
+
+ /**
+ * callback for mouse action for certificate verify on core window
+ *
+ * \param example_cw The example core window structure.
+ * \param mouse_state netsurf mouse state on event
+ * \param x location of event
+ * \param y location of event
+ * \return NSERROR_OK on success otherwise apropriate error code
+ */
+ static nserror
+ example_crtvrfy_mouse(struct example_corewindow *example_cw,
+ browser_mouse_state mouse_state,
+ int x, int y)
+ {
+ struct example_crtvrfy_window *crtvrfy_win;
+ /* technically degenerate container of */
+ crtvrfy_win = (struct example_crtvrfy_window *)example_cw;
+
+ sslcert_viewer_mouse_action(crtvrfy_win->ssl_data, mouse_state, x, y);
+
+ return NSERROR_OK;
+ }
+
+ /**
+ * callback for keypress for certificate verify on core window
+ *
+ * \param example_cw The example core window structure.
+ * \param nskey The netsurf key code
+ * \return NSERROR_OK on success otherwise apropriate error code
+ */
+ static nserror
+ example_crtvrfy_key(struct example_corewindow *example_cw, uint32_t nskey)
+ {
+ struct example_crtvrfy_window *crtvrfy_win;
+
+ /* technically degenerate container of */
+ crtvrfy_win = (struct example_crtvrfy_window *)example_cw;
+
+ if (sslcert_viewer_keypress(crtvrfy_win->ssl_data, nskey)) {
+ return NSERROR_OK;
+ }
+ return NSERROR_NOT_IMPLEMENTED;
+ }
+
+ /**
+ * callback on draw event for certificate verify on core window
+ *
+ * \param example_cw The example core window structure.
+ * \param r The rectangle of the window that needs updating.
+ * \return NSERROR_OK on success otherwise apropriate error code
+ */
+ static nserror
+ example_crtvrfy_draw(struct example_corewindow *example_cw, struct rect *r)
+ {
+ struct redraw_context ctx = {
+ .interactive = true,
+ .background_images = true,
+ .plot = &example_plotters
+ };
+ struct example_crtvrfy_window *crtvrfy_win;
+
+ /* technically degenerate container of */
+ crtvrfy_win = (struct example_crtvrfy_window *)example_cw;
+
+ sslcert_viewer_redraw(crtvrfy_win->ssl_data, 0, 0, r, &ctx);
+
+ return NSERROR_OK;
+ }
+
+ /* exported interface documented in example/ssl_cert.h */
+ nserror example_cert_verify(struct nsurl *url,
+ const struct ssl_cert_info *certs,
+ unsigned long num,
+ nserror (*cb)(bool proceed, void *pw),
+ void *cbpw)
+ {
+ struct example_crtvrfy_window *ncwin;
+ nserror res;
+
+ ncwin = malloc(sizeof(struct example_crtvrfy_window));
+ if (ncwin == NULL) {
+ return NSERROR_NOMEM;
+ }
+
+ res = toolkit_create_window(&ncwin->window);
+ if (res != NSERROR_OK) {
+ LOG("SSL UI builder init failed");
+ free(ncwin);
+ return res;
+ }
+
+ /* store the widget that the toolkit is drawing into */
+ ncwin->core.widget = toolkit_get_widget(ncwin->window, "SSLDrawingArea"));
+
+ /* would typicaly setup toolkit accept/reject buttons etc. here */
+ toolkit_connect_button_press(ncwin->tk_accept_button,
+ example_crtvrfy_accept,
+ ncwin);
+
+
+ /* initialise example core window */
+ ncwin->core.draw = example_crtvrfy_draw;
+ ncwin->core.key = example_crtvrfy_key;
+ ncwin->core.mouse = example_crtvrfy_mouse;
+
+ res = example_corewindow_init(&ncwin->core);
+ if (res != NSERROR_OK) {
+ free(ncwin);
+ return res;
+ }
+
+ /* initialise certificate viewing interface */
+ res = sslcert_viewer_create_session_data(num, url, cb, cbpw, certs,
+ &ncwin->ssl_data);
+ if (res != NSERROR_OK) {
+ free(ncwin);
+ return res;
+ }
+
+ res = sslcert_viewer_init(ncwin->core.cb_table,
+ (struct core_window *)ncwin,
+ ncwin->ssl_data);
+ if (res != NSERROR_OK) {
+ free(ncwin);
+ return res;
+ }
+
+ toolkit_widget_show(ncwin->window);
+
+ return NSERROR_OK;
+ }
diff --git a/docs/env.sh b/docs/env.sh
new file mode 100644
index 0000000..518123e
--- a/dev/null
+++ b/docs/env.sh
@@ -0,0 +1,320 @@
+#!/bin/sh
+#
+# NetSurf Library, tool and browser support script
+#
+# Usage: source env.sh
+# TARGET_ABI / HOST sets the target for library builds
+# TARGET_WORKSPACE is the workspace directory to keep the sandboxes
+#
+# This script allows NetSurf and its libraries to be built without
+# requiring installation into a system.
+#
+# Copyright 2013 Vincent Sanders <vince@netsurf-browser.org>
+# Released under the MIT Licence
+
+# parameters
+
+# The system doing the building
+if [ "x${BUILD}" = "x" ]; then
+ BUILD=$(cc -dumpmachine)
+fi
+
+# Get the host build if unset
+if [ "x${HOST}" = "x" ]; then
+ if [ "x${TARGET_ABI}" = "x" ]; then
+ HOST=${BUILD}
+ else
+ HOST=${TARGET_ABI}
+ fi
+else
+ HOST_CC_LIST="${HOST}-cc ${HOST}-gcc /opt/netsurf/${HOST}/cross/bin/${HOST}-cc /opt/netsurf/${HOST}/cross/bin/${HOST}-gcc"
+ for HOST_CC_V in $(echo ${HOST_CC_LIST});do
+ HOST_CC=$(/bin/which ${HOST_CC_V})
+ if [ "x${HOST_CC}" != "x" ];then
+ break
+ fi
+ done
+ if [ "x${HOST_CC}" = "x" ];then
+ echo "Unable to execute host compiler for HOST=${HOST}. is it set correctly?"
+ return 1
+ fi
+
+ HOST_CC_MACHINE=$(${HOST_CC} -dumpmachine 2>/dev/null)
+
+ if [ "${HOST_CC_MACHINE}" != "${HOST}" ];then
+ echo "Compiler dumpmachine differes from HOST setting"
+ return 2
+ fi
+ unset HOST_CC_LIST HOST_CC_V HOST_CC HOST_CC_MACHINE
+fi
+
+if [ "x${TARGET_WORKSPACE}" = "x" ]; then
+ TARGET_WORKSPACE=${HOME}/dev-netsurf/workspace
+fi
+
+if [ "x${USE_CPUS}" = "x" ]; then
+ NCPUS=$(getconf _NPROCESSORS_ONLN 2>/dev/null || getconf NPROCESSORS_ONLN 2>/dev/null)
+ NCPUS="${NCPUS:-1}"
+ NCPUS=$((NCPUS * 2))
+ USE_CPUS="-j${NCPUS}"
+fi
+
+# The GTK version to build for (either 2 or 3 currently)
+if [ "x${NETSURF_GTK_MAJOR}" = "x" ]; then
+ NETSURF_GTK_MAJOR=2
+fi
+
+
+###############################################################################
+# Setup environment
+###############################################################################
+
+echo "BUILD=${BUILD}"
+echo "HOST=${HOST}"
+echo "TARGET_WORKSPACE=${TARGET_WORKSPACE}"
+echo "USE_CPUS=${USE_CPUS}"
+
+export PREFIX=${TARGET_WORKSPACE}/inst-${HOST}
+export PKG_CONFIG_PATH=${PREFIX}/lib/pkgconfig:${PKG_CONFIG_PATH}::
+export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${PREFIX}/lib
+export PATH=${PATH}:${PREFIX}/bin
+export NETSURF_GTK_MAJOR
+
+# make tool
+MAKE=make
+
+# NetSurf GIT repositories
+NS_GIT="git://git.netsurf-browser.org"
+
+# Buildsystem: everything depends on this
+NS_BUILDSYSTEM="buildsystem"
+
+# internal libraries all frontends require (order is important)
+NS_INTERNAL_LIBS="libwapcaplet libparserutils libhubbub libdom libcss libnsgif libnsbmp libutf8proc libnsutils libnspsl"
+
+# The browser itself
+NS_BROWSER="netsurf"
+
+
+# add target specific libraries
+case "${HOST}" in
+ i586-pc-haiku)
+ # tools required to build the browser for haiku (beos)
+ NS_TOOLS="nsgenbind"
+ # libraries required for the haiku target abi
+ NS_FRONTEND_LIBS="libsvgtiny"
+ ;;
+ *arwin*)
+ # tools required to build the browser for OS X
+ NS_TOOLS=""
+ # libraries required for the Darwin target abi
+ NS_FRONTEND_LIBS="libsvgtiny libnsfb"
+ ;;
+ arm-unknown-riscos)
+ # tools required to build the browser for RISC OS
+ NS_TOOLS="nsgenbind"
+ # libraries required for the risc os target abi
+ NS_FRONTEND_LIBS="libsvgtiny librufl libpencil librosprite"
+ ;;
+ *-atari-mint)
+ # tools required to build the browser for atari
+ NS_TOOLS=""
+ # libraries required for the atari frontend
+ NS_FRONTEND_LIBS=""
+ ;;
+ ppc-amigaos)
+ # default tools required to build the browser
+ NS_TOOLS="nsgenbind"
+ # default additional internal libraries
+ NS_FRONTEND_LIBS="libsvgtiny"
+ ;;
+ m68k-unknown-amigaos)
+ # default tools required to build the browser
+ NS_TOOLS="nsgenbind"
+ # default additional internal libraries
+ NS_FRONTEND_LIBS="libsvgtiny"
+ ;;
+ *-unknown-freebsd*)
+ # tools required to build the browser for freebsd
+ NS_TOOLS=""
+ # libraries required for the freebsd frontend
+ NS_FRONTEND_LIBS=""
+ # select gnu make
+ MAKE=gmake
+ ;;
+ *)
+ # default tools required to build the browser
+ NS_TOOLS="nsgenbind"
+ # default additional internal libraries
+ NS_FRONTEND_LIBS="libsvgtiny libnsfb"
+ ;;
+esac
+
+export MAKE
+
+################ OS Package installation ################
+
+# deb packages for dpkg based systems
+NS_DEV_DEB="build-essential pkg-config git gperf libcurl3-dev libssl-dev libpng-dev libjpeg-dev"
+NS_TOOL_DEB="flex bison libhtml-parser-perl"
+if [ "x${NETSURF_GTK_MAJOR}" = "x3" ]; then
+ NS_GTK_DEB="libgtk-3-dev librsvg2-dev"
+else
+ NS_GTK_DEB="libgtk2.0-dev librsvg2-dev"
+fi
+
+# apt get commandline to install necessary dev packages
+ns-apt-get-install()
+{
+ sudo apt-get install $(echo ${NS_DEV_DEB} ${NS_TOOL_DEB} ${NS_GTK_DEB})
+}
+
+# RPM packages for rpm based systems (tested on fedora 20)
+NS_DEV_RPM="git gcc pkgconfig libexpat-devel openssl-devel libcurl-devel perl-Digest-MD5-File libjpeg-devel libpng-devel"
+NS_TOOL_RPM="flex bison"
+if [ "x${NETSURF_GTK_MAJOR}" = "x3" ]; then
+ NS_GTK_RPM="gtk3-devel librsvg2-devel"
+else
+ NS_GTK_RPM="gtk2-devel librsvg2-devel"
+fi
+
+# yum commandline to install necessary dev packages
+ns-yum-install()
+{
+ sudo yum -y install $(echo ${NS_DEV_RPM} ${NS_TOOL_RPM} ${NS_GTK_RPM})
+}
+
+# Haiku secondary arch suffix:
+# empty for primary (gcc2 on x86),
+# "_x86" for gcc4 secondary.
+HA=_x86
+# Haiku packages
+NS_DEV_HPKG="devel:libcurl${HA} devel:libpng${HA} devel:libjpeg${HA} devel:libcrypto${HA} devel:libiconv${HA} devel:libexpat${HA} cmd:pkg_config${HA} cmd:gperf html_parser"
+
+# pkgman commandline to install necessary dev packages
+ns-pkgman-install()
+{
+ pkgman install $(echo ${NS_DEV_HPKG})
+}
+
+# MAC OS X
+NS_DEV_MACPORT="git expat openssl curl libjpeg-turbo libpng"
+
+ns-macport-install()
+{
+ PATH=/opt/local/bin:/opt/local/sbin:$PATH sudo /opt/local/bin/port install $(echo ${NS_DEV_MACPORT})
+}
+
+NS_DEV_FREEBSDPKG="gmake curl"
+
+# FreeBSD package install
+ns-freebsdpkg-install()
+{
+ pkg install $(echo ${NS_DEV_FREEBSDPKG})
+}
+
+# generic for help text
+NS_DEV_GEN="git, gcc, pkgconfig, expat library, openssl library, libcurl, perl, perl MD5 digest, libjpeg library, libpng library"
+NS_TOOL_GEN="flex tool, bison tool"
+if [ "x${NETSURF_GTK_MAJOR}" = "x3" ]; then
+ NS_GTK_GEN="gtk+ 3 toolkit library, librsvg2 library"
+else
+ NS_GTK_GEN="gtk+ 2 toolkit library, librsvg2 library"
+fi
+
+# Genertic OS package install
+# looks for package managers and tries to use them if present
+ns-package-install()
+{
+ if [ -x "/usr/bin/apt-get" ]; then
+ ns-apt-get-install
+ elif [ -x "/usr/bin/yum" ]; then
+ ns-yum-install
+ elif [ -x "/bin/pkgman" ]; then
+ ns-pkgman-install
+ elif [ -x "/opt/local/bin/port" ]; then
+ ns-macport-install
+ elif [ -x "/usr/sbin/pkg" ]; then
+ ns-freebsdpkg-install
+ else
+ echo "Unable to determine OS packaging system in use."
+ echo "Please ensure development packages are installed for:"
+ echo ${NS_DEV_GEN}"," ${NS_TOOL_GEN}"," ${NS_GTK_GEN}
+ fi
+}
+
+################ Development helpers ################
+
+# git pull in all repos parameters are passed to git pull
+ns-pull()
+{
+ for REPO in $(echo ${NS_BUILDSYSTEM} ${NS_INTERNAL_LIBS} ${NS_FRONTEND_LIBS} ${NS_TOOLS} ${NS_BROWSER}) ; do
+ echo -n " GIT: Pulling ${REPO}: "
+ if [ -f "${TARGET_WORKSPACE}/${REPO}/.git/config" ]; then
+ (cd ${TARGET_WORKSPACE}/${REPO} && git pull $*; )
+ else
+ echo "Repository not present"
+ fi
+ done
+}
+
+# clone all repositories
+ns-clone()
+{
+ mkdir -p ${TARGET_WORKSPACE}
+ for REPO in $(echo ${NS_BUILDSYSTEM} ${NS_INTERNAL_LIBS} ${NS_FRONTEND_LIBS} ${NS_RISCOS_LIBS} ${NS_TOOLS} ${NS_BROWSER}) ; do
+ echo -n " GIT: Cloning ${REPO}: "
+ if [ -f ${TARGET_WORKSPACE}/${REPO}/.git/config ]; then
+ echo "Repository already present"
+ else
+ (cd ${TARGET_WORKSPACE} && git clone ${NS_GIT}/${REPO}.git; )
+ fi
+ done
+
+ # put current env.sh in place in workspace
+ if [ ! -f "${TARGET_WORKSPACE}/env.sh" -a -f ${TARGET_WORKSPACE}/${NS_BROWSER}/docs/env.sh ]; then
+ cp ${TARGET_WORKSPACE}/${NS_BROWSER}/docs/env.sh ${TARGET_WORKSPACE}/env.sh
+ fi
+}
+
+# issues a make command to all libraries
+ns-make-libs()
+{
+ for REPO in $(echo ${NS_BUILDSYSTEM} ${NS_TOOLS}); do
+ echo " MAKE: make -C ${REPO} $USE_CPUS $*"
+ ${MAKE} -C ${TARGET_WORKSPACE}/${REPO} $USE_CPUS $*
+ if [ $? -ne 0 ]; then
+ return $?
+ fi
+ done
+
+ for REPO in $(echo ${NS_INTERNAL_LIBS} ${NS_FRONTEND_LIBS}); do
+ echo " MAKE: make -C ${REPO} $USE_CPUS $*"
+ ${MAKE} -C ${TARGET_WORKSPACE}/${REPO} HOST=${HOST} $USE_CPUS $*
+ if [ $? -ne 0 ]; then
+ return $?
+ fi
+ done
+}
+
+# issues a make command for framebuffer libraries
+ns-make-libnsfb()
+{
+ echo " MAKE: make -C libnsfb $USE_CPUS $*"
+ ${MAKE} -C ${TARGET_WORKSPACE}/libnsfb HOST=${HOST} $USE_CPUS $*
+}
+
+# pulls all repos and makes and installs the libraries and tools
+ns-pull-install()
+{
+ ns-pull $*
+
+ ns-make-libs install
+}
+
+# Passes appropriate flags to make
+ns-make()
+{
+ ${MAKE} $USE_CPUS "$@"
+}
+
diff --git a/docs/gource.sh b/docs/gource.sh
new file mode 100755
index 0000000..a1fbcbe
--- a/dev/null
+++ b/docs/gource.sh
@@ -0,0 +1,71 @@
+#!/bin/bash
+#
+# This script generates a gource visualisation with some parameters.
+#
+# you need a recent gource and ffmpeg install for this to work
+
+# Settings
+
+TITLE="Netsurf"
+
+# length and quality
+TYPE="std" # sml, std, lrg
+
+#Camera mode
+CMODE=overview # overview, track
+
+# standard monitor (suitable for video projector playback)
+#OUTPUT_SIZE="1024x768"
+
+# HD widescreen 720p
+OUTPUT_SIZE="1280x720"
+
+# HD widescreen 1080p
+#OUTPUT_SIZE="1280x1080"
+
+TMP_DIR=/net/holly/srv/video/Unsorted/
+
+######################################################################
+
+#quality parameters
+case ${TYPE} in
+ "std")
+ # standard overview
+ QPARAM="-s 0.25 -i 600 -a 1"
+ ;;
+
+ "lrg")
+ # large overview
+ QPARAM="-s 0.5 -i 200 -a 5"
+ ;;
+
+ "sml")
+ # rapid overview (3mins)
+ QPARAM="-s 0.04 -i 30 -a 1"
+ ;;
+
+ *)
+ # bad type
+ echo "bad type"
+ exit 1
+ ;;
+
+esac
+
+echo "Generating ${TITLE}-gource-${TYPE}-${OUTPUT_SIZE}-${CMODE}"
+
+TMP_PPM=${TMP_DIR}/${TITLE}-gource-${TYPE}-${OUTPUT_SIZE}-${CMODE}.ppm
+
+# output filename
+FILENAME=${TITLE}-gource-${TYPE}-${OUTPUT_SIZE}-${CMODE}.mp4
+
+# filter some directories which are not interesting
+FILEFILTER="\!NetSurf/|riscos/distribution/|gtk/res/|framebuffer/res/|amiga/resources/|beos/res/|cocoa/res/|windows/res/|atari/res"
+
+# generate
+gource --title "NetSurf Development" -${OUTPUT_SIZE} ${QPARAM} --max-files 10000 --bloom-multiplier 0.10 --bloom-intensity 0.5 --title ${TITLE} --highlight-all-users --output-framerate 25 --hide filenames --stop-at-end --date-format "%d %B %Y" --bloom-intensity 0.2 --file-filter "${FILEFILTER}" --key --camera-mode ${CMODE} --output-ppm-stream - > ${TMP_PPM}
+
+#convert the ppm to movie
+ffmpeg -y -r 25 -f image2pipe -vcodec ppm -i ${TMP_PPM} -vcodec libx264 -b:v 2000k ${FILENAME}
+
+
diff --git a/docs/ideas/cache.txt b/docs/ideas/cache.txt
new file mode 100644
index 0000000..fda0617
--- a/dev/null
+++ b/docs/ideas/cache.txt
@@ -0,0 +1,178 @@
+Content caching
+===============
+
+NetSurf's existing fetch/cache architecture has a number of problems:
+
+1) Content dependencies are not modelled.
+2) Content source data for non-shareable contents is duplicated.
+3) Detection of content sharability is dependent on Content-Type, which
+ requires content cloning (which will fail for dependent contents).
+4) Detection of cycles in content dependency graphs is not performed
+ (e.g. content1 includes content2, which includes content1).
+5) All content caching is in-memory, there's no offline storage.
+
+Proposal
+--------
+
+A split-level cache.
+
+Low-level cache:
+
+ + Responsible for source data (+header) management.
+ + Interfaces with low-level fetch system to retrieve data from network.
+ + Is responsible for offline storage (if any) of cache objects.
+ + Returns opaque handles to low-level cache objects.
+ + Handles HTTP redirects, recording URLs encountered when retrieving resource.
+ + May perform content-type sniffing (requires usage context)
+
+High-level cache:
+
+ + Responsible for content objects.
+ + Tracks content dependencies (and potential cycles).
+ + Returns opaque handles to content objects.
+ + Manages content sharability & reusability (see below).
+ + Contents with unknown types are never shared and thus get unique handles.
+ + Content handles <> content objects: they're an indirection mechanism.
+
+Content sharability & reusability
+--------------------------------
+
+ If a content is shareable, then it may have multiple concurrent users.
+ Otherwise, it may have at most one user.
+
+ If a content is reusable, then it may be retained in the cache for later use
+ when it has no users. Otherwise, it will be removed from the cache when
+ it has no users.
+
+Example: retrieving a top-level resource
+----------------------------------------
+
+ 1) Client requests an URL, specifying no parent handle.
+ 2) High-level cache asks low-level cache for low-level handle for URL.
+ 3) Low-level cache looks for appropriate object in its index.
+ a) it finds one that's not stale and returns its handle
+ b) it finds only stale entries, or no appropiate entry,
+ so allocates a new entry, requests a fetch for it,
+ and returns the handle.
+ 4) High-level cache looks for content objects that are using the low-level
+ handle.
+ a) it finds one that's shareable and selects its handle for use.
+ b) it finds only non-shareable entries, or no appropriate entry,
+ so allocates a new entry and selects its handle for use.
+ 5) High-level cache registers the parent and client with the selected handle,
+ then returns the selected handle.
+ 6) Client carries on, happy in the knowledge that a content is available.
+
+Example: retrieving a child resource
+------------------------------------
+
+ 1) Client requests an URL, specifying parent handle.
+ 2) High-level cache searches parent+ancestors for requested URL.
+ a) it finds the URL, so returns a non-fatal error.
+ b) it does not find the URL, so proceeds from step 2 of the
+ top-level resource algorithm.
+
+ NOTE: this approach means that shareable contents may have multiple parents.
+
+Handling of contents of unknown type
+------------------------------------
+
+ Contents of unknown type are, by definition, not shareable. Therefore, each
+ client will be issued with a different content handle.
+
+ Content types are only known once a resource's headers are fetched (or once
+ the type has been sniffed from the resource's data when the headers are
+ inconclusive).
+
+ As a resource is fetched, users of the resource are informed of the fetch
+ status. Therefore, the high-level cache is always informed of fetch progress.
+ Cache clients need not care about this: they are simply interested in
+ a content's readiness for use.
+
+ When the high-level cache is informed of a low-level cache object's type,
+ it is in a position to determine whether the corresponding content handles
+ can share a single content object or not.
+
+ If it detects that a single content object may be shared by multiple handles,
+ it simply creates the content object and registers each of the handles as
+ a user of the content.
+
+ If it detects that each handle requires a separate content object, then it
+ will create a content object for each handle and register the handle as a
+ user.
+
+ This approach requires that clients of the high-level cache get issued with
+ handles to content objects, rather than content objects (so that the decision
+ whether to create multiple content objects can be deferred until suitable
+ information is available).
+
+ Handles with no associated content object will act as if they had a content
+ object that was not ready for use.
+
+A more concrete example
+-----------------------
+
+ + bw1 contains html1 which includes css1, css2, img1, img2
+ + bw2 contains html2 which includes css1, img1, img2
+ + bw3 contains img1
+
+ Neither HTML nor CSS contents are shareable.
+ All shareable contents are requested from the high-level cache
+ once their type is known.
+
+ Low-level cache contains source data for:
+
+ 1 - html1
+ 2 - html2
+ 3 - css1
+ 4 - css2
+ 5 - img1
+ 6 - img2
+
+ High-level cache contains:
+
+ Content objects (ll-handle in parentheses):
+
+ + c1 (1 - html1)
+ + c2 (2 - html2)
+ + c3 (3 - css1)
+ + c4 (4 - css2)
+ + c5 (5 - img1)
+ + c6 (6 - img2)
+ + c7 (3 - css1)
+
+ Content handles (objects in parentheses):
+
+ + h1 (c1, used by bw1)
+ + h2 (c3, used by h1)
+ + h3 (c4, used by h1)
+ + h4 (c2, used by bw2)
+ + h5 (c7, used by h4)
+ + h6 (c5, used by h1,h4,bw3)
+ + h7 (c6, used by h1,h4)
+
+ If img1 was not of known type when requested:
+
+ Content handles (objects in parentheses):
+
+ + h1 (c1, used by bw1)
+ + h2 (c3, used by h1)
+ + h3 (c4, used by h1)
+ + h4 (c2, used by bw2)
+ + h5 (c7, used by h4)
+ + h6 (c5, used by h1)
+ + h7 (c6, used by h1,h4)
+ + h8 (c5, used by h4)
+ + h9 (c5, used by bw3)
+
+This achieves the desired effect that:
+
+ + source data is shared between contents
+ + content objects are only created when absolutely necessary
+ + content usage/dependency is tracked and cycles avoided
+ + offline storage is possible
+
+Achieving this requires the use of indirection objects, but these are expected
+to be small in comparison to the content objects / ll-cache objects that they
+are indirecting.
+
diff --git a/docs/ideas/css-engine.txt b/docs/ideas/css-engine.txt
new file mode 100644
index 0000000..1ea8778
--- a/dev/null
+++ b/docs/ideas/css-engine.txt
@@ -0,0 +1,381 @@
+CSS engine
+==========
+
+Requirements
+------------
+
+ + Parse stylesheets conforming to the forward compatible CSS grammar
+ (Note that in the short term, the semantic analysis stage only need
+ support CSS2.1)
+ + Stylesheet management/merging (i.e. multiple stylesheets may be added
+ to a single engine context and thus affect style selection)
+ + Be able to select a style for a DOM node based upon the current stylesheets
+ in the engine context.
+ + Implemented as a standalone, reusable, library -- ideally MIT licensed.
+
+Suggested API
+-------------
+
+struct css_context;
+struct css_style;
+struct css_stylesheet;
+
+typedef struct css_context css_context;
+typedef struct css_style css_style;
+typedef struct css_stylesheet css_stylesheet;
+
+typedef enum css_error {
+ CSS_OK,
+ CSS_NOMEM,
+ /* etc */
+} css_error;
+
+typedef enum css_origin {
+ CSS_ORIGIN_UA,
+ CSS_ORIGIN_USER,
+ CSS_ORIGIN_AUTHOR
+} css_origin;
+
+#define CSS_MEDIA_SCREEN (1<<0)
+#define CSS_MEDIA_PRINT (1<<1)
+/* etc */
+#define CSS_MEDIA_ALL (0xffffffff)
+
+#define CSS_PSEUDO_CLASS_NONE (0)
+#define CSS_PSEUDO_CLASS_LINK (1<<0)
+#define CSS_PSEUDO_CLASS_VISITED (1<<1)
+#define CSS_PSEUDO_CLASS_HOVER (1<<2)
+#define CSS_PSEUDO_CLASS_ACTIVE (1<<3)
+#define CSS_PSEUDO_CLASS_FOCUS (1<<4)
+
+typedef enum css_property {
+ CSS_BACKGROUND_ATTACHMENT,
+ /* etc */
+} css_property;
+
+typedef struct css_value {
+ css_property property;
+
+ union {
+ css_background_attachment background_attachment;
+ /* etc */
+ } value;
+} css_value;
+
+typedef css_error (*css_import_handler)(void *pw, const char *url,
+ css_stylesheet *sheet);
+
+/* Initialise library */
+css_error css_init(void);
+/* Finalise library */
+css_error css_fini(void);
+
+/* Create a stylesheet associated with the given URL,
+ * specifying the sheet's origin, the media type(s) it applies to and
+ * a callback routine for fetching imported sheets */
+css_stylesheet *css_stylesheet_create(const char *url,
+ css_origin origin, uint32_t media,
+ css_import_handler import_callback, void *pw);
+/* Destroy a stylesheet */
+void css_stylesheet_destroy(css_stylesheet *sheet);
+
+/* Append data to a stylesheet, parsing progressively */
+css_error css_stylesheet_append_data(css_stylesheet *sheet,
+ const uint8_t *data, size_t len);
+/* Tell stylesheet parser that there's no more data (will complete parsing) */
+css_error css_stylesheet_data_done(css_stylesheet *sheet);
+
+/* Retrieve the URL associated with a stylesheet */
+const char *css_stylesheet_get_url(css_stylesheet *sheet);
+/* Retrieve the origin of a stylesheet */
+css_origin css_stylesheet_get_origin(css_stylesheet *sheet);
+/* Retrieve the media type(s) applicable to a stylesheet */
+uint32_t css_stylesheet_get_media(css_stylesheet *sheet);
+
+/* Create a selection context */
+css_context *css_context_create(void);
+/* Destroy a selection context */
+void css_context_destroy(css_context *context);
+
+/* Append a top-level stylesheet to a selection context */
+css_error css_context_append_sheet(css_context *context,
+ css_stylesheet *sheet);
+/* Insert a top-level stylesheet into a selection context, at the given index */
+css_error css_context_insert_sheet(css_context *context,
+ css_stylesheet *sheet, uint32_t index);
+/* Remove a top-level stylesheet from a selection context */
+css_error css_context_remove_sheet(css_context *context,
+ css_stylesheet *sheet);
+
+/* Retrieve the total number of top-level sheets in a selection context */
+uint32_t css_context_count_sheets(css_context *context);
+/* Get a stylesheet from a selection context given an index [0, count) */
+const css_stylesheet *css_context_get_sheet(css_context *context,
+ uint32_t index);
+
+/* Select a style for a given DOM node with the given pseudo classes active
+ * and media type.
+ *
+ * If the document language contains non-CSS presentational hints (e.g. HTML
+ * presentational attributes etc), then these are passed in through
+ * property_list and treated as if they were encountered at the start of the
+ * author stylesheet with a specificity of 0. */
+css_style *css_style_select(css_context *context,
+ <dom_node_type> *node, uint32_t pseudo_classes, uint32_t media,
+ css_value **property_list, uint32_t property_list_length);
+/* Destroy a selected style */
+void css_style_destroy(css_style *style);
+
+/* Retrieve a property value from a style */
+css_value *css_value_get(css_style *style, css_property property);
+/* Destroy a property value */
+void css_value_destroy(css_value *value);
+
+Memory management
+-----------------
+
+ + Stylesheets are owned by their creator. Selection contexts reference them.
+ + Selection contexts are owned by the client.
+ + Selected styles are owned by the client.
+ + Property values are owned by the client.
+
+ Therefore, the only difficulty lies within the handling of stylesheets
+ inserted into a selection context. The client code must ensure that a
+ stylesheet is destroyed after it has been removed from any selection
+ contexts which are using it.
+
+DOM node types & tree traversal
+-------------------------------
+
+ This is currently undecided. Either the CSS engine is tied to a DOM
+ implementation (and makes API calls directly), or it's more generic and
+ performs API calls through a vtable provided by the client.
+
+Imported stylesheets
+--------------------
+
+ Imported stylesheets are handled by the CSS engine creating an appropriate
+ css_stylesheet object for the imported sheet and then asking the client
+ to fetch the data and append it to the sheet. The imported sheet is then
+ stored in the sheet that imported it. This effectively creates a tree of
+ stylesheets beneath the initial top-level sheet created by the client.
+
+Style selection algorithm
+-------------------------
+
+ css_style_select(context, node, pseudo_classes, media,
+ property_list, property_list_length):
+ result = blank_style;
+ done_props = false;
+ foreach sheet in context:
+ # Assumes that sheets are in the order UA, USER, AUTHOR
+ if !done_props && css_stylesheet_get_origin(sheet) == CSS_ORIGIN_AUTHOR:
+ fake_rule = fake_rule(node, property_list, property_list_length);
+ cascade(result, fake_rule, CSS_ORIGIN_AUTHOR);
+ done_props = true;
+ process_sheet(sheet, node, pseudo_classes, media, result);
+ return result;
+
+ fake_rule(node, property_list, property_list_length):
+ rule = (node.name, 0); # Specificity is 0
+ foreach (property, value, importance) in property_list:
+ rule[property] = (value, importance);
+ return rule;
+
+ process_sheet(sheet, node, pseudo_classes, media, result):
+ if (css_stylesheet_get_media(sheet) & media) == 0:
+ return;
+ foreach import in sheet:
+ process_sheet(import, node, pseudo_classes, media, result);
+ origin = css_stylesheet_get_origin(sheet);
+ foreach rule in sheet:
+ if matches_rule(rule, node, pseudo_classes):
+ cascade(result, rule, origin);
+
+ cascade(result, rule, origin):
+ foreach (property, value, importance) in rule:
+ insert = false;
+ if result[property]:
+ rOrigin = result[property].origin;
+ rImportance = result[property].importance;
+ rSpecificity = result[property].specificity;
+ if rOrigin < origin:
+ if rImportance == "important":
+ if rOrigin != CSS_ORIGIN_USER:
+ insert = true;
+ else:
+ insert = true;
+ else if rOrigin == origin:
+ if rImportance == "" && importance == "important":
+ if rOrigin == CSS_ORIGIN_UA:
+ if rSpecificity <= rule.specificity:
+ insert = true;
+ else:
+ insert = true;
+ else if rImportance == "important" && importance == "":
+ if rOrigin == CSS_ORIGIN_UA:
+ if rSpecificity <= rule.specificity:
+ insert = true;
+ else:
+ if rSpecificity <= rule.specificity:
+ insert = true;
+ else:
+ if origin == CSS_ORIGIN_USER && importance == "important":
+ insert = true;
+ else:
+ insert = true;
+ if insert:
+ result[property] = (value, origin, importance, rule.specificity);
+
+Outstanding issues
+------------------
+
+ + Parsing/selection quirks.
+
+ Probably as an argument to css_stylesheet_create() and possibly
+ css_style_select(). This could either take the form of a blanket
+ full/almost/not quirks mode flag or be more granular and permit the
+ toggling of individual quirks.
+
+ References:
+
+ + http://developer.mozilla.org/en/docs/Mozilla_Quirks_Mode_Behavior
+ + http://www.opera.com/docs/specs/doctype/
+ + http://www.quirksmode.org/css/quirksmode.html
+ + http://www.cs.tut.fi/~jkorpela/quirks-mode.html
+ + Grep WebKit sources for inCompatMode()
+
+ + The :lang pseudo-class
+
+ Need to pass the current language string into css_style_select()
+
+ + Pseudo-elements
+
+ Probably as an argument to css_style_select(). Most likely a bitfield
+ like the way in which pseudo-classes are handled.
+
+ The inheritance model of :first-line and :first-letter is such that:
+
+ + css_style_select() must begin with a blank style and not the
+ parent node's style
+ + an API for cascading one style onto another is needed
+
+ This is because pseudo-elements may be nested inside children of the
+ node to which they are logically connected. e.g.:
+
+ <div>
+ <p>
+ first paragraph
+ </p>
+ </div>
+
+ is logically equivalent to
+
+ <div>
+ <p>
+ <div:first-line>
+ <p:first-line>
+ first paragraph
+ </p:first-line>
+ </div:first-line>
+ </p>
+ </div>
+
+ so the actual cascade order is only known at the time the render tree is
+ built. Note that, courtesy of scripting, the location of pseudo-elements
+ can move around (e.g. if some text was inserted just before the <p> within
+ the div, above, then <div:first-line> would move). Additionally, the actual
+ content that pseudo-elements apply to can change due to reflow.
+
+ Pseudo-elements may also affect the processing of inline boxes. e.g.:
+
+ <p>
+ <span>foo bar baz bat</span>
+ </p>
+
+ becomes (logically):
+
+ <p>
+ <p:first-line>
+ <span>foo bar baz </span>
+ </p:first-line>
+ <span>bat</span>
+ </p>
+
+ In terms of interaction between pseudo-elements, :first-letter inherits
+ from :first-line e.g.:
+
+ <p>
+ first line
+ second line
+ </p>
+
+ becomes (logically):
+
+ <p>
+ <p:first-line>
+ <p:first-letter>
+ f
+ </p:first-letter>
+ irst line
+ </p:first-line>
+ second line
+ </p>
+
+ :first-line and :first-letter apply to the relevant content _including_ any
+ text inserted using :before and :after.
+
+ List of CSS 3 pseudo-elements:
+
+ + :(:)?first-line
+ + :(:)?first-letter
+ + :(:)?before
+ + :(:)?after
+ + ::selection
+ + ::footnote-call
+ + ::footnote-marker
+ + ::before-page-break
+ + ::after-page-break
+ + ::line-number-left
+ + ::line-number-right
+ + ::line-number-inside
+ + ::line-number-outside
+ + ::slot()
+ + ::value
+ + ::choices
+ + ::repeat-item
+ + ::repeat-index
+ + ::marker
+ + ::outside
+ + ::alternate
+ + ::line-marker
+
+ References:
+
+ + CSS 2.1 $$5.12 and $$12.1
+
+ + Stylesheet charset handling
+
+ An embedded stylesheet shares the charset of the containing document.
+
+ The charset of a stand-alone stylesheet can be specified by (in order of
+ priority, highest -> lowest):
+
+ + the transport layer
+ + a BOM and/or @charset at the immediate start of the sheet
+ + <link charset=""> or other metadata from the linking mechanism
+ + charset of referring stylesheet or document
+ + assuming UTF-8
+
+ The API currently has no way of conveying the first, third, or fourth of
+ these to the engine. This can be realised through the addition of a
+ parameter to css_stylesheet_create()
+
+ CSS 2.1 $4.4 specifies that a stylesheet's transport encoding must be a
+ superset of US-ASCII.
+
+ The internal encoding will be UTF-8.
+
+ All strings passed in by the client are assumed to be UTF-8 encoded.
+ Strings retrieved from DOM nodes are assumed to be UTF-8 encoded.
+
diff --git a/docs/ideas/render-library.txt b/docs/ideas/render-library.txt
new file mode 100644
index 0000000..db645c4
--- a/dev/null
+++ b/docs/ideas/render-library.txt
@@ -0,0 +1,121 @@
+Rendering library
+=================
+
+General notes
+-------------
+
+ + Potentially long-running routines probably want to exit early and
+ ask to be resumed (or similar)
+ + There's loads of stuff missing from here (like a typesystem :)
+
+Possible API
+------------
+
+ /* Initialise library */
+ error html_init(void);
+ /* Finalise library */
+ error html_fini(void);
+
+ /* Create a context */
+ ctx html_create(void);
+ /* Destroy a context */
+ void html_destroy(ctx);
+
+ /* Configure a context
+ *
+ * Things that need configuring:
+ *
+ * Callbacks from library -> client:
+ *
+ * + Handler for embedded object fetch requests (how to handle frames?)
+ * + Event notification handler (e.g. form submission / link navigation,
+ * mouse pointer shape changing, redraw request, position caret, etc)
+ *
+ * Other stuff:
+ *
+ * + Scale? (should this be handled by the client?)
+ * + Whether to run scripts? (possibly, not needed yet)
+ */
+ error html_setopt(ctx, opttype, optparams);
+
+ /* Feed HTML data to a context */
+ error html_process_data(ctx, data, len);
+ /* Flag end of data to context */
+ error html_data_done(ctx);
+
+ /* Reflow context, to given width/height */
+ error html_reflow(ctx, width, height);
+
+ /* Redraw context, using provided plotters */
+ error html_redraw(ctx, rect, plot_table);
+
+ /* Some kind of input event notification APIs.
+ * These are called by the client to notify the library
+ * that something's happened.
+ *
+ * e.g.:
+ */
+ error html_mouse_move(ctx, x, y);
+ error html_mouse_press(ctx, x, y, buttons, modifiers);
+ error html_mouse_release(ctx, x, y, buttons, modifiers);
+ error html_key_press(ctx, key, modifiers);
+ error html_key_release(ctx, key, modifiers);
+ error html_scroll_x(ctx, offset);
+ error html_scroll_y(ctx, offset);
+
+ /* Retrieve properties of document in context
+ *
+ * e.g.:
+ */
+ error html_get_title(ctx, title);
+
+Example usage
+-------------
+
+/* Main routine */
+main:
+ /* Initialise library */
+ html_init();
+
+ /* Create a context */
+ ctx = html_create();
+
+ /* Configure the context */
+ html_setopt(ctx, FETCH_HANDLER, my_fetcher);
+ html_setopt(ctx, EVENT_HANDLER, my_event_handler);
+
+ /* Get it to process data */
+ foreach (chunk, len) in data:
+ html_process_data(ctx, chunk, len);
+ html_data_done(ctx);
+
+ /* Reflow content to desired dimensions */
+ html_reflow(ctx, width, height);
+
+ /* Main client event loop -- processes UI-toolkit events */
+ do:
+ on mouse event:
+ html_mouse_{move,press,release}(ctx, event.x, event.y ...);
+ on key event:
+ html_key_{press,release}{ctx, event.key, event.modifiers);
+ on scroll event:
+ html_scroll_{x,y}(ctx, event.offset);
+ on redraw event:
+ html_redraw(ctx, event.rect, my_plotters);
+ until quit;
+
+ /* Destroy context */
+ html_destroy(ctx);
+
+ /* Finalise library */
+ html_fini();
+
+/* Event handler for library-generated events */
+my_event_handler:
+ on pointer shape change:
+ set_pointer_shape(shape);
+ on redraw request:
+ redraw_window(window);
+ on position caret:
+ position caret(x, y);
+
diff --git a/docs/mainpage.md b/docs/mainpage.md
new file mode 100644
index 0000000..c1b7a0c
--- a/dev/null
+++ b/docs/mainpage.md
@@ -0,0 +1,91 @@
+NetSurf web browser
+===================
+
+The NetSurf code makes use of Doxygen for code documentation.
+
+User Interface
+--------------
+
+There are some basic user guides for the
+[framebuffer](docs/using-framebuffer.md) and
+[monkey](docs/using-monkey.md) frontends.
+
+The [core user options](docs/netsurf-options.md) of the browser are
+documented which are augmented by each frontend in a specific manner.
+
+Documented API
+--------------
+
+There are several documents which detail specific aspects of the
+codebase and APIs.
+
+### Core window
+
+The [core window API](docs/core-window-interface.md) allows frontends
+to use generic core code for user interface elements beyond the
+browser render.
+
+### Source object caching
+
+The [source object caching](docs/source-object-backing-store.md)
+provides a way for downloaded content to be kept on a persistent
+storage medium such as hard disc to make future retrieval of that
+content quickly.
+
+### Javascript
+
+JavaScript is provided by integrating the duktape library. There are [instructions](docs/updating-duktape.md) on how to update the library.
+
+A list of [unimplemented DOM and CSSOM methods](unimplemented.html)
+is available outlining the remaining API that have to be implemented.
+
+Development
+-----------
+
+Compiling a development edition of NetSurf requires a POSIX style
+environment. Typically this means a Linux based system although Free
+BSD, Open BSD, Mac OS X and Haiku all known to work.
+
+### Working with the team
+
+Generally it is sensible to check with the other developers if you are
+planning to make a change to NetSurf intended to be merged.
+
+We are often about on the IRC channel but failing that the developer
+mailing list is a good place to try.
+
+All the project sources are held in [public git repositories](http://source.netsurf-browser.org/)
+
+### Toolchains
+
+Compilation for non POSIX toolkits/frontends (e.g. RISC OS) generally
+relies upon a cross compilation environment which is generated using
+the makefiles found in our
+[toolchains](http://source.netsurf-browser.org/toolchains.git/)
+repository. These toolchains are built by the Continuous Integration
+(CI) system and the
+[results of the system](http://ci.netsurf-browser.org/builds/toolchains/)
+are published as a convenience.
+
+### Quick setup
+
+The [quick start guide](docs/quick-start.md) can be used to get a
+development environment setup quickly and uses the
+[env.sh](env_8sh_source.html) script the core team utilises.
+
+### Manual setup
+
+The Manual environment setup and compilation method is covered by the
+details in the [netsurf libraries](docs/netsurf-libraries.md) document
+for the core libraries and then one of the building documents for the
+specific frontend.
+
+- [Amiga Os cross](docs/building-AmigaCross.md) and [Amiga OS](docs/building-AmigaOS.md)
+- [Framebuffer](docs/building-Framebuffer.md)
+- [GTK](docs/building-GTK.md)
+- [Haiku (BeOS)](docs/building-Haiku.md)
+- [Windows Win32](docs/building-Windows.md)
+
+These documents are sometimes not completely up to
+date and the env.sh script should be considered canonical.
+
diff --git a/docs/netsurf-fb.1 b/docs/netsurf-fb.1
new file mode 100644
index 0000000..e4c3100
--- a/dev/null
+++ b/docs/netsurf-fb.1
@@ -0,0 +1,362 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH NETSURF 1 "December 24, 2014"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+netsurf \- A small fast web browser
+.SH SYNOPSIS
+.B netsurf-fb
+.RI [ options ]
+.RI [ url ]
+.SH DESCRIPTION
+This manual page documents briefly the
+.B netsurf
+browser.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
+.\" respectively.
+\fBnetsurf\fP is a small fast web browser. This man page only describes how to run the browser.
+.SH OPTIONS
+This programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+.PP
+The command line parameters override any options loaded from the users Choices file.
+.PP
+A summary of options is included below.
+.TP
+.B \-v
+Enable verbose logging.
+.TP
+.B \-\-http_proxy
+Bboolean indicating if the http proxy is being used.
+.TP
+.B \-\-http_proxy_host
+The http proxy host.
+.TP
+.B \-\-http_proxy_port
+The http proxy port.
+.TP
+.B \-\-http_proxy_auth
+The authentication scheme for the http proxy.
+.TP
+.B \-\-http_proxy_auth_user
+The authentication schemes user.
+.TP
+.B \-\-http_proxy_auth_pass
+The authentication schemes password.
+.TP
+.B \-\-font_size
+The default font size to use.
+.TP
+.B \-\-font_min_size
+The minimum font size to use.
+.TP
+.B \-\-font_sans
+Family name of the sans serif font.
+.TP
+.B \-\-font_serif
+Family name of the serif font.
+.TP
+.B \-\-font_mono
+Family name of the monospace font.
+.TP
+.B \-\-font_cursive
+Family name of the cursive font.
+.TP
+.B \-\-font_fantasy
+Family name of the fantasy font.
+.TP
+.B \-\-accept_language
+Languages to accept.
+.TP
+.B \-\-accept_charset
+Character set to accept
+.TP
+.B \-\-memory_cache_size
+Maximum memory cache size.
+.TP
+.B \-\-disc_cache_age
+Maximum disc cache size.
+.TP
+.B \-\-block_advertisements
+Boolean to enable ad blocking.
+.TP
+.B \-\-minimum_gif_delay
+Minimum time between gif frames
+.TP
+.B \-\-send_referer
+Boolean controlling whether referer data should be sent
+.TP
+.B \-\-animate_images
+Boolean controlling whether images should be animated.
+.TP
+.B \-\-expire_url
+expire url
+.TP
+.B \-\-font_default
+Default font.
+.TP
+.B \-\-ca_bundle
+ca bundle
+.TP
+.B \-\-ca_path
+ca path
+.TP
+.B \-\-cookie_file
+cookie file
+.TP
+.B \-\-cookie_jar
+cookie jar
+.TP
+.B \-\-homepage_url
+homepage url
+.TP
+.B \-\-search_url_bar
+search url bar
+.TP
+.B \-\-search_provider
+search provider
+.TP
+.B \-\-url_suggestion
+url suggestion
+.TP
+.B \-\-window_x
+The X co-ordinate of the initial window.
+.TP
+.B \-\-window_y
+The Y co-ordinate of the initial window.
+.TP
+.B \-\-window_width
+The width of the initial window.
+.TP
+.B \-\-window_height
+The height of the initial window.
+.TP
+.B \-\-window_screen_width
+window screen width
+.TP
+.B \-\-window_screen_height
+window screen height
+.TP
+.B \-\-toolbar_status_size
+toolbar status size
+.TP
+.B \-\-scale
+Initial scale factor.
+.TP
+.B \-\-incremental_reflow
+Boolean controlling whether incremental reflow is performed.
+.TP
+.B \-\-min_reflow_period
+Minimum time between incremental reflows
+.TP
+.B \-\-core_select_menu
+core select menu
+.TP
+.B \-\-max_fetchers
+max fetchers
+.TP
+.B \-\-max_fetchers_per_host
+max fetchers per host
+.TP
+.B \-\-max_cached_fetch_handles
+max cached fetch handles
+.TP
+.B \-\-suppress_curl_debug
+suppress curl debug
+.TP
+.B \-\-target_blank
+target blank
+.TP
+.B \-\-button_2_tab
+button 2 tab
+.TP
+.B \-\-margin_top
+margin top
+.TP
+.B \-\-margin_bottom
+margin bottom
+.TP
+.B \-\-margin_left
+margin left
+.TP
+.B \-\-margin_right
+margin right
+.TP
+.B \-\-export_scale
+export scale
+.TP
+.B \-\-suppress_images
+suppress images
+.TP
+.B \-\-remove_backgrounds
+remove backgrounds
+.TP
+.B \-\-enable_loosening
+enable loosening
+.TP
+.B \-\-enable_PDF_compression
+enable PDF compression
+.TP
+.B \-\-enable_PDF_password
+enable_PDF_password
+.TP
+.B \-\-gui_colour_bg_1
+gui colour bg_1
+.TP
+.B \-\-gui_colour_fg_1
+gui colour fg_1
+.TP
+.B \-\-gui_colour_fg_2
+gui colour fg_2
+.TP
+.B \-\-sys_colour_ActiveBorder
+Override CSS sys_colour_ActiveBorder colour.
+.TP
+.B \-\-sys_colour_ActiveCaption
+Override CSS sys_colour_ActiveCaption colour.
+.TP
+.B \-\-sys_colour_AppWorkspace
+Override CSS sys_colour_AppWorkspace colour.
+.TP
+.B \-\-sys_colour_Background
+Override CSS sys_colour_Background colour.
+.TP
+.B \-\-sys_colour_ButtonFace
+Override CSS sys_colour_ButtonFace colour.
+.TP
+.B \-\-sys_colour_ButtonHighlight
+Override CSS sys_colour_ButtonHighlight colour.
+.TP
+.B \-\-sys_colour_ButtonShadow
+Override CSS sys_colour_ButtonShadow colour.
+.TP
+.B \-\-sys_colour_ButtonText
+Override CSS sys_colour_ButtonText colour.
+.TP
+.B \-\-sys_colour_CaptionText
+Override CSS sys_colour_CaptionText colour.
+.TP
+.B \-\-sys_colour_GrayText
+Override CSS sys_colour_GrayText colour.
+.TP
+.B \-\-sys_colour_Highlight
+Override CSS sys_colour_Highlight colour.
+.TP
+.B \-\-sys_colour_HighlightText
+Override CSS sys_colour_HighlightText colour.
+.TP
+.B \-\-sys_colour_InactiveBorder
+Override CSS sys_colour_InactiveBorder colour.
+.TP
+.B \-\-sys_colour_InactiveCaption
+Override CSS sys_colour_InactiveCaption colour.
+.TP
+.B \-\-sys_colour_InactiveCaptionText
+Override CSS sys_colour_InactiveCaptionText colour.
+.TP
+.B \-\-sys_colour_InfoBackground
+Override CSS sys_colour_InfoBackground colour.
+.TP
+.B \-\-sys_colour_InfoText
+Override CSS sys_colour_InfoText colour.
+.TP
+.B \-\-sys_colour_Menu
+Override CSS sys_colour_Menu colour.
+.TP
+.B \-\-sys_colour_MenuText
+Override CSS sys_colour_MenuText colour.
+.TP
+.B \-\-sys_colour_Scrollbar
+Override CSS sys_colour_Scrollbar colour.
+.TP
+.B \-\-sys_colour_ThreeDDarkShadow
+Override CSS sys_colour_ThreeDDarkShadow colour.
+.TP
+.B \-\-sys_colour_ThreeDFace
+Override CSS sys_colour_ThreeDFace colour.
+.TP
+.B \-\-sys_colour_ThreeDHighlight
+Override CSS sys_colour_ThreeDHighlight colour.
+.TP
+.B \-\-sys_colour_ThreeDLightShadow
+Override CSS sys_colour_ThreeDLightShadow colour.
+.TP
+.B \-\-sys_colour_ThreeDShadow
+Override CSS sys_colour_ThreeDShadow colour.
+.TP
+.B \-\-sys_colour_Window
+Override CSS sys_colour_Window colour.
+.TP
+.B \-\-sys_colour_WindowFrame
+Override CSS sys_colour_WindowFrame colour.
+.TP
+.B \-\-sys_colour_WindowText
+Override CSS sys_colour_WindowText colour.
+.TP
+.B \-\-render_resample
+render resample
+.TP
+.B \-\-downloads_clear
+downloads clear
+.TP
+.B \-\-request_overwrite
+request overwrite
+.TP
+.B \-\-downloads_directory
+downloads directory
+.TP
+.B \-\-url_file
+url file
+.TP
+.B \-\-show_single_tab
+Force tabs to always be show.
+.TP
+.B \-\-button_type
+button type
+.TP
+.B \-\-disable_popups
+disable popups
+.TP
+.B \-\-disable_plugins
+disable plugins
+.TP
+.B \-\-history_age
+history age
+.TP
+.B \-\-hover_urls
+hover urls
+.TP
+.B \-\-focus_new
+focus new
+.TP
+.B \-\-new_blank
+new blank
+.TP
+.B \-\-hotlist_path
+hotlist path
+.TP
+.B \-\-source_tab
+source tab
+.TP
+.B \-\-current_theme
+current theme
+.SH AUTHOR
+netsurf-fb was written by the netsurf developers.
+.PP
+This manual page was written by Vincent Sanders <vince@debian.org>,
+for the Debian project (and may be used by others).
diff --git a/docs/netsurf-gtk.1 b/docs/netsurf-gtk.1
new file mode 100644
index 0000000..7b2f4f4
--- a/dev/null
+++ b/docs/netsurf-gtk.1
@@ -0,0 +1,281 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" Copyright 2014 Vincent Sanders
+.\"
+.\" Permission is hereby granted, free of charge, to any person obtaining a copy of this man page (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+.\"
+.\"The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+.\"
+.\"THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+.Dd December 26, 2014
+.Dt NETSURF 1 CON
+.Os
+.Sh NAME
+.Nm netsurf
+.Nd a small fast web browser
+.Sh SYNOPSIS
+.Nm netsurf-gtk
+.Op Ar options
+.Op Ar url
+.Sh DESCRIPTION
+.Nm
+is a lightweight, fast, standards-compliant web browser.
+This man page only describes how to run the browser.
+.Pp
+The command line parameters override any options loaded from the user's
+.Pa Choices
+file.
+.Pp
+In addition to these parameters the standard GTK+ options may be passed.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl v
+Enable verbose logging.
+.It Fl -http_proxy
+Boolean indicating if the http proxy is being used.
+.It Fl -http_proxy_host
+The http proxy host.
+.It Fl -http_proxy_port
+The http proxy port.
+.It Fl -http_proxy_auth
+The authentication scheme for the http proxy.
+.It Fl -http_proxy_auth_user
+The authentication schemes user.
+.It Fl -http_proxy_auth_pass
+The authentication schemes password.
+.It Fl -font_size
+The default font size to use.
+.It Fl -font_min_size
+The minimum font size to use.
+.It Fl -font_sans
+Family name of the sans serif font.
+.It Fl -font_serif
+Family name of the serif font.
+.It Fl -font_mono
+Family name of the monospace font.
+.It Fl -font_cursive
+Family name of the cursive font.
+.It Fl -font_fantasy
+Family name of the fantasy font.
+.It Fl -accept_language
+Languages to accept.
+.It Fl -accept_charset
+Character set to accept
+.It Fl -memory_cache_size
+Maximum memory cache size.
+.It Fl -disc_cache_age
+Maximum disc cache size.
+.It Fl -block_advertisements
+Boolean to enable ad blocking.
+.It Fl -minimum_gif_delay
+Minimum time between gif frames
+.It Fl -send_referer
+Boolean controlling whether referrer data should be sent
+.It Fl -animate_images
+Boolean controlling whether images should be animated.
+.It Fl -expire_url
+expire url
+.It Fl -font_default
+Default font.
+.It Fl -ca_bundle
+Certificate authority bundle path.
+.It Fl -ca_path
+Certificate authority path
+.It Fl -cookie_file
+cookie file
+.It Fl -cookie_jar
+cookie jar
+.It Fl -homepage_url
+homepage url
+.It Fl -search_url_bar
+search url bar
+.It Fl -search_provider
+search provider
+.It Fl -url_suggestion
+url suggestion
+.It Fl -window_x
+The X co-ordinate of the initial window.
+.It Fl -window_y
+The Y co-ordinate of the initial window.
+.It Fl -window_width
+The width of the initial window.
+.It Fl -window_height
+The height of the initial window.
+.It Fl -window_screen_width
+window screen width
+.It Fl -window_screen_height
+window screen height
+.It Fl -toolbar_status_size
+toolbar status size
+.It Fl -scale
+Initial scale factor.
+.It Fl -incremental_reflow
+Boolean controlling whether incremental reflow is performed.
+.It Fl -min_reflow_period
+Minimum time between incremental reflows
+.It Fl -core_select_menu
+core select menu
+.It Fl -max_fetchers
+max fetchers
+.It Fl -max_fetchers_per_host
+max fetchers per host
+.It Fl -max_cached_fetch_handles
+max cached fetch handles
+.It Fl -suppress_curl_debug
+suppress curl debug
+.It Fl -target_blank
+target blank
+.It Fl -button_2_tab
+button 2 tab
+.It Fl -margin_top
+margin top
+.It Fl -margin_bottom
+margin bottom
+.It Fl -margin_left
+margin left
+.It Fl -margin_right
+margin right
+.It Fl -export_scale
+export scale
+.It Fl -suppress_images
+suppress images
+.It Fl -remove_backgrounds
+remove backgrounds
+.It Fl -enable_loosening
+enable loosening
+.It Fl -enable_PDF_compression
+enable PDF compression
+.It Fl -enable_PDF_password
+enable_PDF_password
+.It Fl -gui_colour_bg_1
+gui colour bg_1
+.It Fl -gui_colour_fg_1
+gui colour fg_1
+.It Fl -gui_colour_fg_2
+gui colour fg_2
+.It Fl -sys_colour_ActiveBorder
+Override CSS sys_colour_ActiveBorder colour.
+.It Fl -sys_colour_ActiveCaption
+Override CSS sys_colour_ActiveCaption colour.
+.It Fl -sys_colour_AppWorkspace
+Override CSS sys_colour_AppWorkspace colour.
+.It Fl -sys_colour_Background
+Override CSS sys_colour_Background colour.
+.It Fl -sys_colour_ButtonFace
+Override CSS sys_colour_ButtonFace colour.
+.It Fl -sys_colour_ButtonHighlight
+Override CSS sys_colour_ButtonHighlight colour.
+.It Fl -sys_colour_ButtonShadow
+Override CSS sys_colour_ButtonShadow colour.
+.It Fl -sys_colour_ButtonText
+Override CSS sys_colour_ButtonText colour.
+.It Fl -sys_colour_CaptionText
+Override CSS sys_colour_CaptionText colour.
+.It Fl -sys_colour_GrayText
+Override CSS sys_colour_GrayText colour.
+.It Fl -sys_colour_Highlight
+Override CSS sys_colour_Highlight colour.
+.It Fl -sys_colour_HighlightText
+Override CSS sys_colour_HighlightText colour.
+.It Fl -sys_colour_InactiveBorder
+Override CSS sys_colour_InactiveBorder colour.
+.It Fl -sys_colour_InactiveCaption
+Override CSS sys_colour_InactiveCaption colour.
+.It Fl -sys_colour_InactiveCaptionText
+Override CSS sys_colour_InactiveCaptionText colour.
+.It Fl -sys_colour_InfoBackground
+Override CSS sys_colour_InfoBackground colour.
+.It Fl -sys_colour_InfoText
+Override CSS sys_colour_InfoText colour.
+.It Fl -sys_colour_Menu
+Override CSS sys_colour_Menu colour.
+.It Fl -sys_colour_MenuText
+Override CSS sys_colour_MenuText colour.
+.It Fl -sys_colour_Scrollbar
+Override CSS sys_colour_Scrollbar colour.
+.It Fl -sys_colour_ThreeDDarkShadow
+Override CSS sys_colour_ThreeDDarkShadow colour.
+.It Fl -sys_colour_ThreeDFace
+Override CSS sys_colour_ThreeDFace colour.
+.It Fl -sys_colour_ThreeDHighlight
+Override CSS sys_colour_ThreeDHighlight colour.
+.It Fl -sys_colour_ThreeDLightShadow
+Override CSS sys_colour_ThreeDLightShadow colour.
+.It Fl -sys_colour_ThreeDShadow
+Override CSS sys_colour_ThreeDShadow colour.
+.It Fl -sys_colour_Window
+Override CSS sys_colour_Window colour.
+.It Fl -sys_colour_WindowFrame
+Override CSS sys_colour_WindowFrame colour.
+.It Fl -sys_colour_WindowText
+Override CSS sys_colour_WindowText colour.
+.It Fl -render_resample
+render resample
+.It Fl -downloads_clear
+downloads clear
+.It Fl -request_overwrite
+request overwrite
+.It Fl -downloads_directory
+downloads directory
+.It Fl -url_file
+url file
+.It Fl -show_single_tab
+Force tabs to always be show.
+.It Fl -button_type
+button type
+.It Fl -disable_popups
+disable popups
+.It Fl -disable_plugins
+disable plugins
+.It Fl -history_age
+history age
+.It Fl -hover_urls
+hover urls
+.It Fl -focus_new
+focus new
+.It Fl -new_blank
+new blank
+.It Fl -hotlist_path
+hotlist path
+.It Fl -source_tab
+source tab
+.It Fl -current_theme
+current theme
+.Sh FILES
+.Bl -item -width HOMEconfignetsurfChoicesxxxx
+.It
+.Pa $HOME/.config/netsurf/Choices
+.It
+.Pa $HOME/.config/netsurf/Hotlist
+.El
+.Sh SEE ALSO
+.Xr gtk-options 7
+.Sh STANDARDS
+.Rs
+.%D December 3, 2014
+.%I Web Hypertext Application Technology Working Group
+.%T HTML Living Standard
+.%U https://html.spec.whatwg.org/multipage/
+.Re
+.Pp
+.Rs
+.%D June 7, 2011
+.%I World Wide Web Consortium
+.%T Cascading Style Sheets Level 2 Revision 1 (CSS 2.1) Specification
+.%U http://www.w3.org/TR/CSS21/
+.Re
+.Pp
+.Rs
+.%D December 17, 2014
+.%I Web Hypertext Application Technology Working Group
+.%T Document Object Model Living Standard
+.%U https://dom.spec.whatwg.org/
+.Re
+.Sh AUTHORS
+Authorship information for
+.Nm
+is available at the project homepage,
+.Lk http://www.netsurf-browser.org/
+.Pp
+This manual page was written by
+.An Vincent Sanders Aq Mt vince@netsurf-browser.org
diff --git a/docs/netsurf-libraries.md b/docs/netsurf-libraries.md
new file mode 100644
index 0000000..dc5a980
--- a/dev/null
+++ b/docs/netsurf-libraries.md
@@ -0,0 +1,51 @@
+--------------------------------------------------------------------------------
+ NetSurf project libraries required 1 July 2012
+--------------------------------------------------------------------------------
+
+ To build NetSurf, you need the libraries required by the core, and any extra
+ libraries required by the specific front end you are building.
+
+
+ NetSurf Core
+==============
+
+ Required:
+
+ $ git clone git://git.netsurf-browser.org/buildsystem
+ $ git clone git://git.netsurf-browser.org/libwapcaplet
+ $ git clone git://git.netsurf-browser.org/libparserutils
+ $ git clone git://git.netsurf-browser.org/libhubbub
+ $ git clone git://git.netsurf-browser.org/libcss
+ $ git clone git://git.netsurf-browser.org/libdom
+ $ git clone git://git.netsurf-browser.org/libnsbmp
+ $ git clone git://git.netsurf-browser.org/libnsgif
+
+ Optional:
+
+ $ git clone git://git.netsurf-browser.org/libsvgtiny
+
+
+ RISC OS front end
+===================
+
+ Required:
+
+ $ git clone git://git.netsurf-browser.org/libpencil
+ $ git clone git://git.netsurf-browser.org/rufl
+
+
+ Framebuffer front end
+=======================
+
+ Required:
+
+ $ git clone git://git.netsurf-browser.org/libnsfb
+
+
+ Non RISC OS front ends
+========================
+
+ Optional:
+
+ $ git clone git://git.netsurf-browser.org/librosprite
+
diff --git a/docs/netsurf-options.md b/docs/netsurf-options.md
new file mode 100644
index 0000000..89b8814
--- a/dev/null
+++ b/docs/netsurf-options.md
@@ -0,0 +1,241 @@
+--------------------------------------------------------------------------------
+ Common NetSurf user options 4nd December 2014
+--------------------------------------------------------------------------------
+
+ This document outlines the common configuration options supported by the
+ NetSurf core.
+
+Overview
+========
+
+ The users configurations are generally stored in a "Choices" file
+ and are loaded at browser startup. Most user interfaces provide a
+ way to configure these parameters in a manner consistant with the
+ toolkit in use.
+
+ The user choices are stored as a simple key:value list.
+
+ Each entry has a type, one of: boolean, integer, unsigned integer,
+ hexadecimal colour value or string.
+
+General Options
+===============
+
++----------------------+--------+-----------+----------------------------------+
+| Option Key | Type | Default | Description |
++----------------------+--------+-----------+----------------------------------+
+| http_proxy | bool | false | An HTTP proxy should be used. |
+| | | | |
+| http_proxy | bool | false | An HTTP proxy should be used. |
+| | | | |
+| http_proxy_host | string | NULL | Hostname of proxy. |
+| | | | |
+| http_proxy_port | int | 8080 | Proxy port. |
+| | | | |
+| http_proxy_auth | int | 0 | Proxy authentication method. |
+| | | | |
+| http_proxy_auth_user | string | NULL | Proxy authentication user name |
+| | | | |
+| http_proxy_auth_pass | string | NULL | Proxy authentication password |
+| | | | |
+| http_proxy_noproxy | string | localhost | Proxy omission list |
+| | | | |
+| font_size | int | 128 | Default font size / 0.1pt. |
+| | | | |
+| font_min_size | int | 85 | Minimum font size. |
+| | | | |
+| font_sans | string | NULL | Default sans serif font |
+| | | | |
+| font_serif | string | NULL | Default serif font |
+| | | | |
+| font_mono | string | NULL | Default monospace font
+| | | | |
+| font_cursive | string | NULL | Default cursive font
+| | | | |
+| font_fantasy | string | NULL | Default fantasy font
+| | | | |
+| accept_language | string | NULL | Accept-Language header.
+| | | | |
+| accept_charset | string | NULL | Accept-Charset header.
+| | | | |
+| memory_cache_size | int | 12MiB | Preferred maximum size of memory |
+| | | | cache in bytes. |
+| | | | |
+| disc_cache_size | uint | 1GiB | Preferred expiry size of disc |
+| | | | cache in bytes. |
+| | | | |
+| disc_cache_age | int | 28 | Preferred expiry age of disc |
+| | | | cache in days. |
+| | | | |
+| block_advertisements | bool | false | Whether to block advertisements
+| | | | |
+| do_not_track | bool | false | Disable website tracking [1]
+| | | | |
+| minimum_gif_delay | int | 10 | Minimum GIF animation delay
+| | | | |
+| send_referer | bool | true | Whether to send the referer HTTP |
+| | | | header. |
+| | | | |
+| foreground_images | bool | true | Whether to fetch foreground images
+| | | | |
+| background_images | bool | true | Whether to fetch background images
+| | | | |
+| animate_images | bool | true | Whether to animate images
+| | | | |
+| enable_javascript | bool | false | Whether to execute javascript
+| | | | |
+| script_timeout | int | 10 | Maximum time to wait for a script|
+| | | | to run in seconds |
+| | | | |
+| expire_url | int | 28 | How many days to retain URL data |
+| | | | for. |
+| | | | |
+| font_default | int | 0 | Default font family
+| | | | |
+| ca_bundle | string | NULL | ca-bundle location
+| | | | |
+| ca_path | string | NULL | ca-path location
+| | | | |
+| cookie_file | string | NULL | Cookie file location
+| | | | |
+| cookie_jar | string | NULL | Cookie jar location
+| | | | |
+| homepage_url | string | NULL | Home page location
+| | | | |
+| search_url_bar | bool | false | search web from url bar
+| | | | |
+| search_provider | int | 0 | default web search provider
+| | | | |
+| url_suggestion | bool | true | URL completion in url bar
+| | | | |
+| window_x | int | 0 | default x position of new windows
+| | | | |
+| window_y | int | 0 | default y position of new windows
+| | | | |
+| window_width | int | 0 | default width of new windows
+| | | | |
+| window_height | int | 0 | default height of new windows
+| | | | |
+| window_screen_width | int | 0 | width of screen when above |
+| | | | options were saved |
+| | | | |
+| window_screen_height | int | 0 | height of screen when above |
+| | | | options were saved |
+| | | | |
+| toolbar_status_size | int | 6667 | default size of status bar vs. |
+| | | | h scroll bar |
+| | | | |
+| scale | int | 100 | default window scale
+| | | | |
+| incremental_reflow | bool | true | Whether to reflow web pages while|
+| | | | objects are fetching |
+| | | | |
+| min_reflow_period | uint | 25 | Minimum time (in cs) between HTML|
+| | | | reflows while objects are fetching
+| | | | |
+| core_select_menu | bool | false | Use core selection menu |
+| | | | |
++----------------------+--------+-----------+----------------------------------+
+
+[1] http://www.w3.org/Submission/2011/SUBM-web-tracking-protection-20110224/#dnt-uas
+
+Fetcher options
+===============
+
++--------------------------+------+------+-------------------------------------+
+| Option Key | Type | Dflt | Description |
++--------------------------+------+------+-------------------------------------+
+| max_fetchers | int | 24 | Maximum simultaneous active fetchers|
+| | | | |
+| max_fetchers_per_host | int | 5 | Maximum simultaneous active fetchers|
+| | | | per host. (<=option_max_fetchers |
+| | | | else it makes no sense) [2] |
+| | | | |
+| max_cached_fetch_handles | int | 6 | Maximum number of inactive fetchers |
+| | | | cached. The total number of handles|
+| | | | netsurf will therefore have open is|
+| | | | this plus option_max_fetchers. |
+| | | | |
+| suppress_curl_debug | bool | true | Suppress debug output from cURL. |
+| | | | |
+| target_blank | bool | true | Whether to allow target="_blank" |
+| | | | |
+| button_2_tab | bool | true | Whether second mouse button opens in|
+| | | | new tab. |
+| | | | |
++--------------------------+------+------+-------------------------------------+
+
+[2] Note that rfc2616 section 8.1.4 says that there should be no more
+ than two keepalive connections per host. None of the main browsers
+ follow this as it slows page fetches down considerably.
+ See https://bugzilla.mozilla.org/show_bug.cgi?id=423377#c4
+
+
+PDF / Print options
+===================
+
++------------------------+------+-------+--------------------------------------+
+| Option Key | Type | Deflt | Description |
++------------------------+------+-------+--------------------------------------+
+| margin_top | int | 10 | top margin of exported page |
+| | | | |
+| margin_bottom | int | 10 | bottom margin of exported page |
+| | | | |
+| margin_left | int | 10 | left margin of exported page |
+| | | | |
+| margin_right | int | 10 | right margin of exported page |
+| | | | |
+| export_scale | int | 70 | scale of exported content |
+| | | | |
+| suppress_images | bool | false | suppressing images in printed content|
+| | | | |
+| remove_backgrounds | bool | false | turning off all backgrounds for |
+| | | | printed content |
+| | | | |
+| enable_loosening | bool | true | turning on content loosening for |
+| | | | printed content |
+| | | | |
+| enable_PDF_compression | bool | true | compression of PDF documents |
+| | | | |
+| enable_PDF_password | bool | false | setting a password and encoding PDF |
+| | | | documents |
++------------------------+------+-------+--------------------------------------+
+
+System colours
+==============
+
+These are the css system colours which the browser also uses to style
+generated output.
+
++--------------------------------+--------+------------+
+| Option Key | Type | Default |
++--------------------------------+--------+------------+
+| sys_colour_ActiveBorder | colour | 0x00d3d3d3 |
+| sys_colour_ActiveCaption | colour | 0x00f1f1f1 |
+| sys_colour_AppWorkspace | colour | 0x00f1f1f1 |
+| sys_colour_Background | colour | 0x006e6e6e |
+| sys_colour_ButtonFace | colour | 0x00f9f9f9 |
+| sys_colour_ButtonHighlight | colour | 0x00ffffff |
+| sys_colour_ButtonShadow | colour | 0x00aeaeae |
+| sys_colour_ButtonText | colour | 0x004c4c4c |
+| sys_colour_CaptionText | colour | 0x004c4c4c |
+| sys_colour_GrayText | colour | 0x00505050 |
+| sys_colour_Highlight | colour | 0x00c00800 |
+| sys_colour_HighlightText | colour | 0x00ffffff |
+| sys_colour_InactiveBorder | colour | 0x00f1f1f1 |
+| sys_colour_InactiveCaption | colour | 0x00e6e6e6 |
+| sys_colour_InactiveCaptionText | colour | 0x00a6a6a6 |
+| sys_colour_InfoBackground | colour | 0x008fdfef |
+| sys_colour_InfoText | colour | 0x00000000 |
+| sys_colour_Menu | colour | 0x00f1f1f1 |
+| sys_colour_MenuText | colour | 0x004e4e4e |
+| sys_colour_Scrollbar | colour | 0x00cccccc |
+| sys_colour_ThreeDDarkShadow | colour | 0x00aeaeae |
+| sys_colour_ThreeDFace | colour | 0x00f9f9f9 |
+| sys_colour_ThreeDHighlight | colour | 0x00ffffff |
+| sys_colour_ThreeDLightShadow | colour | 0x00ffffff |
+| sys_colour_ThreeDShadow | colour | 0x00d5d5d5 |
+| sys_colour_Window | colour | 0x00f1f1f1 |
+| sys_colour_WindowFrame | colour | 0x004e4e4e |
+| sys_colour_WindowText | colour | 0x00000000 |
++--------------------------------+--------+------------+
diff --git a/docs/quick-start.md b/docs/quick-start.md
new file mode 100644
index 0000000..8bc90de
--- a/dev/null
+++ b/docs/quick-start.md
@@ -0,0 +1,111 @@
+Quick Build Steps for NetSurf
+=============================
+
+Last Updated: 24 February 2015
+
+This document provides steps for building NetSurf.
+
+
+Grab a temporary env.sh
+-----------------------
+
+ $ wget http://git.netsurf-browser.org/netsurf.git/plain/docs/env.sh
+ $ source env.sh
+
+
+Install any packages you need
+-----------------------------
+
+Installs all packages required to build NetSurf and the NetSurf project
+libraries.
+
+ $ ns-package-install
+
+If your package manager is not supported, you will have to install third
+ party packages manually.
+
+
+Get the NetSurf project source code from Git
+--------------------------------------------
+
+ $ ns-clone
+
+
+Build and install our project libraries
+---------------------------------------
+
+Updates NetSurf project library sources to latest, builds and installs them.
+
+ $ ns-pull-install
+
+
+Switch to new NetSurf workspace
+-------------------------------
+
+Remove the bootstrack script and use the newly installed one
+
+ $ rm env.sh
+ $ cd ~/dev-netsurf/workspace
+ $ source env.sh
+
+
+Build and run NetSurf
+---------------------
+
+ $ cd netsurf
+
+To build the native front end (the GTK front end on Linux, BSDs, etc) you
+could do:
+
+ $ make
+ $ ./nsgtk
+
+To build the framebuffer front end, you could do:
+
+ $ make TARGET=framebuffer
+ $ ./nsfb
+
+
+Cross Compiling
+===============
+
+If you are cross compiling, you can follow the above steps, but when
+sourcing env.sh, you should set HOST environment variable to the
+appropriate triplet for your cross compiler. For example, to cross
+compile for RISC OS:
+
+ $ HOST=arm-unknown-riscos source env.sh
+
+After that, the commands such as `ns-package-install` and
+`ns-pull-install` will do what is appropriate for the platform you
+are building for.
+
+To do the final build of NetSurf, pass the appropriate TARGET to make.
+For example, to cross compile for RISC OS:
+
+ $ make TARGET=riscos
+
+Finally, you can package up your build to transfer to the system you
+are developing for. For example, to produce a package for RISC OS:
+
+ $ make TARGET=riscos package
+
+Getting a cross compiler set up
+-------------------------------
+
+We maintain cross compilation environments and an SDK for a number of
+platforms. These may be found in our toolchains repository.
+
+ $ git clone git://git.netsurf-browser.org/toolchains
+
+Pre-built versions of the toolchains for Debian systems are often available
+via our [automated build and test infrastructure](http://ci.netsurf-browser.org/builds/toolchains/)
+
+
+Not working?
+============
+
+If the above steps are inapplicable, or don't work, you can build manually.
+Follow the instructions in the BUILDING-* documents in the docs/ directory
+the NetSurf browser source tree.
+
diff --git a/docs/source-object-backing-store.md b/docs/source-object-backing-store.md
new file mode 100644
index 0000000..0fb3614
--- a/dev/null
+++ b/docs/source-object-backing-store.md
@@ -0,0 +1,204 @@
+Source Object (low level) cache backing store
+=============================================
+
+Introduction
+------------
+
+The source object cache provides a system to extend the life of source
+objects (HTML files, images etc.) after they are no longer immediately
+being used.
+
+Only fetch types where we have well defined rules on caching are
+considered, in practice this limits us to HTTP(S). The section in
+RFC2616 [1] on caching specifies these rules.
+
+To further extend the objects lifetime they can be pushed into a
+backing store where the objects are available for reuse less quickly
+than from RAM but faster than retrieving from the network again.
+
+The backing store implementation provides a key:value infrastructure
+with a simple store, retrieve and invalidate interface.
+
+Generic filesystem backing store
+--------------------------------
+
+Although the backing store interface is fully pluggable a generic
+implementation based on storing objects on the filesystem in a
+hierarchy of directories.
+
+The option to alter the backing store format exists and is controlled
+by a version field. It is implementation defined what happens if a
+version mis-match occurs.
+
+As the backing store only holds cache data one should not expect a
+great deal of effort to be expended converting formats (i.e. the cache
+may simply be discarded).
+
+Layout version 1.1
+------------------
+
+An object has an identifier value generated from the URL (NetSurf
+backing stores uses the URL as the unique key). The value used is
+obtained using nsurl_hash() which is currently a 32 bit FNV so is
+directly usable.
+
+This identifier is adequate to ensure the collision rate for the
+hashed URL values (a collision for every 2^16 URLs added) is
+sufficiently low the overhead of returning the wrong object (which
+backing stores are permitted to do) is not significant.
+
+An entry list is maintained which contains all the metadata about a
+given identifier. This list is limited in length to constrain the
+resources necessary to maintain it. It is made persistent to avoid the
+overhead of reconstructing it at initialisation and to keep the data
+used to improve the eviction decisions.
+
+Each object is stored and retrieved directly into the filesystem using
+a filename generated from a RFC4648 base32 encoding of an address
+value. The objects address is derived from the identifier by cropping
+it to a shorter length.
+
+A mapping between the object address and its entry is maintained which
+uses storage directly proportional to the size of the address length.
+
+The cropping length is stored in the control file with the default
+values set at compile time. This allows existing backing stores to
+continue operating with existing data independently of new default
+setting. This setting gives some ability to tune the default cache
+index size to values suitable for a specific host operating system.
+
+E.g. Linux based systems can easily cope with several megabytes of
+mmaped index but RISC OS might want to limit this to a few megabytes
+of heap at most.
+
+The files are stored on disc using their base32 address value.
+By creating a directory for each character of the encoded filename
+(except the last which is of course the leafname) we create a
+directory structure where no directory has more than 32 entries.
+
+E.g. A 19bit address of 0x1 would be base32 encoded into AAAB
+resulting in the data being stored in a file path of
+"/store/prefix/d/B/A/A/BAAAAA".
+
+An address of 0x00040001 encodes to BAAB and a file path of
+"/store/prefix/m/B/A/A/BAABAAA"
+
+Version 1.0
+-----------
+
+The version 1 layout was identical to the 1.1 except base64url
+encoding was used, this proved problematic as some systems filesystems
+were case insensitive so upper and lower case letters collided.
+
+There is no upgrade provision from the previous version simply delete
+the cache directory.
+
+Control files
+~~~~~~~~~~~~~
+
+control
++++++++
+A control file is used to hold a list of values describing how the
+other files in the backing store should be used.
+
+entries
++++++++
+
+this file contains a table of entries describing the files held on the
+filesystem.
+
+Each control file table entry is 28 bytes and consists of
+
+ - signed 64 bit value for last use time
+
+ - 32bit full url hash allowing for index reconstruction and
+ additional collision detection. Also the possibility of increasing
+ the ADDRESS_LENGTH although this would require renaming all the
+ existing files in the cache and is not currently implemented.
+
+ - unsigned 32bit length for data
+
+ - unsigned 32bit length for metadata
+
+ - unsigned 16bit value for number of times used.
+
+ - unsigned 16bit value for flags
+
+ - unsigned 16bit value for data block index (unused)
+
+ - unsigned 16bit value for metatdata block index (unused)
+
+Address to entry index
+~~~~~~~~~~~~~~~~~~~~~~
+
+An entry index is held in RAM that allows looking up the address to
+map to an entry in the control file.
+
+The index is the only data structure whose size is directly dependant
+on the length of the hash specifically:
+
+(2 ^ (ADDRESS_BITS - 3)) * ENTRY_BITS) in bytes
+
+where ADDRESS_BITS is how long the address is in bits and ENTRY_BITS
+is how many entries the control file (and hence the while
+cache) may hold.
+
+RISCOS values
++++++++++++++
+
+By limiting the ENTRY_BITS size to 14 (16,384 entries) the entries
+list is limited to 448kilobytes.
+
+The typical values for RISC OS would set ADDRESS_BITS to 18. This
+spreads the entries over 262144 hash values which uses 512 kilobytes
+for the index. Limiting the hash space like this reduces the
+effectiveness of the cache.
+
+A small ADDRESS_LENGTH causes a collision (two URLs with the same
+address) to happen roughly for every 2 ^ (ADDRESS_BITS / 2) = 2 ^ 9 =
+512 objects stored. This roughly translates to a cache miss due to
+collision every ten pages navigated to.
+
+Larger systems
+++++++++++++++
+
+In general ENTRY_BITS set to 16 as this limits the store to 65536
+objects which given the average size of an object at 8 kilobytes
+yields half a gigabyte of disc used which is judged to be sufficient.
+
+For larger systems e.g. those using GTK frontend we would most likely
+select ADDRESS_BITS as 22 resulting in a collision every 2048 objects
+but the index using some 8 Megabytes
+
+Typical values
+--------------
+
+Example 1
+~~~~~~~~~
+
+For a store with 1034 objects generated from a random navigation of
+pages linked from the about:welcome page.
+
+Metadata total size is 593608 bytes an average of 574 bytes. The
+majority of the storage is used to hold the URLs and headers.
+
+Data total size is 9180475 bytes a mean of 8879 bytes 1648726 in the
+largest 10 entries which if excluded gives 7355 bytes average size
+
+Example 2
+~~~~~~~~~
+
+355 pages navigated in 80 minutes from about:welcome page and a
+handful of additional sites (google image search and reddit)
+
+2018 objects in cache at quit. 400 objects from news.bbc.co.uk alone
+
+Metadata total 987,439 bytes mean of 489 bytes
+
+data total 33,127,831 bytes mean of 16,416 bytes
+
+with one single 5,000,811 byte gif
+
+data totals without gif is 28,127,020 mean 13,945
+
+[1] http://tools.ietf.org/html/rfc2616#section-13 \ No newline at end of file
diff --git a/docs/unit-testing b/docs/unit-testing
new file mode 100644
index 0000000..49d82ed
--- a/dev/null
+++ b/docs/unit-testing
@@ -0,0 +1,166 @@
+NetSurf Unit Testing
+====================
+
+Overview
+--------
+
+NetSurf has unit tests integrated in the test directory. These tests
+use the check unit test framework for C [1].
+
+The tests are in a logical hierachy of "suite", "case" and individual
+"test". Historicaly we have split suites of tests into separate test
+programs although the framework does not madate this and some test
+programs contain more than one suite.
+
+
+Execution
+---------
+
+The test programs are executed by using the standard "test" target
+from the top level make invocation. The "coverage" target additionally
+generates code coverage reports allowing visibility on how much of a
+code module is being exercised.
+
+The check library must be installed to run the tests and the CI system
+automatically executes all enabled tests and generates coverage
+reports for each commit.
+
+Adding tests
+------------
+
+The test/Makefile defines each indiviadual test program that should be
+built and executed in the TESTS variable.
+
+The test program source files are defined in a xxx_SRCS variable and
+the make rules will then ensure the target program is built and
+executed.
+
+Each individual test program requires a main function which creates
+one (or more) suites. The suites are added to a test runner and then
+executed and the results reported.
+
+int main(int argc, char **argv)
+{
+ int number_failed;
+ SRunner *sr;
+
+ sr = srunner_create(foo_suite_create());
+ //srunner_add_suite(sr, bar_suite_create());
+
+ srunner_run_all(sr, CK_ENV);
+
+ number_failed = srunner_ntests_failed(sr);
+ srunner_free(sr);
+
+ return (number_failed == 0) ? EXIT_SUCCESS : EXIT_FAILURE;
+}
+
+Suite creation is done with a sub function to logically split suite
+code into sub modules. Each suite has test cases added to it.
+
+Suite *foo_suite_create(void)
+{
+ Suite *s;
+ s = suite_create("foo");
+
+ suite_add_tcase(s, baz_case_create());
+ suite_add_tcase(s, qux_case_create());
+
+ return s;
+}
+
+Test cases include the actual tests to be performed within each case.
+
+TCase *baz_case_create(void)
+{
+ TCase *tc;
+ tc = tcase_create("Baz");
+
+ tcase_add_test(tc, xxyz_test);
+ tcase_add_test(tc, zzyx_test);
+
+ return tc;
+}
+
+A test case may optionally have a fixture which is code that is
+executed before and after each test case. Unchecked fixtures are
+executed once before the test process forks for each test whereas
+checked fixtures are executed for each and every test.
+
+static void fixture_setup(void)
+{
+}
+
+static void fixture_teardown(void)
+{
+}
+
+TCase *qux_case_create(void)
+{
+ TCase *tc;
+
+ /* Matching entry tests */
+ tc = tcase_create("Match");
+
+ tcase_add_checked_fixture(tc,
+ fixture_setup,
+ fixture_teardown);
+
+ tcase_add_test(tc, zzz_test);
+
+ return tc;
+}
+
+Additionally test cases can contain tests executed in a loop. The test
+recives a single integer as a parameter named _i which iterates
+between values specified in the case setup.
+
+TCase *baz_case_create(void)
+{
+ TCase *tc;
+ tc = tcase_create("Baz");
+
+ tcase_add_loop_test(tc, looping_test, 0, 5);
+
+ return tc;
+}
+
+It is also possible to create tests which will generate a signal. The
+most commonly used of these is to check asserts in API calls.
+
+TCase *baz_case_create(void)
+{
+ TCase *tc;
+ tc = tcase_create("Baz");
+
+ tcase_add_test_raise_signal(tc, assert_test, 6);
+
+ return tc;
+}
+
+
+Actual test code is self contained in a function which uses the
+ck_assert macros to test results. The check framework requires each
+test to use the START_TEST and END_TEST macros when definig them.
+
+/**
+ * url access leaf test
+ */
+START_TEST(nsurl_access_leaf_test)
+{
+ nserror err;
+ nsurl *res_url;
+ const struct test_triplets *tst = &access_tests[_i];
+
+ /* not testing create, this should always succeed */
+ err = nsurl_create(tst->test1, &res_url);
+ ck_assert(err == NSERROR_OK);
+
+ ck_assert_str_eq(nsurl_access_leaf(res_url), tst->res);
+
+ nsurl_unref(res_url);
+}
+END_TEST
+
+
+[1] https://libcheck.github.io/check/
diff --git a/docs/updating-duktape.md b/docs/updating-duktape.md
new file mode 100644
index 0000000..672fccc
--- a/dev/null
+++ b/docs/updating-duktape.md
@@ -0,0 +1,29 @@
+Updating Duktape
+================
+
+1. Fetch the [latest release](http://duktape.org/download.html) archive.
+
+2. Extract it somewhere.
+
+3. That extracts to a `duktape-[VERSION]` directory.
+
+4. We need to tell duktape about our `duk_custom.h` header:
+
+ 1. Change into the `duktape-[VERSION]` directory.
+
+ 2. Run the following command:
+
+ python2 tools/configure.py \
+ --output-directory /tmp/output \
+ --source-directory src-input \
+ --config-metadata config \
+ --fixup-line '#include "duk_custom.h"'
+
+ 3. This generates a suitable set of duktape
+ sources in `/tmp/output`
+
+5. Replace the `duktape.c`, `duktape.h` and
+ `duk_config.h` files in the netsurf source
+ tree (in `content/handlers/javascript/duktape`)
+ with those generated in `/tmp/output`.
+
diff --git a/docs/using-framebuffer.md b/docs/using-framebuffer.md
new file mode 100644
index 0000000..3af8f98
--- a/dev/null
+++ b/docs/using-framebuffer.md
@@ -0,0 +1,207 @@
+--------------------------------------------------------------------------------
+ Usage Instructions for Framebuffer NetSurf 2nd October 2010
+--------------------------------------------------------------------------------
+
+ This document provides usage instructions for the Framebuffer version of
+ NetSurf.
+
+ Framebuffer NetSurf has been tested on Ubuntu and Debian.
+
+Overview
+========
+
+ What it is
+ ----------
+
+ The NetSurf framebuffer front end is primarily intended for kiosk
+ and embedded applications where there is insufficient Operating
+ System support for a full graphical windowing environment.
+
+ The framebuffer frontend features:
+
+ * A trivial occluded rectangle window management toolkit
+
+ * Font handling system using either:
+ - A trivial internal monochrome bitmap glyph set.
+ - An interface to fully anti-aliased glyphs using libfreetype 2
+
+ * Uses libnsfb to provide transparent support for:
+ - Numerous surface providers allowing usage on Linux, X, SDL, VNC
+ and any mapped linear memory region.
+ - Surface depths of 8, 16, 24 and 32bpp
+ - Optimised software plotters for lines, rectangles, polygons,
+ arbitrary ellipses (including circles), cubic and quadratic
+ splines, font glyphs and 32bpp RGBA bitmaps.
+ - Abstracted input handling.
+
+ What it is not
+ --------------
+
+ The framebuffer frontend is not a replacement for full native
+ ports. It lacks functionality and flexibility compared to such
+ implementations.
+
+ Limitations include:
+ - Single window interface.
+ - No tabbed interface.
+ - Expects to control the entire plotting surface.
+ - No ability to re-size a surface after initialisation.
+ - Inflexible input character mapping.
+ - Limited history view.
+
+ In addition it should be noted support for some libnsfb surfaces has
+ been implemented purely for debugging functionality (SDL
+ especially) and is not intended to replace native surface
+ handlers.
+
+ If a high level windowing system is available then a native NetSurf
+ frontend is almost certainly a better choice than attempting to use
+ the framebuffer frontend.
+
+ If there is a graphical environment which supports GTK then using
+ the GTK frontend is a vastly superior choice. The framebuffer
+ frontend will appear exceptionally limited on such capable systems.
+
+
+Configuring
+===========
+
+ Several resources are set at *compile* time and are not changeable at
+ run time such as the icon bitmaps, the font system to use and what
+ default surface to use. Refer to the BUILDING-Framebuffer document
+ for details.
+
+ As with any NetSurf frontend run-time configuration is read from a
+ "Choices" file. This file is a simple key:value list and is located
+ in "${HOME}/.netsurf/Choices".
+
+ The standard values supported by the NetSurf core are documented in
+ the Options document. In addition to these there are a number of
+ values to control specific aspects of the framebuffer version.
+
+ Toolkit Options
+ ---------------
+
+ The trivial toolkit has some configuration parameters allowing the
+ user to alter specific aspects of the UI. All the sizes are in
+ surface pixels however that is mapped.
+
+ fb_furniture_size
+ This is the size allowed for the scroll bar elements.
+
+ fb_toolbar_size
+ The height of the toolbar.
+
+ fb_toolbar_layout
+ The layout of the toolbar, layout uses a string to define buttons
+ type and position each character adds an element to the toolbar:
+
+ b - Move back in history
+ l - Display the local history
+ f - Move forward in history
+ s - stop fetching content
+ r - refresh content
+ u - url bar expands to fit remaining space
+ t - throbber/activity indicator
+ c - close the current window
+ q - Disable The toolbar altogether
+
+ If the option contains only the q specifier the toolbar is
+ disabled altogether (this was previously the empty string but that
+ was difficult to configure correctly).
+
+ The default layout is "blfsrutc" there should be no more than a
+ single url bar entry.
+
+ fb_osk
+ Whether the on screen keyboard should be enabled for input.
+
+
+ Framebuffer Surface
+ -------------------
+
+ There are four command line switches which override compiled in
+ defaults these are:
+
+ -f <handler>
+ Selects a surface handler to pass to libnsfb instead of the
+ default. (e.g. x, sdl, mem, linux)
+
+ -b <depth>
+ Selects the pixel depth to pass to libnsfb instead of the
+ compiled in default. (one of 8, 16, 24, 32)
+
+ -w <width>
+ Selects the surface width to pass to libnsfb instead of the
+ compiled in default.
+
+ -h <height>
+ Selects the surface height to pass to libnsfb instead of the
+ compiled in default.
+
+ The libnsfb surface parameters are controlled with:
+
+ fb_refresh - The refresh rate (for physical displays)
+ fb_depth - The depth (in bits per pixel) of the surface
+ fb_device - The path to the device (for physical displays)
+ fb_input_devpath - The path to the input devices (for linux input layer)
+ fb_input_glob - The input device selection glob (for linux input layer)
+ window_width - The width of the framebuffer
+ window_height - The height of the framebuffer
+
+ The defaults are for 800 by 600 pixels at 16bpp and 70Hz refresh rate.
+
+ The documentation of libnsfb should be consulted for further
+ information about supported surfaces and their configuration.
+
+ Fonts
+ -----
+
+ If the compile time option is set to use the freetype font system
+ then several configuration options are available. If the simple
+ bitmap glyphs are used none of these options apply.
+
+ Font faces are provided for the css default styles of sans serif,
+ serif, monospace, cursive and fantasy. Only the sans serif
+ non-italic normal weight font is required to exist, If any of the
+ other faces are missing the sans serif font will be used instead.
+
+ The compiled in default font file paths are specified within the
+ build time Makefile.config. The default faces is the truetype DejaVu
+ font set in the directory /usr/share/fonts/truetype/ttf-dejavu/
+
+ The font glyphs are, by default, rendered as 256 level transparency
+ which gives excellent visual results even on small font sizes.
+
+ The font selection may be changed by placing truetype font files
+ in the resources path. The resource files will be the generic names
+ sans_serif.ttf, sans_serif_bold.ttf etc.
+
+ The font system is configured at run-time by several options:
+
+ fb_font_monochrome
+ This option causes the renderer to use monochrome glyph
+ rendering. This method of rendering is much less visually
+ appealing and while faster to plot it is slower to render.
+
+ fb_font_cachesize
+ This option sets the number of kilobytes of memory set aside for
+ caching the rendered glyphs. This caching significantly improves
+ the performance of using the freetype rendering system. It is set
+ to 2048 by default (2 Megabytes of memory) which impiracle testing
+ shows to be a suitable value for the seven default faces.
+
+ The remaining options control the files to be used for font faces. The
+ font file name options will override both the compiled in paths and
+ files found in the resource path.
+
+ fb_face_sans_serif - The sans serif face
+ fb_face_sans_serif_bold - The bold sans serif face
+ fb_face_sans_serif_italic - The italic sans serif face
+ fb_face_sans_serif_italic_bold - The bold italic sans serif face.
+ fb_face_serif - The serif font
+ fb_face_serif_bold - The bold serif font
+ fb_face_monospace - The monospaced font
+ fb_face_monospace_bold - The bold monospaced font
+ fb_face_cursive - The cursive font
+ fb_face_fantasy - The fantasy font
diff --git a/docs/using-monkey.md b/docs/using-monkey.md
new file mode 100644
index 0000000..33e5042
--- a/dev/null
+++ b/docs/using-monkey.md
@@ -0,0 +1,318 @@
+--------------------------------------------------------------------------------
+ Usage Instructions for Monkey NetSurf 13 March 2011
+--------------------------------------------------------------------------------
+
+ This document provides usage instructions for the Monkey version of
+ NetSurf.
+
+ Monkey NetSurf has been tested on Ubuntu.
+
+Overview
+========
+
+ What it is
+ ----------
+
+ The NetSurf Monkey front end is a developer debug tool used to
+ test how the core interacts with the user interface. It allows
+ the developers to profile NetSurf and to interact with the core
+ directly as though the developer were a front end.
+
+ What it is not
+ --------------
+
+ Monkey is not a tool for building web-crawling robots or indeed
+ anything other than a debug tool for the NetSurf developers.
+
+ How to interact with nsmonkey
+ -----------------------------
+
+ In brief, monkey will produce tagged output on stdout and expect
+ commands on stdin. Windows are numbered and for the most part
+ tokens are space separated. In some cases (e.g. title or status)
+ the final element on the output line is a string which might have
+ spaces embedded within it. As such, output from nsmonkey should be
+ parsed a token at a time, so that when such a string is encountered,
+ the parser can stop splitting and return the rest.
+
+ Commands to Monkey are namespaced. For example commands related to
+ browser windows are prefixed by WINDOW.
+
+ Top level tags for nsmonkey
+ ---------------------------
+
+ QUIT
+
+ WINDOW
+
+ Top level response tags for nsmonkey
+ ------------------------------------
+
+ GENERIC
+
+ WARN, ERROR, DIE
+
+ WINDOW
+
+ DOWNLOAD_WINDOW
+
+ SSLCERT
+
+ 401LOGIN
+
+ PLOT
+
+ In the below, %something% indicates a substitution made by Monkey.
+
+ %url% will be a URL
+ %id% will be an opaque ID
+ %n% will be a number
+ %bool% will be TRUE or FALSE
+ %str% is a string and will only ever be at the end of an output line.
+
+ Warnings, errors etc
+ --------------------
+
+ Warnings (tagged WARN) come from the NetSurf core.
+ Errors (tagged ERROR) tend to come from Monkey's parsers
+ Death (tagged DIE) comes from the core and kills Monkey dead.
+
+Commands
+========
+
+ Generic commands
+ ----------------
+
+ QUIT
+ Cause monkey to quit cleanly.
+ This will cleanly destroy open windows etc.
+
+ Window commands
+ ---------------
+
+ WINDOW NEW [%url%]
+ Create a new browser window, optionally giving the core
+ a URL to immediately navigate to.
+ Minimally you will receive a WINDOW NEW WIN %id% response.
+
+ WINDOW DESTROY %id%
+ Destroy the given browser window.
+ Minimally you will recieve a WINDOW DESTROY WIN %id% response.
+
+ WINDOW GO %id% %url% [%url%]
+ Cause the given browser window to visit the given URL.
+ Optionally you can give a referrer URL to also use (simulating
+ a click in the browser on a link).
+ Minimally you can expect throbber, url etc responses.
+
+ WINDOW REDRAW %id% [%num% %num% %num% %num%]
+ Cause a browser window to redraw. Optionally you can give a
+ set of coordinates to simulate a partial expose of the window.
+ Said coordinates are in traditional X0 Y0 X1 Y1 order.
+ The coordinates are in canvas, not window, coordinates. So you
+ should take into account the scroll offsets when issuing this
+ command.
+ Minimally you can expect redraw start/stop messages and you
+ can likely expect some number of PLOT results.
+
+ WINDOW RELOAD %id%
+ Cause a browser window to reload its current content.
+ Expect responses similar to a GO command.
+
+
+Responses
+=========
+
+ Generic messages
+ ----------------
+
+ GENERIC STARTED
+ Monkey has started and is ready for commands
+
+ GENERIC CLOSING_DOWN
+ Monkey has been told to shut down and is doing so
+
+ GENERIC FINISHED
+ Monkey has finished and will now exit
+
+ GENERIC LAUNCH URL %url%
+ The core asked monkey to launch the given URL
+
+ GENERIC THUMBNAIL URL %url%
+ The core asked monkey to thumbnail a content without
+ a window.
+
+ GENERIC POLL BLOCKING
+ Monkey reached a point where it could sleep waiting for
+ commands or scheduled timeouts. No fetches nor redraws
+ were pending.
+
+ Window messages
+ ---------------
+
+ WINDOW NEW WIN %id% FOR %id% CLONE %id% NEWTAB %bool%
+ The core asked Monkey to open a new window. The IDs for 'FOR' and
+ 'CLONE' are core window IDs, the WIN id is a Monkey window ID.
+
+ WINDOW SIZE WIN %id% WIDTH %n% HEIGHT %n%
+ The window specified has been set to the shown width and height.
+
+ WINDOW DESTROY WIN %id%
+ The core has instructed Monkey to destroy the named window.
+
+ WINDOW TITLE WIN %id% STR %str%
+ The core supplied a titlebar title for the given window.
+
+ WINDOW REDRAW WIN %id%
+ The core asked that Monkey redraw the given window.
+
+ WINDOW GET_DIMENSIONS WIN %id% WIDTH %n% HEIGHT %n%
+ The core asked Monkey what the dimensions of the window are.
+ Monkey has to respond immediately and returned the supplied width
+ and height values to the core.
+
+ WINDOW NEW_CONTENT WIN %id%
+ The core has informed Monkey that the named window has a new
+ content object.
+
+ WINDOW NEW_ICON WIN %id%
+ The core has informed Monkey that the named window hsa a new
+ icon (favicon) available.
+
+ WINDOW START_THROBBER WIN %id%
+ The core asked Monkey to start the throbber for the named
+ window. This indicates to the user that the window is busy.
+
+ WINDOW STOP_THROBBER WIN %id%
+ The core asked Monkey to stop the throbber for the named
+ window. This indicates to the user that the window is finished.
+
+ WINDOW SET_SCROLL WIN %id% X %n% Y %n%
+ The core asked Monkey to set the named window's scroll offsets
+ to the given X and Y position.
+
+ WINDOW UPDATE_BOX WIN %id% X %n% Y %n% WIDTH %n% HEIGHT %n%
+ The core asked Monkey to redraw the given portion of the content
+ display. Note these coordinates refer to the content, not the
+ viewport which Monkey is simulating.
+
+ WINDOW UPDATE_EXTENT WIN %id% WIDTH %n% HEIGHT %n%
+ The core has told us that the content in the given window has a
+ total width and height as shown. This allows us (along with the
+ window's width and height) to know the scroll limits.
+
+ WINDOW SET_STATUS WIN %id% STR %str%
+ The core has told us that the given window needs its status bar
+ updating with the given message.
+
+ WINDOW SET_POINTER WIN %id% POINTER %id%
+ The core has told us to update the mouse pointer for the given
+ window to the given pointer ID.
+
+ WINDOW SET_SCALE WIN %id% SCALE %n%
+ The core has asked us to scale the given window by the given scale
+ factor.
+
+ WINDOW SET_URL WIN %id% URL %url%
+ The core has informed us that the given window's URL bar needs
+ updating to the given url.
+
+ WINDOW GET_SCROLL WIN %id% X %n% Y %n%
+ The core asked Monkey for the scroll offsets. Monkey returned the
+ numbers shown for the window named.
+
+ WINDOW SCROLL_START WIN %id%
+ The core asked Monkey to scroll the named window to the top/left.
+
+ WINDOW POSITION_FRAME WIN %id% X0 %n% Y0 %n% X1 %n% Y1 %n%
+ The core asked Monkey to position the named window as a frame at
+ the given coordinates of its parent.
+
+ WINDOW SCROLL_VISIBLE WIN %id% X0 %n% Y0 %n% X1 %n% Y1 %n%
+ The core asked Monkey to scroll the named window until the
+ indicated box is visible.
+
+ WINDOW PLACE_CARET WIN %id% X %n% Y %n% HEIGHT %n%
+ The core asked Monkey to render a caret in the named window at the
+ indicated position with the indicated height.
+
+ WINDOW REMOVE_CARET WIN %id%
+ The core asked Monkey to remove any caret in the named window.
+
+ WINDOW SCROLL_START WIN %id% X0 %n% Y0 %n% X1 %n% Y1 %n%
+ The core asked Monkey to scroll the named window to the start of
+ the given box.
+
+ WINDOW SELECT_MENU WIN %id%
+ The core asked Monkey to produce a selection menu for the named
+ window.
+
+ WINDOW SAVE_LINK WIN %id% URL %url% TITLE %str%
+ The core asked Monkey to save a link from the given window with
+ the given URL and anchor title.
+
+ WINDOW THUMBNAIL WIN %id% URL %url%
+ The core asked Monkey to render a thumbnail for the given window
+ which is currently at the given URL.
+
+ WINDOW REDRAW WIN %id% START
+ WINDOW REDRAW WIN %id% STOP
+ The core wraps redraws in these messages. Thus PLOT responses can
+ be allocated to the appropriate window.
+
+ Download window messages
+ ------------------------
+
+ DOWNLOAD_WINDOW CREATE DWIN %id% WIN %id%
+ The core asked Monkey to create a download window owned by the
+ given browser window.
+
+ DOWNLOAD_WINDOW DATA DWIN %id% SIZE %n% DATA %str%
+ The core asked Monkey to update the named download window with
+ the given byte size and data string.
+
+ DOWNLOAD_WINDOW ERROR DWIN %id% ERROR %str%
+ The core asked Monkey to update the named download window with
+ the given error message.
+
+ DOWNLOAD_WINDOW DONE DWIN %id%
+ The core asked Monkey to destroy the named download window.
+
+ SSL Certificate messages
+ ------------------------
+
+ SSLCERT VERIFY CERT %id% URL %url%
+ The core asked Monkey to say whether or not a given SSL
+ certificate is OK.
+
+ 401 Login messages
+ ------------------
+
+ 401LOGIN OPEN M4 %id% URL %url% REALM %str%
+ The core asked Monkey to ask for identification for the named
+ realm at the given URL.
+
+ Plotter messages
+ ----------------
+
+ Note, Monkey won't clip coordinates, but sometimes the core does.
+
+ PLOT CLIP X0 %n% Y0 %n% X1 %n% Y1 %n%
+ The core asked Monkey to clip plotting to the given clipping
+ rectangle (X0,Y0) (X1,Y1)
+
+ PLOT TEXT X %n% Y %n% STR %str%
+ The core asked Monkey to plot the given string at the
+ given coordinates.
+
+ PLOT LINE X0 %n% Y0 %n% X1 %n% Y1 %n%
+ The core asked Monkey to plot a line with the given start
+ and end coordinates.
+
+ PLOT RECT X0 %n% Y0 %n% X1 %n% Y1 %n%
+ The core asked Monkey to plot a rectangle with the given
+ coordinates as the corners.
+
+ PLOT BITMAP X %n% Y %n% WIDTH %n% HEIGHT %n%
+ The core asked Monkey to plot a bitmap at the given
+ coordinates, scaled to the given width/height.