Skip to content

Commit dbbe836

Browse files
miquellamiquella
committed
Add roff formatted man pages
1 parent 5106b45 commit dbbe836

12 files changed

+203
-0
lines changed

‎man/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Markdown Conversion
2+
===================
3+
4+
To simplify documentation writing, our man pages are first written in Markdown
5+
and then converted to roff format using the `md2man` Ruby gem.
6+
7+
If you modify a Markdown document in this directory you should commit the
8+
regenerated roff version in the same commit. To regenerate the roff version,
9+
use this command:
10+
11+
```sh
12+
md2man-roff DOCFILE.1.md > DOCFILE.1
13+
```
14+
15+
But first, you may have to install the `md2man` gem: `gem install md2man`

‎man/vaulted-add.1

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.TH vaulted\-add 1
2+
.SH NAME
3+
.PP
4+
vaulted add \- interactively creates the content of a new vault
5+
.SH SYNOPSIS
6+
.PP
7+
\fB\fCvaulted add\fR \fIname\fP
8+
.SH DESCRIPTION
9+
.PP
10+
Spawns an interactve mode for editing the content of a new vault.
11+
.PP
12+
Upon quitting, the new content is saved to the vault.

‎man/vaulted-cp.1

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.TH vaulted\-cp 1
2+
.SH NAME
3+
.PP
4+
vaulted cp \- copies the content of a vault and saves it as a new vault with a new password
5+
.SH SYNOPSIS
6+
.PP
7+
\fB\fCvaulted cp\fR \fIold\fP \fInew\fP
8+
.br
9+
\fB\fCvaulted copy\fR \fIold\fP \fInew\fP
10+
.SH DESCRIPTION
11+
.PP
12+
Content in the \fInew\fP vault is created or replaced by content from \fIold\fP\&.
13+
.PP
14+
If the \fB\fCVAULTED_PASSWORD\fR environment variable is set, it will be used as the
15+
password for \fIold\fP, otherwise the password will be requested via the tty.
16+
.PP
17+
If the \fB\fCVAULTED_NEW_PASSWORD\fR environment variable is set, it will be used as
18+
the password for \fInew\fP, otherwise the password will be requested via the tty.

‎man/vaulted-dump.1

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.TH vaulted\-dump 1
2+
.SH NAME
3+
.PP
4+
vaulted dump \- writes the content of a vault to stdout as JSON
5+
.SH SYNOPSIS
6+
.PP
7+
\fB\fCvaulted dump\fR \fIname\fP
8+
.SH DESCRIPTION
9+
.PP
10+
Dumps the content of the vault to stdout in JSON format.

‎man/vaulted-edit.1

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.TH vaulted\-edit 1
2+
.SH NAME
3+
.PP
4+
vaulted edit \- interactively edits the content of an existing vault
5+
.SH SYNOPSIS
6+
.PP
7+
\fB\fCvaulted edit\fR \fIname\fP
8+
.SH DESCRIPTION
9+
.PP
10+
Spawns an interactve mode for editing the content of an existing vault.
11+
.PP
12+
Upon quitting, the new content is saved to the vault.

‎man/vaulted-env.1

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.TH vaulted\-env 1
2+
.SH NAME
3+
.PP
4+
vaulted env \- outputs shell commands that load secrets for a vault into the shell
5+
.SH SYNOPSIS
6+
.PP
7+
\fB\fCvaulted env\fR \fIname\fP
8+
.SH DESCRIPTION
9+
.PP
10+
Creates an environment using variables and the AWS key stored in the vault. The
11+
resulting environment variables are used to generate shell commands that will
12+
load the secrets into a shell.
13+
.PP
14+
The shell is autodetected from the \fB\fCSHELL\fR environment variable, if the shell
15+
is unknown or unspecified, \fB\fCsh\fR compatible commands are emitted.
16+
.PP
17+
\fINote:\fP SSH keys are ignored when generating environments this way. This is due
18+
to the inability to track the lifetime of the environment, which means the SSH
19+
agent would exist indefinitely.

‎man/vaulted-load.1

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.TH vaulted\-load 1
2+
.SH NAME
3+
.PP
4+
vaulted load \- uses JSON provided to stdin to create or replace the content of a vault
5+
.SH SYNOPSIS
6+
.PP
7+
\fB\fCvaulted load\fR \fIname\fP
8+
.SH DESCRIPTION
9+
.PP
10+
Replaces the content of \fIname\fP with JSON content provided via stdin.

