Marco Ricci commited on 2025-02-10 00:41:49
Zeige 2 geänderte Dateien mit 49 Einfügungen und 21 Löschungen.
Some cross-references and trade names weren't marked up as such.
... | ... |
@@ -152,7 +152,7 @@ The compatibility and extension options modify the behavior to enable additional |
152 | 152 |
May be specified multiple times. |
153 | 153 |
Must not overlap with any of the settings being set afterwards. |
154 | 154 |
|
155 |
- (vault(1) does not support this option.) |
|
155 |
+ (<i>vault</i>(1) does not support this option.) |
|
156 | 156 |
|
157 | 157 |
<b>-</b><b>-export-as</b> \{ <b>json</b> | <b>sh</b> \} |
158 | 158 |
: When exporting the configuration via `--export`, export as JSON (default) or as a shell script in <i>sh</i>(1) format. |
... | ... |
@@ -160,7 +160,7 @@ The compatibility and extension options modify the behavior to enable additional |
160 | 160 |
The JSON format is compatible with <i>vault</i>(1). |
161 | 161 |
For the shell script format, see the ["SHELL SCRIPT EXPORT FORMAT"](#shell-script-export-format) section for details. |
162 | 162 |
|
163 |
- (vault(1) behaves as if `--export-as json` were always given.) |
|
163 |
+ (<i>vault</i>(1) behaves as if `--export-as json` were always given.) |
|
164 | 164 |
|
165 | 165 |
<b>-</b><b>-modern-editor-interface</b> | <b>-</b><b>-vault-legacy-editor-interface</b> |
166 | 166 |
: When editing notes, use a modern editor interface similar to <i>git</i>(1), or use the <i>vault</i>(1) legacy editing interface. |
... | ... |
@@ -174,7 +174,7 @@ The compatibility and extension options modify the behavior to enable additional |
174 | 174 |
<b>derivepassphrase vault</b> will use different editing instructions texts to reflect the editing interface in use. |
175 | 175 |
Additionally, for the legacy editing interface, a backup of the old notes contents will be stored in the configuration directory if the new notes differ from the old notes, to mitigate the risk of data loss because the edit cannot be aborted. |
176 | 176 |
|
177 |
- (vault(1) behaves as if `--vault-legacy-editor-interface` were always given.) |
|
177 |
+ (<i>vault</i>(1) behaves as if `--vault-legacy-editor-interface` were always given.) |
|
178 | 178 |
|
179 | 179 |
<b>-</b><b>-print-notes-before</b> / <b>-</b><b>-print-notes-after</b> |
180 | 180 |
: When deriving a passphrase, if the service has any service notes, print these notes before or after (<em>default</em>) the passphrase. |
... | ... |
@@ -129,15 +129,22 @@ for how this interacts with a stored passphrase or |
129 | 129 |
key. |
130 | 130 |
. |
131 | 131 |
.It Fl k , \-key |
132 |
-Select an SSH key. |
|
132 |
+Select an |
|
133 |
+.Tn SSH |
|
134 |
+key. |
|
133 | 135 |
.Pp |
134 | 136 |
. |
135 |
-An SSH agent such as OpenSSH's |
|
137 |
+An |
|
138 |
+.Tn SSH |
|
139 |
+agent such as |
|
140 |
+.Tn OpenSSH Ns No 's |
|
136 | 141 |
.Xr ssh-agent 1 |
137 |
-or PuTTY's |
|
142 |
+.Tn PuTTY Ns No 's |
|
138 | 143 |
.Xr pageant 1 |
139 | 144 |
must be running and accessible, and have the desired key loaded. |
140 |
-The SSH key must also be |
|
145 |
+The |
|
146 |
+.Tn SSH |
|
147 |
+key must also be |
|
141 | 148 |
.Em suitable |
142 | 149 |
for this purpose; see |
143 | 150 |
.Sx SSH key suitability |
... | ... |
@@ -567,7 +574,10 @@ and sometimes the agent used: |
567 | 574 |
. |
568 | 575 |
.It |
569 | 576 |
.Tn RSA , |
570 |
-Ed25519 and Ed448 keys are always suitable. |
|
577 |
+.Tn Ed25519 |
|
578 |
+and |
|
579 |
+.Tn Ed448 |
|
580 |
+keys are always suitable. |
|
571 | 581 |
.Tn OpenSSH Ns No 's |
572 | 582 |
.Xr ssh-agent 1 |
573 | 583 |
supports only these keys as suitable keys. |
... | ... |
@@ -636,9 +646,10 @@ legacy editor interface. |
636 | 646 |
.It |
637 | 647 |
There is |
638 | 648 |
.Sy no way |
639 |
-to retrieve the generated passphrases if the master passphrase, the SSH key, |
|
640 |
-or the exact passphrase settings are lost, short of trying out all possible |
|
641 |
-combinations. |
|
649 |
+to retrieve the generated passphrases if the master passphrase, the |
|
650 |
+.Tn SSH |
|
651 |
+key, or the exact passphrase settings are lost, short of trying out all |
|
652 |
+possible combinations. |
|
642 | 653 |
You are |
643 | 654 |
.Sy strongly |
644 | 655 |
advised to keep independent backups of the settings and the |
... | ... |
@@ -799,35 +810,48 @@ Further details are contained in the variable part of the message. |
799 | 810 |
. |
800 | 811 |
.\" Message-ID: ErrMsgTemplate.SSH_KEY_NOT_LOADED |
801 | 812 |
.It The requested SSH key is not loaded into the agent. |
802 |
-The running SSH agent does not contain the necessary SSH key. |
|
813 |
+The running |
|
814 |
+.Tn SSH |
|
815 |
+agent does not contain the necessary |
|
816 |
+.Tn SSH |
|
817 |
+key. |
|
803 | 818 |
. |
804 | 819 |
.\" Message-ID: ErrMsgTemplate.NO_SSH_AGENT_FOUND |
805 | 820 |
.It Cannot find any running SSH agent because SSH_AUTH_SOCK is not set. |
806 |
-We require a running SSH agent, but cannot locate its communication channel, |
|
807 |
-which is normally indicated by the |
|
821 |
+We require a running |
|
822 |
+.Tn SSH |
|
823 |
+agent, but cannot locate its communication channel, which is normally |
|
824 |
+indicated by the |
|
808 | 825 |
.Ev SSH_AUTH_SOCK |
809 | 826 |
environment variable. |
810 | 827 |
. |
811 | 828 |
.\" Message-ID: ErrMsgTemplate.NO_AF_UNIX |
812 | 829 |
.It Cannot connect to an SSH agent because this Python version does not support UNIX domain sockets. |
813 | 830 |
This Python installation does not support the communication mechanism |
814 |
-necessary to talk to SSH agents. |
|
831 |
+necessary to talk to |
|
832 |
+.Tn SSH |
|
833 |
+agents. |
|
815 | 834 |
. |
816 | 835 |
.\" Message-ID: ErrMsgTemplate.CANNOT_CONNECT_TO_AGENT |
817 | 836 |
.It Cannot connect to the SSH agent: %s. |
818 |
-We cannot connect to the SSH agent indicated by the |
|
837 |
+We cannot connect to the |
|
838 |
+.Tn SSH |
|
839 |
+agent indicated by the |
|
819 | 840 |
.Ev SSH_AUTH_SOCK |
820 | 841 |
environment variable. |
821 | 842 |
Further details are contained in the variable part of the message. |
822 | 843 |
. |
823 | 844 |
.\" Message-ID: ErrMsgTemplate.AGENT_REFUSED_LIST_KEYS |
824 | 845 |
.It The SSH agent failed to or refused to supply a list of loaded keys. |
825 |
-The SSH agent \(em while responsive in principle \(em did not fulfill the |
|
826 |
-request. |
|
846 |
+The |
|
847 |
+.Tn SSH |
|
848 |
+agent \(em while responsive in principle \(em did not fulfill the request. |
|
827 | 849 |
. |
828 | 850 |
.\" Message-ID: ErrMsgTemplate.AGENT_REFUSED_SIGNATURE |
829 | 851 |
.It "The SSH agent failed to or refused to" "issue a signature with the selected key," "necessary for deriving a service passphrase." |
830 |
-The SSH agent \(em while responsive in principle \(em failed to cooperate with |
|
852 |
+The |
|
853 |
+.Tn SSH |
|
854 |
+agent \(em while responsive in principle \(em failed to cooperate with |
|
831 | 855 |
deriving a service passphrase from the selected master |
832 | 856 |
.Tn SSH |
833 | 857 |
key. |
... | ... |
@@ -878,7 +902,9 @@ the same configuration setting was passed as an option and as an argument to |
878 | 902 |
.\" Message-ID: ErrMsgTemplate.NO_KEY_OR_PHRASE |
879 | 903 |
.It No passphrase or key was given in the configuration. |
880 | 904 |
.Nm derivepassphrase vault |
881 |
-does not know whether to use a master SSH key or a master passphrase. |
|
905 |
+does not know whether to use a master |
|
906 |
+.Tn SSH |
|
907 |
+key or a master passphrase. |
|
882 | 908 |
. |
883 | 909 |
.\" Message-ID: ErrMsgTemplate.USER_ABORTED_PASSPHRASE |
884 | 910 |
.It No passphrase was given; the user aborted the request. |
... | ... |
@@ -953,7 +979,9 @@ affects tab completion, not other functionality. |
953 | 979 |
.\" Message-ID: WarnMsgTemplate.SERVICE_PASSPHRASE_INEFFECTIVE |
954 | 980 |
.It Setting a %s passphrase is ineffective because a key is also set |
955 | 981 |
The configuration (global or key-specific) contains both a stored master |
956 |
-passphrase and an SSH key. |
|
982 |
+passphrase and an |
|
983 |
+.Tn SSH |
|
984 |
+key. |
|
957 | 985 |
The master passphrase will not take effect. |
958 | 986 |
. |
959 | 987 |
.\" Message-ID: WarnMsgTemplate.V10_SUBCOMMAND_REQUIRED |
960 | 988 |