]> gitweb.stoutner.com Git - PrivacyBrowserPC.git/blob - doc/index.docbook
c2896e29c34eb34b21e31b870f744ca5338b22ad
[PrivacyBrowserPC.git] / doc / index.docbook
1 <?xml version="1.0" ?>
2
3 <!--
4   Copyright 2023 Soren Stoutner <soren@stoutner.com>.
5
6   This file is part of Privacy Browser PC <https://www.stoutner.com/privacy-browser-pc>.
7
8   Permission is granted to copy, distribute and/or modify this document
9   under the terms of the GNU Free Documentation License, Version 1.3
10   or any later version published by the Free Software Foundation;
11   with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
12
13   You should have received a copy of the GNU Free Documentation License
14   along with Privacy Browser PC.  If not, see <http://www.gnu.org/licenses/>. -->
15
16 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
17   <!-- Privacy Browser’s name -->
18   <!ENTITY privacybrowser "<application>Privacy Browser</application>">
19
20   <!-- People. -->
21   <!ENTITY Soren.Stoutner "<personname><firstname>Soren</firstname><surname>Stoutner</surname></personname>">
22   <!ENTITY Soren.Stoutner.mail "<email>soren@stoutner.com</email>">
23
24   <!-- Set the language of this documentation. -->
25   <!ENTITY % English "INCLUDE">
26
27   <!-- Default entries.  May not be needed. -->
28   <!ENTITY i18n-translatable-entity "<application>Translatable Entity</application>">
29   <!ENTITY % addindex "IGNORE">
30 ]>
31
32 <book id="privacybrowser" lang="&language;">
33   <bookinfo>
34     <title>The &privacybrowser; Handbook</title>
35
36     <authorgroup>
37       <author>&Soren.Stoutner; &Soren.Stoutner.mail;</author>
38
39       <!-- Add translators here.  TRANS:ROLES_OF_TRANSLATORS -->
40     </authorgroup>
41
42     <copyright>
43       <year>2016-2017, 2021-2023</year>
44       <holder>&Soren.Stoutner;</holder>
45     </copyright>
46
47     <!-- Documentation license. -->
48     <legalnotice>&FDLNotice;</legalnotice>
49
50     <!-- Last update. -->
51     <date>2023-02-22</date>
52
53     <!-- The version of Privacy Browser this documentation is written for. -->
54     <releaseinfo>&privacybrowser; version 0.1</releaseinfo>
55
56
57     <!-- Abstract about this handbook -->
58     <abstract>
59       <para>
60         &privacybrowser; is a web browser that respects your privacy.
61       </para>
62
63       <para>
64         The only way to prevent data from being abused is to prevent it from being collected in the first place.
65       </para>
66     </abstract>
67
68     <!-- This is a set of Keywords for indexing by search engines. -->
69     <keywordset>
70       <keyword>KDE</keyword>
71       <keyword>privacy</keyword>
72       <keyword>browser</keyword>
73     </keywordset>
74   </bookinfo>
75
76   <!-- Introduction. -->
77   <chapter id="introduction">
78     <title>Introduction</title>
79
80     <para>
81       &privacybrowser; is currently in an early alpha state.
82       Most of the features are not yet implemented, but I thought it would be useful to publish it so that users can track the progress and submit feedback.
83     </para>
84
85     <para>
86       To distinguish between the Android and the PC version, the website, issue tracker,
87       and code base refer to this version as <ulink url="https://www.stoutner.com/privacy-browser-pc/">Privacy Browser PC</ulink>.
88     </para>
89
90     <para>
91       The best place to discuss the development of Privacy Browser is <ulink url="https://redmine.stoutner.com/projects/privacy-browser-pc/boards">on the forum</ulink>.
92       I also frequently post on my <ulink url="https://fosstodon.org/@privacybrowser">Mastodon account</ulink> regarding the development status.
93     </para>
94
95     <!-- Qt WebEngine. -->
96     <sect1 id="qt-webengine">
97       <title>Qt WebEngine</title>
98
99       <para>
100         Privacy Browser uses <ulink url="https://doc.qt.io/qt-5/qtwebengine-index.html">Qt WebEngine</ulink> to render websites.
101         Qt WebEngine is based on the <ulink url="https://www.chromium.org/blink/">Chromium Blink</ulink> source code.
102         Because Privacy Browser is built on the <ulink url="https://api.kde.org/frameworks/index.html">KDE Framework</ulink>,
103         it currently uses the <ulink url="https://community.kde.org/Schedules/Plasma_6">Qt 5</ulink> packages.
104       </para>
105
106       <para>
107         The current Qt 5 packages are in long-term support mode.
108         From a feature perspective, Qt WebEngine 5.15.x is based on <ulink url="https://wiki.qt.io/QtWebEngine/ChromiumVersions">Chromium 87.0.4280.144</ulink>.
109         Security fixes are backported every few months with <ulink url="https://wiki.qt.io/Qt_5.15_Release#Release_Plan">each release</ulink>.
110       </para>
111     </sect1>
112
113     <!-- Bugs and missing features. -->
114     <sect1 id="bugs-and-missing-features">
115       <title>Bugs and Missing Features</title>
116
117       <para>
118         There is a list of feature requests and known bugs at <ulink url="https://redmine.stoutner.com/projects/privacy-browser-pc/issues">redmine.stoutner.com</ulink>.
119         Users should anticipate that all the current features of <ulink url="https://www.stoutner.com/privacy-browser-android/">Privacy Browser Android</ulink>
120         will also be implemented in Privacy Browser PC.
121         There is no need at this point to create features requests for these as they will be added as I start working on each feature and have a better idea of how they will be implemented.
122         However, each feature that has already been implemented should be bug free.
123         If you discover a bug that is not already documented at <ulink url="https://redmine.stoutner.com/projects/privacy-browser-pc/issues">redmine.stoutner.com</ulink> please add it.
124       </para>
125
126       <para>
127         Below is a list of known prominent bugs or missing features in this alpha release.
128       </para>
129
130       <itemizedlist>
131         <listitem><para>The page zoom is <ulink url="https://redmine.stoutner.com/issues/799">momentarily reset</ulink> every time a new URL is loaded.</para></listitem>
132         <listitem><para>If domain settings change the user agent, loading of the new URL is interrupted and the
133           <ulink url="https://redmine.stoutner.com/issues/821">previous site is reloaded</ulink>.</para></listitem>
134         <listitem><para>Browser <ulink url="https://redmine.stoutner.com/issues/831">error messages are not displayed</ulink> unless JavaScript is enabled.</para></listitem>
135         <listitem><para>Bookmarks are <ulink url="https://redmine.stoutner.com/issues/968">not yet implemented</ulink>.</para></listitem>
136         <listitem><para>Blocklists are <ulink url="https://redmine.stoutner.com/issues/969">not yet implemented</ulink>.</para></listitem>
137       </itemizedlist>
138     </sect1>
139   </chapter>
140
141   <!-- Using Privacy Browser. -->
142   <chapter id="using-privacy-browser">
143     <title>Using &privacybrowser;</title>
144
145     <para>
146       <mediaobject>
147         <imageobject>
148           <imagedata fileref="privacybrowser-window.png" format="PNG"/>
149         </imageobject>
150         <textobject>
151           <phrase>Screenshot</phrase>
152         </textobject>
153       </mediaobject>
154     </para>
155
156     <!-- JavaScript. -->
157     <sect1 id="javascript">
158       <title>JavaScript</title>
159
160       <para>
161         JavaScript allows web pages to run scripts (programs) on your device. It allows web pages to function more like apps, but it also allows web pages to spy on you.
162         Most of the tracking on the internet does not work when JavaScript is disabled.
163         JavaScript can be toggled by clicking on the privacy shield, which is blue if JavaScript is disabled and red when it is enabled.
164         <inlinemediaobject>
165           <imageobject>
166             <imagedata fileref="javascript.png" format="PNG"/>
167           </imageobject>
168           <textobject>
169             <phrase>JavaScript</phrase>
170           </textobject>
171         </inlinemediaobject>
172       </para>
173     </sect1>
174
175     <!-- Local Storage. -->
176     <sect1 id="local-storage">
177       <title>Local Storage</title>
178
179       <para>
180         <ulink url="https://doc.qt.io/qt-5/qwebenginecookiestore.html#setCookieFilter">Local storage</ulink>
181         in Privacy Browser encompasses cookies, DOM storage, IndexedDB, service workers, and the filesystem API.
182         Local storage can be toggled through an action on the toolbar.
183       </para>
184
185       <!-- Cookies. -->
186       <sect2 id="cookies">
187         <title>Cookies</title>
188
189         <para>
190           <ulink url="https://en.wikipedia.org/wiki/HTTP_cookie">Cookies</ulink>
191           allow websites to store small pieces of information for a specific host that are sent in the HTTP header every time the browser connects to that host.
192           Privacy Browser allows a maximum of <ulink url="http://browsercookielimits.iain.guru/">180 cookies with a maximum size of 4096 bytes per cookie</ulink> to be set per domain.
193           Cookies are often used to track users across the web, particularly third-party cookies (which are completely blocked in Privacy Browser).
194           They are also used as a security mechanism on websites where you log in to identify it is you as you browse from page to page on a site.
195         </para>
196
197         <para>
198           <mediaobject>
199             <imageobject>
200               <imagedata fileref="cookies.png" format="PNG"/>
201             </imageobject>
202             <textobject>
203               <phrase>Cookies</phrase>
204             </textobject>
205           </mediaobject>
206         </para>
207
208         <para>
209           The cookies dialog is opened from <xref linkend="settings-cookies"/>.
210           Durable cookies are shared with all tabs that are opened after they are made durable and are preserved even when Privacy Browser is restarted.
211           This allows users to stay logged in to sites of their choosing. No cookies are durable by default. Making a cookie durable requires specific user interaction.
212         </para>
213
214         <para>
215           All other cookies are specific to the tab where they are created and are destroyed when the tab is closed.
216         </para>
217       </sect2>
218
219       <!-- DOM storage. -->
220       <sect2 id="dom-storage">
221         <title>DOM storage</title>
222
223         <para>
224           <ulink url="https://en.wikipedia.org/wiki/Web_storage">DOM (Document Object Model) storage</ulink>, also knows as web storage, allows web pages to store information on a client device.
225           The storage capacity is larger than for cookies and the data is not automatically sent in the headers with every HTTP request.
226           In Privacy Browser, each website is allowed to store a <ulink url="https://arty.name/localstorage.html">5 MB of data</ulink> in DOM storage.
227           DOM storage requires JavaScript to function, and, in addition, requires an extra toggle to be enabled.
228           In Privacy Browser, DOM storage is limited to the tab where it is created and is destroyed when the tab is closed.
229         </para>
230       </sect2>
231
232       <!-- IndexedDB. -->
233       <sect2 id="indexeddb">
234         <title>IndexedDB</title>
235
236         <para>
237           <ulink url="https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API">IndexedDB</ulink>
238           provides web pages with a local database where they can store â€śsignificant amounts of structured data”.
239           There is disagreement on the internet about the maximum size of an IndexedDB database, probably because the various rendering engines keep changing their mind.
240           But it is usually listed at somewhere between 20% and 80% of <emphasis>your entire hard drive</emphasis> with each individual domain limited to some segment of that.
241           IndexedDB requires JavaScript to function.
242           In Privacy Browser, this database is limited to the tab where it is created and is destroyed when the tab is closed.
243         </para>
244       </sect2>
245
246       <!-- Service Workers. -->
247       <sect2 id="service-workers">
248         <title>Service Workers</title>
249
250         <para>
251           <ulink url="https://developer.chrome.com/docs/workbox/service-worker-overview/">Service workers</ulink> are offline JavaScript proxies of a website. They have their own cache that is usually hidden and hard to clear.
252           They were designed by people who want the web browser to become the operating system and run full â€śapps”.
253           In Privacy Browser, service workers are limited to the tab where they are created and are destroyed when the tab is closed.
254         </para>
255       </sect2>
256
257       <!-- Filesystem API. -->
258       <sect2 id="filesystem-api">
259         <title>Filesystem API</title>
260
261         <para>
262           The <ulink url="https://developer.chrome.com/articles/file-system-access/">filesystem API</ulink> grants the browser direct access to the files on your system.
263           Like service workers, the filesystem API is a summarily bad idea thought up by those who want the browser to become an operating system.
264           Even when JavaScript and local storage are enabled, the filesystem API does not work in Privacy Browser.
265         </para>
266       </sect2>
267     </sect1>
268
269     <!-- User Agent. -->
270     <sect1 id="user-agent">
271       <title>User Agent</title>
272
273       <para>
274         The user agent is a text string that is sent as part of every HTTP header that identifies the browser to the web server.
275         Privacy Browser's default user agent is <code>PrivacyBrowser/1.0</code>.
276         Qt WebEngine 5.15.12’s default user agent is <code>Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) QtWebEngine/5.15.12 Chrome/87.0.4280.144 Safari/537.36</code>.
277       </para>
278
279       <para>
280         Over the years user agents have become quite lengthy,
281         partially because they tend to include a <ulink url="https://webaim.org/blog/user-agent-string-history/">brief history of the internet</ulink>.
282         In the modern world they serve almost no good purpose, but some web developers still think they need them so they can send different version of their website to different browsers.
283         Some servers <ulink url="https://www.stoutner.com/user-agent-problems/">refuse to function correctly</ulink> if they don't like the user agent that is sent.
284       </para>
285
286       <para>
287         At some point in the future Privacy Browser will send no user agent by default.
288         Not only is that currently impossible because the Qt WebEngine doesn't allow you to not send a user agent (I will probably have to fork it to enable that functionality),
289         but even web servers that don't care what the user agent is often refuse to send an answer if there is no user agent at all.
290         Getting rid of this relic of the internet is going to take some time and a retraining of common expectations.
291       </para>
292     </sect1>
293
294     <!-- Domain Settings. -->
295     <sect1 id="domain-settings">
296       <title>Domain Settings</title>
297
298       <para>
299         Domain setting make it easy to automatically change JavaScript, local storage, user agent, and other settings when the domain changes.
300         Domain settings for the current domain can be accessed through the domain settings button at the far right of the URL line edit.
301         Domain settings for all domains can be accessed through <xref linkend="settings-domain-settings"/>. When domain settings are active, the URL line edit will have a green background.
302       </para>
303     </sect1>
304
305     <!-- HTTP Pings. -->
306     <sect1 id="http-pings">
307       <title>HTTP Pings</title>
308
309       <para>
310         HTTP hyperlinks can have an extra <ulink url="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#ping">ping attribute</ulink> that sends a POST request to a different URL.
311         These HTTP pings are commonly used for tracking.
312         <ulink url="https://www.theregister.com/2019/04/06/apple_safari_changes/">Most browsers</ulink> send HTTP pings without informing the user
313         <ulink url="https://lists.w3.org/Archives/Public/public-html/2018May/0027.html">in any way</ulink>
314         (despite what The Register article says, current versions of FireFox also happily send HTTP pings).
315       </para>
316
317       <para>
318         Privacy Browser blocks all HTTP pings and presents a dialog informing the user every time the current tab attempts to send one.
319         Hopefully, as more people become aware of what HTTP pings are, web sites will become more embarrassed about using them.
320         This is a classic example of how those who wrote the HTTP specs do not have the best interests of internet users at heart. I would like the day to come where they are removed from the specs.
321       </para>
322     </sect1>
323
324     <!-- Spell Checking. -->
325     <sect1 id="spell-checking">
326       <title>Spell Checking</title>
327
328       <para>
329         Privacy Browser uses the binary <filename>.bdic</filename> Hunspell dictionary format <ulink url="https://doc.qt.io/qt-5/qtwebengine-features.html#spellchecker">utilized by Qt WebEngine</ulink>
330         which was <ulink url="https://sites.google.com/a/chromium.org/dev/developers/how-tos/editing-the-spell-checking-dictionaries">created by Google for Chromium</ulink>.
331         Debian’s Hunspell dictionary language packages are slowly adding support for the <filename>.bdic</filename> format. Those which have are listed by Privacy Browser as suggested packages.
332       </para>
333
334       <para>
335         Once a <filename>.bdic</filename> dictionary is installed, it can be enabled in Privacy Browser’s settings.
336       </para>
337     </sect1>
338   </chapter>
339
340   <!-- Commands. -->
341   <chapter id="commands">
342     <title>Command Reference</title>
343
344     <!-- Main Window. -->
345     <sect1 id="main-window">
346       <title>Main Window</title>
347
348       <!-- File. -->
349       <sect2>
350         <title>File</title>
351
352         <variablelist>
353           <!-- New Tab. -->
354           <varlistentry id="file-new-tab">
355             <term>
356               <menuchoice>
357                 <shortcut>
358                   <keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo>
359                 </shortcut>
360                 <guimenu>File</guimenu>
361                 <guimenuitem>New Tab</guimenuitem>
362               </menuchoice>
363             </term>
364
365             <listitem>
366               <para>
367                 Create a new tab.
368               </para>
369             </listitem>
370           </varlistentry>
371
372           <!-- New Window. -->
373           <varlistentry id="file-new-window">
374             <term>
375               <menuchoice>
376                 <shortcut>
377                   <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
378                 </shortcut>
379                 <guimenu>File</guimenu>
380                 <guimenuitem>New Window</guimenuitem>
381               </menuchoice>
382             </term>
383
384             <listitem>
385               <para>
386                 Create a new window.
387               </para>
388             </listitem>
389           </varlistentry>
390
391           <!-- Print. -->
392           <varlistentry  id="file-print">
393             <term>
394               <menuchoice>
395                 <shortcut>
396                   <keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
397                 </shortcut>
398                 <guimenu>File</guimenu>
399                 <guimenuitem>Print</guimenuitem>
400               </menuchoice>
401             </term>
402
403             <listitem>
404               <para>
405                 Print the document.
406               </para>
407             </listitem>
408           </varlistentry>
409
410           <!-- Print Preview. -->
411           <varlistentry  id="file-print-preview">
412             <term>
413               <menuchoice>
414                 <shortcut>
415                   <keycombo action="simul">&Ctrl;&Shift;<keycap>P</keycap></keycombo>
416                 </shortcut>
417                 <guimenu>File</guimenu>
418                 <guimenuitem>Print Preview</guimenuitem>
419               </menuchoice>
420             </term>
421
422             <listitem>
423               <para>
424                 Display the print preview dialog.
425               </para>
426             </listitem>
427           </varlistentry>
428
429           <!-- Quit. -->
430           <varlistentry  id="file-quit">
431             <term>
432               <menuchoice>
433                 <shortcut>
434                   <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
435                 </shortcut>
436                 <guimenu>File</guimenu>
437                 <guimenuitem>Quit</guimenuitem>
438               </menuchoice>
439             </term>
440
441             <listitem>
442               <para>
443                 Quit &privacybrowser;.
444               </para>
445             </listitem>
446           </varlistentry>
447         </variablelist>
448       </sect2>
449
450       <!-- Edit. -->
451       <sect2>
452         <title>Edit</title>
453
454         <variablelist>
455           <!-- Find. -->
456           <varlistentry id="edit-find">
457             <term>
458               <menuchoice>
459                 <shortcut>
460                   <keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo>
461                 </shortcut>
462                 <guimenu>Edit</guimenu>
463                 <guimenuitem>Find</guimenuitem>
464               </menuchoice>
465             </term>
466
467             <listitem>
468               <para>
469                 Display the find toolbar and focus the find text line edit. If the toolbar is already displayed, the find text line edit is refocused and the text it contains is selected.
470               </para>
471             </listitem>
472           </varlistentry>
473
474
475           <!-- Find Next. -->
476           <varlistentry id="edit-find-next">
477             <term>
478               <menuchoice>
479                 <shortcut>
480                   <keycap>F3</keycap>
481                 </shortcut>
482                 <guimenu>Edit</guimenu>
483                 <guimenuitem>Find Next</guimenuitem>
484               </menuchoice>
485             </term>
486
487             <listitem>
488               <para>
489                 Find the next entry on the page that matches the specified text. This action is only displayed if the find toolbar is visible.
490               </para>
491             </listitem>
492           </varlistentry>
493
494           <!-- Find Previous. -->
495           <varlistentry id="edit-find-previous">
496             <term>
497               <menuchoice>
498                 <shortcut>
499                   <keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo>
500                 </shortcut>
501                 <guimenu>Edit</guimenu>
502                 <guimenuitem>Find Previous</guimenuitem>
503               </menuchoice>
504             </term>
505
506             <listitem>
507               <para>
508                 Find the previous entry on the page that matches the specified text. This action is only displayed if the find toolbar is visible.
509               </para>
510             </listitem>
511           </varlistentry>
512         </variablelist>
513       </sect2>
514
515       <!-- View. -->
516       <sect2>
517         <title>View</title>
518
519         <variablelist>
520           <!-- Refresh. -->
521           <varlistentry id="view-refresh">
522             <term>
523               <menuchoice>
524                 <shortcut>
525                   <keycap>F5</keycap>
526                 </shortcut>
527                 <guimenu>View</guimenu>
528                 <guimenuitem>Refresh</guimenuitem>
529               </menuchoice>
530             </term>
531
532             <listitem>
533               <para>
534                 Reload the website in the current tab.
535               </para>
536             </listitem>
537           </varlistentry>
538
539           <!-- Full Screen Mode. -->
540           <varlistentry id="view-full-screen-mode">
541             <term>
542               <menuchoice>
543                 <shortcut>
544                   <keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo>
545                 </shortcut>
546                 <guimenu>View</guimenu>
547                 <guimenuitem>Full Screen Mode</guimenuitem>
548               </menuchoice>
549             </term>
550
551             <listitem>
552               <para>
553                 Toggle full screen mode. This performs the same action as <xref linkend="f11"/>.
554               </para>
555             </listitem>
556           </varlistentry>
557         </variablelist>
558       </sect2>
559
560       <!-- Go. -->
561       <sect2>
562         <title>Go</title>
563
564         <variablelist>
565           <!-- Back. -->
566           <varlistentry id="go-back">
567             <term>
568               <menuchoice>
569                 <shortcut>
570                   <keycombo action="simul">&Alt;<keycap>Left</keycap></keycombo>
571                 </shortcut>
572                 <guimenu>Go</guimenu>
573                 <guimenuitem>Back</guimenuitem>
574               </menuchoice>
575             </term>
576
577             <listitem>
578               <para>
579                 Navigate back one step in the current tab’s history. The action is disabled if it is not possible to go back.
580               </para>
581             </listitem>
582           </varlistentry>
583
584           <!-- Forward. -->
585           <varlistentry id="go-forward">
586             <term>
587               <menuchoice>
588                 <shortcut>
589                   <keycombo action="simul">&Alt;<keycap>Right</keycap></keycombo>
590                 </shortcut>
591                 <guimenu>Go</guimenu>
592                 <guimenuitem>Forward</guimenuitem>
593               </menuchoice>
594             </term>
595
596             <listitem>
597               <para>
598                 Navigate forward one step in the current tab’s history. The action is disabled if it is not possible to go forward.
599               </para>
600             </listitem>
601           </varlistentry>
602
603           <!-- Home. -->
604           <varlistentry id="go-home">
605             <term>
606               <menuchoice>
607                 <shortcut>
608                   <keycombo action="simul">&Alt;<keycap>Home</keycap></keycombo>
609                 </shortcut>
610                 <guimenu>Go</guimenu>
611                 <guimenuitem>Home</guimenuitem>
612               </menuchoice>
613             </term>
614
615             <listitem>
616               <para>
617                 Load the home page in the current tab.
618               </para>
619             </listitem>
620           </varlistentry>
621         </variablelist>
622       </sect2>
623
624       <!-- On-The-Fly Settings. -->
625       <sect2>
626         <title>On-The-Fly Settings</title>
627
628         <!-- User Agent. -->
629         <sect3>
630           <title>User Agent</title>
631
632           <variablelist>
633             <!-- Privacy Browser. -->
634             <varlistentry id="user-agent-privacy-browser">
635               <term>
636                 <menuchoice>
637                   <shortcut>
638                     <keycombo action="simul">&Ctrl;&Alt;<keycap>P</keycap></keycombo>
639                   </shortcut>
640                   <guimenu>On-The-Fly Settings</guimenu>
641                   <guisubmenu>User Agent</guisubmenu>
642                   <guimenuitem>Privacy Browser</guimenuitem>
643                 </menuchoice>
644               </term>
645
646               <listitem>
647                 <para>
648                   Use the Privacy Browser user agent for the current tab.
649                 </para>
650               </listitem>
651             </varlistentry>
652
653             <!-- WebEngine Default. -->
654             <varlistentry id="user-agent-webengine-default">
655               <term>
656                 <menuchoice>
657                   <shortcut>
658                     <keycombo action="simul">&Ctrl;&Alt;<keycap>W</keycap></keycombo>
659                   </shortcut>
660                   <guimenu>On-The-Fly Settings</guimenu>
661                   <guisubmenu>User Agent</guisubmenu>
662                   <guimenuitem>WebEngine Default</guimenuitem>
663                 </menuchoice>
664               </term>
665
666               <listitem>
667                 <para>
668                   Use the WebEngine Default user agent for the current tab.
669                 </para>
670               </listitem>
671             </varlistentry>
672
673             <!-- Firefox on Linux. -->
674             <varlistentry id="user-agent-firefox-linux">
675               <term>
676                 <menuchoice>
677                   <shortcut>
678                     <keycombo action="simul">&Ctrl;&Alt;<keycap>F</keycap></keycombo>
679                   </shortcut>
680                   <guimenu>On-The-Fly Settings</guimenu>
681                   <guisubmenu>User Agent</guisubmenu>
682                   <guimenuitem>Firefox on Linux</guimenuitem>
683                 </menuchoice>
684               </term>
685
686               <listitem>
687                 <para>
688                   Use the Firefox on Linux user agent for the current tab.
689                 </para>
690               </listitem>
691             </varlistentry>
692
693             <!-- Chromium on Linux. -->
694             <varlistentry id="user-agent-chromium-linux">
695               <term>
696                 <menuchoice>
697                   <shortcut>
698                     <keycombo action="simul">&Ctrl;&Alt;<keycap>C</keycap></keycombo>
699                   </shortcut>
700                   <guimenu>On-The-Fly Settings</guimenu>
701                   <guisubmenu>User Agent</guisubmenu>
702                   <guimenuitem>Chromium on Linux</guimenuitem>
703                 </menuchoice>
704               </term>
705
706               <listitem>
707                 <para>
708                   Use the Chromium on Linux user agent for the current tab.
709                 </para>
710               </listitem>
711             </varlistentry>
712
713             <!-- Firefox on Windows. -->
714             <varlistentry id="user-agent-firefox-windows">
715               <term>
716                 <menuchoice>
717                   <shortcut>
718                     <keycombo action="simul">&Ctrl;&Alt;&Shift;<keycap>F</keycap></keycombo>
719                   </shortcut>
720                   <guimenu>On-The-Fly Settings</guimenu>
721                   <guisubmenu>User Agent</guisubmenu>
722                   <guimenuitem>Firefox on Windows</guimenuitem>
723                 </menuchoice>
724               </term>
725
726               <listitem>
727                 <para>
728                   Use the Firefox on Windows user agent for the current tab.
729                 </para>
730               </listitem>
731             </varlistentry>
732
733             <!-- Chrome on Windows. -->
734             <varlistentry id="user-agent-chrome-windows">
735               <term>
736                 <menuchoice>
737                   <shortcut>
738                     <keycombo action="simul">&Ctrl;&Alt;&Shift;<keycap>C</keycap></keycombo>
739                   </shortcut>
740                   <guimenu>On-The-Fly Settings</guimenu>
741                   <guisubmenu>User Agent</guisubmenu>
742                   <guimenuitem>Chrome on Windows</guimenuitem>
743                 </menuchoice>
744               </term>
745
746               <listitem>
747                 <para>
748                   Use the Chrome on Windows user agent for the current tab.
749                 </para>
750               </listitem>
751             </varlistentry>
752
753             <!-- Edge on Windows. -->
754             <varlistentry id="user-agent-edge-windows">
755               <term>
756                 <menuchoice>
757                   <shortcut>
758                     <keycombo action="simul">&Ctrl;&Alt;<keycap>E</keycap></keycombo>
759                   </shortcut>
760                   <guimenu>On-The-Fly Settings</guimenu>
761                   <guisubmenu>User Agent</guisubmenu>
762                   <guimenuitem>Edge on Windows</guimenuitem>
763                 </menuchoice>
764               </term>
765
766               <listitem>
767                 <para>
768                   Use the Edge on Windows user agent for the current tab.
769                 </para>
770               </listitem>
771             </varlistentry>
772
773             <!-- Safari on macOS. -->
774             <varlistentry id="user-agent-safari-macOS">
775               <term>
776                 <menuchoice>
777                   <shortcut>
778                     <keycombo action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo>
779                   </shortcut>
780                   <guimenu>On-The-Fly Settings</guimenu>
781                   <guisubmenu>User Agent</guisubmenu>
782                   <guimenuitem>Safari on macOS</guimenuitem>
783                 </menuchoice>
784               </term>
785
786               <listitem>
787                 <para>
788                   Use the Safari on macOS user agent for the current tab.
789                 </para>
790               </listitem>
791             </varlistentry>
792
793             <!-- Custom User Agent. -->
794             <varlistentry id="user-agent-custom">
795               <term>
796                 <menuchoice>
797                   <shortcut>
798                     <keycombo action="simul">&Alt;&Shift;<keycap>C</keycap></keycombo>
799                   </shortcut>
800                   <guimenu>On-The-Fly Settings</guimenu>
801                   <guisubmenu>User Agent</guisubmenu>
802                   <guimenuitem>Custom</guimenuitem>
803                 </menuchoice>
804               </term>
805
806               <listitem>
807                 <para>
808                   Use the custom user agent for the current tab. This action is only active if a custom user agent is set in the settings.
809                 </para>
810               </listitem>
811             </varlistentry>
812           </variablelist>
813         </sect3>
814
815         <!-- Zoom. -->
816         <sect3>
817           <title>Zoom</title>
818
819           <variablelist>
820             <!-- Zoom Factor. -->
821             <varlistentry id="on-the-fly-settings-zoom-factor">
822               <term>
823                 <menuchoice>
824                   <shortcut>
825                     <keycombo action="simul">&Ctrl;&Alt;<keycap>Z</keycap></keycombo>
826                   </shortcut>
827                   <guimenu>On-The-Fly Settings</guimenu>
828                   <guimenuitem>Zoom Factor</guimenuitem>
829                 </menuchoice>
830               </term>
831
832               <listitem>
833                 <para>
834                   Display the zoom factor dialog.
835                 </para>
836               </listitem>
837             </varlistentry>
838           </variablelist>
839         </sect3>
840
841         <!-- Search Engine. -->
842         <sect3>
843           <title>Search Engine</title>
844
845           <variablelist>
846             <!-- Mojeek. -->
847             <varlistentry id="search-engine-mojeek">
848               <term>
849                 <menuchoice>
850                   <shortcut>
851                     <keycombo action="simul">&Ctrl;&Shift;<keycap>M</keycap></keycombo>
852                   </shortcut>
853                   <guimenu>On-The-Fly Settings</guimenu>
854                   <guisubmenu>Search Engine</guisubmenu>
855                   <guimenuitem>Mojeek</guimenuitem>
856                 </menuchoice>
857               </term>
858
859               <listitem>
860                 <para>
861                   Use Mojeek as the search engine.
862                 </para>
863               </listitem>
864             </varlistentry>
865
866             <!-- Monocles. -->
867             <varlistentry id="search-engine-monocles">
868               <term>
869                 <menuchoice>
870                   <shortcut>
871                     <keycombo action="simul">&Ctrl;&Shift;<keycap>O</keycap></keycombo>
872                   </shortcut>
873                   <guimenu>On-The-Fly Settings</guimenu>
874                   <guisubmenu>Search Engine</guisubmenu>
875                   <guimenuitem>Monocles</guimenuitem>
876                 </menuchoice>
877               </term>
878
879               <listitem>
880                 <para>
881                   Use Mojeek as the search engine.
882                 </para>
883               </listitem>
884             </varlistentry>
885
886             <!-- MetaGer. -->
887             <varlistentry id="search-engine-metager">
888               <term>
889                 <menuchoice>
890                   <shortcut>
891                     <keycombo action="simul">&Ctrl;&Shift;<keycap>E</keycap></keycombo>
892                   </shortcut>
893                   <guimenu>On-The-Fly Settings</guimenu>
894                   <guisubmenu>Search Engine</guisubmenu>
895                   <guimenuitem>MetaGer</guimenuitem>
896                 </menuchoice>
897               </term>
898
899               <listitem>
900                 <para>
901                   Use MetaGer as the search engine.
902                 </para>
903               </listitem>
904             </varlistentry>
905
906             <!-- Google. -->
907             <varlistentry id="search-engine-google">
908               <term>
909                 <menuchoice>
910                   <shortcut>
911                     <keycombo action="simul">&Ctrl;&Shift;<keycap>G</keycap></keycombo>
912                   </shortcut>
913                   <guimenu>On-The-Fly Settings</guimenu>
914                   <guisubmenu>Search Engine</guisubmenu>
915                   <guimenuitem>Google</guimenuitem>
916                 </menuchoice>
917               </term>
918
919               <listitem>
920                 <para>
921                   Use Google as the search engine.
922                 </para>
923               </listitem>
924             </varlistentry>
925
926             <!-- Bing. -->
927             <varlistentry id="search-engine-bing">
928               <term>
929                 <menuchoice>
930                   <shortcut>
931                     <keycombo action="simul">&Ctrl;&Shift;<keycap>B</keycap></keycombo>
932                   </shortcut>
933                   <guimenu>On-The-Fly Settings</guimenu>
934                   <guisubmenu>Search Engine</guisubmenu>
935                   <guimenuitem>Bing</guimenuitem>
936                 </menuchoice>
937               </term>
938
939               <listitem>
940                 <para>
941                   Use Bing as the search engine.
942                 </para>
943               </listitem>
944             </varlistentry>
945
946             <!-- Yahoo. -->
947             <varlistentry id="search-engine-yahoo">
948               <term>
949                 <menuchoice>
950                   <shortcut>
951                     <keycombo action="simul">&Ctrl;&Shift;<keycap>Y</keycap></keycombo>
952                   </shortcut>
953                   <guimenu>On-The-Fly Settings</guimenu>
954                   <guisubmenu>Search Engine</guisubmenu>
955                   <guimenuitem>Yahoo</guimenuitem>
956                 </menuchoice>
957               </term>
958
959               <listitem>
960                 <para>
961                   Use Yahoo as the search engine.
962                 </para>
963               </listitem>
964             </varlistentry>
965
966             <!-- Custom Search Engine. -->
967             <varlistentry id="search-engine-custom">
968               <term>
969                 <menuchoice>
970                   <shortcut>
971                     <keycombo action="simul">&Ctrl;&Shift;<keycap>C</keycap></keycombo>
972                   </shortcut>
973                   <guimenu>On-The-Fly Settings</guimenu>
974                   <guisubmenu>Search Engine</guisubmenu>
975                   <guimenuitem>Custom</guimenuitem>
976                 </menuchoice>
977               </term>
978
979               <listitem>
980                 <para>
981                   Use the custom search engine. This action is only active if a custom search engine is set in the settings.
982                 </para>
983               </listitem>
984             </varlistentry>
985           </variablelist>
986         </sect3>
987       </sect2>
988
989       <!-- Settings. -->
990       <sect2>
991         <title>Settings</title>
992
993         <variablelist>
994           <!-- Domain Settings. -->
995           <varlistentry id="settings-domain-settings">
996             <term>
997               <menuchoice>
998                 <shortcut>
999                   <keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo>
1000                 </shortcut>
1001                 <guimenu>Settings</guimenu>
1002                 <guimenuitem>Domain Settings</guimenuitem>
1003               </menuchoice>
1004             </term>
1005
1006             <listitem>
1007               <para>
1008                 Display the domain settings dialog.
1009               </para>
1010             </listitem>
1011           </varlistentry>
1012
1013
1014           <!-- Cookies. -->
1015           <varlistentry id="settings-cookies">
1016             <term>
1017               <menuchoice>
1018                 <shortcut>
1019                   <keycombo action="simul">&Ctrl;<keycap>;</keycap></keycombo>
1020                 </shortcut>
1021                 <guimenu>Settings</guimenu>
1022                 <guimenuitem>Cookies</guimenuitem>
1023               </menuchoice>
1024             </term>
1025
1026             <listitem>
1027               <para>
1028                 Display the cookies dialog.
1029               </para>
1030             </listitem>
1031           </varlistentry>
1032         </variablelist>
1033       </sect2>
1034
1035       <!-- Common Settings and Help Entries. -->
1036       <sect2 id="common-settings-help-menus">
1037         <title>Common Settings and Help Entries</title>
1038
1039         <para>
1040           &privacybrowser; has many common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu> menu items.
1041           For more information read the sections about the <ulink url="help:/fundamentals/ui.html#menus-settings">Settings Menu</ulink>
1042           and <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink>.
1043         </para>
1044       </sect2>
1045
1046       <!-- Other Commands. -->
1047       <sect2>
1048         <title>Other Commands</title>
1049
1050         <variablelist>
1051           <!-- F11. -->
1052           <varlistentry id="f11">
1053             <term>
1054               <command>
1055                 <keycap>F11</keycap>
1056               </command>
1057             </term>
1058
1059             <listitem>
1060               <para>
1061                 Toggle full screen mode. This performs the same action as <xref linkend="view-full-screen-mode"/>.
1062               </para>
1063             </listitem>
1064           </varlistentry>
1065
1066           <!-- Escape. -->
1067           <varlistentry id="escape">
1068             <term>
1069               <command>
1070                 <keycap>&Esc;</keycap>
1071               </command>
1072             </term>
1073
1074             <listitem>
1075               <para>
1076                 Escape runs the first command that applies from the following list.
1077               </para>
1078
1079               <itemizedlist>
1080                 <listitem>
1081                   <para>
1082                     Exit full screen browsing.
1083                   </para>
1084                 </listitem>
1085
1086                 <listitem>
1087                   <para>
1088                     Clear the find text line edit and the find text highlights.
1089                   </para>
1090                 </listitem>
1091
1092                 <listitem>
1093                   <para>
1094                     Hide the find text toolbar.
1095                   </para>
1096                 </listitem>
1097               </itemizedlist>
1098             </listitem>
1099           </varlistentry>
1100         </variablelist>
1101       </sect2>
1102     </sect1>
1103
1104     <!-- Cookies Dialog. -->
1105     <sect1 id="cookies-dialog">
1106       <title>Cookies Dialog</title>
1107
1108       <para>
1109         The cookies dialog is accessed through <xref linkend="settings-cookies"/> (see <xref linkend="cookies"/>).
1110       </para>
1111
1112       <sect2 id="cookies-dialog-commands">
1113         <title>Commands</title>
1114
1115         <variablelist>
1116           <!-- Add Cookie. -->
1117           <varlistentry id="add-cookie">
1118             <term>
1119               <command>
1120                 <keycap>A</keycap>
1121               </command>
1122             </term>
1123
1124             <listitem>
1125               <para>
1126                 Open the add cookie dialog.
1127               </para>
1128             </listitem>
1129           </varlistentry>
1130
1131           <!-- Edit Cookie. -->
1132           <varlistentry id="edit-cookie">
1133             <term>
1134               <command>
1135                 <keycap>E</keycap>
1136               </command>
1137             </term>
1138
1139             <listitem>
1140               <para>
1141                 Open the edit cookie dialog. This command is only valid if a cookie is currently selected.
1142               </para>
1143             </listitem>
1144           </varlistentry>
1145
1146           <!-- Delete Cookies. -->
1147           <varlistentry id="delete-cookies">
1148             <term>
1149               <command>
1150                 <keycap>D</keycap> or <keycap>&Del;</keycap>
1151               </command>
1152             </term>
1153
1154             <listitem>
1155               <para>
1156                 Delete the currently selected cookies. A dialog will confirm the deletion before it is processed.
1157               </para>
1158             </listitem>
1159           </varlistentry>
1160
1161           <!-- Delete All Cookies. -->
1162           <varlistentry id="delete-all-cookie">
1163             <term>
1164               <command>
1165                 <keycap>L</keycap>
1166               </command>
1167             </term>
1168
1169             <listitem>
1170               <para>
1171                 Delete all the cookies. A dialog will confirm the deletion before it is processed.
1172               </para>
1173             </listitem>
1174           </varlistentry>
1175
1176           <!-- Close. -->
1177           <varlistentry id="close-cookies-dialog">
1178             <term>
1179               <command>
1180                 <keycap>C</keycap> or <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
1181               </command>
1182             </term>
1183
1184             <listitem>
1185               <para>
1186                 Close the cookies dialog.
1187               </para>
1188             </listitem>
1189           </varlistentry>
1190         </variablelist>
1191       </sect2>
1192     </sect1>
1193
1194     <!-- Save Dialog. -->
1195     <sect1 id="save-dialog">
1196       <title>Save Dialog</title>
1197
1198       <para>
1199         The save dialog pops up when a download is initiated.
1200       </para>
1201
1202       <sect2 id="save-dialog-commands">
1203         <title>Commands</title>
1204
1205         <variablelist>
1206           <!-- Save. -->
1207           <varlistentry id="save-dialog-save">
1208             <term>
1209               <command>
1210                 <keycap>S</keycap>
1211               </command>
1212             </term>
1213
1214             <listitem>
1215               <para>
1216                 Save the file.
1217               </para>
1218             </listitem>
1219           </varlistentry>
1220
1221           <!-- Close. -->
1222           <varlistentry id="save-dialog-close">
1223             <term>
1224               <command>
1225                 <keycap>C</keycap> or <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
1226               </command>
1227             </term>
1228
1229             <listitem>
1230               <para>
1231                 Close the save dialog without saving the file.
1232               </para>
1233             </listitem>
1234           </varlistentry>
1235         </variablelist>
1236       </sect2>
1237     </sect1>
1238   </chapter>
1239
1240   <!-- FAQ. -->
1241   <chapter id="faq">
1242     <title>Questions and Answers</title>
1243
1244     <qandaset id="faqlist">
1245       <qandaentry>
1246         <!-- Why are there no questions. -->
1247         <question>
1248           <para>Why are there no questions?</para>
1249         </question>
1250
1251         <answer>
1252           <para>Because Privacy Browser is so perfectly designed that none have ever been asked. Also, because this is the first release and nobody has had a chance to ask them yet. ;)</para>
1253         </answer>
1254       </qandaentry>
1255     </qandaset>
1256   </chapter>
1257
1258   <!-- Credits. -->
1259   <chapter id="credits">
1260     <title>Credits and License</title>
1261
1262     <para>
1263       Privacy Browser PC copyright 2016-2017,2021-2023 Soren Stoutner <ulink url="mailto:soren@stoutner.com">soren@stoutner.com</ulink>.
1264     </para>
1265
1266     <!-- Program. -->
1267     <sect1 id="program">
1268       <title>Program</title>
1269
1270       <para>
1271         The source code is available at <ulink url="https://gitweb.stoutner.com/?p=PrivacyBrowserPC.git;a=summary">gitweb.stoutner.com</ulink>
1272         or by running <filename>git clone https://git.stoutner.com/PrivacyBrowserPC.git</filename>.
1273       </para>
1274
1275       <para>
1276         Translators:
1277         <itemizedlist>
1278           <listitem><para>Translations will be added in a future release.</para></listitem>
1279         </itemizedlist>
1280       </para>
1281
1282       <!-- The program license. -->
1283       &underGPL;
1284     </sect1>
1285
1286     <!-- Documentation. -->
1287     <sect1 id="documentation">
1288       <title>Documentation</title>
1289
1290       <para>
1291         <filename>doc/index.docbook</filename> and <filename>src/com.stoutner.privacybrowser.appdata.xml</filename> are released under the
1292         <ulink url="https://www.gnu.org/licenses/fdl-1.3.html">GFDL-1.3 license</ulink> with no Front-Cover or Back-Cover Texts or Invariant Sections.
1293         All other documentation is released under the <ulink url="https://www.gnu.org/licenses/gpl-3.0.html">GPLv3+ license</ulink>.
1294       </para>
1295
1296       <!-- The documentation license. -->
1297       &underFDL;
1298     </sect1>
1299
1300     <!-- Icons. -->
1301     <sect1 id="icons">
1302       <title>Icons</title>
1303
1304       <para>
1305         <inlinemediaobject>
1306           <imageobject>
1307             <imagedata fileref="privacybrowser.png" format="PNG"/>
1308           </imageobject>
1309           <textobject>
1310             <phrase>Privacy Browser</phrase>
1311           </textobject>
1312         </inlinemediaobject>
1313
1314         <inlinemediaobject>
1315           <imageobject>
1316             <imagedata fileref="javascript.png" format="PNG"/>
1317           </imageobject>
1318           <textobject>
1319             <phrase>JavaScript</phrase>
1320           </textobject>
1321         </inlinemediaobject>
1322
1323         <inlinemediaobject>
1324           <imageobject>
1325             <imagedata fileref="privacybrowser-monochrome.png" format="PNG"/>
1326           </imageobject>
1327           <textobject>
1328             <phrase>Privacy Browser Monochrome</phrase>
1329           </textobject>
1330         </inlinemediaobject>
1331
1332         are derived from <filename>security</filename> and <filename>language</filename>, which are part of the <ulink url="https://fonts.google.com/icons">Android Material icon set</ulink>
1333         and are released under the <ulink url="https://www.apache.org/licenses/LICENSE-2.0">Apache License 2.0</ulink>. Modifications copyright 2016-2017,2021-2023 Soren Stoutner.
1334         The resulting images are released under the <ulink url="https://www.gnu.org/licenses/gpl-3.0.html">GPLv3+ license</ulink>.
1335       </para>
1336
1337       <para>
1338         <inlinemediaobject>
1339           <imageobject>
1340             <imagedata fileref="loading.gif" format="GIF"/>
1341           </imageobject>
1342           <textobject>
1343             <phrase>Loading</phrase>
1344           </textobject>
1345         </inlinemediaobject>
1346
1347         comes from <ulink url="https://github.com/Codelessly/FlutterLoadingGIFs/blob/master/packages/cupertino_activity_indicator_selective.gif">FlutterLoadingGIFs</ulink>
1348         where it is named <filename>cupertino_activity_indicator_selective.gif</filename>.
1349         It is released under the <ulink url="https://opensource.org/license/0bsd/">Zero-Clause BSD License</ulink>.
1350       </para>
1351     </sect1>
1352   </chapter>
1353 </book>