From: Florian Schmaus <flo@geekplace.eu>
To: linux-ext4@vger.kernel.org
Cc: Florian Schmaus <flo@geekplace.eu>
Subject: [PATCH 3/3] Clarify in e4crypt man page that -S is an optional argument
Date: Mon, 6 Jul 2020 21:47:27 +0200 [thread overview]
Message-ID: <20200706194727.12979-3-flo@geekplace.eu> (raw)
In-Reply-To: <20200706194727.12979-1-flo@geekplace.eu>
The Backus-Naur Form (BNF) of the synopsis of 'add_key' does currently
not state that the -S parameter takes an *mandatory* argument, while
the BNF found in the commands section of the man page does. The square
brackets around the optional parameter are also missing.
synopsis:
e4crypt add_key -S [ -k keyring ] [-v] [-q] [ -p pad ] [ path ... ]
commands:
e4crypt add_key [-vq] [-S salt ] [-k keyring ] [ -p pad ] [ path ... ]
This simply copies the add_key BNF from he commands section into the
synopsis.
Signed-off-by: Florian Schmaus <flo@geekplace.eu>
---
misc/e4crypt.8.in | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/misc/e4crypt.8.in b/misc/e4crypt.8.in
index 32fbd444..d2d6c872 100644
--- a/misc/e4crypt.8.in
+++ b/misc/e4crypt.8.in
@@ -2,7 +2,7 @@
.SH NAME
e4crypt \- ext4 filesystem encryption utility
.SH SYNOPSIS
-.B e4crypt add_key -S \fR[\fB -k \fIkeyring\fR ] [\fB-v\fR] [\fB-q\fR] \fR[\fB -p \fIpad\fR ] [ \fIpath\fR ... ]
+.B e4crypt add_key \fR[\fB-vq\fR] [\fB-S\fI salt\fR ] [\fB-k \fIkeyring\fR ] [\fB -p \fIpad\fR ] [ \fIpath\fR ... ]
.br
.B e4crypt new_session
.br
--
2.26.2
next prev parent reply other threads:[~2020-07-06 19:53 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-06 19:47 [PATCH 1/3] e4crypt: if salt is explicitly provided to add_key, then use it Florian Schmaus
2020-07-06 19:47 ` [PATCH 2/3] e4crypt: refactor set_policy a little Florian Schmaus
2020-07-06 22:04 ` Eric Biggers
2020-07-06 19:47 ` Florian Schmaus [this message]
2020-07-06 21:57 ` [PATCH 1/3] e4crypt: if salt is explicitly provided to add_key, then use it Eric Biggers
2020-07-07 8:36 ` Florian Schmaus
2020-07-07 21:40 ` Eric Biggers
2020-07-07 8:27 ` [PATCH v2] " Florian Schmaus
2020-07-07 21:47 ` Eric Biggers
2020-10-01 14:36 ` Theodore Y. Ts'o
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200706194727.12979-3-flo@geekplace.eu \
--to=flo@geekplace.eu \
--cc=linux-ext4@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).