Starting the sentence with "Remember options" can easily be confused
with the imperative "remember". Reworded this slightly to be less
ambiguous.
Also clarify that leaving the option empty is equivalent to `skip` and
add `himitsu-ipc` as a related page (it documents the _remember
options_).
---
docs/himitsu-ssh.ini.5.scd | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/docs/himitsu-ssh.ini.5.scd b/docs/himitsu-ssh.ini.5.scd
index 82ee8a0..9a566e6 100644
--- a/docs/himitsu-ssh.ini.5.scd
+++ b/docs/himitsu-ssh.ini.5.scd
@@ -23,32 +23,32 @@ Options related to remembering consent are placed into the [remember] section.
The available options are:
*persist*
- Remember options that should be shown by the prompter when asking to
- persist access of the _proto=ssh_ query. Leave blank, if consent
- should not be remembered.
+ A comma separated list of _remember options_ that are passed to the
+ prompter when requesting persistent access to the _proto=ssh_ query.
+ Leaving this option blank is equivalent to _skip_ and will cause the
+ agent to skip this request.
- The value is a comma separated list of remember options. Possible
- options are _session_, _skip_, _refuse_ or a timeout in seconds as
- integer. _session_ will remember consent until himitsu or hissh-agent
- terminates. _skip_ will postpone the decision until the next prompt
- and _refuse_ will deny the request and future requests won't be shown.
+ Possible options are _session_, _skip_, _refuse_ or a timeout in seconds
+ as integer. _session_ will remember consent until himitsu or hissh-agent
+ terminates. _skip_ will postpone the decision until the next prompt and
+ _refuse_ will deny the request and future requests won't be shown.
The first value will be considered as the default one by the prompter.
- Default value, if the option is omitted: session,300,refuse
+ Default value, if the option is omitted: *session,300,refuse*
*disclose*
- Remember options that the prompter should show when asking for private
- key disclosure in e.g. signing operations. Leave blank, if not
- applicable.
+ A comma separated list of _remember options_ that are passed to the when
+ requesting private key disclosure (e.g.: in signing operations). Leave
+ blank, if not applicable.
Uses the same syntax as the *persist* option.
- Default value, if the option is omitted: skip,session,300
+ Default value, if the option is omitted: *skip,session,300*
# SEE ALSO
-*himitsu-ssh*(7)
+*himitsu-ssh*(7) *himitsu-ipc*(5)
# AUTHORS
--
2.45.2
---
docs/himitsu-ssh.ini.5.scd | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/docs/himitsu-ssh.ini.5.scd b/docs/himitsu-ssh.ini.5.scd
index 9a566e6..59bb5ef 100644
--- a/docs/himitsu-ssh.ini.5.scd
+++ b/docs/himitsu-ssh.ini.5.scd
@@ -46,6 +46,16 @@ The available options are:
Default value, if the option is omitted: *skip,session,300*
+# EXAMPLE
+
+The following example skips remembering
+
+```
+[remember]
+persist=skip
+disclose=skip
+```
+
# SEE ALSO
*himitsu-ssh*(7) *himitsu-ipc*(5)
--
2.45.2