summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2021-11-25 12:24:54 +0000
committerLars Wirzenius <liw@liw.fi>2021-11-25 12:24:54 +0000
commitd72330eb36556100838da18862096951966e9008 (patch)
tree08cd8652eac13ebf906900606a50eec84c2c44fe
parentd24a8f92f808fb82a6d488bf210e8f0397a37d20 (diff)
parent621018126a240390d2e725096aa51cc39d3e8a2a (diff)
downloadsq-user-guide-d72330eb36556100838da18862096951966e9008.tar.gz
Merge branch 'liw/dashless' into 'main'
fix: call it "Sequoia PGP", not "Sequoia-PGP" Closes #21 See merge request sequoia-pgp/sq-user-guide!8
-rw-r--r--README.md4
-rw-r--r--sq-guide.md24
2 files changed, 14 insertions, 14 deletions
diff --git a/README.md b/README.md
index 3a22031..a7d84fd 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
# User guide for sq
This is a sketch of a user guide for sq, the command line tool from
-Sequoia-PGP.
+the Sequoia PGP project.
`sq` is a command line tool for encrypting and authenticating files
-and messages. It is provided by the Sequoia-PGP project as part of an
+and messages. It is provided by the Sequoia PGP project as part of an
implementation of the OpenPGP standard in the Rust programming
language. This is a guide shows how to `sq`, and is aimed at people
comfortable on the command line, and explains any concepts of
diff --git a/sq-guide.md b/sq-guide.md
index 9f4469b..a7bc59c 100644
--- a/sq-guide.md
+++ b/sq-guide.md
@@ -1,7 +1,7 @@
---
-title: "User guide for Sequoia-PGP `sq`"
+title: "User guide for Sequoia PGP `sq`"
subtitle: "Keeping private things private"
-author: "The Sequoia-PGP project"
+author: "The Sequoia PGP project"
documentclass: report
...
@@ -77,13 +77,13 @@ $ ls -l decrypted.md
# Introduction
-## What are Sequoia-PGP and `sq`?
+## What are Sequoia PGP and `sq`?
-[Sequoia-PGP project]: https://sequoia-pgp.org/
+[Sequoia PGP project]: https://sequoia-pgp.org/
[Rust programming language]: https://www.rust-lang.org/
[sequoia-openpgp]: https://gitlab.com/sequoia-pgp/sequoia/-/tree/main/openpgp
-The [Sequoia-PGP project][] works to make use of cryptography for privacy
+The [Sequoia PGP project][] works to make use of cryptography for privacy
and authentication in communication more commonplace. The project
produces and maintains an implementation of the OpenPGP standard
that's easy and uncomplicated to use.
@@ -92,8 +92,8 @@ OpenPGP is used widely in the IT industry and by free and open source
projects to verify the authenticity of software packages, and for
encrypting and authenticating messages.
-`sq` is the command line tool provided by Sequoia-PGP. It's easy and
-uncomplicated to use. Sequoia-PGP also provides a library for the
+`sq` is the command line tool provided by Sequoia PGP. It's easy and
+uncomplicated to use. Sequoia PGP also provides a library for the
[Rust programming language][], called [sequoia-openpgp][]. However,
the library is only of interest to software developers, and this guide
is aimed at users of the `sq` tool.
@@ -149,7 +149,7 @@ specified by the OpenPGP standard:
* encrypting and decrypting data
The guide shows how to use the `sq` command line tool from
-Sequoia-PGP. It does not cover integrating Sequoia-PGP with mail
+Sequoia PGP. It does not cover integrating Sequoia PGP with mail
software, version control, file transfer software, or other
applications. (That will be covered by other documentation.)
@@ -171,7 +171,7 @@ This guide has the following structure:
underlying concepts.
* There is also an appendix with a glossary, which can be helpful for
looking up unknown terminology, and another appendix with links to
- additional material relevant to Sequoia-PGP and cryptography.
+ additional material relevant to Sequoia PGP and cryptography.
* The rest of this guide is discussions of the concepts needed
to understand how cryptography works, and how to use it well.
@@ -986,7 +986,7 @@ specifics that have been covered in the rest of the book.
-# Appendix: Switching from GnuPG to Sequoia-PGP {.unnumbered}
+# Appendix: Switching from GnuPG to Sequoia PGP {.unnumbered}
This appendix is aimed at people who already know how to use `gpg`,
the command line tool from GnuPG that roughly corresponds to `sq`. It
@@ -1119,7 +1119,7 @@ gpg --decrypt hello.txt.gpg
# Appendix: Glossary {#glossary .unnumbered}
This appendix explains all the specialist terminology related to
-OpenPGP and Sequoia-PGP. It includes both the terms Sequoia prefers
+OpenPGP and Sequoia PGP. It includes both the terms Sequoia prefers
(e.g., "certificate") and the older terminology for the same thing
("public key").
@@ -1204,7 +1204,7 @@ verify
* [Public key cryptography on Wikipedia](https://en.wikipedia.org/wiki/Public-key_cryptography)
* [RFC 4880](https://datatracker.ietf.org/doc/html/rfc4880), the
Internet standard specification for OpenPGP
-* [Sequoia-PGP website](https://sequoia-pgp.org/)
+* [Sequoia PGP website](https://sequoia-pgp.org/)
# Appendix: Copyright license {.unnumbered}