‎man/vaulted-ls.1

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.TH vaulted\-ls 1
2+
.SH NAME
3+
.PP
4+
vaulted ls \- lists all vaults
5+
.SH SYNOPSIS
6+
.PP
7+
\fB\fCvaulted ls\fR
8+
.br
9+
\fB\fCvaulted list\fR
10+
.SH DESCRIPTION
11+
.PP
12+
Lists all vaults, one per line, to stdout.

‎man/vaulted-rm.1

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.TH vaulted\-rm 1
2+
.SH NAME
3+
.PP
4+
vaulted rm \- removes existing vaults
5+
.SH SYNOPSIS
6+
.PP
7+
\fB\fCvaulted rm\fR \fIname\fP \fI\&...\fP
8+
.SH DESCRIPTION
9+
.PP
10+
Removes the vaults specified by \fIname\fP\&. The exit code is equal to the number of
11+
vaults that could not be removed.
12+
.PP
13+
If a vault cannot be removed, the error is displayed on stdout.

‎man/vaulted-shell.1

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.TH vaulted\-shell 1
2+
.SH NAME
3+
.PP
4+
vaulted shell \- starts an interactive shell with the secrets for the vault loaded into the shell
5+
.SH SYNOPSIS
6+
.PP
7+
\fB\fCvaulted shell\fR \fIname\fP
8+
.SH DESCRIPTION
9+
.PP
10+
Starts an interactive shell (uses the \fB\fCSHELL\fR environment variable, if set;
11+
otherwise defaults to \fB\fC/bin/sh\fR).

‎man/vaulted-upgrade.1

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.TH vaulted\-upgrade 1
2+
.SH NAME
3+
.PP
4+
vaulted upgrade \- upgrades legacy vaults to the current vault format
5+
.SH SYNOPSIS
6+
.PP
7+
\fB\fCvaulted upgrade\fR
8+
.SH DESCRIPTION
9+
.PP
10+
Reads legacy vaults and converts them to the current vault format. The same
11+
password is used for the converted vaults.
12+
.PP
13+
The exit code is equal to the number of vaults that could not be upgraded.

‎man/vaulted.1

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
.TH vaulted 1
2+
.SH NAME
3+
.PP
4+
vaulted \- spawn environments from securely stored secrets
5+
.SH SYNOPSIS
6+
.PP
7+
\fB\fCvaulted\fR \fB\fC\-n\fR \fIname\fP [\fB\fC\-i\fR]
8+
.br
9+
\fB\fCvaulted\fR \fB\fC\-n\fR \fIname\fP [\fB\fC\-\-\fR] \fICMD\fP
10+
.PP
11+
\fB\fCvaulted\fR \fICOMMAND\fP [\fIargs...\fP]
12+
.SH DESCRIPTION
13+
.PP
14+
If no \fICOMMAND\fP is provided, \fB\fCvaulted\fR either spawns \fICMD\fP (if provided) or
15+
spawns an interactive shell.
16+
.PP
17+
\fB\fC\-\-\fR may be used to differentiate the \fICMD\fP from \fB\fCvaulted\fR\&'s own arguments.
18+
.SH COMMANDS
19+
.TP
20+
\fB\fCadd\fR
21+
Interactively creates the content of a new vault. See
22+
.BR vaulted-add (1).
23+
.TP
24+
\fB\fCcp\fR / \fB\fCcopy\fR
25+
Copies the content of a vault and saves it as a new vault with a new password. See
26+
.BR vaulted-cp (1).
27+
.TP
28+
\fB\fCdump\fR
29+
Writes the content of a vault to stdout as JSON. See
30+
.BR vaulted-dump (1).
31+
.TP
32+
\fB\fCedit\fR
33+
Interactively edits the content of an existing vault. See
34+
.BR vaulted-edit (1).
35+
.TP
36+
\fB\fCenv\fR
37+
Outputs shell commands that load secrets for a vault into the shell. See
38+
.BR vaulted-env (1).
39+
.TP
40+
\fB\fCload\fR
41+
Uses JSON provided to stdin to create or replace the content of a vault. See
42+
.BR vaulted-load (1).
43+
.TP
44+
\fB\fCls\fR / \fB\fClist\fR
45+
Lists all vaults. See
46+
.BR vaulted-ls (1).
47+
.TP
48+
\fB\fCrm\fR
49+
Removes existing vaults. See
50+
.BR vaulted-rm (1).
51+
.TP
52+
\fB\fCshell\fR
53+
Starts an interactive shell with the secrets for the vault loaded into the shell. See
54+
.BR vaulted-shell (1).
55+
.TP
56+
\fB\fCupgrade\fR
57+
Upgrades legacy vaults to the current vault format. See
58+
.BR vaulted-upgrade (1).

0 commit comments

Comments
 (0)