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.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     <!-- Spell Checking. -->
 306     <sect1 id="spell-checking">
 307       <title>Spell Checking</title>
 308
 309       <para>
 310         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>
 311         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>.
 312         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.
 313       </para>
 314
 315       <para>
 316         Once a <filename>.bdic</filename> dictionary is installed, it can be enabled in Privacy Browser’s settings.
 317       </para>
 318     </sect1>
 319   </chapter>
 320
 321   <!-- Commands. -->
 322   <chapter id="commands">
 323     <title>Command Reference</title>
 324
 325     <!-- Main Window. -->
 326     <sect1 id="main-window">
 327       <title>Main Window</title>
 328
 329       <!-- File. -->
 330       <sect2>
 331         <title>File</title>
 332
 333         <variablelist>
 334           <!-- New Tab. -->
 335           <varlistentry id="file-new-tab">
 336             <term>
 337               <menuchoice>
 338                 <shortcut>
 339                   <keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo>
 340                 </shortcut>
 341                 <guimenu>File</guimenu>
 342                 <guimenuitem>New Tab</guimenuitem>
 343               </menuchoice>
 344             </term>
 345
 346             <listitem>
 347               <para>
 348                 Create a new tab.
 349               </para>
 350             </listitem>
 351           </varlistentry>
 352
 353           <!-- New Window. -->
 354           <varlistentry id="file-new-window">
 355             <term>
 356               <menuchoice>
 357                 <shortcut>
 358                   <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
 359                 </shortcut>
 360                 <guimenu>File</guimenu>
 361                 <guimenuitem>New Window</guimenuitem>
 362               </menuchoice>
 363             </term>
 364
 365             <listitem>
 366               <para>
 367                 Create a new window.
 368               </para>
 369             </listitem>
 370           </varlistentry>
 371
 372           <!-- Print. -->
 373           <varlistentry  id="file-print">
 374             <term>
 375               <menuchoice>
 376                 <shortcut>
 377                   <keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
 378                 </shortcut>
 379                 <guimenu>File</guimenu>
 380                 <guimenuitem>Print</guimenuitem>
 381               </menuchoice>
 382             </term>
 383
 384             <listitem>
 385               <para>
 386                 Print the document.
 387               </para>
 388             </listitem>
 389           </varlistentry>
 390
 391           <!-- Print Preview. -->
 392           <varlistentry  id="file-print-preview">
 393             <term>
 394               <menuchoice>
 395                 <shortcut>
 396                   <keycombo action="simul">&Ctrl;&Shift;<keycap>P</keycap></keycombo>
 397                 </shortcut>
 398                 <guimenu>File</guimenu>
 399                 <guimenuitem>Print Preview</guimenuitem>
 400               </menuchoice>
 401             </term>
 402
 403             <listitem>
 404               <para>
 405                 Display the print preview dialog.
 406               </para>
 407             </listitem>
 408           </varlistentry>
 409
 410           <!-- Quit. -->
 411           <varlistentry  id="file-quit">
 412             <term>
 413               <menuchoice>
 414                 <shortcut>
 415                   <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
 416                 </shortcut>
 417                 <guimenu>File</guimenu>
 418                 <guimenuitem>Quit</guimenuitem>
 419               </menuchoice>
 420             </term>
 421
 422             <listitem>
 423               <para>
 424                 Quit &privacybrowser;.
 425               </para>
 426             </listitem>
 427           </varlistentry>
 428         </variablelist>
 429       </sect2>
 430
 431       <!-- Edit. -->
 432       <sect2>
 433         <title>Edit</title>
 434
 435         <variablelist>
 436           <!-- Find. -->
 437           <varlistentry id="edit-find">
 438             <term>
 439               <menuchoice>
 440                 <shortcut>
 441                   <keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo>
 442                 </shortcut>
 443                 <guimenu>Edit</guimenu>
 444                 <guimenuitem>Find</guimenuitem>
 445               </menuchoice>
 446             </term>
 447
 448             <listitem>
 449               <para>
 450                 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.
 451               </para>
 452             </listitem>
 453           </varlistentry>
 454
 455
 456           <!-- Find Next. -->
 457           <varlistentry id="edit-find-next">
 458             <term>
 459               <menuchoice>
 460                 <shortcut>
 461                   <keycap>F3</keycap>
 462                 </shortcut>
 463                 <guimenu>Edit</guimenu>
 464                 <guimenuitem>Find Next</guimenuitem>
 465               </menuchoice>
 466             </term>
 467
 468             <listitem>
 469               <para>
 470                 Find the next entry on the page that matches the specified text. This action is only displayed if the find toolbar is visible.
 471               </para>
 472             </listitem>
 473           </varlistentry>
 474
 475           <!-- Find Previous. -->
 476           <varlistentry id="edit-find-previous">
 477             <term>
 478               <menuchoice>
 479                 <shortcut>
 480                   <keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo>
 481                 </shortcut>
 482                 <guimenu>Edit</guimenu>
 483                 <guimenuitem>Find Previous</guimenuitem>
 484               </menuchoice>
 485             </term>
 486
 487             <listitem>
 488               <para>
 489                 Find the previous 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         </variablelist>
 494       </sect2>
 495
 496       <!-- View. -->
 497       <sect2>
 498         <title>View</title>
 499
 500         <variablelist>
 501           <!-- Refresh. -->
 502           <varlistentry id="view-refresh">
 503             <term>
 504               <menuchoice>
 505                 <shortcut>
 506                   <keycap>F5</keycap>
 507                 </shortcut>
 508                 <guimenu>View</guimenu>
 509                 <guimenuitem>Refresh</guimenuitem>
 510               </menuchoice>
 511             </term>
 512
 513             <listitem>
 514               <para>
 515                 Reload the website in the current tab.
 516               </para>
 517             </listitem>
 518           </varlistentry>
 519
 520           <!-- Full Screen Mode. -->
 521           <varlistentry id="view-full-screen-mode">
 522             <term>
 523               <menuchoice>
 524                 <shortcut>
 525                   <keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo>
 526                 </shortcut>
 527                 <guimenu>View</guimenu>
 528                 <guimenuitem>Full Screen Mode</guimenuitem>
 529               </menuchoice>
 530             </term>
 531
 532             <listitem>
 533               <para>
 534                 Toggle full screen mode. This performs the same action as <xref linkend="f11"/>.
 535               </para>
 536             </listitem>
 537           </varlistentry>
 538         </variablelist>
 539       </sect2>
 540
 541       <!-- Go. -->
 542       <sect2>
 543         <title>Go</title>
 544
 545         <variablelist>
 546           <!-- Back. -->
 547           <varlistentry id="go-back">
 548             <term>
 549               <menuchoice>
 550                 <shortcut>
 551                   <keycombo action="simul">&Alt;<keycap>Left</keycap></keycombo>
 552                 </shortcut>
 553                 <guimenu>Go</guimenu>
 554                 <guimenuitem>Back</guimenuitem>
 555               </menuchoice>
 556             </term>
 557
 558             <listitem>
 559               <para>
 560                 Navigate back one step in the current tab’s history. The action is disabled if it is not possible to go back.
 561               </para>
 562             </listitem>
 563           </varlistentry>
 564
 565           <!-- Forward. -->
 566           <varlistentry id="go-forward">
 567             <term>
 568               <menuchoice>
 569                 <shortcut>
 570                   <keycombo action="simul">&Alt;<keycap>Right</keycap></keycombo>
 571                 </shortcut>
 572                 <guimenu>Go</guimenu>
 573                 <guimenuitem>Forward</guimenuitem>
 574               </menuchoice>
 575             </term>
 576
 577             <listitem>
 578               <para>
 579                 Navigate forward one step in the current tab’s history. The action is disabled if it is not possible to go forward.
 580               </para>
 581             </listitem>
 582           </varlistentry>
 583
 584           <!-- Home. -->
 585           <varlistentry id="go-home">
 586             <term>
 587               <menuchoice>
 588                 <shortcut>
 589                   <keycombo action="simul">&Alt;<keycap>Home</keycap></keycombo>
 590                 </shortcut>
 591                 <guimenu>Go</guimenu>
 592                 <guimenuitem>Home</guimenuitem>
 593               </menuchoice>
 594             </term>
 595
 596             <listitem>
 597               <para>
 598                 Load the home page in the current tab.
 599               </para>
 600             </listitem>
 601           </varlistentry>
 602         </variablelist>
 603       </sect2>
 604
 605       <!-- On-The-Fly Settings. -->
 606       <sect2>
 607         <title>On-The-Fly Settings</title>
 608
 609         <!-- User Agent. -->
 610         <sect3>
 611           <title>User Agent</title>
 612
 613           <variablelist>
 614             <!-- Privacy Browser. -->
 615             <varlistentry id="user-agent-privacy-browser">
 616               <term>
 617                 <menuchoice>
 618                   <shortcut>
 619                     <keycombo action="simul">&Ctrl;&Alt;<keycap>P</keycap></keycombo>
 620                   </shortcut>
 621                   <guimenu>On-The-Fly Settings</guimenu>
 622                   <guisubmenu>User Agent</guisubmenu>
 623                   <guimenuitem>Privacy Browser</guimenuitem>
 624                 </menuchoice>
 625               </term>
 626
 627               <listitem>
 628                 <para>
 629                   Use the Privacy Browser user agent for the current tab.
 630                 </para>
 631               </listitem>
 632             </varlistentry>
 633
 634             <!-- WebEngine Default. -->
 635             <varlistentry id="user-agent-webengine-default">
 636               <term>
 637                 <menuchoice>
 638                   <shortcut>
 639                     <keycombo action="simul">&Ctrl;&Alt;<keycap>W</keycap></keycombo>
 640                   </shortcut>
 641                   <guimenu>On-The-Fly Settings</guimenu>
 642                   <guisubmenu>User Agent</guisubmenu>
 643                   <guimenuitem>WebEngine Default</guimenuitem>
 644                 </menuchoice>
 645               </term>
 646
 647               <listitem>
 648                 <para>
 649                   Use the WebEngine Default user agent for the current tab.
 650                 </para>
 651               </listitem>
 652             </varlistentry>
 653
 654             <!-- Firefox on Linux. -->
 655             <varlistentry id="user-agent-firefox-linux">
 656               <term>
 657                 <menuchoice>
 658                   <shortcut>
 659                     <keycombo action="simul">&Ctrl;&Alt;<keycap>F</keycap></keycombo>
 660                   </shortcut>
 661                   <guimenu>On-The-Fly Settings</guimenu>
 662                   <guisubmenu>User Agent</guisubmenu>
 663                   <guimenuitem>Firefox on Linux</guimenuitem>
 664                 </menuchoice>
 665               </term>
 666
 667               <listitem>
 668                 <para>
 669                   Use the Firefox on Linux user agent for the current tab.
 670                 </para>
 671               </listitem>
 672             </varlistentry>
 673
 674             <!-- Chromium on Linux. -->
 675             <varlistentry id="user-agent-chromium-linux">
 676               <term>
 677                 <menuchoice>
 678                   <shortcut>
 679                     <keycombo action="simul">&Ctrl;&Alt;<keycap>C</keycap></keycombo>
 680                   </shortcut>
 681                   <guimenu>On-The-Fly Settings</guimenu>
 682                   <guisubmenu>User Agent</guisubmenu>
 683                   <guimenuitem>Chromium on Linux</guimenuitem>
 684                 </menuchoice>
 685               </term>
 686
 687               <listitem>
 688                 <para>
 689                   Use the Chromium on Linux user agent for the current tab.
 690                 </para>
 691               </listitem>
 692             </varlistentry>
 693
 694             <!-- Firefox on Windows. -->
 695             <varlistentry id="user-agent-firefox-windows">
 696               <term>
 697                 <menuchoice>
 698                   <shortcut>
 699                     <keycombo action="simul">&Ctrl;&Alt;&Shift;<keycap>F</keycap></keycombo>
 700                   </shortcut>
 701                   <guimenu>On-The-Fly Settings</guimenu>
 702                   <guisubmenu>User Agent</guisubmenu>
 703                   <guimenuitem>Firefox on Windows</guimenuitem>
 704                 </menuchoice>
 705               </term>
 706
 707               <listitem>
 708                 <para>
 709                   Use the Firefox on Windows user agent for the current tab.
 710                 </para>
 711               </listitem>
 712             </varlistentry>
 713
 714             <!-- Chrome on Windows. -->
 715             <varlistentry id="user-agent-chrome-windows">
 716               <term>
 717                 <menuchoice>
 718                   <shortcut>
 719                     <keycombo action="simul">&Ctrl;&Alt;&Shift;<keycap>C</keycap></keycombo>
 720                   </shortcut>
 721                   <guimenu>On-The-Fly Settings</guimenu>
 722                   <guisubmenu>User Agent</guisubmenu>
 723                   <guimenuitem>Chrome on Windows</guimenuitem>
 724                 </menuchoice>
 725               </term>
 726
 727               <listitem>
 728                 <para>
 729                   Use the Chrome on Windows user agent for the current tab.
 730                 </para>
 731               </listitem>
 732             </varlistentry>
 733
 734             <!-- Edge on Windows. -->
 735             <varlistentry id="user-agent-edge-windows">
 736               <term>
 737                 <menuchoice>
 738                   <shortcut>
 739                     <keycombo action="simul">&Ctrl;&Alt;<keycap>E</keycap></keycombo>
 740                   </shortcut>
 741                   <guimenu>On-The-Fly Settings</guimenu>
 742                   <guisubmenu>User Agent</guisubmenu>
 743                   <guimenuitem>Edge on Windows</guimenuitem>
 744                 </menuchoice>
 745               </term>
 746
 747               <listitem>
 748                 <para>
 749                   Use the Edge on Windows user agent for the current tab.
 750                 </para>
 751               </listitem>
 752             </varlistentry>
 753
 754             <!-- Safari on macOS. -->
 755             <varlistentry id="user-agent-safari-macOS">
 756               <term>
 757                 <menuchoice>
 758                   <shortcut>
 759                     <keycombo action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo>
 760                   </shortcut>
 761                   <guimenu>On-The-Fly Settings</guimenu>
 762                   <guisubmenu>User Agent</guisubmenu>
 763                   <guimenuitem>Safari on macOS</guimenuitem>
 764                 </menuchoice>
 765               </term>
 766
 767               <listitem>
 768                 <para>
 769                   Use the Safari on macOS user agent for the current tab.
 770                 </para>
 771               </listitem>
 772             </varlistentry>
 773
 774             <!-- Custom User Agent. -->
 775             <varlistentry id="user-agent-custom">
 776               <term>
 777                 <menuchoice>
 778                   <shortcut>
 779                     <keycombo action="simul">&Alt;&Shift;<keycap>C</keycap></keycombo>
 780                   </shortcut>
 781                   <guimenu>On-The-Fly Settings</guimenu>
 782                   <guisubmenu>User Agent</guisubmenu>
 783                   <guimenuitem>Custom</guimenuitem>
 784                 </menuchoice>
 785               </term>
 786
 787               <listitem>
 788                 <para>
 789                   Use the custom user agent for the current tab. This action is only active if a custom user agent is set in the settings.
 790                 </para>
 791               </listitem>
 792             </varlistentry>
 793           </variablelist>
 794         </sect3>
 795
 796         <!-- Zoom. -->
 797         <sect3>
 798           <title>Zoom</title>
 799
 800           <variablelist>
 801             <!-- Zoom Factor. -->
 802             <varlistentry id="on-the-fly-settings-zoom-factor">
 803               <term>
 804                 <menuchoice>
 805                   <shortcut>
 806                     <keycombo action="simul">&Ctrl;&Alt;<keycap>Z</keycap></keycombo>
 807                   </shortcut>
 808                   <guimenu>On-The-Fly Settings</guimenu>
 809                   <guimenuitem>Zoom Factor</guimenuitem>
 810                 </menuchoice>
 811               </term>
 812
 813               <listitem>
 814                 <para>
 815                   Display the zoom factor dialog.
 816                 </para>
 817               </listitem>
 818             </varlistentry>
 819           </variablelist>
 820         </sect3>
 821
 822         <!-- Search Engine. -->
 823         <sect3>
 824           <title>Search Engine</title>
 825
 826           <variablelist>
 827             <!-- Mojeek. -->
 828             <varlistentry id="search-engine-mojeek">
 829               <term>
 830                 <menuchoice>
 831                   <shortcut>
 832                     <keycombo action="simul">&Ctrl;&Shift;<keycap>M</keycap></keycombo>
 833                   </shortcut>
 834                   <guimenu>On-The-Fly Settings</guimenu>
 835                   <guisubmenu>Search Engine</guisubmenu>
 836                   <guimenuitem>Mojeek</guimenuitem>
 837                 </menuchoice>
 838               </term>
 839
 840               <listitem>
 841                 <para>
 842                   Use Mojeek as the search engine.
 843                 </para>
 844               </listitem>
 845             </varlistentry>
 846
 847             <!-- Monocles. -->
 848             <varlistentry id="search-engine-monocles">
 849               <term>
 850                 <menuchoice>
 851                   <shortcut>
 852                     <keycombo action="simul">&Ctrl;&Shift;<keycap>O</keycap></keycombo>
 853                   </shortcut>
 854                   <guimenu>On-The-Fly Settings</guimenu>
 855                   <guisubmenu>Search Engine</guisubmenu>
 856                   <guimenuitem>Monocles</guimenuitem>
 857                 </menuchoice>
 858               </term>
 859
 860               <listitem>
 861                 <para>
 862                   Use Mojeek as the search engine.
 863                 </para>
 864               </listitem>
 865             </varlistentry>
 866
 867             <!-- MetaGer. -->
 868             <varlistentry id="search-engine-metager">
 869               <term>
 870                 <menuchoice>
 871                   <shortcut>
 872                     <keycombo action="simul">&Ctrl;&Shift;<keycap>E</keycap></keycombo>
 873                   </shortcut>
 874                   <guimenu>On-The-Fly Settings</guimenu>
 875                   <guisubmenu>Search Engine</guisubmenu>
 876                   <guimenuitem>MetaGer</guimenuitem>
 877                 </menuchoice>
 878               </term>
 879
 880               <listitem>
 881                 <para>
 882                   Use MetaGer as the search engine.
 883                 </para>
 884               </listitem>
 885             </varlistentry>
 886
 887             <!-- Google. -->
 888             <varlistentry id="search-engine-google">
 889               <term>
 890                 <menuchoice>
 891                   <shortcut>
 892                     <keycombo action="simul">&Ctrl;&Shift;<keycap>G</keycap></keycombo>
 893                   </shortcut>
 894                   <guimenu>On-The-Fly Settings</guimenu>
 895                   <guisubmenu>Search Engine</guisubmenu>
 896                   <guimenuitem>Google</guimenuitem>
 897                 </menuchoice>
 898               </term>
 899
 900               <listitem>
 901                 <para>
 902                   Use Google as the search engine.
 903                 </para>
 904               </listitem>
 905             </varlistentry>
 906
 907             <!-- Bing. -->
 908             <varlistentry id="search-engine-bing">
 909               <term>
 910                 <menuchoice>
 911                   <shortcut>
 912                     <keycombo action="simul">&Ctrl;&Shift;<keycap>B</keycap></keycombo>
 913                   </shortcut>
 914                   <guimenu>On-The-Fly Settings</guimenu>
 915                   <guisubmenu>Search Engine</guisubmenu>
 916                   <guimenuitem>Bing</guimenuitem>
 917                 </menuchoice>
 918               </term>
 919
 920               <listitem>
 921                 <para>
 922                   Use Bing as the search engine.
 923                 </para>
 924               </listitem>
 925             </varlistentry>
 926
 927             <!-- Yahoo. -->
 928             <varlistentry id="search-engine-yahoo">
 929               <term>
 930                 <menuchoice>
 931                   <shortcut>
 932                     <keycombo action="simul">&Ctrl;&Shift;<keycap>Y</keycap></keycombo>
 933                   </shortcut>
 934                   <guimenu>On-The-Fly Settings</guimenu>
 935                   <guisubmenu>Search Engine</guisubmenu>
 936                   <guimenuitem>Yahoo</guimenuitem>
 937                 </menuchoice>
 938               </term>
 939
 940               <listitem>
 941                 <para>
 942                   Use Yahoo as the search engine.
 943                 </para>
 944               </listitem>
 945             </varlistentry>
 946
 947             <!-- Custom Search Engine. -->
 948             <varlistentry id="search-engine-custom">
 949               <term>
 950                 <menuchoice>
 951                   <shortcut>
 952                     <keycombo action="simul">&Ctrl;&Shift;<keycap>C</keycap></keycombo>
 953                   </shortcut>
 954                   <guimenu>On-The-Fly Settings</guimenu>
 955                   <guisubmenu>Search Engine</guisubmenu>
 956                   <guimenuitem>Custom</guimenuitem>
 957                 </menuchoice>
 958               </term>
 959
 960               <listitem>
 961                 <para>
 962                   Use the custom search engine. This action is only active if a custom search engine is set in the settings.
 963                 </para>
 964               </listitem>
 965             </varlistentry>
 966           </variablelist>
 967         </sect3>
 968       </sect2>
 969
 970       <!-- Settings. -->
 971       <sect2>
 972         <title>Settings</title>
 973
 974         <variablelist>
 975           <!-- Domain Settings. -->
 976           <varlistentry id="settings-domain-settings">
 977             <term>
 978               <menuchoice>
 979                 <shortcut>
 980                   <keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo>
 981                 </shortcut>
 982                 <guimenu>Settings</guimenu>
 983                 <guimenuitem>Domain Settings</guimenuitem>
 984               </menuchoice>
 985             </term>
 986
 987             <listitem>
 988               <para>
 989                 Display the domain settings dialog.
 990               </para>
 991             </listitem>
 992           </varlistentry>
 993
 994
 995           <!-- Cookies. -->
 996           <varlistentry id="settings-cookies">
 997             <term>
 998               <menuchoice>
 999                 <shortcut>
