Add more information to the README and update the NEWS file for the upcoming release.
|3 years ago|
|extra||3 years ago|
|man||3 years ago|
|src||3 years ago|
|.gitignore||3 years ago|
|AUTHORS||3 years ago|
|COPYING||3 years ago|
|Makefile.am||3 years ago|
|NEWS||3 years ago|
|README.md||3 years ago|
|configure.ac||3 years ago|
Yorkie - A task-oriented GnuPG frontend
Yorkie is a GTK3-based, task-oriented graphical frontend for GnuPG. “Task-oriented” means that, when it is called, the frontend performs a single task (e.g., encrypting a file), then quits. Therefore Yorkie is not a replacement for long-running frontends such as GPA. The intended use for Yorkie is to be called from the context menu of a graphical file manager, to perform cryptographic operations on files.
The frontend gets its name from yorkie (symbol yki), a fruit fly gene coding for a transcriptional co-activator that is a part of the Hippo signaling pathway.
Yorkie depends on the following libraries:
libgpgme, to perform all cryptographic operations.
GTK3 (and underlying libraries such as GLib), for the graphical user interface.
To encrypt and/or sign a file, call
yki with the
-e option (or no
option at all, as encrypt/sign is the default operation) and the
pathname to the file to encrypt and/or sign. In the dialog that will pop
up, select the settings you want, then click OK to proceed.
To decrypt and/or verify a file, call
yki with the
-d option and the
pathname to the file to decrypt and/or verify. The program will process
the file and display the result of the decryption/verification in a
dialog box. Click OK to actually write the decrypted or verified data to
a new file.
If the file to verify is a detached signature, Yorkie will assume the
corresponding signed data is contained in a file within the same
directory and with the same name minus a
Integration with DES-EMA-compliant file managers
Yorkie comes with two
.desktop files, installed under the
$prefix/share/yorkie directory, to enable calling Yorkie from the
context menu of file managers compliant with the DES-EMA specification
(e.g., LibFM-based file managers such as
PCManFM. Copy these files to your
$XDG_DATA_HOME/file-manager/actions directory for your file manager to
Yorkie is distributed under the terms of the GNU General Public License, version 3 or higher. The full license is included in the COPYING file of the source distribution.
Homepage and repository
The project is located at https://incenp.org/dvlpt/yorkie.html. The latest source code is available at https://git.incenp.org/damien/yorkie.