src/privacybrowser.1

   1 .\" Copyright 2023 Soren Stoutner <soren@stoutner.com>.
   2 .\"
   3 .\" This file is part of Privacy Browser PC <https://www.stoutner.com/privacy-browser-pc>.
   4 .\"
   5 .\" Privacy Browser PC is free software: you can redistribute it and/or modify
   6 .\" it under the terms of the GNU General Public License as published by
   7 .\" the Free Software Foundation, either version 3 of the License, or
   8 .\" (at your option) any later version.
   9 .\"
  10 .\" Privacy Browser PC is distributed in the hope that it will be useful,
  11 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 .\" GNU General Public License for more details.
  14 .\"
  15 .\" You should have received a copy of the GNU General Public License
  16 .\" along with Privacy Browser PC.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 .\" Title Header.
  19 .TH "Privacy Browser" 1 "12 October 2023" "version 0.5" "Privacy Browser User Manual"
  20
  21 .\" Section Header - Name.
  22 .SH NAME
  23 privacybrowser \- a web browser that respects your privacy
  24
  25
  26 .\" Section Header - Synopsis.
  27 .SH SYNOPSIS
  28
  29 .\" Launching homepage.  `.B` is "Bold".
  30 .B privacybrowser
  31 .br
  32
  33 .\" Launching a URL.  `.B` is "Bold".  `.RI` is "Roman (not italic) alternating Italic (underlined)".
  34 .B privacybrowser
  35 .RI [ url ]
  36 .br
  37
  38 .\" Options.  `.B` is "Bold".  `.RI` is "Roman (not italic) alternating Italic (underlined)".
  39 .B privacybrowser
  40 .RI [ option ]
  41
  42
  43 .\" Section Header - Description.
  44 .SH DESCRIPTION
  45 Privacy Browser is a web browser focused on user privacy.  It uses Qt WebEngine to render websites, which is a modified version of Chromium’s rendering engine.
  46
  47
  48 .\" Section Header - Options.
  49 .SH OPTIONS
  50
  51 .\" Help.  `.TP` is "Tag Paragraph".  `.BR` is "Bold alternating Roman (not bold)".
  52 .TP
  53 .BR -h ", " --help
  54 Displays help for command line options.
  55
  56 .\" Help all.  `.TP` is "Tag Paragraph".  `.B` is "Bold".
  57 .TP
  58 .B --help-all
  59 Displays help, including Qt specific options.
  60
  61 .\" Version.  `.TP` is "Tag Paragraph".  `.BR` is "Bold alternating Roman (not bold)".
  62 .TP
  63 .BR -v ", " --version
  64 Displays version information.
  65
  66 .\" Author.  `.TP` is "Tag Paragraph".  `.B` is "Bold".
  67 .TP
  68 .B --author
  69 Show author information.
  70
  71 .\" License.  `.TP` is "Tag Paragraph".  `.B` is "Bold".
  72 .TP
  73 .B --license
  74 Show license information.
  75
  76 .\" Desktop File Name.  `.TP` is "Tag Paragraph".  `.BI` is "Bold alternating Italic (underlined)".
  77 .TP
  78 .BI --desktopfile " file"
  79 The base file name of the desktop entry for this application.
  80
  81
  82 .\" Section Header - Bugs.  `.TP` is "Tag Paragraph".
  83 .SH BUGS
  84 Privacy Browser is an early alpha release.  As such, many features are not yet implemented.  More information can be found at:
  85 .TP
  86 https://www.stoutner.com/privacy-browser-pc/
  87 .TP
  88 Bugs in currently implemented features may be reported at:
  89 .TP
  90 https://redmine.stoutner.com/projects/privacy-browser-pc/issues
  91
  92
  93 .\" Section Header - Author.
  94 .SH AUTHOR
  95 Soren Stoutner <soren@stoutner.com>