1000                   <keycombo action="simul">&Ctrl;<keycap>;</keycap></keycombo>
1001                 </shortcut>
1002                 <guimenu>Settings</guimenu>
1003                 <guimenuitem>Cookies</guimenuitem>
1004               </menuchoice>
1005             </term>
1006
1007             <listitem>
1008               <para>
1009                 Display the cookies dialog.
1010               </para>
1011             </listitem>
1012           </varlistentry>
1013         </variablelist>
1014       </sect2>
1015
1016       <!-- Common Settings and Help Entries. -->
1017       <sect2 id="common-settings-help-menus">
1018         <title>Common Settings and Help Entries</title>
1019
1020         <para>
1021           &privacybrowser; has many common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu> menu items.
1022           For more information read the sections about the <ulink url="help:/fundamentals/ui.html#menus-settings">Settings Menu</ulink>
1023           and <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink>.
1024         </para>
1025       </sect2>
1026
1027       <!-- Other Commands. -->
1028       <sect2>
1029         <title>Other Commands</title>
1030
1031         <variablelist>
1032           <!-- F11. -->
1033           <varlistentry id="f11">
1034             <term>
1035               <command>
1036                 <keycap>F11</keycap>
1037               </command>
1038             </term>
1039
1040             <listitem>
1041               <para>
1042                 Toggle full screen mode. This performs the same action as <xref linkend="view-full-screen-mode"/>.
1043               </para>
1044             </listitem>
1045           </varlistentry>
1046
1047           <!-- Escape. -->
1048           <varlistentry id="escape">
1049             <term>
1050               <command>
1051                 <keycap>&Esc;</keycap>
1052               </command>
1053             </term>
1054
1055             <listitem>
1056               <para>
1057                 Escape runs the first command that applies from the following list.
1058               </para>
1059
1060               <itemizedlist>
1061                 <listitem>
1062                   <para>
1063                     Exit full screen browsing.
1064                   </para>
1065                 </listitem>
1066
1067                 <listitem>
1068                   <para>
1069                     Clear the find text line edit and the find text highlights.
1070                   </para>
1071                 </listitem>
1072
1073                 <listitem>
1074                   <para>
1075                     Hide the find text toolbar.
1076                   </para>
1077                 </listitem>
1078               </itemizedlist>
1079             </listitem>
1080           </varlistentry>
1081         </variablelist>
1082       </sect2>
1083     </sect1>
1084
1085     <!-- Cookies Dialog. -->
1086     <sect1 id="cookies-dialog">
1087       <title>Cookies Dialog</title>
1088
1089       <para>
1090         The cookies dialog is accessed through <xref linkend="settings-cookies"/> (see <xref linkend="cookies"/>).
1091       </para>
1092
1093       <sect2 id="cookies-dialog-commands">
1094         <title>Commands</title>
1095
1096         <variablelist>
1097           <!-- Add Cookie. -->
1098           <varlistentry id="add-cookie">
1099             <term>
1100               <command>
1101                 <keycap>A</keycap>
1102               </command>
1103             </term>
1104
1105             <listitem>
1106               <para>
1107                 Open the add cookie dialog.
1108               </para>
1109             </listitem>
1110           </varlistentry>
1111
1112           <!-- Edit Cookie. -->
1113           <varlistentry id="edit-cookie">
1114             <term>
1115               <command>
1116                 <keycap>E</keycap>
1117               </command>
1118             </term>
1119
1120             <listitem>
1121               <para>
1122                 Open the edit cookie dialog. This command is only valid if a cookie is currently selected.
1123               </para>
1124             </listitem>
1125           </varlistentry>
1126
1127           <!-- Delete Cookies. -->
1128           <varlistentry id="delete-cookies">
1129             <term>
1130               <command>
1131                 <keycap>D</keycap> or <keycap>&Del;</keycap>
1132               </command>
1133             </term>
1134
1135             <listitem>
1136               <para>
1137                 Delete the currently selected cookies. A dialog will confirm the deletion before it is processed.
1138               </para>
1139             </listitem>
1140           </varlistentry>
1141
1142           <!-- Delete All Cookies. -->
1143           <varlistentry id="delete-all-cookie">
1144             <term>
1145               <command>
1146                 <keycap>L</keycap>
1147               </command>
1148             </term>
1149
1150             <listitem>
1151               <para>
1152                 Delete all the cookies. A dialog will confirm the deletion before it is processed.
1153               </para>
1154             </listitem>
1155           </varlistentry>
1156
1157           <!-- Close. -->
1158           <varlistentry id="close-cookies-dialog">
1159             <term>
1160               <command>
1161                 <keycap>C</keycap> or <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
1162               </command>
1163             </term>
1164
1165             <listitem>
1166               <para>
1167                 Close the cookies dialog.
1168               </para>
1169             </listitem>
1170           </varlistentry>
1171         </variablelist>
1172       </sect2>
1173     </sect1>
1174
1175     <!-- Save Dialog. -->
1176     <sect1 id="save-dialog">
1177       <title>Save Dialog</title>
1178
1179       <para>
1180         The save dialog pops up when a download is initiated.
1181       </para>
1182
1183       <sect2 id="save-dialog-commands">
1184         <title>Commands</title>
1185
1186         <variablelist>
1187           <!-- Save. -->
1188           <varlistentry id="save-dialog-save">
1189             <term>
1190               <command>
1191                 <keycap>S</keycap>
1192               </command>
1193             </term>
1194
1195             <listitem>
1196               <para>
1197                 Save the file.
1198               </para>
1199             </listitem>
1200           </varlistentry>
1201
1202           <!-- Close. -->
1203           <varlistentry id="save-dialog-close">
1204             <term>
1205               <command>
1206                 <keycap>C</keycap> or <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
1207               </command>
1208             </term>
1209
1210             <listitem>
1211               <para>
1212                 Close the save dialog without saving the file.
1213               </para>
1214             </listitem>
1215           </varlistentry>
1216         </variablelist>
1217       </sect2>
1218     </sect1>
1219   </chapter>
1220
1221   <!-- FAQ. -->
1222   <chapter id="faq">
1223     <title>Questions and Answers</title>
1224
1225     <qandaset id="faqlist">
1226       <qandaentry>
1227         <!-- Why are there no questions. -->
1228         <question>
1229           <para>Why are there no questions?</para>
1230         </question>
1231
1232         <answer>
1233           <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>
1234         </answer>
1235       </qandaentry>
1236     </qandaset>
1237   </chapter>
1238
1239   <!-- Credits. -->
1240   <chapter id="credits">
1241     <title>Credits and License</title>
1242
1243     <para>
1244       Program copyright 2016-2017,2021-2023 Soren Stoutner <ulink url="mailto:soren@stoutner.com">soren@stoutner.com</ulink>.
1245     </para>
1246
1247     <para>
1248       Translators:
1249       <itemizedlist>
1250         <listitem><para>Translations will be added in a future release.</para></listitem>
1251       </itemizedlist>
1252     </para>
1253
1254     <!-- The program license. -->
1255     &underGPL;
1256
1257     <para>
1258       Documentation copyright 2023 Soren Stoutner <ulink url="mailto:soren@stoutner.com">soren@stoutner.com</ulink>.
1259     </para>
1260
1261     <!-- The documentation license. -->
1262     &underFDL;
1263   </chapter>
1264 </book>