From 95aa7dff6f4da3aa85775d46600f9be2e2f856eb Mon Sep 17 00:00:00 2001 From: Soren Stoutner Date: Wed, 15 Feb 2023 16:47:39 -0700 Subject: [PATCH] Add a man file. --- CMakeLists.txt | 2 +- src/CMakeLists.txt | 16 ++-- src/com.stoutner.privacybrowser.desktop | 6 +- src/databases/CMakeLists.txt | 4 +- src/delegates/CMakeLists.txt | 4 +- src/dialogs/CMakeLists.txt | 4 +- src/filters/CMakeLists.txt | 4 +- src/helpers/CMakeLists.txt | 4 +- ...browser.svg => sc-apps-privacybrowser.svg} | 0 src/interceptors/CMakeLists.txt | 4 +- src/main.cpp | 2 +- src/privacybrowser.1 | 95 +++++++++++++++++++ src/privacybrowser.notifyrc | 4 +- src/resources.qrc | 4 +- src/widgets/CMakeLists.txt | 2 +- src/widgets/TabWidget.cpp | 12 ++- src/windows/BrowserWindow.cpp | 7 +- src/windows/CMakeLists.txt | 4 +- 18 files changed, 142 insertions(+), 36 deletions(-) rename src/icons/{sc-apps-privacy-browser.svg => sc-apps-privacybrowser.svg} (100%) create mode 100644 src/privacybrowser.1 diff --git a/CMakeLists.txt b/CMakeLists.txt index 528e6ff..9a5dee4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,4 +1,4 @@ -# Copyright 2022 Soren Stoutner . +# Copyright 2022-2023 Soren Stoutner . # # This file is part of Privacy Browser PC . # diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 2d1340b..c4459c3 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -16,25 +16,25 @@ # along with Privacy Browser PC. If not, see . # Create the executable and add the resources. -add_executable(privacy-browser resources.qrc) +add_executable(privacybrowser resources.qrc) # List the sources to include in the executable. -target_sources(privacy-browser PRIVATE +target_sources(privacybrowser PRIVATE main.cpp ) # Add the Qt logging category. This will create the `debug.h` header file. -ecm_qt_declare_logging_category(privacy-browser +ecm_qt_declare_logging_category(privacybrowser HEADER debug.h IDENTIFIER PRIVACYBROWSER CATEGORY_NAME "privacybrowser" ) # Include the KConfig controller file. -kconfig_add_kcfg_files(privacy-browser settings/Settings.kcfgc) +kconfig_add_kcfg_files(privacybrowser settings/Settings.kcfgc) # Use KDE Frameworks to handle internationalization of the following UI files. -ki18n_wrap_ui(privacy-browser +ki18n_wrap_ui(privacybrowser uis/AddOrEditCookieDialog.ui uis/AddTabWidget.ui uis/CookiesDialog.ui @@ -48,7 +48,7 @@ ki18n_wrap_ui(privacy-browser ) # Link the following libraries. -target_link_libraries(privacy-browser +target_link_libraries(privacybrowser Qt5::Core Qt5::Gui Qt5::Sql @@ -80,7 +80,7 @@ add_subdirectory(widgets) add_subdirectory(windows) # Install Privacy Browser using the default KDE arguments. -install(TARGETS privacy-browser ${KDE_INSTALL_TARGETS_DEFAULT_ARGS}) +install(TARGETS privacybrowser ${KDE_INSTALL_TARGETS_DEFAULT_ARGS}) # Install Privacy Browser according to the instructions in the desktop file, specifying the permissions. install(PROGRAMS com.stoutner.privacybrowser.desktop DESTINATION ${KDE_INSTALL_APPDIR} PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ) @@ -92,4 +92,4 @@ install(FILES com.stoutner.privacybrowser.appdata.xml DESTINATION ${KDE_INSTALL_ install(FILES privacybrowser.notifyrc DESTINATION ${KDE_INSTALL_KNOTIFYRCDIR}) # Install Privacy Browser's icon. -ecm_install_icons(ICONS icons/sc-apps-privacy-browser.svg DESTINATION ${KDE_INSTALL_ICONDIR}) +ecm_install_icons(ICONS icons/sc-apps-privacybrowser.svg DESTINATION ${KDE_INSTALL_ICONDIR}) diff --git a/src/com.stoutner.privacybrowser.desktop b/src/com.stoutner.privacybrowser.desktop index dc54c91..ddf69a3 100644 --- a/src/com.stoutner.privacybrowser.desktop +++ b/src/com.stoutner.privacybrowser.desktop @@ -30,13 +30,13 @@ GenericName=Web Browser Categories=Network;WebBrowser; # Set the icon. -Icon=privacy-browser.svg +Icon=privacybrowser.svg # Set the executable with the optional URL argument. -Exec=privacy-browser %u +Exec=privacybrowser %u # Specify the WM class, which groups windows of the same application together. -StartupWMClass=privacy-browser +StartupWMClass=privacybrowser # TODO. Set the document path. X-DocPath=privacybrowser/index.html diff --git a/src/databases/CMakeLists.txt b/src/databases/CMakeLists.txt index 0abb936..e38dbd2 100644 --- a/src/databases/CMakeLists.txt +++ b/src/databases/CMakeLists.txt @@ -1,4 +1,4 @@ -# Copyright © 2022 Soren Stoutner . +# Copyright 2022-2023 Soren Stoutner . # # This file is part of Privacy Browser PC . # @@ -17,7 +17,7 @@ # List the sources to include in the executable. -target_sources(privacy-browser PRIVATE +target_sources(privacybrowser PRIVATE CookiesDatabase.cpp DomainsDatabase.cpp ) diff --git a/src/delegates/CMakeLists.txt b/src/delegates/CMakeLists.txt index d56c050..d26efe7 100644 --- a/src/delegates/CMakeLists.txt +++ b/src/delegates/CMakeLists.txt @@ -1,4 +1,4 @@ -# Copyright © 2022 Soren Stoutner . +# Copyright 2022-2023 Soren Stoutner . # # This file is part of Privacy Browser PC . # @@ -17,6 +17,6 @@ # List the sources to include in the executable. -target_sources(privacy-browser PRIVATE +target_sources(privacybrowser PRIVATE ViewOnlyDelegate.cpp ) diff --git a/src/dialogs/CMakeLists.txt b/src/dialogs/CMakeLists.txt index 7120f4d..d30f067 100644 --- a/src/dialogs/CMakeLists.txt +++ b/src/dialogs/CMakeLists.txt @@ -1,4 +1,4 @@ -# Copyright © 2022 Soren Stoutner . +# Copyright 2022-2023 Soren Stoutner . # # This file is part of Privacy Browser PC . # @@ -17,7 +17,7 @@ # List the sources to include in the executable. -target_sources(privacy-browser PRIVATE +target_sources(privacybrowser PRIVATE AddOrEditCookieDialog.cpp CookiesDialog.cpp DomainSettingsDialog.cpp diff --git a/src/filters/CMakeLists.txt b/src/filters/CMakeLists.txt index c57b6ee..c0d5651 100644 --- a/src/filters/CMakeLists.txt +++ b/src/filters/CMakeLists.txt @@ -1,4 +1,4 @@ -# Copyright © 2022 Soren Stoutner . +# Copyright 2022-2023 Soren Stoutner . # # This file is part of Privacy Browser PC . # @@ -17,6 +17,6 @@ # List the sources to include in the executable. -target_sources(privacy-browser PRIVATE +target_sources(privacybrowser PRIVATE MouseEventFilter.cpp ) diff --git a/src/helpers/CMakeLists.txt b/src/helpers/CMakeLists.txt index 042c5c3..a1a19de 100644 --- a/src/helpers/CMakeLists.txt +++ b/src/helpers/CMakeLists.txt @@ -1,4 +1,4 @@ -# Copyright © 2022 Soren Stoutner . +# Copyright 2022-2023 Soren Stoutner . # # This file is part of Privacy Browser PC . # @@ -17,7 +17,7 @@ # List the sources to include in the executable. -target_sources(privacy-browser PRIVATE +target_sources(privacybrowser PRIVATE SearchEngineHelper.cpp UserAgentHelper.cpp ) diff --git a/src/icons/sc-apps-privacy-browser.svg b/src/icons/sc-apps-privacybrowser.svg similarity index 100% rename from src/icons/sc-apps-privacy-browser.svg rename to src/icons/sc-apps-privacybrowser.svg diff --git a/src/interceptors/CMakeLists.txt b/src/interceptors/CMakeLists.txt index 6e92b32..7f044ba 100644 --- a/src/interceptors/CMakeLists.txt +++ b/src/interceptors/CMakeLists.txt @@ -1,4 +1,4 @@ -# Copyright © 2022 Soren Stoutner . +# Copyright 2022-2023 Soren Stoutner . # # This file is part of Privacy Browser PC . # @@ -17,6 +17,6 @@ # List the sources to include in the executable. -target_sources(privacy-browser PRIVATE +target_sources(privacybrowser PRIVATE UrlRequestInterceptor.cpp ) diff --git a/src/main.cpp b/src/main.cpp index d9accc7..b2d3d11 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -65,7 +65,7 @@ int main(int argc, char *argv[]) KAboutData::setApplicationData(aboutData); // Set the window icon. - application.setWindowIcon(QIcon::fromTheme(QStringLiteral("privacy-browser"), QIcon(QStringLiteral(":/icons/sc-apps-privacy-browser.svg")))); + application.setWindowIcon(QIcon::fromTheme(QStringLiteral("privacy-browser"), QIcon(QStringLiteral(":/icons/sc-apps-privacybrowser.svg")))); // Create a command line parser. QCommandLineParser commandLineParser; diff --git a/src/privacybrowser.1 b/src/privacybrowser.1 new file mode 100644 index 0000000..6b78a38 --- /dev/null +++ b/src/privacybrowser.1 @@ -0,0 +1,95 @@ +.\" Copyright 2023 Soren Stoutner . +.\" +.\" This file is part of Privacy Browser PC . +.\" +.\" Privacy Browser PC is free software: you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation, either version 3 of the License, or +.\" (at your option) any later version. +.\" +.\" Privacy Browser PC is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with Privacy Browser PC. If not, see . + +.\" Title Header. +.TH "Privacy Browser" 1 "15 February 2023" "version 0.1" "Privacy Browser User Manual" + +.\" Section Header - Name. +.SH NAME +Privacy Browser \- a web browser that respects your privacy + + +.\" Section Header - Synopsis. +.SH SYNOPSIS + +.\" Launching homepage. `.B` is "Bold". +.B privacybrowser +.br + +.\" Launching a URL. `.B` is "Bold". `.RI` is "Roman (not italic) alternating Italic (underlined)". +.B privacybrowser +.RI [ url ] +.br + +.\" Options. `.B` is "Bold". `.RI` is "Roman (not italic) alternating Italic (underlined)". +.B privacybrowser +.RI [ option ] + + +.\" Section Header - Description. +.SH DESCRIPTION +Privacy Browser is an open source web browser focused on user privacy. It uses Qt WebEngine, which is a modified version of Chromium’s rendering engine. + + +.\" Section Header - Options. +.SH OPTIONS + +.\" Help. `.TP` is "Tag Paragraph". `.BR` is "Bold alternating Roman (not bold)". +.TP +.BR -h ", " --help +Displays help on commandline options. + +.\" Help all. `.TP` is "Tag Paragraph". `.B` is "Bold". +.TP +.B --help-all +Displays help including Qt specific options. + +.\" Version. `.TP` is "Tag Paragraph". `.BR` is "Bold alternating Roman (not bold)". +.TP +.BR -v ", " --version +Displays version information. + +.\" Author. `.TP` is "Tag Paragraph". `.B` is "Bold". +.TP +.B --author +Show author information. + +.\" License. `.TP` is "Tag Paragraph". `.B` is "Bold". +.TP +.B --license +Show license information. + +.\" Desktop File Name. `.TP` is "Tag Paragraph". `.Bi` is "Bold alternating Italic (underlined)". +.TP +.BI --desktopfile " file" +The base file name of the desktop entry for this application. + + +.\" Section Header - Bugs. `.TP` is "Tag Paragraph". +.SH BUGS +Privacy Browser is an early alpha release. As such, many features are not yet implemented. More information can be found at: +.TP +https://www.stoutner.com/privacy-browser-pc/ +.TP +Bugs in currently implemented features may be reported at: +.TP +https://redmine.stoutner.com/projects/privacy-browser-pc/issues + + +.\" Section Header - Author. +.SH AUTHOR +Soren Stoutner diff --git a/src/privacybrowser.notifyrc b/src/privacybrowser.notifyrc index bffb787..08915de 100644 --- a/src/privacybrowser.notifyrc +++ b/src/privacybrowser.notifyrc @@ -1,4 +1,4 @@ -# Copyright 2022 Soren Stoutner . +# Copyright 2022-2023 Soren Stoutner . # # This file is part of Privacy Browser PC . # @@ -16,7 +16,7 @@ # along with Privacy Browser PC. If not, see . [Global] -IconName=sc-apps-privacy-browser +IconName=sc-apps-privacybrowser Name=Privacy Browser Comment=A browser that respects your privacy. DesktopEntry=com.stoutner.privacybrowser.desktop diff --git a/src/resources.qrc b/src/resources.qrc index a6400dd..c86aa0c 100644 --- a/src/resources.qrc +++ b/src/resources.qrc @@ -1,5 +1,5 @@