From eb3ba01d56b2a9e3232558db55f14233a2abe355 Mon Sep 17 00:00:00 2001 From: Florian Sesser Date: Mon, 17 Mar 2025 16:50:56 +0000 Subject: [PATCH 1/6] v1 of grid-manager man page --- docs/man/man1/grid-manager.1 | 59 ++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 docs/man/man1/grid-manager.1 diff --git a/docs/man/man1/grid-manager.1 b/docs/man/man1/grid-manager.1 new file mode 100644 index 000000000..fce8d5d01 --- /dev/null +++ b/docs/man/man1/grid-manager.1 @@ -0,0 +1,59 @@ +.TH GRID-MANAGER 1 "March 2025" "Tahoe-LAFS" "User Commands" +. +.SH NAME +grid-manager \- A Tahoe Grid Manager for issuing certificates to storage-servers. +. +.SH SYNOPSIS +.B grid-manager +[\fIOPTIONS\fR] \fICOMMAND\fR [\fIARGS\fR]... +. +.SH DESCRIPTION +A Tahoe Grid Manager issues certificates to storage-servers. +. +A Tahoe client with one or more Grid Manager public keys configured will only upload to a Storage Server that presents a valid certificate signed by one of the configured Grid Manager keys. +. +Grid Manager configuration can be in a local directory or given via stdin. It contains long-term secret information (a private signing key) and should be kept safe. +. +.SH OPTIONS +.TP +.BR \-c , " --config " \fIPATH\fR +Configuration directory (or \- for stdin). \fIRequired.\fR +.TP +.B \--help +Show this message and exit. +. +.SH COMMANDS +.TP +.B add +Add a new storage-server by name to a Grid Manager. +.TP +.B create +Make a new Grid Manager. +.TP +.B list +List all storage-servers known to a Grid Manager. +.TP +.B public-identity +Show the public identity key of a Grid Manager. +.TP +.B remove +Remove an existing storage-server by name from a Grid Manager. +.TP +.B sign +Sign a new certificate. +. +.SH AUTHORS +Tahoe-LAFS has been written by Brian Warner, Zooko Wilcox-O'Hearn, and numerous other contributors. +. +.SH REPORTING BUGS +Please see . +. +Tahoe-LAFS home page: +. +Tahoe-LAFS development mailing list: +. +.SH COPYRIGHT +Copyright \(co 2006\(en2025 The Tahoe-LAFS Software Foundation. +. +.SH SEE ALSO +tahoe(1) From 551a588b928a7b396466b9561723fd38d7f8c059 Mon Sep 17 00:00:00 2001 From: Florian Sesser Date: Mon, 17 Mar 2025 17:52:10 +0000 Subject: [PATCH 2/6] Add Meejah as main author, minor formatting tweaks --- docs/man/man1/grid-manager.1 | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/man/man1/grid-manager.1 b/docs/man/man1/grid-manager.1 index fce8d5d01..b13aeac76 100644 --- a/docs/man/man1/grid-manager.1 +++ b/docs/man/man1/grid-manager.1 @@ -16,10 +16,10 @@ Grid Manager configuration can be in a local directory or given via stdin. It co . .SH OPTIONS .TP -.BR \-c , " --config " \fIPATH\fR -Configuration directory (or \- for stdin). \fIRequired.\fR +.BR \f[B]-c,\ --config\ \fIPATH\fR +Configuration directory (or - for stdin). \fIRequired.\fR .TP -.B \--help +.B \f[B]--help Show this message and exit. . .SH COMMANDS @@ -43,13 +43,15 @@ Remove an existing storage-server by name from a Grid Manager. Sign a new certificate. . .SH AUTHORS +Grid Manager has been written by meejah. +.PP Tahoe-LAFS has been written by Brian Warner, Zooko Wilcox-O'Hearn, and numerous other contributors. . .SH REPORTING BUGS Please see . -. +.PP Tahoe-LAFS home page: -. +.PP Tahoe-LAFS development mailing list: . .SH COPYRIGHT From 5fbc041873708aaab83dcfa2f65da21c26f03caf Mon Sep 17 00:00:00 2001 From: Florian Sesser Date: Mon, 17 Mar 2025 19:46:09 +0000 Subject: [PATCH 3/6] Add web links to extended documentation --- docs/man/man1/grid-manager.1 | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/man/man1/grid-manager.1 b/docs/man/man1/grid-manager.1 index b13aeac76..3a07cfea1 100644 --- a/docs/man/man1/grid-manager.1 +++ b/docs/man/man1/grid-manager.1 @@ -59,3 +59,6 @@ Copyright \(co 2006\(en2025 The Tahoe-LAFS Software Foundation. . .SH SEE ALSO tahoe(1) +.PP +The Tahoe-LAFS documentation on Grid Managers has more detail than this manual page: . +It includes a tutorial-style step-by-step example on how to set up a managed grid: From 8d6f93325dea058e3049b09972280024a093dcc6 Mon Sep 17 00:00:00 2001 From: Florian Sesser Date: Mon, 17 Mar 2025 19:52:15 +0000 Subject: [PATCH 4/6] Make hyperlinks work --- docs/man/man1/grid-manager.1 | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/man/man1/grid-manager.1 b/docs/man/man1/grid-manager.1 index 3a07cfea1..759beb705 100644 --- a/docs/man/man1/grid-manager.1 +++ b/docs/man/man1/grid-manager.1 @@ -48,11 +48,11 @@ Grid Manager has been written by meejah. Tahoe-LAFS has been written by Brian Warner, Zooko Wilcox-O'Hearn, and numerous other contributors. . .SH REPORTING BUGS -Please see . +Please see https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToReportABug. .PP -Tahoe-LAFS home page: +Tahoe-LAFS home page: https://tahoe-lafs.org/ .PP -Tahoe-LAFS development mailing list: +Tahoe-LAFS development mailing list: https://lists.tahoe-lafs.org/mailman/listinfo/tahoe-dev . .SH COPYRIGHT Copyright \(co 2006\(en2025 The Tahoe-LAFS Software Foundation. @@ -60,5 +60,5 @@ Copyright \(co 2006\(en2025 The Tahoe-LAFS Software Foundation. .SH SEE ALSO tahoe(1) .PP -The Tahoe-LAFS documentation on Grid Managers has more detail than this manual page: . -It includes a tutorial-style step-by-step example on how to set up a managed grid: +The Tahoe-LAFS documentation on Grid Managers has more detail than this manual page: https://tahoe-lafs.readthedocs.io/en/latest/managed-grid.html. +It includes a tutorial-style step-by-step example on how to set up a managed grid: https://tahoe-lafs.readthedocs.io/en/latest/managed-grid.html#example-setup-of-a-new-managed-grid From 52ad7f390f11464d7c3552b4013a76c23fd54ebd Mon Sep 17 00:00:00 2001 From: Florian Sesser Date: Mon, 17 Mar 2025 20:04:33 +0000 Subject: [PATCH 5/6] Make use of groff man hyperlink macros --- docs/man/man1/grid-manager.1 | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/docs/man/man1/grid-manager.1 b/docs/man/man1/grid-manager.1 index 759beb705..c4dfee7a5 100644 --- a/docs/man/man1/grid-manager.1 +++ b/docs/man/man1/grid-manager.1 @@ -48,17 +48,29 @@ Grid Manager has been written by meejah. Tahoe-LAFS has been written by Brian Warner, Zooko Wilcox-O'Hearn, and numerous other contributors. . .SH REPORTING BUGS -Please see https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToReportABug. +Please see +.UR https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToReportABug +.UE +. .PP -Tahoe-LAFS home page: https://tahoe-lafs.org/ +Tahoe-LAFS home page: +.UR https://tahoe-lafs.org/ +.UE .PP -Tahoe-LAFS development mailing list: https://lists.tahoe-lafs.org/mailman/listinfo/tahoe-dev +Tahoe-LAFS development mailing list: +.UR https://lists.tahoe-lafs.org/mailman/listinfo/tahoe-dev +.UE . .SH COPYRIGHT Copyright \(co 2006\(en2025 The Tahoe-LAFS Software Foundation. . .SH SEE ALSO -tahoe(1) +.MR tahoe 1 .PP -The Tahoe-LAFS documentation on Grid Managers has more detail than this manual page: https://tahoe-lafs.readthedocs.io/en/latest/managed-grid.html. -It includes a tutorial-style step-by-step example on how to set up a managed grid: https://tahoe-lafs.readthedocs.io/en/latest/managed-grid.html#example-setup-of-a-new-managed-grid +The Tahoe-LAFS documentation on Grid Managers has more detail than this manual page: +.UR https://tahoe-lafs.readthedocs.io/en/latest/managed-grid.html +.UE +.PP +It includes a step-by-step tutorial on how to set up a managed grid: +.UR https://tahoe-lafs.readthedocs.io/en/latest/managed-grid.html#example-setup-of-a-new-managed-grid +.UE From aab5a9b04a2ec806fa4ecb65201e60790c5ce6e7 Mon Sep 17 00:00:00 2001 From: Florian Sesser Date: Mon, 17 Mar 2025 20:11:05 +0000 Subject: [PATCH 6/6] Braino --- docs/man/man1/grid-manager.1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/man/man1/grid-manager.1 b/docs/man/man1/grid-manager.1 index c4dfee7a5..aefb68adc 100644 --- a/docs/man/man1/grid-manager.1 +++ b/docs/man/man1/grid-manager.1 @@ -20,7 +20,7 @@ Grid Manager configuration can be in a local directory or given via stdin. It co Configuration directory (or - for stdin). \fIRequired.\fR .TP .B \f[B]--help -Show this message and exit. +Show help message and exit. . .SH COMMANDS .TP