diff --git a/CMakeLists.txt b/CMakeLists.txt index 7e504b1..0cbd1bf 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,41 +1,43 @@ cmake_minimum_required(VERSION 3.1.0 FATAL_ERROR) set (CMAKE_CXX_STANDARD 11) set(SYMMY_VERSION 0.70.0) project(symmy VERSION ${SYMMY_VERSION}) find_package(ECM REQUIRED NO_MODULE) set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH}) include(KDEInstallDirs) include(KDECMakeSettings) include(KDECompilerSettings NO_POLICY_SCOPE) include(ECMSetupVersion) include(ECMQtDeclareLoggingCategory) include(FeatureSummary) # ecm >= 5.31 disables alternative operators, but we use them. string(REPLACE "-fno-operator-names" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}") find_package(Qt5 CONFIG REQUIRED Core Gui Widgets) find_package(KF5 REQUIRED COMPONENTS + DocTools KIO I18n WidgetsAddons) find_package(Gpgmepp "1.7.1" CONFIG REQUIRED) find_package(QGpgme "1.7.1" CONFIG REQUIRED) ecm_setup_version(PROJECT VARIABLE_PREFIX SYMMY VERSION_HEADER symmyversion.h) +add_subdirectory(doc) add_subdirectory(src) add_subdirectory(plugins) feature_summary(WHAT ALL INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES) diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 0000000..9fafa82 --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,3 @@ +kdoctools_create_handbook(index.docbook + INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en + SUBDIR symmy) diff --git a/doc/index.docbook b/doc/index.docbook new file mode 100644 index 0000000..5ee9b99 --- /dev/null +++ b/doc/index.docbook @@ -0,0 +1,140 @@ + +Symmy"> + + + +]> + + + + +The &symmy; Handbook + + + ElvisAngelaccio + +
+ elvis.angelaccio@kde.org +
+ + + + + + +2017 +Elvis Angelaccio + + +2017-11-23 +&symmy; 0.70 + + + &FDLNotice; + + + + + &symmy; is a frontend for the symmetric encryption functionality of GPG. + + + + + KDE + encryption + + + + + + Introduction + + &symmy; is a simple command-line application that can be used to encrypt or decrypt one or more files using the symmetric encryption functionality of GPG. + A file encrypted by &symmy; can be decrypted by anyone who has access to the GPG program and the encryption key. + + + &symmy; can also be used from Dolphin or Plasma Folder View thanks to the Encrypt and Decrypt items in the context menu. + + + + + Usage + + + Encrypt Files + + You can encrypt one or more files by selecting them in Dolphin or Plasma Folder View and clicking the Encrypt entry in the context menu. + + + Note that you cannot encrypt a folder. If you need to do that, you should compress the folder and then encrypt the resulting archive. + + + It's also not possible to encrypt remote files or files that are already encrypted. + + + Choose an Encryption Key + + &symmy; will ask you a password (or passphrase) that will be used as encryption key for all the selected files. + You should choose a strong encryption key and you should store it in a secure place (such as a password manager). + If you need to send the key to another person, you should do so over a secure channel (for example, by meeting in person). + + + + Manage an Encryption Operation + + The encryption operation will take some time depending on the number of files and on their size. + You can track the progress of the operation from the notification applet provided by Plasma. + From the notification plasmoid you can also abort the encryption operation if necessary. + + + + + + Decrypt Files + + You can decrypt one or more encrypted files by selecting them in Dolphin or Plasma Folder View and clicking the Decrypt entry in the context menu. + Note that this entry will be visibile only when selecting encrypted files. + + + Type the Decryption Key + + To decrypt the selected files, &symmy; will ask you the password or passphrase that was used as encryption key. + Remember that symmetric encryption means that encryption and decryption keys are the same. + &symmy; assumes that all the selected files have been encrypted using the same key. + If that's not the case, it will fail to decrypt one or more files and it will tell you at the end of the decryption operation. + + + + Manage a Decryption Operation + + The decryption operation will take some time depending on the number of files and on their size. + You can track the progress of the operation from the notification applet provided by Plasma. + From the notification plasmoid you can also abort the decryption operation if necessary. + + + + + + + + Credits and License + + &symmy; + + + Program copyright © 2017 Elvis Angelaccio + elvis.angelaccio@kde.org + + + Documentation copyright © 2017 Elvis Angelaccio + elvis.angelaccio@kde.org + + +&underFDL; +&underGPL; + + +&documentation.index; + +