Skip to content

Commit 9c9faca

Browse files
mmartinvmmartinv
committed
docs: add init-admin man pages and update RPM spec
Generate man pages for the three new init-admin subcommands and update existing server role man pages with SEE ALSO cross-references. Add the new man page entries to the RPM spec %files section so they are included in the package. Signed-off-by: Miguel Martín <mmartinv@redhat.com>
1 parent fabd66d commit 9c9faca

7 files changed

Lines changed: 183 additions & 3 deletions

‎build/package/rpm/go-fdo-server.spec‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,11 @@ install -m 0644 -vp docs/man/*.1 %{buildroot}%{_mandir}/man1
103103
# Man pages
104104
%{_mandir}/man1/go-fdo-server.1*
105105
%{_mandir}/man1/go-fdo-server-manufacturing.1*
106+
%{_mandir}/man1/go-fdo-server-manufacturing-init-admin.1*
106107
%{_mandir}/man1/go-fdo-server-owner.1*
108+
%{_mandir}/man1/go-fdo-server-owner-init-admin.1*
107109
%{_mandir}/man1/go-fdo-server-rendezvous.1*
110+
%{_mandir}/man1/go-fdo-server-rendezvous-init-admin.1*
108111

109112
%pre
110113
%sysusers_create_compat %{SOURCE2}

‎docs/man/go-fdo-server-manufacturing-init-admin.1‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
.nh
2+
.TH "GO-FDO-SERVER-MANUFACTURING-INIT-ADMIN" "1" "go-fdo-server" "Go FDO Server"
3+
4+
.SH NAME
5+
go-fdo-server-manufacturing-init-admin - Create initial admin user and API key
6+
7+
8+
.SH SYNOPSIS
9+
\fBgo-fdo-server manufacturing init-admin [flags]\fP
10+
11+
12+
.SH DESCRIPTION
13+
Creates an admin user with full permissions and generates an API key. The API key is printed to stdout.
14+
15+
16+
.SH OPTIONS
17+
\fB--email\fP="admin@example.com"
18+
Admin user email
19+
20+
.PP
21+
\fB--force\fP[=false]
22+
Create admin even if users exist
23+
24+
.PP
25+
\fB-h\fP, \fB--help\fP[=false]
26+
help for init-admin
27+
28+
.PP
29+
\fB--name\fP="admin"
30+
Admin user name
31+
32+
33+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
34+
\fB--config\fP=""
35+
Pathname of the configuration file
36+
37+
.PP
38+
\fB--db-dsn\fP=""
39+
Database DSN (connection string)
40+
41+
.PP
42+
\fB--db-type\fP="sqlite"
43+
Database type (sqlite or postgres)
44+
45+
.PP
46+
\fB--http-cert\fP=""
47+
Path to server certificate
48+
49+
.PP
50+
\fB--http-key\fP=""
51+
Path to server private key
52+
53+
.PP
54+
\fB--log-level\fP="info"
55+
Set logging level (debug, info, warn, error)
56+
57+
58+
.SH SEE ALSO
59+
\fBgo-fdo-server-manufacturing(1)\fP

‎docs/man/go-fdo-server-manufacturing.1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,4 @@ generate Ownership Vouchers.
7171

7272

7373
.SH SEE ALSO
74-
\fBgo-fdo-server(1)\fP
74+
\fBgo-fdo-server(1)\fP, \fBgo-fdo-server-manufacturing-init-admin(1)\fP

‎docs/man/go-fdo-server-owner-init-admin.1‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
.nh
2+
.TH "GO-FDO-SERVER-OWNER-INIT-ADMIN" "1" "go-fdo-server" "Go FDO Server"
3+
4+
.SH NAME
5+
go-fdo-server-owner-init-admin - Create initial admin user and API key
6+
7+
8+
.SH SYNOPSIS
9+
\fBgo-fdo-server owner init-admin [flags]\fP
10+
11+
12+
.SH DESCRIPTION
13+
Creates an admin user with full permissions and generates an API key. The API key is printed to stdout.
14+
15+
16+
.SH OPTIONS
17+
\fB--email\fP="admin@example.com"
18+
Admin user email
19+
20+
.PP
21+
\fB--force\fP[=false]
22+
Create admin even if users exist
23+
24+
.PP
25+
\fB-h\fP, \fB--help\fP[=false]
26+
help for init-admin
27+
28+
.PP
29+
\fB--name\fP="admin"
30+
Admin user name
31+
32+
33+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
34+
\fB--config\fP=""
35+
Pathname of the configuration file
36+
37+
.PP
38+
\fB--db-dsn\fP=""
39+
Database DSN (connection string)
40+
41+
.PP
42+
\fB--db-type\fP="sqlite"
43+
Database type (sqlite or postgres)
44+
45+
.PP
46+
\fB--http-cert\fP=""
47+
Path to server certificate
48+
49+
.PP
50+
\fB--http-key\fP=""
51+
Path to server private key
52+
53+
.PP
54+
\fB--log-level\fP="info"
55+
Set logging level (debug, info, warn, error)
56+
57+
58+
.SH SEE ALSO
59+
\fBgo-fdo-server-owner(1)\fP

‎docs/man/go-fdo-server-owner.1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,4 @@ TO0 protocol against the Rendezvous server, registering itself as a device owner
7171

7272

7373
.SH SEE ALSO
74-
\fBgo-fdo-server(1)\fP
74+
\fBgo-fdo-server(1)\fP, \fBgo-fdo-server-owner-init-admin(1)\fP

‎docs/man/go-fdo-server-rendezvous-init-admin.1‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
.nh
2+
.TH "GO-FDO-SERVER-RENDEZVOUS-INIT-ADMIN" "1" "go-fdo-server" "Go FDO Server"
3+
4+
.SH NAME
5+
go-fdo-server-rendezvous-init-admin - Create initial admin user and API key
6+
7+
8+
.SH SYNOPSIS
9+
\fBgo-fdo-server rendezvous init-admin [flags]\fP
10+
11+
12+
.SH DESCRIPTION
13+
Creates an admin user with full permissions and generates an API key. The API key is printed to stdout.
14+
15+
16+
.SH OPTIONS
17+
\fB--email\fP="admin@example.com"
18+
Admin user email
19+
20+
.PP
21+
\fB--force\fP[=false]
22+
Create admin even if users exist
23+
24+
.PP
25+
\fB-h\fP, \fB--help\fP[=false]
26+
help for init-admin
27+
28+
.PP
29+
\fB--name\fP="admin"
30+
Admin user name
31+
32+
33+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
34+
\fB--config\fP=""
35+
Pathname of the configuration file
36+
37+
.PP
38+
\fB--db-dsn\fP=""
39+
Database DSN (connection string)
40+
41+
.PP
42+
\fB--db-type\fP="sqlite"
43+
Database type (sqlite or postgres)
44+
45+
.PP
46+
\fB--http-cert\fP=""
47+
Path to server certificate
48+
49+
.PP
50+
\fB--http-key\fP=""
51+
Path to server private key
52+
53+
.PP
54+
\fB--log-level\fP="info"
55+
Set logging level (debug, info, warn, error)
56+
57+
58+
.SH SEE ALSO
59+
\fBgo-fdo-server-rendezvous(1)\fP

‎docs/man/go-fdo-server-rendezvous.1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,4 @@ directs devices to their Owner server during the TO1 protocol.
7676

7777

7878
.SH SEE ALSO
79-
\fBgo-fdo-server(1)\fP
79+
\fBgo-fdo-server(1)\fP, \fBgo-fdo-server-rendezvous-init-admin(1)\fP

0 commit comments

Comments
 (0)