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     </abstract>
  63
  64     <!-- This is a set of Keywords for indexing by search engines. -->
  65     <keywordset>
  66       <keyword>KDE</keyword>
  67       <keyword>privacy</keyword>
  68       <keyword>browser</keyword>
  69     </keywordset>
  70   </bookinfo>
  71
  72   <!-- Introduction. -->
  73   <chapter id="introduction">
  74     <title>Introduction</title>
  75
  76     <para>
  77       &privacybrowser; is currently in an early alpha state.
  78       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.
  79     </para>
  80
  81     <para>
  82       To distinguish between the Android and the PC version, the website, issue tracker,
  83       and code base refer to this version as <ulink url="https://www.stoutner.com/privacy-browser-pc/">Privacy Browser PC</ulink>.
  84     </para>
  85
  86     <para>
  87       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>.
  88       I also frequently post on my <ulink url="https://fosstodon.org/@privacybrowser">Mastodon account</ulink> regarding the development status.
  89     </para>
  90
  91     <!-- Qt WebEngine. -->
  92     <sect1 id="qt-webengine">
  93       <title>Qt WebEngine</title>
  94
  95       <para>
  96         Privacy Browser uses <ulink url="https://doc.qt.io/qt-5/qtwebengine-index.html">Qt WebEngine</ulink> to render websites.
  97         Qt WebEngine is based on the <ulink url="https://www.chromium.org/blink/">Chromium Blink</ulink> source code.
  98         Because Privacy Browser is built on the <ulink url="https://api.kde.org/frameworks/index.html">KDE Framework</ulink>,
  99         it currently uses the <ulink url="https://community.kde.org/Schedules/Plasma_6">Qt 5</ulink> packages.
 100       </para>
 101
 102       <para>
 103         The current Qt 5 packages are in long-term support mode.
 104         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>.
 105         Security fixes are backported every few months with <ulink url="https://wiki.qt.io/Qt_5.15_Release#Release_Plan">each release</ulink>.
 106       </para>
 107     </sect1>
 108
 109     <!-- Bugs and missing features. -->
 110     <sect1 id="bugs-and-missing-features">
 111       <title>Bugs and Missing Features</title>
 112
 113       <para>
 114         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>.
 115         Users should anticipate that all the current features of <ulink url="https://www.stoutner.com/privacy-browser-android/">Privacy Browser Android</ulink>
 116         will also be implemented in Privacy Browser PC.
 117         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.
 118         However, each feature that has already been implemented should be bug free.
 119         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.
 120       </para>
 121
 122       <para>
 123         Below is a list of known prominent bugs or missing features in this alpha release.
 124       </para>
 125
 126       <itemizedlist>
 127         <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>
 128         <listitem><para>If domain settings change the user agent, loading of the new URL is interrupted and the
 129           <ulink url="https://redmine.stoutner.com/issues/821">previous site is reloaded</ulink>.</para></listitem>
 130         <listitem><para>Browser <ulink url="https://redmine.stoutner.com/issues/831">error messages are not displayed</ulink> unless JavaScript is enabled.</para></listitem>
 131         <listitem><para>Bookmarks are <ulink url="https://redmine.stoutner.com/issues/968">not yet implemented</ulink>.</para></listitem>
 132         <listitem><para>Blocklists are <ulink url="https://redmine.stoutner.com/issues/969">not yet implemented</ulink>.</para></listitem>
 133       </itemizedlist>
 134     </sect1>
 135   </chapter>
 136
 137   <!-- Using Privacy Browser. -->
 138   <chapter id="using-privacy-browser">
 139     <title>Using &privacybrowser;</title>
 140
 141     <para>
 142       <mediaobject>
 143         <imageobject>
 144           <imagedata fileref="privacybrowser.png" format="PNG"/>
 145         </imageobject>
 146         <textobject>
 147           <phrase>Screenshot</phrase>
 148         </textobject>
 149       </mediaobject>
 150     </para>
 151
 152     <!-- JavaScript. -->
 153     <sect1 id="javascript">
 154       <title>JavaScript</title>
 155
 156       <para>
 157         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.
 158         Most of the tracking on the internet does not work when JavaScript is disabled.
 159         JavaScript can be toggled by clicking on the privacy shield, which is blue if JavaScript is disabled and red when it is enabled.
 160         <inlinemediaobject>
 161           <imageobject>
 162             <imagedata fileref="javascript.png" format="PNG"/>
 163           </imageobject>
 164           <textobject>
 165             <phrase>JavaScript</phrase>
 166           </textobject>
 167         </inlinemediaobject>
 168       </para>
 169     </sect1>
 170
 171     <!-- Local Storage. -->
 172     <sect1 id="local-storage">
 173       <title>Local Storage</title>
 174
 175       <para>
 176         <ulink url="https://doc.qt.io/qt-5/qwebenginecookiestore.html#setCookieFilter">Local storage</ulink>
 177         in Privacy Browser encompasses cookies, DOM storage, IndexedDB, service workers, and the filesystem API.
 178         Local storage can be toggled through an action on the toolbar.
 179       </para>
 180
 181       <!-- Cookies. -->
 182       <sect2 id="cookies">
 183         <title>Cookies</title>
 184
 185         <para>
 186           <ulink url="https://en.wikipedia.org/wiki/HTTP_cookie">Cookies</ulink>
 187           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.
 188           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.
 189           Cookies are often used to track users across the web, particularly third-party cookies (which are completely blocked in Privacy Browser).
 190           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.
 191         </para>
 192
 193         <para>
 194           <mediaobject>
 195             <imageobject>
 196               <imagedata fileref="cookies.png" format="PNG"/>
 197             </imageobject>
 198             <textobject>
 199               <phrase>Cookies</phrase>
 200             </textobject>
 201           </mediaobject>
 202         </para>
 203
 204         <para>
 205           The cookies dialog is opened from <xref linkend="settings-cookies"/>.
 206           Durable cookies are shared with all tabs that are opened after they are made durable and are preserved even when Privacy Browser is restarted.
 207           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.
 208         </para>
 209
 210         <para>
 211           All other cookies are specific to the tab where they are created and are destroyed when the tab is closed.
 212         </para>
 213       </sect2>
 214
 215       <!-- DOM storage. -->
 216       <sect2 id="dom-storage">
 217         <title>DOM storage</title>
 218
 219         <para>
 220           <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.
 221           The storage capacity is larger than for cookies and the data is not automatically sent in the headers with every HTTP request.
 222           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.
 223           DOM storage requires JavaScript to function, and, in addition, requires an extra toggle to be enabled.
 224           In Privacy Browser, DOM storage is limited to the tab where it is created and is destroyed when the tab is closed.
 225         </para>
 226       </sect2>
 227
 228       <!-- IndexedDB. -->
 229       <sect2 id="indexeddb">
 230         <title>IndexedDB</title>
 231
 232         <para>
 233           <ulink url="https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API">IndexedDB</ulink>
 234           provides web pages with a local database where they can store “significant amounts of structured data”.
 235           There is disagreement on the internet about the maximum size of an IndexedDB database, probably because the various rendering engines keep changing their mind.
 236           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.
 237           IndexedDB requires JavaScript to function.
 238           In Privacy Browser, this database is limited to the tab where it is created and is destroyed when the tab is closed.
 239         </para>
 240       </sect2>
 241
 242       <!-- Service Workers. -->
 243       <sect2 id="service-workers">
 244         <title>Service Workers</title>
 245
 246         <para>
 247           <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.
 248           They were designed by people who want the web browser to become the operating system and run full “apps”.
 249           In Privacy Browser, service workers are limited to the tab where they are created and are destroyed when the tab is closed.
 250         </para>
 251       </sect2>
 252
 253       <!-- Filesystem API. -->
 254       <sect2 id="filesystem-api">
 255         <title>Filesystem API</title>
 256
 257         <para>
 258           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.
 259           Like service workers, the filesystem API is a summarily bad idea thought up by those who want the browser to become an operating system.
 260           Even when JavaScript and local storage are enabled, the filesystem API does not work in Privacy Browser.
 261         </para>
 262       </sect2>
 263     </sect1>
 264
 265     <!-- User Agent. -->
 266     <sect1 id="user-agent">
 267       <title>User Agent</title>
 268
 269       <para>
 270         The user agent is a text string that is sent as part of every HTTP header that identifies the browser to the web server.
 271         Privacy Browser's default user agent is <code>PrivacyBrowser/1.0</code>.
 272         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>.
 273       </para>
 274
 275       <para>
 276         Over the years user agents have become quite lengthy,
 277         partially because they tend to include a <ulink url="https://webaim.org/blog/user-agent-string-history/">brief history of the internet</ulink>.
 278         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.
 279         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.
 280       </para>
 281
 282       <para>
 283         At some point in the future Privacy Browser will send no user agent by default.
 284         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),
 285         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.
 286         Getting rid of this relic of the internet is going to take some time and a retraining of common expectations.
 287       </para>
 288     </sect1>
 289
 290     <!-- Domain Settings. -->
 291     <sect1 id="domain-settings">
 292       <title>Domain Settings</title>
 293
 294       <para>
 295         Domain setting make it easy to automatically change JavaScript, local storage, user agent, and other settings when the domain changes.
 296         Domain settings for the current domain can be accessed through the domain settings button at the far right of the URL line edit.
 297         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.
 298       </para>
 299     </sect1>
 300
 301     <!-- Spell Checking. -->
 302     <sect1 id="spell-checking">
 303       <title>Spell Checking</title>
 304
 305       <para>
 306         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>
 307         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>.
 308         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.
 309       </para>
 310
 311       <para>
 312         Once a <filename>.bdic</filename> dictionary is installed, it can be enabled in Privacy Browser’s settings.
 313       </para>
 314     </sect1>
 315   </chapter>
 316
 317   <!-- Commands. -->
 318   <chapter id="commands">
 319     <title>Command Reference</title>
 320
 321     <!-- Main Window. -->
 322     <sect1 id="main-window">
 323       <title>Main Window</title>
 324
 325       <!-- File. -->
 326       <sect2>
 327         <title>File</title>
 328
 329         <variablelist>
 330           <!-- New Tab. -->
 331           <varlistentry id="file-new-tab">
 332             <term>
 333               <menuchoice>
 334                 <shortcut>
 335                   <keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo>
 336                 </shortcut>
 337                 <guimenu>File</guimenu>
 338                 <guimenuitem>New Tab</guimenuitem>
 339               </menuchoice>
 340             </term>
 341
 342             <listitem>
 343               <para>
 344                 Create a new tab.
 345               </para>
 346             </listitem>
 347           </varlistentry>
 348
 349           <!-- New Window. -->
 350           <varlistentry id="file-new-window">
 351             <term>
 352               <menuchoice>
 353                 <shortcut>
 354                   <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
 355                 </shortcut>
 356                 <guimenu>File</guimenu>
 357                 <guimenuitem>New Window</guimenuitem>
 358               </menuchoice>
 359             </term>
 360
 361             <listitem>
 362               <para>
 363                 Create a new window.
 364               </para>
 365             </listitem>
 366           </varlistentry>
 367
 368           <!-- Print. -->
 369           <varlistentry  id="file-print">
 370             <term>
 371               <menuchoice>
 372                 <shortcut>
 373                   <keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
 374                 </shortcut>
 375                 <guimenu>File</guimenu>
 376                 <guimenuitem>Print</guimenuitem>
 377               </menuchoice>
 378             </term>
 379
 380             <listitem>
 381               <para>
 382                 Print the document.
 383               </para>
 384             </listitem>
 385           </varlistentry>
 386
 387           <!-- Print Preview. -->
 388           <varlistentry  id="file-print-preview">
 389             <term>
 390               <menuchoice>
 391                 <shortcut>
 392                   <keycombo action="simul">&Ctrl;&Shift;<keycap>P</keycap></keycombo>
 393                 </shortcut>
 394                 <guimenu>File</guimenu>
 395                 <guimenuitem>Print Preview</guimenuitem>
 396               </menuchoice>
 397             </term>
 398
 399             <listitem>
 400               <para>
 401                 Display the print preview dialog.
 402               </para>
 403             </listitem>
 404           </varlistentry>
 405
 406           <!-- Quit. -->
 407           <varlistentry  id="file-quit">
 408             <term>
 409               <menuchoice>
 410                 <shortcut>
 411                   <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
 412                 </shortcut>
 413                 <guimenu>File</guimenu>
 414                 <guimenuitem>Quit</guimenuitem>
 415               </menuchoice>
 416             </term>
 417
 418             <listitem>
 419               <para>
 420                 Quit &privacybrowser;.
 421               </para>
 422             </listitem>
 423           </varlistentry>
 424         </variablelist>
 425       </sect2>
 426
 427       <!-- Edit. -->
 428       <sect2>
 429         <title>Edit</title>
 430
 431         <variablelist>
 432           <!-- Find. -->
 433           <varlistentry id="edit-find">
 434             <term>
 435               <menuchoice>
 436                 <shortcut>
 437                   <keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo>
 438                 </shortcut>
 439                 <guimenu>Edit</guimenu>
 440                 <guimenuitem>Find</guimenuitem>
 441               </menuchoice>
 442             </term>
 443
 444             <listitem>
 445               <para>
 446                 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.
 447               </para>
 448             </listitem>
 449           </varlistentry>
 450
 451
 452           <!-- Find Next. -->
 453           <varlistentry id="edit-find-next">
 454             <term>
 455               <menuchoice>
 456                 <shortcut>
 457                   <keycap>F3</keycap>
 458                 </shortcut>
 459                 <guimenu>Edit</guimenu>
 460                 <guimenuitem>Find Next</guimenuitem>
 461               </menuchoice>
 462             </term>
 463
 464             <listitem>
 465               <para>
 466                 Find the next entry on the page that matches the specified text. This action is only displayed if the find toolbar is visible.
 467               </para>
 468             </listitem>
 469           </varlistentry>
 470
 471           <!-- Find Previous. -->
 472           <varlistentry id="edit-find-previous">
 473             <term>
 474               <menuchoice>
 475                 <shortcut>
 476                   <keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo>
 477                 </shortcut>
 478                 <guimenu>Edit</guimenu>
 479                 <guimenuitem>Find Previous</guimenuitem>
 480               </menuchoice>
 481             </term>
 482
 483             <listitem>
 484               <para>
 485                 Find the previous entry on the page that matches the specified text. This action is only displayed if the find toolbar is visible.
 486               </para>
 487             </listitem>
 488           </varlistentry>
 489         </variablelist>
 490       </sect2>
 491
 492       <!-- View. -->
 493       <sect2>
 494         <title>View</title>
 495
 496         <variablelist>
 497           <!-- Refresh. -->
 498           <varlistentry id="view-refresh">
 499             <term>
 500               <menuchoice>
 501                 <shortcut>
 502                   <keycap>F5</keycap>
 503                 </shortcut>
 504                 <guimenu>View</guimenu>
 505                 <guimenuitem>Refresh</guimenuitem>
 506               </menuchoice>
 507             </term>
 508
 509             <listitem>
 510               <para>
 511                 Reload the website in the current tab.
 512               </para>
 513             </listitem>
 514           </varlistentry>
 515
 516           <!-- Full Screen Mode. -->
 517           <varlistentry id="view-full-screen-mode">
 518             <term>
 519               <menuchoice>
 520                 <shortcut>
 521                   <keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo>
 522                 </shortcut>
 523                 <guimenu>View</guimenu>
 524                 <guimenuitem>Full Screen Mode</guimenuitem>
 525               </menuchoice>
 526             </term>
 527
 528             <listitem>
 529               <para>
 530                 Toggle full screen mode. This performs the same action as <xref linkend="f11"/>.
 531               </para>
 532             </listitem>
 533           </varlistentry>
 534         </variablelist>
 535       </sect2>
 536
 537       <!-- Go. -->
 538       <sect2>
 539         <title>Go</title>
 540
 541         <variablelist>
 542           <!-- Back. -->
 543           <varlistentry id="go-back">
 544             <term>
 545               <menuchoice>
 546                 <shortcut>
 547                   <keycombo action="simul">&Alt;<keycap>Left</keycap></keycombo>
 548                 </shortcut>
 549                 <guimenu>Go</guimenu>
 550                 <guimenuitem>Back</guimenuitem>
 551               </menuchoice>
 552             </term>
 553
 554             <listitem>
 555               <para>
 556                 Navigate back one step in the current tab’s history. The action is disabled if it is not possible to go back.
 557               </para>
 558             </listitem>
 559           </varlistentry>
 560
 561           <!-- Forward. -->
 562           <varlistentry id="go-forward">
 563             <term>
 564               <menuchoice>
 565                 <shortcut>
 566                   <keycombo action="simul">&Alt;<keycap>Right</keycap></keycombo>
 567                 </shortcut>
 568                 <guimenu>Go</guimenu>
 569                 <guimenuitem>Forward</guimenuitem>
 570               </menuchoice>
 571             </term>
 572
 573             <listitem>
 574               <para>
 575                 Navigate forward one step in the current tab’s history. The action is disabled if it is not possible to go forward.
 576               </para>
 577             </listitem>
 578           </varlistentry>
 579
 580           <!-- Home. -->
 581           <varlistentry id="go-home">
 582             <term>
 583               <menuchoice>
 584                 <shortcut>
 585                   <keycombo action="simul">&Alt;<keycap>Home</keycap></keycombo>
 586                 </shortcut>
 587                 <guimenu>Go</guimenu>
 588                 <guimenuitem>Home</guimenuitem>
 589               </menuchoice>
 590             </term>
 591
 592             <listitem>
 593               <para>
 594                 Load the home page in the current tab.
 595               </para>
 596             </listitem>
 597           </varlistentry>
 598         </variablelist>
 599       </sect2>
 600
 601       <!-- On-The-Fly Settings. -->
 602       <sect2>
 603         <title>On-The-Fly Settings</title>
 604
 605         <!-- User Agent. -->
 606         <sect3>
 607           <title>User Agent</title>
 608
 609           <variablelist>
 610             <!-- Privacy Browser. -->
 611             <varlistentry id="user-agent-privacy-browser">
 612               <term>
 613                 <menuchoice>
 614                   <shortcut>
 615                     <keycombo action="simul">&Ctrl;&Alt;<keycap>P</keycap></keycombo>
 616                   </shortcut>
 617                   <guimenu>On-The-Fly Settings</guimenu>
 618                   <guisubmenu>User Agent</guisubmenu>
 619                   <guimenuitem>Privacy Browser</guimenuitem>
 620                 </menuchoice>
 621               </term>
 622
 623               <listitem>
 624                 <para>
 625                   Use the Privacy Browser user agent for the current tab.
 626                 </para>
 627               </listitem>
 628             </varlistentry>
 629
 630             <!-- WebEngine Default. -->
 631             <varlistentry id="user-agent-webengine-default">
 632               <term>
 633                 <menuchoice>
 634                   <shortcut>
 635                     <keycombo action="simul">&Ctrl;&Alt;<keycap>W</keycap></keycombo>
 636                   </shortcut>
 637                   <guimenu>On-The-Fly Settings</guimenu>
 638                   <guisubmenu>User Agent</guisubmenu>
 639                   <guimenuitem>WebEngine Default</guimenuitem>
 640                 </menuchoice>
 641               </term>
 642
 643               <listitem>
 644                 <para>
 645                   Use the WebEngine Default user agent for the current tab.
 646                 </para>
 647               </listitem>
 648             </varlistentry>
 649
 650             <!-- Firefox on Linux. -->
 651             <varlistentry id="user-agent-firefox-linux">
 652               <term>
 653                 <menuchoice>
 654                   <shortcut>
 655                     <keycombo action="simul">&Ctrl;&Alt;<keycap>F</keycap></keycombo>
 656                   </shortcut>
 657                   <guimenu>On-The-Fly Settings</guimenu>
 658                   <guisubmenu>User Agent</guisubmenu>
 659                   <guimenuitem>Firefox on Linux</guimenuitem>
 660                 </menuchoice>
 661               </term>
 662
 663               <listitem>
 664                 <para>
 665                   Use the Firefox on Linux user agent for the current tab.
 666                 </para>
 667               </listitem>
 668             </varlistentry>
 669
 670             <!-- Chromium on Linux. -->
 671             <varlistentry id="user-agent-chromium-linux">
 672               <term>
 673                 <menuchoice>
 674                   <shortcut>
 675                     <keycombo action="simul">&Ctrl;&Alt;<keycap>C</keycap></keycombo>
 676                   </shortcut>
 677                   <guimenu>On-The-Fly Settings</guimenu>
 678                   <guisubmenu>User Agent</guisubmenu>
 679                   <guimenuitem>Chromium on Linux</guimenuitem>
 680                 </menuchoice>
 681               </term>
 682
 683               <listitem>
 684                 <para>
 685                   Use the Chromium on Linux user agent for the current tab.
 686                 </para>
 687               </listitem>
 688             </varlistentry>
 689
 690             <!-- Firefox on Windows. -->
 691             <varlistentry id="user-agent-firefox-windows">
 692               <term>
 693                 <menuchoice>
 694                   <shortcut>
 695                     <keycombo action="simul">&Ctrl;&Alt;&Shift;<keycap>F</keycap></keycombo>
 696                   </shortcut>
 697                   <guimenu>On-The-Fly Settings</guimenu>
 698                   <guisubmenu>User Agent</guisubmenu>
 699                   <guimenuitem>Firefox on Windows</guimenuitem>
 700                 </menuchoice>
 701               </term>
 702
 703               <listitem>
 704                 <para>
 705                   Use the Firefox on Windows user agent for the current tab.
 706                 </para>
 707               </listitem>
 708             </varlistentry>
 709
 710             <!-- Chrome on Windows. -->
 711             <varlistentry id="user-agent-chrome-windows">
 712               <term>
 713                 <menuchoice>
 714                   <shortcut>
 715                     <keycombo action="simul">&Ctrl;&Alt;&Shift;<keycap>C</keycap></keycombo>
 716                   </shortcut>
 717                   <guimenu>On-The-Fly Settings</guimenu>
 718                   <guisubmenu>User Agent</guisubmenu>
 719                   <guimenuitem>Chrome on Windows</guimenuitem>
 720                 </menuchoice>
 721               </term>
 722
 723               <listitem>
 724                 <para>
 725                   Use the Chrome on Windows user agent for the current tab.
 726                 </para>
 727               </listitem>
 728             </varlistentry>
 729
 730             <!-- Edge on Windows. -->
 731             <varlistentry id="user-agent-edge-windows">
 732               <term>
 733                 <menuchoice>
 734                   <shortcut>
 735                     <keycombo action="simul">&Ctrl;&Alt;<keycap>E</keycap></keycombo>
 736                   </shortcut>
 737                   <guimenu>On-The-Fly Settings</guimenu>
 738                   <guisubmenu>User Agent</guisubmenu>
 739                   <guimenuitem>Edge on Windows</guimenuitem>
 740                 </menuchoice>
 741               </term>
 742
 743               <listitem>
 744                 <para>
 745                   Use the Edge on Windows user agent for the current tab.
 746                 </para>
 747               </listitem>
 748             </varlistentry>
 749
 750             <!-- Safari on macOS. -->
 751             <varlistentry id="user-agent-safari-macOS">
 752               <term>
 753                 <menuchoice>
 754                   <shortcut>
 755                     <keycombo action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo>
 756                   </shortcut>
 757                   <guimenu>On-The-Fly Settings</guimenu>
 758                   <guisubmenu>User Agent</guisubmenu>
 759                   <guimenuitem>Safari on macOS</guimenuitem>
 760                 </menuchoice>
 761               </term>
 762
 763               <listitem>
 764                 <para>
 765                   Use the Safari on macOS user agent for the current tab.
 766                 </para>
 767               </listitem>
 768             </varlistentry>
 769
 770             <!-- Custom User Agent. -->
 771             <varlistentry id="user-agent-custom">
 772               <term>
 773                 <menuchoice>
 774                   <shortcut>
 775                     <keycombo action="simul">&Alt;&Shift;<keycap>C</keycap></keycombo>
 776                   </shortcut>
 777                   <guimenu>On-The-Fly Settings</guimenu>
 778                   <guisubmenu>User Agent</guisubmenu>
 779                   <guimenuitem>Custom</guimenuitem>
 780                 </menuchoice>
 781               </term>
 782
 783               <listitem>
 784                 <para>
 785                   Use the custom user agent for the current tab. This action is only active if a custom user agent is set in the settings.
 786                 </para>
 787               </listitem>
 788             </varlistentry>
 789           </variablelist>
 790         </sect3>
 791
 792         <!-- Zoom. -->
 793         <sect3>
 794           <title>Zoom</title>
 795
 796           <variablelist>
 797             <!-- Zoom Factor. -->
 798             <varlistentry id="on-the-fly-settings-zoom-factor">
 799               <term>
 800                 <menuchoice>
 801                   <shortcut>
 802                     <keycombo action="simul">&Ctrl;&Alt;<keycap>Z</keycap></keycombo>
 803                   </shortcut>
 804                   <guimenu>On-The-Fly Settings</guimenu>
 805                   <guimenuitem>Zoom Factor</guimenuitem>
 806                 </menuchoice>
 807               </term>
 808
 809               <listitem>
 810                 <para>
 811                   Display the zoom factor dialog.
 812                 </para>
 813               </listitem>
 814             </varlistentry>
 815           </variablelist>
 816         </sect3>
 817
 818         <!-- Search Engine. -->
 819         <sect3>
 820           <title>Search Engine</title>
 821
 822           <variablelist>
 823             <!-- Mojeek. -->
 824             <varlistentry id="search-engine-mojeek">
 825               <term>
 826                 <menuchoice>
 827                   <shortcut>
 828                     <keycombo action="simul">&Ctrl;&Shift;<keycap>M</keycap></keycombo>
 829                   </shortcut>
 830                   <guimenu>On-The-Fly Settings</guimenu>
 831                   <guisubmenu>Search Engine</guisubmenu>
 832                   <guimenuitem>Mojeek</guimenuitem>
 833                 </menuchoice>
 834               </term>
 835
 836               <listitem>
 837                 <para>
 838                   Use Mojeek as the search engine.
 839                 </para>
 840               </listitem>
 841             </varlistentry>
 842
 843             <!-- Monocles. -->
 844             <varlistentry id="search-engine-monocles">
 845               <term>
 846                 <menuchoice>
 847                   <shortcut>
 848                     <keycombo action="simul">&Ctrl;&Shift;<keycap>O</keycap></keycombo>
 849                   </shortcut>
 850                   <guimenu>On-The-Fly Settings</guimenu>
 851                   <guisubmenu>Search Engine</guisubmenu>
 852                   <guimenuitem>Monocles</guimenuitem>
 853                 </menuchoice>
 854               </term>
 855
 856               <listitem>
 857                 <para>
 858                   Use Mojeek as the search engine.
 859                 </para>
 860               </listitem>
 861             </varlistentry>
 862
 863             <!-- MetaGer. -->
 864             <varlistentry id="search-engine-metager">
 865               <term>
 866                 <menuchoice>
 867                   <shortcut>
 868                     <keycombo action="simul">&Ctrl;&Shift;<keycap>E</keycap></keycombo>
 869                   </shortcut>
 870                   <guimenu>On-The-Fly Settings</guimenu>
 871                   <guisubmenu>Search Engine</guisubmenu>
 872                   <guimenuitem>MetaGer</guimenuitem>
 873                 </menuchoice>
 874               </term>
 875
 876               <listitem>
 877                 <para>
 878                   Use MetaGer as the search engine.
 879                 </para>
 880               </listitem>
 881             </varlistentry>
 882
 883             <!-- Google. -->
 884             <varlistentry id="search-engine-google">
 885               <term>
 886                 <menuchoice>
 887                   <shortcut>
 888                     <keycombo action="simul">&Ctrl;&Shift;<keycap>G</keycap></keycombo>
 889                   </shortcut>
 890                   <guimenu>On-The-Fly Settings</guimenu>
 891                   <guisubmenu>Search Engine</guisubmenu>
 892                   <guimenuitem>Google</guimenuitem>
 893                 </menuchoice>
 894               </term>
 895
 896               <listitem>
 897                 <para>
 898                   Use Google as the search engine.
 899                 </para>
 900               </listitem>
 901             </varlistentry>
 902
 903             <!-- Bing. -->
 904             <varlistentry id="search-engine-bing">
 905               <term>
 906                 <menuchoice>
 907                   <shortcut>
 908                     <keycombo action="simul">&Ctrl;&Shift;<keycap>B</keycap></keycombo>
 909                   </shortcut>
 910                   <guimenu>On-The-Fly Settings</guimenu>
 911                   <guisubmenu>Search Engine</guisubmenu>
 912                   <guimenuitem>Bing</guimenuitem>
 913                 </menuchoice>
 914               </term>
 915
 916               <listitem>
 917                 <para>
 918                   Use Bing as the search engine.
 919                 </para>
 920               </listitem>
 921             </varlistentry>
 922
 923             <!-- Yahoo. -->
 924             <varlistentry id="search-engine-yahoo">
 925               <term>
 926                 <menuchoice>
 927                   <shortcut>
 928                     <keycombo action="simul">&Ctrl;&Shift;<keycap>Y</keycap></keycombo>
 929                   </shortcut>
 930                   <guimenu>On-The-Fly Settings</guimenu>
 931                   <guisubmenu>Search Engine</guisubmenu>
 932                   <guimenuitem>Yahoo</guimenuitem>
 933                 </menuchoice>
 934               </term>
 935
 936               <listitem>
 937                 <para>
 938                   Use Yahoo as the search engine.
 939                 </para>
 940               </listitem>
 941             </varlistentry>
 942
 943             <!-- Custom Search Engine. -->
 944             <varlistentry id="search-engine-custom">
 945               <term>
 946                 <menuchoice>
 947                   <shortcut>
 948                     <keycombo action="simul">&Ctrl;&Shift;<keycap>C</keycap></keycombo>
 949                   </shortcut>
 950                   <guimenu>On-The-Fly Settings</guimenu>
 951                   <guisubmenu>Search Engine</guisubmenu>
 952                   <guimenuitem>Custom</guimenuitem>
 953                 </menuchoice>
 954               </term>
 955
 956               <listitem>
 957                 <para>
 958                   Use the custom search engine. This action is only active if a custom search engine is set in the settings.
 959                 </para>
 960               </listitem>
 961             </varlistentry>
 962           </variablelist>
 963         </sect3>
 964       </sect2>
 965
 966       <!-- Settings. -->
 967       <sect2>
 968         <title>Settings</title>
 969
 970         <variablelist>
 971           <!-- Domain Settings. -->
 972           <varlistentry id="settings-domain-settings">
 973             <term>
 974               <menuchoice>
 975                 <shortcut>
 976                   <keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo>
 977                 </shortcut>
 978                 <guimenu>Settings</guimenu>
 979                 <guimenuitem>Domain Settings</guimenuitem>
 980               </menuchoice>
 981             </term>
 982
 983             <listitem>
 984               <para>
 985                 Display the domain settings dialog.
 986               </para>
 987             </listitem>
 988           </varlistentry>
 989
 990
 991           <!-- Cookies. -->
 992           <varlistentry id="settings-cookies">
 993             <term>
 994               <menuchoice>
 995                 <shortcut>
 996                   <keycombo action="simul">&Ctrl;<keycap>;</keycap></keycombo>
 997                 </shortcut>
 998                 <guimenu>Settings</guimenu>
 999                 <guimenuitem>Cookies</guimenuitem>
