Skip to content

Commit

Permalink
fix error in edit man page
Browse files Browse the repository at this point in the history
  • Loading branch information
ryan-norton authored and miquella committed Mar 23, 2017
1 parent 5446ba3 commit e37f732
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 34 deletions.
42 changes: 23 additions & 19 deletions doc/man/vaulted-edit.1
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,30 @@ m \- MFA
Manages MFA (multi\-factor authentication) ARN or serial number. If enabled,
user will be prompted to enter MFA code when accessing vault. MFA will
remain active for the vault duration.
.RE
.PP
If you are using STS credentials, which occurs by default (see the 't'
option below for details), you must have MFA enabled to invoke any IAM calls.
* r \- Role
.br
ARN of role to be assumed when accessing vault.
When assuming a role, the maximum duration allowed by AWS is 1 hour. If your
duration is greater than 1 hour when setting a role, the duration will be
adjusted to 1 hour.
* t \- Substitute with temporary credentials
If you are using STS credentials, which occurs by default (see the 't'
option below for details), you must have MFA enabled to invoke any IAM calls.
.IP \(bu 2
r \- Role
.br
ARN of role to be assumed when accessing vault.
When assuming a role, the maximum duration allowed by AWS is 1 hour. If your
duration is greater than 1 hour when setting a role, the duration will be
adjusted to 1 hour.
.IP \(bu 2
t \- Substitute with temporary credentials
.br
Toggles whether your AWS credentials are substituted with a set of temporary
credentials. For more details on this process, see the documentation for
\fB\fCvaulted shell\fR\&.
* S \- Show/Hide Key
Toggles whether your AWS credentials are substituted with a set of temporary
credentials. For more details on this process, see the documentation for
\fB\fCvaulted shell\fR\&.
.IP \(bu 2
S \- Show/Hide Key
.br
Toggles whether Secret Access Key ID is displayed when viewing vault
details in the edit menu. This setting only affects the current editing
session and is reset to hidden each time the vault is reopened for editing.
* D \- Delete
Toggles whether Secret Access Key ID is displayed when viewing vault
details in the edit menu. This setting only affects the current editing
session and is reset to hidden each time the vault is reopened for editing.
.IP \(bu 2
D \- Delete
.br
Removes all AWS details stored in the vault.
Removes all AWS details stored in the vault.
.RE
5 changes: 2 additions & 3 deletions doc/vaulted-edit.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ AWS KEY
* m - MFA
Manages MFA (multi-factor authentication) ARN or serial number. If enabled,
user will be prompted to enter MFA code when accessing vault. MFA will
remain active for the vault duration.

remain active for the vault duration.
If you are using STS credentials, which occurs by default (see the 't'
option below for details), you must have MFA enabled to invoke any IAM calls.
* r - Role
Expand All @@ -44,4 +43,4 @@ AWS KEY
details in the edit menu. This setting only affects the current editing
session and is reset to hidden each time the vault is reopened for editing.
* D - Delete
Removes all AWS details stored in the vault.
Removes all AWS details stored in the vault.
24 changes: 12 additions & 12 deletions man.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit e37f732

Please sign in to comment.