Skip to content

Commit 26dd195

Browse files
committed
flux-keygen(1): add --name option
Problem: the flux-keygen --name option is undocumented. Add it to the flux-keygen(1) man page.
1 parent ebc3245 commit 26dd195

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

doc/man1/flux-keygen.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ flux-keygen(1)
66
SYNOPSIS
77
========
88

9-
**flux** **keygen** *PATH*
9+
**flux** **keygen** [*--name=NAME*] *PATH*
1010

1111

1212
DESCRIPTION
@@ -28,6 +28,17 @@ In that case, each broker self-generates a unique certificate and the
2828
public keys are exchanged with PMI.
2929

3030

31+
OPTIONS
32+
=======
33+
34+
``flux-keygen`` accepts the following options:
35+
36+
**-n, --name=NAME**
37+
Set the certificate metadata ``name`` field. The value is logged when
38+
:man1:`flux-broker` authenticates a peer that presents this certificate.
39+
A cluster name might be appropriate here. Default: the local hostname.
40+
41+
3142
RESOURCES
3243
=========
3344

0 commit comments

Comments
 (0)