Warning, /utilities/symmy/doc/man-symmy.1.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" encoding="UTF-8"?>
0002 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003   <!ENTITY % English "INCLUDE">
0004 ]>
0005 <!--
0006     SPDX-License-Identifier: CC0-1.0
0007     SPDX-FileCopyrightText: 2017 Elvis Angelaccio <elvis.angelaccio@kde.org>
0008 -->
0009 <refentry lang="&language;">
0010 <refentryinfo>
0011 <title>Symmy User's Manual</title>
0012 <author>
0013 &Elvis.Angelaccio;
0014 &Elvis.Angelaccio.mail;
0015 <personblurb><para>Authored this program and this man page</para></personblurb>
0016 </author>
0017 <date>2017-11-25</date>
0018 <releaseinfo>symmy 0.70</releaseinfo>
0019 </refentryinfo>
0020 
0021 <refmeta>
0022 <refentrytitle><command>symmy</command></refentrytitle>
0023 <manvolnum>1</manvolnum>
0024 </refmeta>
0025 
0026 <refnamediv>
0027 <refname><command>symmy</command></refname>
0028 <refpurpose>Frontend for the symmetric encryption functionality of GPG.</refpurpose>
0029 </refnamediv>
0030 
0031 <refsynopsisdiv id="_synopsis">
0032 <cmdsynopsis>
0033 <command>symmy</command>
0034 <arg rep="repeat"><replaceable>OPTIONS</replaceable></arg>
0035 <arg rep="repeat"><replaceable>FILES</replaceable></arg>
0036 </cmdsynopsis>
0037 </refsynopsisdiv>
0038 
0039 <refsect1>
0040 <title>DESCRIPTION</title>
0041 <para>
0042 <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.
0043 A file encrypted by <command>symmy</command> can be decrypted by anyone who has access to the GPG program and the encryption key.
0044 </para>
0045 <para>
0046 <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.
0047 </para>
0048 </refsect1>
0049 
0050 <refsect1>
0051 <title>ENCRYPTION</title>
0052 <para>
0053 You can encrypt one or more files by writing their paths after the <option>encrypt</option> option.
0054 You can also select them in &dolphin; or &plasma; Folder View and click the <guimenuitem>Encrypt</guimenuitem> entry in the context menu.
0055 </para>
0056 <para>
0057 Note that you cannot encrypt a folder. If you need to do that, you should compress the folder and then encrypt the resulting archive.
0058 It's also not possible to encrypt remote files or files that are already encrypted.
0059 </para>
0060 
0061 <refsect2>
0062 <title>Choosing an Encryption Key</title>
0063 <para>
0064 <command>symmy</command> will ask you a password (or passphrase) that will be used as encryption key for <emphasis>all</emphasis> the selected files.
0065 You should choose a strong encryption key and you should store it in a secure place (such as a password manager).
0066 If you need to send the key to another person, you should do so over a secure channel (for example, by meeting in person).
0067 </para>
0068 </refsect2>
0069 
0070 <refsect2>
0071 <title>GPG Requirement</title>
0072 <para>
0073 <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.
0074 </para>
0075 </refsect2>
0076 
0077 <refsect2>
0078 <title>Managing an Encryption Operation</title>
0079 <para>
0080 The encryption operation will take some time depending on the number of files and on their size.
0081 You can track the progress of the operation from the notification applet provided by &plasma;.
0082 From the notification plasmoid you can also abort the encryption operation if necessary.
0083 </para>
0084 </refsect2>
0085 </refsect1>
0086 
0087 <refsect1>
0088 <title>DECRYPTION</title>
0089 <para>
0090 You can decrypt one or more encrypted files by writing their paths after the <option>decrypt</option> option.
0091 You can also select them in &dolphin; or &plasma; Folder View and click the <guimenuitem>Decrypt</guimenuitem> entry in the context menu.
0092 Note that this entry will be visible only when selecting encrypted files.
0093 </para>
0094 
0095 <refsect2>
0096 <title>Managing a Decryption Operation</title>
0097 <para>
0098 The decryption operation will take some time depending on the number of files and on their size.
0099 You can track the progress of the operation from the notification applet provided by &plasma;.
0100 From the notification plasmoid you can also abort the decryption operation if necessary.
0101 </para>
0102 </refsect2>
0103 
0104 </refsect1>
0105 
0106 <refsect1>
0107 <title>OPTIONS</title>
0108 <variablelist>
0109 
0110 <varlistentry>
0111 <term>
0112 <option>-e, --encrypt</option>
0113 </term>
0114 <listitem>
0115 <para>
0116 Encrypts the given list of files after asking a passphrase. This option is implicitly set if there are no other options.
0117 </para>
0118 </listitem>
0119 </varlistentry>
0120 
0121 <varlistentry>
0122 <term>
0123 <option>-d, --decrypt</option>
0124 </term>
0125 <listitem>
0126 <para>
0127 Decrypts the given list of files after asking the decryption key. Note that <option>encrypt</option> and <option>decrypt</option> are mutually exclusive.
0128 </para>
0129 </listitem>
0130 </varlistentry>
0131 
0132 <varlistentry>
0133 <term>
0134 <option>-h, --help</option>
0135 </term>
0136 <listitem>
0137 <para>
0138 Shows a brief synopsis and description of the command line options.
0139 </para>
0140 </listitem>
0141 </varlistentry>
0142 
0143 <varlistentry>
0144 <term>
0145 <option>-v, --version</option>
0146 </term>
0147 <listitem>
0148 <para>
0149 Shows the version of this program.
0150 </para>
0151 </listitem>
0152 </varlistentry>
0153 
0154 <varlistentry>
0155 <term>
0156 <option>--author</option>
0157 </term>
0158 <listitem>
0159 <para>
0160 Shows information about the author of this program.
0161 </para>
0162 </listitem>
0163 </varlistentry>
0164 
0165 <varlistentry>
0166 <term>
0167 <option>--license</option>
0168 </term>
0169 <listitem>
0170 <para>
0171 Shows information about the license of this program.
0172 </para>
0173 </listitem>
0174 </varlistentry>
0175 
0176 </variablelist>
0177 </refsect1>
0178 
0179 </refentry>