Welcome to little lamb

Code » ssp » commit e64d2ed

doc: Mention RFCs & minor tweak re: escaping

author Olivier Brunel
2023-09-20 11:03:29 UTC
committer Olivier Brunel
2023-09-20 11:07:37 UTC
parent 1cdbf309a9600559585402e4b102cc78700911b7

doc: Mention RFCs & minor tweak re: escaping

src/doc/ssp.1.md +17 -2

diff --git a/src/doc/ssp.1.md b/src/doc/ssp.1.md
index c0e5f78..52b02bf 100644
--- a/src/doc/ssp.1.md
+++ b/src/doc/ssp.1.md
@@ -15,6 +15,13 @@ ssp - One-Time Password management
 Passwords (OTPs), whether you want to handle them from your computer or as a
 backup solution.
 
+It supports HOTP (An HMAC-Based One-Time Password Algorithm; as per [RFC 4226])
+as well as TOTP (Time-Based One-Time Password Algorithm; as per [RFC 6238]).
+
+[RFC 4226]: https://datatracker.ietf.org/doc/html/rfc4226
+[RFC 6238]: https://datatracker.ietf.org/doc/html/rfc6238
+
+
 # OPTIONS
 
 : *-D*, *--database* `FILE`
@@ -85,8 +92,16 @@ There are no restrictions of length or acceptable characters imposed by *ssp*
 byte).
 Specifically, inputs are treated as byte streams and processed as such.
 
-Note however that in order to use specific characters, or simply spaces, you'll
-need to put argument within double-quotes (`"`).
+Note however that in order to use specific characters you might have to put
+argument within double-quotes (`"`).
+
+! NOTE: Don't forget about your shell's own escaping
+! In order to give *ssp* an argument within double-quotes, remember that you'll
+! probably need to account for your shell's own escaping, e.g. put the whole
+! thing in between single-quotes.
+
+The content within double-quotes can be escaped as needed, according the the
+following rules.
 
 ## Escaping rules