Skip to content

Commit 8ef1d40

Browse files
AureliaDoloAureliaDolo
committed
Re generate CLI manpages.
1 parent 449d861 commit 8ef1d40

24 files changed

Lines changed: 131 additions & 42 deletions

‎docs/cli/manpages/parsec-cli-device-change-authentication.1‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,24 @@
44
.SH NAME
55
parsec\-cli\-device\-change\-authentication \- Change authentication medium for a device
66
.SH SYNOPSIS
7-
\fBparsec\-cli device change\-authentication\fR [\fB\-\-password\-stdin\fR] [\fB\-d\fR|\fB\-\-device\fR] [\fB\-c\fR|\fB\-\-config\-dir\fR] [\fB\-p\fR|\fB\-\-password\fR] [\fB\-k\fR|\fB\-\-keyring\fR] [\fB\-h\fR|\fB\-\-help\fR]
7+
\fBparsec\-cli device change\-authentication\fR [\fB\-\-auth\fR] [\fB\-\-password\-stdin\fR] [\fB\-d\fR|\fB\-\-device\fR] [\fB\-c\fR|\fB\-\-config\-dir\fR] [\fB\-h\fR|\fB\-\-help\fR]
88
.SH DESCRIPTION
99
Change authentication medium for a device
1010
.SH OPTIONS
1111
.TP
12+
\fB\-\-auth\fR \fI<AUTH>\fR [default: password]
13+
New authentication method for the new device
14+
.br
15+
16+
.br
17+
\fIPossible values:\fR
18+
.RS 14
19+
.IP \(bu 2
20+
keyring
21+
.IP \(bu 2
22+
password
23+
.RE
24+
.TP
1225
\fB\-\-password\-stdin\fR
1326
Read the password from stdin instead of TTY. This flag needs to be explicitly set (it does not have a env var)
1427
.TP
@@ -23,12 +36,6 @@ Parsec config directory
2336
.RS
2437
May also be specified with the \fBPARSEC_CONFIG_DIR\fR environment variable.
2538
.RE
26-
.TP
27-
\fB\-p\fR, \fB\-\-password\fR
28-
29-
.TP
30-
\fB\-k\fR, \fB\-\-keyring\fR
31-
3239
.TP
3340
\fB\-h\fR, \fB\-\-help\fR
3441
Print help

‎docs/cli/manpages/parsec-cli-device-forget-local.1‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,14 @@
44
.SH NAME
55
parsec\-cli\-device\-forget\-local \- Forget a local device It will still exist on the server but not locally anymore
66
.SH SYNOPSIS
7-
\fBparsec\-cli device forget\-local\fR [\fB\-d\fR|\fB\-\-device\fR] [\fB\-c\fR|\fB\-\-config\-dir\fR] [\fB\-\-force\fR] [\fB\-h\fR|\fB\-\-help\fR]
7+
\fBparsec\-cli device forget\-local\fR [\fB\-\-force\fR] [\fB\-d\fR|\fB\-\-device\fR] [\fB\-c\fR|\fB\-\-config\-dir\fR] [\fB\-h\fR|\fB\-\-help\fR]
88
.SH DESCRIPTION
99
Forget a local device It will still exist on the server but not locally anymore
1010
.SH OPTIONS
1111
.TP
12+
\fB\-\-force\fR
13+
force default option to bypass interaction
14+
.TP
1215
\fB\-d\fR, \fB\-\-device\fR \fI<DEVICE>\fR
1316
Device ID
1417
.RS
@@ -21,8 +24,5 @@ Parsec config directory
2124
May also be specified with the \fBPARSEC_CONFIG_DIR\fR environment variable.
2225
.RE
2326
.TP
24-
\fB\-\-force\fR
25-
Force forgetting local device without confirmation
26-
.TP
2727
\fB\-h\fR, \fB\-\-help\fR
2828
Print help

‎docs/cli/manpages/parsec-cli-device-import-recovery-device.1‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,24 @@
44
.SH NAME
55
parsec\-cli\-device\-import\-recovery\-device \- Import recovery device
66
.SH SYNOPSIS
7-
\fBparsec\-cli device import\-recovery\-device\fR [\fB\-\-password\-stdin\fR] [\fB\-c\fR|\fB\-\-config\-dir\fR] <\fB\-i\fR|\fB\-\-input\fR> <\fB\-l\fR|\fB\-\-label\fR> [\fB\-h\fR|\fB\-\-help\fR]
7+
\fBparsec\-cli device import\-recovery\-device\fR [\fB\-\-auth\fR] [\fB\-\-password\-stdin\fR] [\fB\-c\fR|\fB\-\-config\-dir\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR> <\fB\-l\fR|\fB\-\-label\fR>
88
.SH DESCRIPTION
99
Import recovery device
1010
.SH OPTIONS
1111
.TP
12+
\fB\-\-auth\fR \fI<AUTH>\fR [default: password]
13+
New authentication method for the new device
14+
.br
15+
16+
.br
17+
\fIPossible values:\fR
18+
.RS 14
19+
.IP \(bu 2
20+
keyring
21+
.IP \(bu 2
22+
password
23+
.RE
24+
.TP
1225
\fB\-\-password\-stdin\fR
1326
Read the password from stdin instead of TTY. This flag needs to be explicitly set (it does not have a env var)
1427
.TP
@@ -22,7 +35,7 @@ May also be specified with the \fBPARSEC_CONFIG_DIR\fR environment variable.
2235
Path where encrypted recovery device data is
2336
.TP
2437
\fB\-l\fR, \fB\-\-label\fR \fI<LABEL>\fR
25-
new device label
38+
New device label
2639
.TP
2740
\fB\-h\fR, \fB\-\-help\fR
2841
Print help

‎docs/cli/manpages/parsec-cli-device-overwrite-server-url.1‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,16 @@
44
.SH NAME
55
parsec\-cli\-device\-overwrite\-server\-url \- Change the server URL for the device, this is normally not needed
66
.SH SYNOPSIS
7-
\fBparsec\-cli device overwrite\-server\-url\fR [\fB\-\-password\-stdin\fR] [\fB\-d\fR|\fB\-\-device\fR] [\fB\-c\fR|\fB\-\-config\-dir\fR] <\fB\-s\fR|\fB\-\-server\-url\fR> [\fB\-h\fR|\fB\-\-help\fR]
7+
\fBparsec\-cli device overwrite\-server\-url\fR [\fB\-\-force\fR] [\fB\-\-password\-stdin\fR] [\fB\-d\fR|\fB\-\-device\fR] [\fB\-c\fR|\fB\-\-config\-dir\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-s\fR|\fB\-\-server\-url\fR>
88
.SH DESCRIPTION
99
Change the server URL for the device, this is normally not needed.
1010
.PP
1111
This is only useful if the organization gets migrated to a new server with a different domain name.
1212
.SH OPTIONS
1313
.TP
14+
\fB\-\-force\fR
15+
force default option to bypass interaction
16+
.TP
1417
\fB\-\-password\-stdin\fR
1518
Read the password from stdin instead of TTY. This flag needs to be explicitly set (it does not have a env var)
1619
.TP

‎docs/cli/manpages/parsec-cli-invite-claim.1‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,24 @@
44
.SH NAME
55
parsec\-cli\-invite\-claim \- Claim an invitation
66
.SH SYNOPSIS
7-
\fBparsec\-cli invite claim\fR [\fB\-\-password\-stdin\fR] [\fB\-d\fR|\fB\-\-data\-dir\fR] [\fB\-c\fR|\fB\-\-config\-dir\fR] [\fB\-\-use\-keyring\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIADDR\fR>
7+
\fBparsec\-cli invite claim\fR [\fB\-\-auth\fR] [\fB\-\-password\-stdin\fR] [\fB\-d\fR|\fB\-\-data\-dir\fR] [\fB\-c\fR|\fB\-\-config\-dir\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIADDR\fR>
88
.SH DESCRIPTION
99
Claim an invitation
1010
.SH OPTIONS
1111
.TP
12+
\fB\-\-auth\fR \fI<AUTH>\fR [default: password]
13+
New authentication method for the new device
14+
.br
15+
16+
.br
17+
\fIPossible values:\fR
18+
.RS 14
19+
.IP \(bu 2
20+
keyring
21+
.IP \(bu 2
22+
password
23+
.RE
24+
.TP
1225
\fB\-\-password\-stdin\fR
1326
Read the password from stdin instead of TTY. This flag needs to be explicitly set (it does not have a env var)
1427
.TP
@@ -24,9 +37,6 @@ Parsec config directory
2437
May also be specified with the \fBPARSEC_CONFIG_DIR\fR environment variable.
2538
.RE
2639
.TP
27-
\fB\-\-use\-keyring\fR
28-
Use keyring to store the password for the device
29-
.TP
3040
\fB\-h\fR, \fB\-\-help\fR
3141
Print help
3242
.TP

‎docs/cli/manpages/parsec-cli-ls.1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
.SH NAME
55
parsec\-cli\-ls \- List workspace contents
66
.SH SYNOPSIS
7-
\fBparsec\-cli ls\fR <\fB\-w\fR|\fB\-\-workspace\fR> [\fB\-\-password\-stdin\fR] [\fB\-d\fR|\fB\-\-device\fR] [\fB\-c\fR|\fB\-\-config\-dir\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIPATH\fR]
7+
\fBparsec\-cli ls\fR [\fB\-\-password\-stdin\fR] [\fB\-d\fR|\fB\-\-device\fR] [\fB\-c\fR|\fB\-\-config\-dir\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-w\fR|\fB\-\-workspace\fR> [\fIPATH\fR]
88
.SH DESCRIPTION
99
List workspace contents
1010
.SH OPTIONS

‎docs/cli/manpages/parsec-cli-organization-bootstrap.1‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,28 @@
44
.SH NAME
55
parsec\-cli\-organization\-bootstrap \- Configure new organization
66
.SH SYNOPSIS
7-
\fBparsec\-cli organization bootstrap\fR <\fB\-a\fR|\fB\-\-addr\fR> <\fB\-d\fR|\fB\-\-device\-label\fR> <\fB\-l\fR|\fB\-\-label\fR> <\fB\-e\fR|\fB\-\-email\fR> [\fB\-\-sequester\-key\fR] [\fB\-\-password\-stdin\fR] [\fB\-h\fR|\fB\-\-help\fR]
7+
\fBparsec\-cli organization bootstrap\fR [\fB\-\-auth\fR] [\fB\-\-password\-stdin\fR] [\fB\-\-sequester\-key\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-\-addr\fR> <\fB\-d\fR|\fB\-\-device\-label\fR> <\fB\-l\fR|\fB\-\-label\fR> <\fB\-e\fR|\fB\-\-email\fR>
88
.SH DESCRIPTION
99
Configure new organization
1010
.SH OPTIONS
1111
.TP
12-
\fB\-a\fR, \fB\-\-addr\fR \fI<ADDR>\fR
12+
\fB\-\-auth\fR \fI<AUTH>\fR [default: password]
13+
New authentication method for the new device
14+
.br
15+
16+
.br
17+
\fIPossible values:\fR
18+
.RS 14
19+
.IP \(bu 2
20+
keyring
21+
.IP \(bu 2
22+
password
23+
.RE
24+
.TP
25+
\fB\-\-password\-stdin\fR
26+
Read the password from stdin instead of TTY. This flag needs to be explicitly set (it does not have a env var)
27+
.TP
28+
\fB\-\-addr\fR \fI<ADDR>\fR
1329
Bootstrap address (e.g: parsec3://127.0.0.1:6770/Org?no_ssl=true&action=bootstrap_organization&token=59961ba6dcc9b018d2fdc9da1c0c762b716a27cff30594562dc813e4b765871a or http://127.0.0.1:6770/Org?no_ssl=true&action=bootstrap_organization&token=59961ba6dcc9b018d2fdc9da1c0c762b716a27cff30594562dc813e4b765871a)
1430
.TP
1531
\fB\-d\fR, \fB\-\-device\-label\fR \fI<DEVICE_LABEL>\fR
@@ -24,8 +40,5 @@ User email
2440
\fB\-\-sequester\-key\fR \fI<SEQUESTER_KEY>\fR
2541
Sequester authority verify key path
2642
.TP
27-
\fB\-\-password\-stdin\fR
28-
Read the password from stdin instead of TTY
29-
.TP
3043
\fB\-h\fR, \fB\-\-help\fR
3144
Print help

‎docs/cli/manpages/parsec-cli-organization-create.1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
.SH NAME
55
parsec\-cli\-organization\-create \- Create new organization
66
.SH SYNOPSIS
7-
\fBparsec\-cli organization create\fR <\fB\-t\fR|\fB\-\-token\fR> <\fB\-a\fR|\fB\-\-addr\fR> [\fB\-h\fR|\fB\-\-help\fR] <\fIORGANIZATION\fR>
7+
\fBparsec\-cli organization create\fR [\fB\-h\fR|\fB\-\-help\fR] <\fB\-t\fR|\fB\-\-token\fR> <\fB\-a\fR|\fB\-\-addr\fR> <\fIORGANIZATION\fR>
88
.SH DESCRIPTION
99
Create new organization
1010
.SH OPTIONS

‎docs/cli/manpages/parsec-cli-organization-stats.1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
.SH NAME
55
parsec\-cli\-organization\-stats \- Get data & user statistics on organization
66
.SH SYNOPSIS
7-
\fBparsec\-cli organization stats\fR <\fB\-o\fR|\fB\-\-organization\fR> <\fB\-t\fR|\fB\-\-token\fR> <\fB\-a\fR|\fB\-\-addr\fR> [\fB\-h\fR|\fB\-\-help\fR]
7+
\fBparsec\-cli organization stats\fR [\fB\-h\fR|\fB\-\-help\fR] <\fB\-o\fR|\fB\-\-organization\fR> <\fB\-t\fR|\fB\-\-token\fR> <\fB\-a\fR|\fB\-\-addr\fR>
88
.SH DESCRIPTION
99
Get data & user statistics on organization
1010
.SH OPTIONS

‎docs/cli/manpages/parsec-cli-organization-status.1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
.SH NAME
55
parsec\-cli\-organization\-status \- Get organization status
66
.SH SYNOPSIS
7-
\fBparsec\-cli organization status\fR <\fB\-o\fR|\fB\-\-organization\fR> <\fB\-t\fR|\fB\-\-token\fR> <\fB\-a\fR|\fB\-\-addr\fR> [\fB\-h\fR|\fB\-\-help\fR]
7+
\fBparsec\-cli organization status\fR [\fB\-h\fR|\fB\-\-help\fR] <\fB\-o\fR|\fB\-\-organization\fR> <\fB\-t\fR|\fB\-\-token\fR> <\fB\-a\fR|\fB\-\-addr\fR>
88
.SH DESCRIPTION
99
Get organization status
1010
.SH OPTIONS

0 commit comments

Comments
 (0)