adam/flenser
SHA256
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename user-facing bits of Dillo to Flenser.

Browse Source 
I dunno if I got them all.

This is also now version 0.0.0
This commit is contained in:
ADAM David Alan Martin
2025-04-12 00:42:01 -04:00
parent 564567d389
commit e595830fab
32 changed files with 161 additions and 155 deletions
Download Patch File Download Diff File Expand all files Collapse all files

140
doc/user_help.in.html
View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Dillo User Manual</title>
<title>Flenser User Manual</title>
<style>
body {
background: white;
@ -74,13 +74,13 @@ footer {
<body>
<div class="main">
<h1>Dillo User Manual</h1>
<h1>Flenser User Manual</h1>
<p>Welcome to the user manual of the Dillo browser. The manual is divided into
<p>Welcome to the user manual of the Flenser browser. The manual is divided into
<em>sections</em> but is written in a <em>single page</em> to allow search by
keywords. Generated for version __VERSION__.</p>
<details><!-- Not supported in Dillo, but decays ok -->
<details><!-- Not supported in Flenser, but decays ok -->
<summary class="toc">Table of contents:</summary>
<ul class="toc">
<li><a href="#introduction">Introduction</a></li>
@ -114,7 +114,7 @@ keywords. Generated for version __VERSION__.</p>
</ul>
<li><a href="#configuration">Configuration</a>
<ul>
<li><a href="#dillorc">Dillorc</a></li>
<li><a href="#flenserrc">Flenserrc</a></li>
<li><a href="#cookiesrc">Cookiesrc</a></li>
<li><a href="#domainrc">Domainrc</a></li>
<li><a href="#style-css">Style.css</a></li>
@ -134,13 +134,13 @@ keywords. Generated for version __VERSION__.</p>
</details>
<h2 id="introduction">Introduction</h2>
<p>Dillo is a web browser designed to be fast, use few resources and support
<p>Flenser is a web browser designed to be fast, use few resources and support
slow and unreliable networks on resource-constrained machines. It can load local
and remote files via HTTP, HTTPS and FTP. Other protocols like Gemini, Gopher,
IPFS and others are available as
<a href="#plugins">plugins</a>.</p>
<p>Dillo supports a subset of HTML 4.01 and CSS 2.1 but it <b>doesn't support
<p>Flenser supports a subset of HTML 4.01 and CSS 2.1 but it <b>doesn't support
JavaScript</b> and only implements some elements of HTML 5 and CSS 3. It also
renders plain text documents and images in PNG, JPG, GIF, SVG and WebP
formats.</p>
@ -155,18 +155,18 @@ device. At the top of the browser window you have the location bar and the main
buttons to control the browser. You can leave the mouse for a brief moment over
any part of the menu to show a tooltip with more information.
<p>
Dillo has <em>context sensitive menus</em>, which are opened with the right mouse
Flenser has <em>context sensitive menus</em>, which are opened with the right mouse
button, available on pages, links, images, forms, the Back and Forward buttons,
and the bug meter. They show different actions to be performed specific to the
element. For example, to save a page you can right-click on the page and select
"Save page as...". Or to copy a link URL you can right-click on a link and
select "Copy link location".
<p>
Dillo can hide all panels and use the whole window area to display the page. To
Flenser can hide all panels and use the whole window area to display the page. To
switch between modes use the ESC key. You can also choose the control panel size
by going to the Tools button and selecting a different one under "Panel size".
<p>
You can open this manual from Dillo by clicking on the top right "?" button. It
You can open this manual from Flenser by clicking on the top right "?" button. It
doesn't require a network connection.
<h3 id="scrolling">Scrolling</h3>
@ -211,7 +211,7 @@ doesn't require a network connection.
</ul>
<p>You can control the <b>size of a <em>step</em></b> by setting the
<code>scroll_step</code> option in the <a href="#dillorc">dillorc</a>
<code>scroll_step</code> option in the <a href="#flenserrc">flenserrc</a>
configuration file. By default it will scroll 100 pixels per step. The vertical
scrollbar can be positioned on the left side setting the
<code>scrollbar_on_left</code> option to <code>YES</code>, by default it is on
@ -232,7 +232,7 @@ To find text in a document right-click to open the <em>Page menu</em> and select
<em>Find text</em> or press <code>Ctrl+F</code> on the keyboard. Then type the
substring that you want to find and click Next (or the <code>Enter</code> key).
</p>
Dillo will scroll the page and highlight found text starting from the top. To
Flenser will scroll the page and highlight found text starting from the top. To
find a word (not a substring) use spaces around it to limit the search to
matching words only.
<p>
@ -248,7 +248,7 @@ button.
If you want to select more than one screen, hold the mouse left button down and
scroll with PgUp, PgDn or the arrow keys.
<P>
If you want to paste an URL into Dillo, do it on the "clear-URL"
If you want to paste an URL into Flenser, do it on the "clear-URL"
button (the "X" next to the <a href="#location-bar">location bar</a>).
<p>
@ -259,7 +259,7 @@ zoom factor. Use <code>Ctrl +</code> to increase the size, <code>Ctrl -</code>
to decrease it and <code>Ctrl 0</code> to reset the value to 100%.
<p>
The initial zoom factor is specified by the <code>zoom_factor</code> option in
the <a href="#dillorc">dillorc</a> configuration file. When a new tab or window
the <a href="#flenserrc">flenserrc</a> configuration file. When a new tab or window
is opened, the current zoom factor value is inherited.
<h2 id="navigation">Navigation</h2>
@ -327,7 +327,7 @@ You can also select the location bar content from the keyboard by pressing
<p>
Several search engines are available by pressing the magnifying glass icon next
to the location bar or by pressing <code>Ctrl+S</code>. The search engines are
configured in <a href="#dillorc">Dillorc</a> with the option
configured in <a href="#flenserrc">Flenserrc</a> with the option
<code>search_url</code>. Use it multiple times to define multiple search
engines.
<p>
@ -338,19 +338,19 @@ search_url="dd DuckDuckGo http://duckduckgo.com/lite/?kp=-1&amp;kd=-1&amp;q=%s"
</pre>
<p>
Defines the "DuckDuckGo" search engine with the prefix "<code>dd</code>", so you
can type in the location bar "<code>dd dillo browser</code>" to search with
DuckDuckGo for the keywords "dillo browser".
can type in the location bar "<code>dd flenser browser</code>" to search with
DuckDuckGo for the keywords "flenser browser".
<h3 id="tabs">Tabs</h3>
<p>
Dillo can open different web pages into tabs. To open a link in a new tab click
Flenser can open different web pages into tabs. To open a link in a new tab click
the middle button instead of the left button. The same applies to buttons to
submit a form. A new tab can also be opened from the <code>File</code> menu or
using the shortcut <code>Ctrl+T</code>.
<p>
Press <code>Shift</code> while middle-clicking a link to automatically focus the
new tab. If you want this behaviour to be the default, set the following option
in the <a href="#dillorc">dillorc</a> configuration file:
in the <a href="#flenserrc">flenserrc</a> configuration file:
<pre>
focus_new_tab=YES
</pre>
@ -372,21 +372,21 @@ right_click_closes_tab=NO
<p>
Use the <code>new_tab_page</code> option to control which page is loaded in a
newly opened tab, by default is an empty page. To open the
bookmarks page set the following line in <a href="#dillorc">dillorc</a>:
bookmarks page set the following line in <a href="#flenserrc">flenserrc</a>:
<pre>
new_tab_page="dpi:/bm/"
</pre>
<h3 id="bookmarks">Bookmarks</h3>
<p>
Dillo can save URLs of web pages as bookmarks so you can open them later. To
Flenser can save URLs of web pages as bookmarks so you can open them later. To
bookmark the current page, open the <em>Page menu</em> by right-clicking on the
page and select "Bookmark this page" (it also works over a link).
<p>
To see or edit the bookmarks, click on the Bookmarks button on the panel or
press <code>Ctrl+B</code>.
<p>
Bookmarks are handled by a built-in Dillo plugin named <code>bm</code> (read more
Bookmarks are handled by a built-in Flenser plugin named <code>bm</code> (read more
about plugins in the <a href="#plugins">Plugins section</a>) and are
synchronized across all instances of the browser. The list of bookmarks can also
be shown by opening the URL <a href="dpi:/bm/"><code>dpi:/bm/</code></a>.
@ -397,24 +397,24 @@ can edit the file directly to change the bookmarks.
<h2 id="privacy-and-network">Privacy and network</h2>
<p>The default privacy policy in Dillo attempts to keep the user safe from
<p>The default privacy policy in Flenser attempts to keep the user safe from
tracking, <em>even if this policy breaks a lot of website functionality</em>. In
this section you can add exceptions or relax the configuration at your own risk.
<h3 id="https">HTTPS</h3>
<p>Dillo has support for
<p>Flenser has support for
<a href="https://en.wikipedia.org/wiki/HTTPS">HTTPS</a>,
allowing secure connections to remote websites. Use the protocol
"<code>https:</code>" to specify the use of HTTPS. When a problem is encountered
with the remote certificate, a warning dialog explains the details and allows
you to choose what to do: continue loading the website or cancel.
<p>
By default Dillo looks for a TLS library at build time, which can be OpenSSL or
By default Flenser looks for a TLS library at build time, which can be OpenSSL or
mbedTLS. You can see which library is being used by looking at the console when
it starts:
<pre>
$ dillo
$ flenser
dillo_dns_init: Here we go! (threaded)
TLS library: <u>OpenSSL 3.2.1 30 Jan 2024</u>
...
@ -426,7 +426,7 @@ Due to privacy concerns, <b>cookies are disabled by default</b> unless
explicitly enabled in the configuration.
<p>
Support for cookies is implemented using a built-in plugin that shares them
between several instances of Dillo and follows the
between several instances of Flenser and follows the
<a href="http://tools.ietf.org/html/rfc6265">RFC 6265</a>
specification. Current cookie limits are 20 per domain and
1200 in total.
@ -436,17 +436,17 @@ the <a href="#cookiesrc">Cookiesrc section</a> to see how to enable cookies for
some domains or accept them by default.</p>
<h3 id="proxy">Proxy</h3>
<p>Dillo can use a HTTP proxy by setting the environment variable
<p>Flenser can use a HTTP proxy by setting the environment variable
<code>http_proxy</code> or the
<a href="#dillorc">configuration option</a> with the same name. All HTTP and
<a href="#flenserrc">configuration option</a> with the same name. All HTTP and
HTTPS traffic will be sent through the proxy.
<p><b>Note</b>: Plugins may not implement proxy support.
</p>
<h3 id="ad-blocking">Ad blocking</h3>
<p>Dillo has the ability to block content when loading a page based on the domain
the embedded content is being loaded from. You can control how Dillo handles
<p>Flenser has the ability to block content when loading a page based on the domain
the embedded content is being loaded from. You can control how Flenser handles
automatic requests for resources (like images and style sheets) that aren't at
the same domain as the original page.</p>
@ -468,30 +468,30 @@ You can browse without images now:
An image's alt text (or <code>[IMG]</code> placeholder) will appear in the
page.
<li>If you want to load an individual image, left click on its text.
<li>You can set "no images" as the default mode in dillorc.
<li>You can set "no images" as the default mode in flenserrc.
</ul>
<h2 id="configuration">Configuration</h2>
<p>Dillo has <b>several configuration files</b> that control the behavior of the
<p>Flenser has <b>several configuration files</b> that control the behavior of the
browser. Each configuration file is searched <em>first</em> in the
<a href="file:~/.dillo"><code>~/.dillo</code></a> directory and,
<a href="file:~/.flenser"><code>~/.flenser</code></a> directory and,
<em>if not found</em>, in the default system configuration directory (typically
<code>/etc/dillo</code>).</p>
<code>/etc/flenser</code>).</p>
<p>Most configuration files can include comments by <em>starting</em> a line
with the "<code>#</code>" symbol. Their specific syntax is described in the
following sections.</p>
<h3 id="dillorc">Dillorc</h3>
<h3 id="flenserrc">Flenserrc</h3>
<p>The main configuration of Dillo is controlled by the
<a href="file:~/.dillo/dillorc"><code>dillorc</code></a> file.
<p>The main configuration of Flenser is controlled by the
<a href="file:~/.flenser/flenserrc"><code>flenserrc</code></a> file.
The list of all available options can be found in the system
configuration file, typically
<a href="file:/etc/dillo/dillorc"><code>/etc/dillo/dillorc</code></a>. You may
<a href="file:/etc/flenser/flenserrc"><code>/etc/flenser/flenserrc</code></a>. You may
want to copy it into
<a href="file:~/.dillo/dillorc"><code>~/.dillo/dillorc</code></a>
<a href="file:~/.flenser/flenserrc"><code>~/.flenser/flenserrc</code></a>
and edit it to suit your needs.</p>
The file is commented to describe what each option does. The default value for
@ -511,7 +511,7 @@ search_url="Wikipedia http://www.wikipedia.org/w/index.php?search=%s&amp;go=Go"
<h3 id="cookiesrc">Cookiesrc</h3>
<p>Cookies are configured in the
<a href="file:~/.dillo/cookiesrc"><code>~/.dillo/cookiesrc</code></a>
<a href="file:~/.flenser/cookiesrc"><code>~/.flenser/cookiesrc</code></a>
file by using rules, with one rule per line. The rule syntax is very simple,
first specify the <em>host</em> and then the <em>action</em>, separated by
white spaces. Comment lines start with <code>#</code> as the first character and
@ -529,7 +529,7 @@ allow sites to track you over time).
<p>
When the cookies plugin exits, only the accepted cookies by <code>ACCEPT</code>
are saved to
<a href="file:~/.dillo/cookies.txt"><code>~/.dillo/cookies.txt</code></a>,
<a href="file:~/.flenser/cookies.txt"><code>~/.flenser/cookies.txt</code></a>,
and ACCEPT_SESSION cookies are
forgotten. The cookies plugin normally exits after a period of inactivity, but
you can force it to exit with the command <code>dpidc stop</code>.
@ -552,21 +552,21 @@ fltk.org ACCEPT
save them when the cookie plugin exits.</li>
</ul>
<p>
Dillo is especially concerned about privacy and security issues. Our advice is
Flenser is especially concerned about privacy and security issues. Our advice is
to <em>avoid cookies whenever possible</em> and at most set ACCEPT_SESSION to
<em>specific trusted sites</em>.
<h3 id="domainrc">Domainrc</h3>
<p>With the
<code>~/.dillo/domainrc</code>
file, you can control how Dillo handles automatic requests for resources
<code>~/.flenser/domainrc</code>
file, you can control how Flenser handles automatic requests for resources
(like images and style sheets) that aren't at the same domain as the
original page.
<p>
The file contains one rule per line. Comments are specified by starting the line
with the <code>#</code> symbol. The default rule is either
<code>default accept</code> or <code>default deny</code> and will cause Dillo
<code>default accept</code> or <code>default deny</code> and will cause Flenser
to, respectively, accept all requests by default or deny all requests by
default.
<p>
@ -598,22 +598,22 @@ default accept
<p>Custom
<a href="https://en.wikipedia.org/wiki/CSS">CSS styles</a> can be placed in the
<a href="file:~/.dillo/style.css"><code>~/.dillo/style.css</code></a>
<a href="file:~/.flenser/style.css"><code>~/.flenser/style.css</code></a>
file to set default web page styles. To override page styles add the
"<code>!important</code>" flag.
<h3 id="dpidrc">Dpidrc</h3>
<p>The configuration for <a href="#plugins">plugins</a> is placed in the
<a href="file:~/.dillo/dpidrc"><code>~/.dillo/dpidrc</code></a> file.</p>
<a href="file:~/.flenser/dpidrc"><code>~/.flenser/dpidrc</code></a> file.</p>
<p>Plugins are searched in the <code>~/.dillo/dpi/</code> directory first, and
<p>Plugins are searched in the <code>~/.flenser/dpi/</code> directory first, and
then in the system directory if not found. The <code>dpi_dir</code> option
sets the system <code>dpi</code> directory and must be specified once. Here is
an example:</p>
<pre>
dpi_dir=/usr/lib/dillo/dpi
dpi_dir=/usr/lib/flenser/dpi
</pre>
<p>By default, plugins will receive requests at the URL
@ -645,7 +645,7 @@ image inline in a HTML document.
<p>Web page URLs can be saved as bookmarks so they can be accessed in the future.
Bookmarks are stored in a plain text file located at
<a href="file:~/.dillo/bm.txt"><code>~/.dillo/bm.txt</code></a>. The file can be
<a href="file:~/.flenser/bm.txt"><code>~/.flenser/bm.txt</code></a>. The file can be
modified by using the
<a href="dpi:/bm/">Book button</a>
in the toolbar and the context menu on a page or link, but they can also be
@ -674,11 +674,11 @@ tool.
<h3 id="keysrc">Keysrc</h3>
<p>The mapping of keys in Dillo is controlled by the
<a href="file:~/.dillo/keysrc"><code>~/.dillo/keysrc</code></a> file.
<p>The mapping of keys in Flenser is controlled by the
<a href="file:~/.flenser/keysrc"><code>~/.flenser/keysrc</code></a> file.
The format is "<code>key = action</code>" or
"<code>&lt;modifier&gt;key = action</code>". Lines that begin with a "#" are comments.
The commented-out bindings below show the defaults built into Dillo.
The commented-out bindings below show the defaults built into Flenser.
<ul>
<li>Modifiers recognized: Shift, Ctrl, Alt, Meta (on Mac OS X use "Meta" for
@ -693,7 +693,7 @@ MediaPlay, MediaPrev, MediaStop, Refresh, Search, Sleep, Stop, VolumeDown,
VolumeMute, VolumeUp.
</ul>
<p>If Dillo is running under X11, keys whose names are not recognized can be
<p>If Flenser is running under X11, keys whose names are not recognized can be
specified using their keysym value in hexadecimal. Use <code>xev</code> to get
the keysym, for example:
<pre>
@ -720,10 +720,10 @@ l = right
<h2 id="advanced-usage">Advanced usage</h2>
These sections focus on advanced topics and are recommended for experienced
users of Dillo.
users of Flenser.
<h3 id="plugins">Plugins</h3>
<p>The functionality of Dillo can be extended by using plugins, which can
<p>The functionality of Flenser can be extended by using plugins, which can
translate other formats to HTML, implement new protocols or provide a custom
service.</p>
@ -731,12 +731,12 @@ service.</p>
interact with the browser using the
<a href="https://dillo-browser.github.io/old/dpi1.html">DPI protocol</a>. A
<a href="https://dillo-browser.github.io/#plugins">list of plugins</a>
is available on the Dillo website. Some plugins are just a
is available on the Flenser website. Some plugins are just a
<a href="https://raw.githubusercontent.com/dillo-browser/dillo-plugin-man/master/man.filter.dpi">few
lines of shell script</a>, so you are encouraged to read them to learn how to
write your own plugins. Plugins are searched by looking for files that end with
the <code>.dpi</code> extension (or <code>.dpi.exe</code> in Windows) in
<code>~/.dillo/dpi</code> and <code>dpi_dir</code> (see the
<code>~/.flenser/dpi</code> and <code>dpi_dir</code> (see the
<a href="#dpidrc">Dpidrc</a> configuration section).</p>
<p>There are two types of plugins: <em>filters</em> and <em>servers</em>.
@ -751,10 +751,10 @@ share information among requests.</p>
<p>You can install plugins from any third party, but you should always
review the source before running code written by others. To install a new
plugin, copy the files to <code>~/.dillo/dpi/<em>name</em>/</code> and
plugin, copy the files to <code>~/.flenser/dpi/<em>name</em>/</code> and
then associate the <em>name</em> protocol to the program that must run in
the
<a href="file:~/.dillo/dpidrc"><code>~/.dillo/dpidrc</code></a> file.
<a href="file:~/.flenser/dpidrc"><code>~/.flenser/dpidrc</code></a> file.
Plugins may have other software dependencies required for it to work.</p>
<p>Here is an example of how to manually install the
@ -762,20 +762,20 @@ Plugins may have other software dependencies required for it to work.</p>
(it comes with a Makefile that automates the process, so this is not necessary),
which is a filter plugin written in shell script:</p>
<pre>
$ mkdir -p ~/.dillo/dpi/gemini
$ cp gemini.filter.dpi ~/.dillo/dpi/gemini/
$ chmod +x ~/.dillo/dpi/gemini/gemini.filter.dpi
$ echo "proto.gemini=gemini/gemini.filter.dpi" >> ~/.dillo/dpidrc
$ mkdir -p ~/.flenser/dpi/gemini
$ cp gemini.filter.dpi ~/.flenser/dpi/gemini/
$ chmod +x ~/.flenser/dpi/gemini/gemini.filter.dpi
$ echo "proto.gemini=gemini/gemini.filter.dpi" >> ~/.flenser/dpidrc
$ dpidc stop
</pre>
<p>Now, when a request is made to an URL that begins with the
<code>gemini:</code> protocol, it will be processed by the
<code>gemini/gemini.filter.dpi</code> program, and the output will be displayed
by Dillo.</p>
by Flenser.</p>
<h3 id="bug-meter">Bug Meter</h3>
<p>
Dillo includes a
Flenser includes a
<a href='https://dillo-browser.github.io/old/help/bug_meter.html'>bug meter</a>
which shows the number of detected bugs inside the page. The bugs are caught at
parsing time, so the error messages also show the line where they occur and
@ -785,14 +785,14 @@ The primary purpose of the bug meter is to help webmasters and page authors to
polish the contents of their sites with a view to making them
compliant with HTML standards.
<p>
The bug meter is located at the lower right corner of Dillo. Use the left-click
The bug meter is located at the lower right corner of Flenser. Use the left-click
to see the messages, right-click for a menu to open other HTML validators.
<h3 id="keyboard-shortcuts">Keyboard shortcuts</h3>
<p>
Most actions can be issued by using a keyboard shortcut. The key bindings can be
changed in the
<code><a href="file:~/.dillo/keysrc">~/.dillo/keysrc</a></code> file (see the
<code><a href="file:~/.flenser/keysrc">~/.flenser/keysrc</a></code> file (see the
<a href="#keysrc">keysrc</a> section).
The list of default bindings is given in the following table.
<p>
@ -808,7 +808,7 @@ The list of default bindings is given in the following table.
<tr><td>Ctrl-O <td>Open <td>Open file
<tr><td>Ctrl-U <td> <td>View source
<tr><td>Ctrl-B <td>Bookmarks <td>View bookmarks
<tr><td>Ctrl-Q <td>Quit <td>Quit dillo
<tr><td>Ctrl-Q <td>Quit <td>Quit flenser
<tr><td>Ctrl-+ or Ctrl-= <td>Bigger <td>Zoom in
<tr><td>Ctrl-- <td>Smaller <td>Zoom out
<tr><td>Ctrl-0 <td>100% <td>Reset zoom to 100%