1000               </menuchoice>
1001             </term>
1002
1003             <listitem>
1004               <para>
1005                 Display the cookies dialog.
1006               </para>
1007             </listitem>
1008           </varlistentry>
1009         </variablelist>
1010       </sect2>
1011
1012       <!-- Common Settings and Help Entries. -->
1013       <sect2 id="common-settings-help-menus">
1014         <title>Common Settings and Help Entries</title>
1015
1016         <para>
1017           &privacybrowser; has many common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu> menu items.
1018           For more information read the sections about the <ulink url="help:/fundamentals/ui.html#menus-settings">Settings Menu</ulink>
1019           and <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink>.
1020         </para>
1021       </sect2>
1022
1023       <!-- Other Commands. -->
1024       <sect2>
1025         <title>Other Commands</title>
1026
1027         <variablelist>
1028           <!-- F11. -->
1029           <varlistentry id="f11">
1030             <term>
1031               <command>
1032                 <keycap>F11</keycap>
1033               </command>
1034             </term>
1035
1036             <listitem>
1037               <para>
1038                 Toggle full screen mode. This performs the same action as <xref linkend="view-full-screen-mode"/>.
1039               </para>
1040             </listitem>
1041           </varlistentry>
1042
1043           <!-- Escape. -->
1044           <varlistentry id="escape">
1045             <term>
1046               <command>
1047                 <keycap>&Esc;</keycap>
1048               </command>
1049             </term>
1050
1051             <listitem>
1052               <para>
1053                 Escape runs the first command that applies from the following list.
1054               </para>
1055
1056               <itemizedlist>
1057                 <listitem>
1058                   <para>
1059                     Exit full screen browsing.
1060                   </para>
1061                 </listitem>
1062
1063                 <listitem>
1064                   <para>
1065                     Clear the find text line edit and the find text highlights.
1066                   </para>
1067                 </listitem>
1068
1069                 <listitem>
1070                   <para>
1071                     Hide the find text toolbar.
1072                   </para>
1073                 </listitem>
1074               </itemizedlist>
1075             </listitem>
1076           </varlistentry>
1077         </variablelist>
1078       </sect2>
1079     </sect1>
1080
1081     <!-- Cookies Dialog. -->
1082     <sect1 id="cookies-dialog">
1083       <title>Cookies Dialog</title>
1084
1085       <para>
1086         The cookies dialog is accessed through <xref linkend="settings-cookies"/> (see <xref linkend="cookies"/>).
1087       </para>
1088
1089       <sect2 id="cookies-dialog-commands">
1090         <title>Commands</title>
1091
1092         <variablelist>
1093           <!-- Add Cookie. -->
1094           <varlistentry id="add-cookie">
1095             <term>
1096               <command>
1097                 <keycap>A</keycap>
1098               </command>
1099             </term>
1100
1101             <listitem>
1102               <para>
1103                 Open the add cookie dialog.
1104               </para>
1105             </listitem>
1106           </varlistentry>
1107
1108           <!-- Edit Cookie. -->
1109           <varlistentry id="edit-cookie">
1110             <term>
1111               <command>
1112                 <keycap>E</keycap>
1113               </command>
1114             </term>
1115
1116             <listitem>
1117               <para>
1118                 Open the edit cookie dialog. This command is only valid if a cookie is currently selected.
1119               </para>
1120             </listitem>
1121           </varlistentry>
1122
1123           <!-- Delete Cookies. -->
1124           <varlistentry id="delete-cookies">
1125             <term>
1126               <command>
1127                 <keycap>D</keycap> or <keycap>&Del;</keycap>
1128               </command>
1129             </term>
1130
1131             <listitem>
1132               <para>
1133                 Delete the currently selected cookies. A dialog will confirm the deletion before it is processed.
1134               </para>
1135             </listitem>
1136           </varlistentry>
1137
1138           <!-- Delete All Cookies. -->
1139           <varlistentry id="delete-all-cookie">
1140             <term>
1141               <command>
1142                 <keycap>L</keycap>
1143               </command>
1144             </term>
1145
1146             <listitem>
1147               <para>
1148                 Delete all the cookies. A dialog will confirm the deletion before it is processed.
1149               </para>
1150             </listitem>
1151           </varlistentry>
1152
1153           <!-- Close. -->
1154           <varlistentry id="close-cookies-dialog">
1155             <term>
1156               <command>
1157                 <keycap>C</keycap> or <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
1158               </command>
1159             </term>
1160
1161             <listitem>
1162               <para>
1163                 Close the cookies dialog.
1164               </para>
1165             </listitem>
1166           </varlistentry>
1167         </variablelist>
1168       </sect2>
1169     </sect1>
1170
1171     <!-- Save Dialog. -->
1172     <sect1 id="save-dialog">
1173       <title>Save Dialog</title>
1174
1175       <para>
1176         The save dialog pops up when a download is initiated.
1177       </para>
1178
1179       <sect2 id="save-dialog-commands">
1180         <title>Commands</title>
1181
1182         <variablelist>
1183           <!-- Save. -->
1184           <varlistentry id="save-dialog-save">
1185             <term>
1186               <command>
1187                 <keycap>S</keycap>
1188               </command>
1189             </term>
1190
1191             <listitem>
1192               <para>
1193                 Save the file.
1194               </para>
1195             </listitem>
1196           </varlistentry>
1197
1198           <!-- Close. -->
1199           <varlistentry id="save-dialog-close">
1200             <term>
1201               <command>
1202                 <keycap>C</keycap> or <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
1203               </command>
1204             </term>
1205
1206             <listitem>
1207               <para>
1208                 Close the save dialog without saving the file.
1209               </para>
1210             </listitem>
1211           </varlistentry>
1212         </variablelist>
1213       </sect2>
1214     </sect1>
1215   </chapter>
1216
1217   <!-- FAQ. -->
1218   <chapter id="faq">
1219     <title>Questions and Answers</title>
1220
1221     <qandaset id="faqlist">
1222       <qandaentry>
1223         <!-- Why are there no questions. -->
1224         <question>
1225           <para>Why are there no questions?</para>
1226         </question>
1227
1228         <answer>
1229           <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>
1230         </answer>
1231       </qandaentry>
1232     </qandaset>
1233   </chapter>
1234
1235   <!-- Credits. -->
1236   <chapter id="credits">
1237     <title>Credits and License</title>
1238
1239     <para>
1240       Program copyright 2016-2017,2021-2023 Soren Stoutner <ulink url="mailto:soren@stoutner.com">soren@stoutner.com</ulink>.
1241     </para>
1242
1243     <para>
1244       Translators:
1245       <itemizedlist>
1246         <listitem><para>Translations will be added in a future release.</para></listitem>
1247       </itemizedlist>
1248     </para>
1249
1250     <!-- The program license. -->
1251     &underGPL;
1252
1253     <para>
1254       Documentation copyright 2023 Soren Stoutner <ulink url="mailto:soren@stoutner.com">soren@stoutner.com</ulink>.
1255     </para>
1256
1257     <!-- The documentation license. -->
1258     &underFDL;
1259   </chapter>
1260 </book>