Git commit 5b3eb51374cff62a5535492e68e069c05634c6e7 by Elvis Angelaccio. Committed on 25/11/2017 at 12:37. Pushed by elvisangelaccio into branch 'master'.
Install manpage rather than docbook Supersedes D8988 KDocTools >= 5.27 is required for the Elvis.Angelaccio entities. Reviewers: #documentation Differential Revision: https://phabricator.kde.org/D8994 M +4 -3 CMakeLists.txt M +4 -3 doc/CMakeLists.txt D +0 -146 doc/index.docbook A +176 -0 doc/man-symmy.1.docbook https://commits.kde.org/symmy/5b3eb51374cff62a5535492e68e069c05634c6e7 diff --git a/CMakeLists.txt b/CMakeLists.txt index 0cbd1bf..ee8f677 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -4,9 +4,10 @@ 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}) +set(KF5_MIN_VERSION 5.27.0) +find_package(ECM ${KF5_MIN_VERSION} REQUIRED NO_MODULE) +set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH}) include(KDEInstallDirs) include(KDECMakeSettings) @@ -23,7 +24,7 @@ find_package(Qt5 CONFIG REQUIRED Gui Widgets) -find_package(KF5 REQUIRED COMPONENTS +find_package(KF5 ${KF5_MIN_VERSION} REQUIRED COMPONENTS DocTools KIO I18n diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 9fafa82..59082a5 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,3 +1,4 @@ -kdoctools_create_handbook(index.docbook - INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en - SUBDIR symmy) +kdoctools_create_manpage(man-symmy.1.docbook + 1 + INSTALL_DESTINATION + ${KDE_INSTALL_MANDIR}) diff --git a/doc/index.docbook b/doc/index.docbook deleted file mode 100644 index d394f59..0000000 --- a/doc/index.docbook +++ /dev/null @@ -1,146 +0,0 @@ -<?xml version="1.0" ?> -<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [ - <!ENTITY symmy "<application>Symmy</application>"> - <!ENTITY kappname "&symmy;"> - <!ENTITY % addindex "IGNORE"> - <!ENTITY % English "INCLUDE"> -]> - -<book id="symmy" lang="&language;"> - -<bookinfo> -<title>The &symmy; Handbook</title> - -<authorgroup> - <author><firstname>Elvis</firstname><surname>Angelaccio</surname> - <affiliation> - <address> - <email>[email protected]</email> - </address> - </affiliation> - </author> -<!-- TRANS:ROLES_OF_TRANSLATORS --> -</authorgroup> - -<copyright> -<year>2017</year> -<holder>Elvis Angelaccio</holder> -</copyright> - -<date>2017-11-23</date> -<releaseinfo>&symmy; 0.70</releaseinfo> - -<legalnotice> - &FDLNotice; -</legalnotice> - -<abstract> - <para> - &symmy; is a frontend for the symmetric encryption functionality of GPG. - </para> -</abstract> - -<keywordset> - <keyword>KDE</keyword> - <keyword>encryption</keyword> -</keywordset> - -</bookinfo> - -<chapter id="introduction"> - <title>Introduction</title> - <para> - &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. - </para> - <para> - &symmy; can also be used from Dolphin or Plasma Folder View thanks to the <guimenuitem>Encrypt</guimenuitem> and <guimenuitem>Decrypt</guimenuitem> items in the context menu. - </para> -</chapter> - -<chapter id="usage"> - <title>Usage</title> - - <sect1 id="encryption"> - <title>Encrypt Files</title> - <para> - You can encrypt one or more files by selecting them in Dolphin or Plasma Folder View and clicking the <guimenuitem>Encrypt</guimenuitem> entry in the context menu. - </para> - <para> - Note that you cannot encrypt a folder. If you need to do that, you should compress the folder and then encrypt the resulting archive. - </para> - <para> - It's also not possible to encrypt remote files or files that are already encrypted. - </para> - <sect2 id="encryption_key"> - <title>Choose an Encryption Key</title> - <para> - &symmy; will ask you a password (or passphrase) that will be used as encryption key for <emphasis>all</emphasis> 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). - </para> - </sect2> - <sect2 id="gpg-requirement"> - <title>GPG Requirement</title> - <para> - &symmy; uses GPG to perform the actual encryption, so it assumes that the <application>gpg-agent</application> process is running and properly configured. - </para> - </sect2> - <sect2 id="managing_encryption"> - <title>Manage an Encryption Operation</title> - <para> - 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. - </para> - </sect2> - </sect1> - - <sect1 id="decryption"> - <title>Decrypt Files</title> - <para> - You can decrypt one or more encrypted files by selecting them in Dolphin or Plasma Folder View and clicking the <guimenuitem>Decrypt</guimenuitem> entry in the context menu. - Note that this entry will be visible only when selecting encrypted files. - </para> - <sect2 id="decryption_key"> - <title>Type the Decryption Key</title> - <para> - 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. - </para> - </sect2> - <sect2 id="managing_decryption"> - <title>Manage a Decryption Operation</title> - <para> - 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. - </para> - </sect2> - </sect1> - -</chapter> - -<chapter id="credits"> - <title>Credits and License</title> - <para> - &symmy; - </para> - <para> - Program copyright © 2017 Elvis Angelaccio - <email>[email protected]</email> - </para> - <para> - Documentation copyright © 2017 Elvis Angelaccio - <email>[email protected]</email> - </para> -<!-- TRANS:CREDIT_FOR_TRANSLATORS --> -&underFDL; -&underGPL; -</chapter> - -&documentation.index; - -</book> diff --git a/doc/man-symmy.1.docbook b/doc/man-symmy.1.docbook new file mode 100644 index 0000000..3731318 --- /dev/null +++ b/doc/man-symmy.1.docbook @@ -0,0 +1,176 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [ + <!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>Symmy User's Manual</title> +<author> +&Elvis.Angelaccio; +&Elvis.Angelaccio.mail; +<personblurb><para>Authored this program and this man page</para></personblurb> +</author> +<date>2017-11-25</date> +<releaseinfo>symmy 0.70</releaseinfo> +</refentryinfo> + +<refmeta> +<refentrytitle><command>symmy</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>symmy</command></refname> +<refpurpose>Frontend for the symmetric encryption functionality of GPG.</refpurpose> +</refnamediv> + +<refsynopsisdiv id="_synopsis"> +<cmdsynopsis> +<command>symmy</command> +<arg rep="repeat"><replaceable>OPTIONS</replaceable></arg> +<arg rep="repeat"><replaceable>FILES</replaceable></arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>DESCRIPTION</title> +<para> +<command>symmy</command> is a simple application that can be used to encrypt or decrypt one or more files using the symmetric encryption functionality of GPG. +A file encrypted by <command>symmy</command> can be decrypted by anyone who has access to the GPG program and the encryption key. +</para> +<para> +<command>symmy</command> can also be used from &dolphin; or &plasma; Folder View thanks to the <guimenuitem>Encrypt</guimenuitem> and <guimenuitem>Decrypt</guimenuitem> items in the context menu. +</para> +</refsect1> + +<refsect1> +<title>ENCRYPTION</title> +<para> +You can encrypt one or more files by writing their paths after the <option>encrypt</option> option. +You can also select them in &dolphin; or &plasma; Folder View and click the <guimenuitem>Encrypt</guimenuitem> entry in the context menu. +</para> +<para> +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. +</para> + +<refsect2> +<title>Choosing an Encryption Key</title> +<para> +<command>symmy</command> will ask you a password (or passphrase) that will be used as encryption key for <emphasis>all</emphasis> 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). +</para> +</refsect2> + +<refsect2> +<title>GPG Requirement</title> +<para> +<command>symmy</command> uses GPG to perform the actual encryption, so it assumes that the <command>gpg-agent</command> process is running and properly configured. +</para> +</refsect2> + +<refsect2> +<title>Managing an Encryption Operation</title> +<para> +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. +</para> +</refsect2> +</refsect1> + +<refsect1> +<title>DECRYPTION</title> +<para> +You can decrypt one or more encrypted files by writing their paths after the <option>decrypt</option> option. +You can also select them in &dolphin; or &plasma; Folder View and click the <guimenuitem>Decrypt</guimenuitem> entry in the context menu. +Note that this entry will be visible only when selecting encrypted files. +</para> + +<refsect2> +<title>Managing a Decryption Operation</title> +<para> +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. +</para> +</refsect2> + +</refsect1> + +<refsect1> +<title>OPTIONS</title> +<variablelist> + +<varlistentry> +<term> +<option>-e, --encrypt</option> +</term> +<listitem> +<para> +Encrypts the given list of files after asking a passphrase. This option is implicitly set if there are no other options. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>-d, --decrypt</option> +</term> +<listitem> +<para> +Decrypts the given list of files after asking the decryption key. Note that <option>encrypt</option> and <option>decrypt</option> are mutually exclusive. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>-h, --help</option> +</term> +<listitem> +<para> +Shows a brief synopsis and description of the command line options. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>-v, --version</option> +</term> +<listitem> +<para> +Shows the version of this program. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--author</option> +</term> +<listitem> +<para> +Shows information about the author of this program. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<option>--license</option> +</term> +<listitem> +<para> +Shows information about the license of this program. +</para> +</listitem> +</varlistentry> + +</variablelist> +</refsect1> + +</refentry>
