Package: release.debian.org Severity: normal Control: affects -1 + src:tahoe-lafs User: [email protected] Usertags: unblock
Please unblock package tahoe-lafs. [ Reason ]The upstream has updated package's manpages. In tahoe-lafs/1.20.0-6 I have backported an upstream PR with the changes touching only the manpages.
[ Impact ] tahoe-lafs would ship incomplete and not the most up-to-date manpages. [ Tests ] Package builds successfully. [ Risks ] None known; tahoe-lafs is a leaf package. [ Checklist ] [x] all changes are documented in the d/changelog [x] I reviewed all changes and I approve them [x] attach debdiff against the package in testing [ Other info ] None unblock tahoe-lafs/1.20.0-6
diff -Nru tahoe-lafs-1.20.0/debian/changelog tahoe-lafs-1.20.0/debian/changelog --- tahoe-lafs-1.20.0/debian/changelog 2025-04-14 08:39:41.000000000 -0400 +++ tahoe-lafs-1.20.0/debian/changelog 2025-05-16 04:15:21.000000000 -0400 @@ -1,3 +1,9 @@ +tahoe-lafs (1.20.0-6) unstable; urgency=medium + + * Backport a PR adjusting manpages. + + -- Andrius Merkys <[email protected]> Fri, 16 May 2025 04:15:21 -0400 + tahoe-lafs (1.20.0-5) unstable; urgency=medium * Limit building to 64bit architectures (Closes: #1103096) diff -Nru tahoe-lafs-1.20.0/debian/manpages tahoe-lafs-1.20.0/debian/manpages --- tahoe-lafs-1.20.0/debian/manpages 2025-04-14 08:39:41.000000000 -0400 +++ tahoe-lafs-1.20.0/debian/manpages 2025-05-16 04:15:21.000000000 -0400 @@ -1 +1,2 @@ +docs/man/man1/grid-manager.1 docs/man/man1/tahoe.1 diff -Nru tahoe-lafs-1.20.0/debian/patches/1433.patch tahoe-lafs-1.20.0/debian/patches/1433.patch --- tahoe-lafs-1.20.0/debian/patches/1433.patch 1969-12-31 19:00:00.000000000 -0500 +++ tahoe-lafs-1.20.0/debian/patches/1433.patch 2025-05-16 04:15:21.000000000 -0400 @@ -0,0 +1,1395 @@ +From 81ce6de5a894c5a419761460ffc73b6a972246b1 Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Tue, 18 Mar 2025 16:01:28 +0000 +Subject: [PATCH 01/18] Update tahoe man page: Global options + +--- + docs/man/man1/tahoe.1 | 43 ++++++++++++++++++++++++++++++++----------- + 1 file changed, 32 insertions(+), 11 deletions(-) + +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index ab3d3c4c5a..0bb40d6eb5 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -1,11 +1,30 @@ +-.TH TAHOE 1 "July 2011" "Tahoe-LAFS \[em] tahoe command" "User Commands" ++.TH TAHOE 1 "March 2025" "Tahoe-LAFS \[em] tahoe command" "User Commands" + .SH NAME +-.PP +-tahoe - Secure distributed file store. ++tahoe \- Secure distributed file store. + .SH SYNOPSIS +-.PP +-tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]PARAMETER\f[]]... +-.SH GENERAL OPTIONS ++.B tahoe ++[\fI\,global-options\/\fR] \fI\,<command> \/\fR[\fI\,command-options\/\fR] ++.SH GLOBAL OPTIONS ++.TP ++\fB\-d\fR, \fB\-\-node\-directory=\fR ++Specify which Tahoe node directory should be ++used. The directory should either contain a ++full Tahoe node, or a file named node.url that ++points to some other Tahoe node. It should also ++contain a file named 'private/aliases' which ++contains the mapping from alias name to root ++dirnode URI. [default for most commands: ++\&`$HOME/.tahoe'] ++.TP ++\fB\-\-eliot\-destination=\fR ++Add an Eliot logging destination. May be given ++more than once. ++.TP ++\fB\-\-help\fR ++Display help and exit. ++.TP ++\fB\-\-help\-eliot\-destinations\fR ++Emit usage information for \fB\-\-eliot\-destination\fR. + .TP + .B \f[B]-q,\ --quiet\f[] + Operate silently. +@@ -22,11 +41,13 @@ Display version numbers and paths to their locations. + .RS + .RE + .TP +-.B \f[B]-d,\ --node-directory\f[] +-Specify which Tahoe node directory should be used. +-(default for most commands: `$HOME/.tahoe') +-.RS +-.RE ++\fB\-\-wormhole\-invite\-appid=\fR ++The appid to use on the wormhole server. ++[default: tahoe\-lafs.org/invite] ++.TP ++\fB\-\-wormhole\-server=\fR ++The magic wormhole server to use. [default: ++ws://wormhole.tahoe\-lafs.org:4000/v1] + .SH COMMANDS + .PP + The \f[B]tahoe\f[] runner can be used for various tasks depending + +From 549ce0aaa66b2a0659188b4707d35dd0be1596aa Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Tue, 18 Mar 2025 16:27:37 +0000 +Subject: [PATCH 02/18] Update tahoe man page: Overhaul 'Controlling nodes' + section + +--- + docs/man/man1/tahoe.1 | 47 ++++++++++++------------------------------- + 1 file changed, 13 insertions(+), 34 deletions(-) + +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index 0bb40d6eb5..3a25c013e1 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -99,53 +99,32 @@ only). + tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] + .SS COMMANDS + .TP +-.B \f[B]start\f[] +-Start a node (of any type). +-.RS +-.RE +-.TP +-.B \f[B]stop\f[] +-Stop a node. +-.RS +-.RE +-.TP +-.B \f[B]restart\f[] +-Restart a node. +-.RS +-.RE +-.TP + .B \f[B]run\f[] +-Run a node synchronously. ++Run a node without daemonizing. ++This is the only option for runnings nodes. ++In the past, tahoe offered service running internally (with start, restart, ++stop commands), but this was brittle and not very portable and has been ++discontinued. + .RS + .RE + .SS OPTIONS + .TP +-.B \f[B]-p,\ --profile\f[] +-Run under the Python profiler, putting results in +-`profiling_results.prof' (use with \f[B]start\f[] or +-\f[B]restart\f[] only). +-.RS +-.RE +-.TP +-.B \f[B]--syslog\f[] +-Tell the node to log to syslog, not a file (use with \f[B]start\f[] +-or \f[B]restart\f[] only). ++.B \f[B]--allow-stdin-close\f[] ++Do not exit when stdin closes ("tahoe run" otherwise will exit). ++This is required for some service runners (like systemd, for example). + .RS + .RE + .TP + .B \f[B]-C,\ --basedir=\f[] +-Same as \[em]node-directory. +-.RS +-.RE +-.TP +-.B \f[B]-d,\ --node-directory=\f[] +-Specify which Tahoe node directory should be used (default for commands +-other than \f[B]run\f[]: `$HOME/.tahoe/'). ++Specify which Tahoe base directory should be used. ++This has the same effect as the global --node-directory option. [default: '$HOME/.tahoe'] + .RS + .RE + .TP + .B \f[B]--help\f[] +-Display help and exit ++Display help and exit. This includes lots of `twistd-options' for debugging, ++logging, profiling, et cetera that are left out of this manual page for ++brevity. + .RS + .RE + .SS USING THE FILE STORE + +From 4b5e9bdb5fe626a941c75c3be4ef5171d5671678 Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Tue, 18 Mar 2025 21:22:15 +0000 +Subject: [PATCH 03/18] Update tahoe man page: Add description and see also + section + +--- + docs/man/man1/grid-manager.1 | 76 ++++++++++++++++++++++++++++++++++++ + docs/man/man1/tahoe.1 | 16 ++++++++ + 2 files changed, 92 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 0000000000..aefb68adc0 +--- /dev/null ++++ b/docs/man/man1/grid-manager.1 +@@ -0,0 +1,76 @@ ++.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 \f[B]-c,\ --config\ \fIPATH\fR ++Configuration directory (or - for stdin). \fIRequired.\fR ++.TP ++.B \f[B]--help ++Show help 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 ++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 ++.UR https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToReportABug ++.UE ++. ++.PP ++Tahoe-LAFS home page: ++.UR https://tahoe-lafs.org/ ++.UE ++.PP ++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 ++.MR tahoe 1 ++.PP ++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 +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index 3a25c013e1..5ce7be1fbd 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -4,6 +4,15 @@ tahoe \- Secure distributed file store. + .SH SYNOPSIS + .B tahoe + [\fI\,global-options\/\fR] \fI\,<command> \/\fR[\fI\,command-options\/\fR] ++.SH DESCRIPTION ++Tahoe-LAFS offers provider-independent security for your data. ++You don't have to trust Tahoe-LAFS storage nodes for confidentiality or integrity - both are provided through cryptography. ++Additionally, Tahoe-LAFS helps with availability and anonymity. ++ ++The `tahoe' command line application is a single program offering access to almost all of Tahoe-LAFS' functionality. ++Brevity permits only a succinct overview, and even then, not all commands and options can be covered here. ++Please have a look at the `SEE ALSO' section at the end of this manual page for pointers to further instructions. ++. + .SH GLOBAL OPTIONS + .TP + \fB\-d\fR, \fB\-\-node\-directory=\fR +@@ -272,3 +281,10 @@ tahoe-dev mailing list: <https://lists.tahoe-lafs.org/mailman/listinfo/tahoe-dev + .SH COPYRIGHT + .PP + Copyright \@ 2006\[en]2013 The Tahoe-LAFS Software Foundation ++.SH "SEE ALSO" ++Run 'tahoe \fB\-\-help\fR' for an overview of commands and 'tahoe <command> \fB\-\-help\fR' for more details on each command. ++ ++See ++.UR https://tahoe-lafs.readthedocs.io/ ++.UE ++for more in-depth, longer-form documentation and step-by-step tutorials. + +From e5a368ce4942cf310057c18b4fa42a680af79662 Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Mon, 28 Apr 2025 13:26:45 +0000 +Subject: [PATCH 04/18] Line length + light edits + +--- + docs/man/man1/tahoe.1 | 40 ++++++++++++++++++++++++++++------------ + 1 file changed, 28 insertions(+), 12 deletions(-) + +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index 5ce7be1fbd..4c88f95404 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -5,13 +5,20 @@ tahoe \- Secure distributed file store. + .B tahoe + [\fI\,global-options\/\fR] \fI\,<command> \/\fR[\fI\,command-options\/\fR] + .SH DESCRIPTION +-Tahoe-LAFS offers provider-independent security for your data. +-You don't have to trust Tahoe-LAFS storage nodes for confidentiality or integrity - both are provided through cryptography. +-Additionally, Tahoe-LAFS helps with availability and anonymity. ++Tahoe-LAFS offers provider-independent security ++for your data. You don't have to trust Tahoe-LAFS ++storage nodes for confidentiality or integrity - ++both are provided through cryptography. ++Additionally, Tahoe-LAFS helps with availability ++and anonymity. + +-The `tahoe' command line application is a single program offering access to almost all of Tahoe-LAFS' functionality. +-Brevity permits only a succinct overview, and even then, not all commands and options can be covered here. +-Please have a look at the `SEE ALSO' section at the end of this manual page for pointers to further instructions. ++The `tahoe' command line application is a single ++program offering access to almost all of ++Tahoe-LAFS' functionality. Brevity permits only a ++succinct overview, and even then, not all commands ++and options can be covered here. Please have a ++look at the `SEE ALSO' section at the end of this ++manual page for pointers to further instructions. + . + .SH GLOBAL OPTIONS + .TP +@@ -110,10 +117,10 @@ tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] + .TP + .B \f[B]run\f[] + Run a node without daemonizing. +-This is the only option for runnings nodes. +-In the past, tahoe offered service running internally (with start, restart, +-stop commands), but this was brittle and not very portable and has been +-discontinued. ++This is the only option for running nodes. ++In the past, tahoe offered service watching internally (with start, restart, ++stop commands), but this was and not very portable and has been ++deprecated. + .RS + .RE + .SS OPTIONS +@@ -282,9 +289,18 @@ tahoe-dev mailing list: <https://lists.tahoe-lafs.org/mailman/listinfo/tahoe-dev + .PP + Copyright \@ 2006\[en]2013 The Tahoe-LAFS Software Foundation + .SH "SEE ALSO" +-Run 'tahoe \fB\-\-help\fR' for an overview of commands and 'tahoe <command> \fB\-\-help\fR' for more details on each command. ++Run 'tahoe \fB\-\-help\fR' for an overview of ++commands and 'tahoe <command> \fB\-\-help\fR' for ++more details on each command. + + See + .UR https://tahoe-lafs.readthedocs.io/ + .UE +-for more in-depth, longer-form documentation and step-by-step tutorials. ++for more in-depth, longer-form documentation and ++step-by-step tutorials. ++ ++See ++.UR https://tahoe-lafs.readthedocs.io/en/tahoe-lafs-1.20.0/frontends/CLI.html ++.UE ++for user documentation specific to the 'tahoe' ++command. + +From 80fdaba0faf19fa2f1550835bb16316af4ce4e11 Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Mon, 28 Apr 2025 17:35:19 +0000 +Subject: [PATCH 05/18] Update tahoe(1) manpage WIP + +--- + docs/man/man1/tahoe.1 | 83 +++++++++++++++++++++---------------------- + 1 file changed, 41 insertions(+), 42 deletions(-) + +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index 4c88f95404..9259d0e890 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -6,19 +6,20 @@ tahoe \- Secure distributed file store. + [\fI\,global-options\/\fR] \fI\,<command> \/\fR[\fI\,command-options\/\fR] + .SH DESCRIPTION + Tahoe-LAFS offers provider-independent security +-for your data. You don't have to trust Tahoe-LAFS +-storage nodes for confidentiality or integrity - +-both are provided through cryptography. +-Additionally, Tahoe-LAFS helps with availability +-and anonymity. ++for your data. You don't have to trust storage ++nodes for confidentiality or integrity - both are ++provided through cryptography. ++Additionally, Tahoe-LAFS can help with availability ++and anonymity (but cannot guarantee either by itself). + +-The `tahoe' command line application is a single +-program offering access to almost all of +-Tahoe-LAFS' functionality. Brevity permits only a +-succinct overview, and even then, not all commands +-and options can be covered here. Please have a +-look at the `SEE ALSO' section at the end of this +-manual page for pointers to further instructions. ++The "tahoe" executable can be used to create and ++manage client/server nodes, manipulate the file ++store, and perform several debugging/maintenance ++tasks. ++ ++Please have a look at the `SEE ALSO' section at ++the end of this manual page for pointers to ++further instructions. + . + .SH GLOBAL OPTIONS + .TP +@@ -52,11 +53,6 @@ Display version numbers. + .RS + .RE + .TP +-.B \f[B]--version-and-path\f[] +-Display version numbers and paths to their locations. +-.RS +-.RE +-.TP + \fB\-\-wormhole\-invite\-appid=\fR + The appid to use on the wormhole server. + [default: tahoe\-lafs.org/invite] +@@ -68,7 +64,7 @@ ws://wormhole.tahoe\-lafs.org:4000/v1] + .PP + The \f[B]tahoe\f[] runner can be used for various tasks depending + on the command used. +-.SS ADMINISTRATION ++.SH ADMINISTRATION + .PP + tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] + .RS +@@ -78,19 +74,14 @@ tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] + Create a node that acts as a client, server or both. + .TP + .B \f[B]create-client\f[] +-Create a client node (with storage initially disabled). ++Create a client node (providing storage to others initially disabled). + .TP + .B \f[B]create-introducer\f[] + Create an introducer node. + .SS OPTIONS + .TP + .B \f[B]-C,\ --basedir=\f[] +-Same as \[em]node-directory. +-.TP +-.B \f[B]-d,\ --node-directory=\f[] +-Specify which Tahoe node directory should be used. +-(default for \f[B]create-node\f[] and \f[B]create-client\f[]: +-`$HOME/.tahoe/'). ++Same as the global --node-directory option. + .TP + .B \f[B]-n,\ --nickname=\f[] + Specify the nickname for this node (\f[B]create-node\f[] and +@@ -110,14 +101,14 @@ Default: `tcp:3456:interface=127.0.0.1' (\f[B]create-node\f[] and + Do not offer storage service to other nodes (\f[B]create-node\f[] + only). + .RE +-.SS CONTROLLING NODES ++.SH CONTROLLING NODES + .PP + tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] + .SS COMMANDS + .TP + .B \f[B]run\f[] + Run a node without daemonizing. +-This is the only option for running nodes. ++This is the only command for running nodes. + In the past, tahoe offered service watching internally (with start, restart, + stop commands), but this was and not very portable and has been + deprecated. +@@ -132,8 +123,7 @@ This is required for some service runners (like systemd, for example). + .RE + .TP + .B \f[B]-C,\ --basedir=\f[] +-Specify which Tahoe base directory should be used. +-This has the same effect as the global --node-directory option. [default: '$HOME/.tahoe'] ++Same as the global --node-directory option. + .RS + .RE + .TP +@@ -143,7 +133,9 @@ logging, profiling, et cetera that are left out of this manual page for + brevity. + .RS + .RE +-.SS USING THE FILE STORE ++.SH USING THE FILE STORE ++.PP ++tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] + .TP + .B \f[B]mkdir\f[] + Create a new directory. +@@ -238,7 +230,7 @@ Check all files/directories reachable from a starting point + .PP + Please run `tahoe \f[I]COMMAND\f[] --help' for more details on each + command. +-.SS DEBUGGING ++.SH DEBUGGING + .PP + tahoe debug \f[I]SUBCOMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]PARAMETER\f[]]... + .SS SUBCOMMANDS +@@ -267,6 +259,11 @@ Describe all shares in node dirs. + Corrupt a share by flipping a bit. + .RS + .RE ++.TP ++.B \f[B]flogtool\f[] ++Utilities to access log files. ++.RS ++.RE + .PP + Please run e.g.\ `tahoe debug dump-share --help' for more + details on each subcommand. +@@ -277,30 +274,32 @@ and dozens of others. + This manpage was originally written by bertagaz. + .SH REPORTING BUGS + .PP +-Please see <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToReportABug>. +-.PP +-For known security issues see +-<https://tahoe-lafs.org/trac/tahoe-lafs/browser/docs/known_issues.rst>. ++Please see ++.UR https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToReportABug ++.UE . + .PP + Tahoe-LAFS home page: <https://tahoe-lafs.org/> + .PP +-tahoe-dev mailing list: <https://lists.tahoe-lafs.org/mailman/listinfo/tahoe-dev> ++tahoe-dev mailing list: ++.UR https://lists.tahoe-lafs.org/mailman/listinfo/tahoe-dev ++.UE + .SH COPYRIGHT + .PP +-Copyright \@ 2006\[en]2013 The Tahoe-LAFS Software Foundation ++Copyright \(co 2006\(en2025 The Tahoe-LAFS Software Foundation. + .SH "SEE ALSO" + Run 'tahoe \fB\-\-help\fR' for an overview of + commands and 'tahoe <command> \fB\-\-help\fR' for + more details on each command. + ++See ++.UR https://tahoe-lafs.readthedocs.io/en/tahoe-lafs-1.20.0/frontends/CLI.html ++.UE ++for user documentation specific to the 'tahoe' ++command. ++ + See + .UR https://tahoe-lafs.readthedocs.io/ + .UE + for more in-depth, longer-form documentation and + step-by-step tutorials. + +-See +-.UR https://tahoe-lafs.readthedocs.io/en/tahoe-lafs-1.20.0/frontends/CLI.html +-.UE +-for user documentation specific to the 'tahoe' +-command. + +From c10695a16ce6f4a18ba3656adf0367fe4c2f372b Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Mon, 28 Apr 2025 17:37:56 +0000 +Subject: [PATCH 06/18] White-space only (or nothing at all?) - Clear manual + indentation + +This seems to do nothing at all - .RS indents and .RE un-indents. +--- + docs/man/man1/tahoe.1 | 62 ------------------------------------------- + 1 file changed, 62 deletions(-) + +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index 9259d0e890..3d3497ddac 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -45,13 +45,9 @@ Emit usage information for \fB\-\-eliot\-destination\fR. + .TP + .B \f[B]-q,\ --quiet\f[] + Operate silently. +-.RS +-.RE + .TP + .B \f[B]-V,\ --version\f[] + Display version numbers. +-.RS +-.RE + .TP + \fB\-\-wormhole\-invite\-appid=\fR + The appid to use on the wormhole server. +@@ -67,7 +63,6 @@ on the command used. + .SH ADMINISTRATION + .PP + tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] +-.RS + .SS COMMANDS + .TP + .B \f[B]create-node\f[] +@@ -100,7 +95,6 @@ Default: `tcp:3456:interface=127.0.0.1' (\f[B]create-node\f[] and + .B \f[B]--no-storage\f[] + Do not offer storage service to other nodes (\f[B]create-node\f[] + only). +-.RE + .SH CONTROLLING NODES + .PP + tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] +@@ -112,120 +106,76 @@ This is the only command for running nodes. + In the past, tahoe offered service watching internally (with start, restart, + stop commands), but this was and not very portable and has been + deprecated. +-.RS +-.RE + .SS OPTIONS + .TP + .B \f[B]--allow-stdin-close\f[] + Do not exit when stdin closes ("tahoe run" otherwise will exit). + This is required for some service runners (like systemd, for example). +-.RS +-.RE + .TP + .B \f[B]-C,\ --basedir=\f[] + Same as the global --node-directory option. +-.RS +-.RE + .TP + .B \f[B]--help\f[] + Display help and exit. This includes lots of `twistd-options' for debugging, + logging, profiling, et cetera that are left out of this manual page for + brevity. +-.RS +-.RE + .SH USING THE FILE STORE + .PP + tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] + .TP + .B \f[B]mkdir\f[] + Create a new directory. +-.RS +-.RE + .TP + .B \f[B]add-alias\f[] + Add a new alias cap. +-.RS +-.RE + .TP + .B \f[B]create-alias\f[] + Create a new alias cap. +-.RS +-.RE + .TP + .B \f[B]list-aliases\f[] + List all alias caps. +-.RS +-.RE + .TP + .B \f[B]ls\f[] + List a directory. +-.RS +-.RE + .TP + .B \f[B]get\f[] + Retrieve a file from the grid. +-.RS +-.RE + .TP + .B \f[B]put\f[] + Upload a file into the grid. +-.RS +-.RE + .TP + .B \f[B]cp\f[] + Copy one or more files or directories. +-.RS +-.RE + .TP + .B \f[B]unlink\f[] + Unlink a file or directory on the grid. +-.RS +-.RE + .TP + .B \f[B]rm\f[] + Unlink a file or directory on the grid (same as \f[B]unlink\f[]). +-.RS +-.RE + .TP + .B \f[B]mv\f[] + Move a file within the grid. +-.RS +-.RE + .TP + .B \f[B]ln\f[] + Make an additional link to an existing file or directory. +-.RS +-.RE + .TP + .B \f[B]backup\f[] + Make target dir look like local dir. +-.RS +-.RE + .TP + .B \f[B]webopen\f[] + Open a web browser to a grid file or directory. +-.RS +-.RE + .TP + .B \f[B]manifest\f[] + List all files/directories in a subtree. +-.RS +-.RE + .TP + .B \f[B]stats\f[] + Print statistics about all files/directories in a subtree. +-.RS +-.RE + .TP + .B \f[B]check\f[] + Check a single file or directory. +-.RS +-.RE + .TP + .B \f[B]deep-check\f[] + Check all files/directories reachable from a starting point +-.RS +-.RE + .SS OPTIONS + .PP + Please run `tahoe \f[I]COMMAND\f[] --help' for more details on each +@@ -237,33 +187,21 @@ tahoe debug \f[I]SUBCOMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]PARAMETER\f[]]... + .TP + .B \f[B]dump-share\f[] + Unpack and display the contents of a share. +-.RS +-.RE + .TP + .B \f[B]dump-cap\f[] + Unpack a read-cap or write-cap. +-.RS +-.RE + .TP + .B \f[B]find-shares\f[] + Locate sharefiles in node directories. +-.RS +-.RE + .TP + .B \f[B]catalog-shares\f[] + Describe all shares in node dirs. +-.RS +-.RE + .TP + .B \f[B]corrupt-share\f[] + Corrupt a share by flipping a bit. +-.RS +-.RE + .TP + .B \f[B]flogtool\f[] + Utilities to access log files. +-.RS +-.RE + .PP + Please run e.g.\ `tahoe debug dump-share --help' for more + details on each subcommand. + +From 51ec3a8ab4300eb0c43253252b034562684ab995 Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Mon, 28 Apr 2025 18:42:47 +0000 +Subject: [PATCH 07/18] tahoe (1) man page - more edits + +--- + docs/man/man1/tahoe.1 | 44 ++++++++++++++++++++++++------------------- + 1 file changed, 25 insertions(+), 19 deletions(-) + +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index 3d3497ddac..ecb8791730 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -59,20 +59,26 @@ ws://wormhole.tahoe\-lafs.org:4000/v1] + .SH COMMANDS + .PP + The \f[B]tahoe\f[] runner can be used for various tasks depending +-on the command used. +-.SH ADMINISTRATION ++on the command used: + .PP + tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] ++.SH ADMINISTRATION + .SS COMMANDS + .TP + .B \f[B]create-node\f[] + Create a node that acts as a client, server or both. + .TP + .B \f[B]create-client\f[] +-Create a client node (providing storage to others initially disabled). ++Create a client node (disabling providing storage to others). + .TP + .B \f[B]create-introducer\f[] + Create an introducer node. ++When the grid is large or very dynamic, introducers make it easier for clients to connect. ++See "Static Server Definitions" in the documentation on how to configure clients to connect to one or more storage servers without using an introdcuer. ++.TP ++.B \f[B]invite\f[] ++Invite a new node to a grid. ++See "Magic Wormhole Invites" in the documentation. + .SS OPTIONS + .TP + .B \f[B]-C,\ --basedir=\f[] +@@ -86,6 +92,10 @@ Specify the nickname for this node (\f[B]create-node\f[] and + Specify the introducer FURL to use (\f[B]create-node\f[] and + \f[B]create-client\f[] only). + .TP ++.B \f[B]--hostname=\f[] ++Hostname to automatically set --location/--port when ++--listen=tcp (the default). ++.TP + .B \f[B]-p,\ --webport=\f[] + Specify which TCP port to run the HTTP interface on. + Use `none' to disable. +@@ -96,8 +106,6 @@ Default: `tcp:3456:interface=127.0.0.1' (\f[B]create-node\f[] and + Do not offer storage service to other nodes (\f[B]create-node\f[] + only). + .SH CONTROLLING NODES +-.PP +-tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] + .SS COMMANDS + .TP + .B \f[B]run\f[] +@@ -121,16 +129,17 @@ logging, profiling, et cetera that are left out of this manual page for + brevity. + .SH USING THE FILE STORE + .PP +-tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] +-.TP ++Please run `tahoe \f[I]COMMAND\f[] --help' for more details on each ++command. ++.SS COMMANDS + .B \f[B]mkdir\f[] +-Create a new directory. ++Create a directory and return its directory capability ("dircap"). + .TP + .B \f[B]add-alias\f[] +-Add a new alias cap. ++Add an alias for an existing cap. + .TP + .B \f[B]create-alias\f[] +-Create a new alias cap. ++Create an alias pointing to a new cap. + .TP + .B \f[B]list-aliases\f[] + List all alias caps. +@@ -176,13 +185,12 @@ Check a single file or directory. + .TP + .B \f[B]deep-check\f[] + Check all files/directories reachable from a starting point +-.SS OPTIONS +-.PP +-Please run `tahoe \f[I]COMMAND\f[] --help' for more details on each +-command. + .SH DEBUGGING + .PP + tahoe debug \f[I]SUBCOMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]PARAMETER\f[]]... ++ ++Please run e.g.\ `tahoe debug dump-share --help' for more ++details on each subcommand. + .SS SUBCOMMANDS + .TP + .B \f[B]dump-share\f[] +@@ -202,9 +210,6 @@ Corrupt a share by flipping a bit. + .TP + .B \f[B]flogtool\f[] + Utilities to access log files. +-.PP +-Please run e.g.\ `tahoe debug dump-share --help' for more +-details on each subcommand. + .SH AUTHORS + .PP + Tahoe-LAFS has been written by Brian Warner, Zooko Wilcox-O'Hearn +@@ -238,6 +243,7 @@ command. + See + .UR https://tahoe-lafs.readthedocs.io/ + .UE +-for more in-depth, longer-form documentation and +-step-by-step tutorials. ++for "the documentation" - in-depth, longer-form ++explanations, specifications and step-by-step ++tutorials. + + +From 72ad89093638d0b3e2db3d44fa8f7fc055bc8f3f Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Mon, 28 Apr 2025 18:47:55 +0000 +Subject: [PATCH 08/18] Check syntax and act on groff's warnings + +Command used: `groff -rCHECKSTYLE=3 -man -ww tahoe.1 > /dev/null` +--- + docs/man/man1/tahoe.1 | 12 ++++++------ + 1 file changed, 6 insertions(+), 6 deletions(-) + +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index ecb8791730..1b503a800a 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -11,12 +11,12 @@ nodes for confidentiality or integrity - both are + provided through cryptography. + Additionally, Tahoe-LAFS can help with availability + and anonymity (but cannot guarantee either by itself). +- ++.sp + The "tahoe" executable can be used to create and + manage client/server nodes, manipulate the file + store, and perform several debugging/maintenance + tasks. +- ++.sp + Please have a look at the `SEE ALSO' section at + the end of this manual page for pointers to + further instructions. +@@ -188,7 +188,7 @@ Check all files/directories reachable from a starting point + .SH DEBUGGING + .PP + tahoe debug \f[I]SUBCOMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]PARAMETER\f[]]... +- ++.sp + Please run e.g.\ `tahoe debug dump-share --help' for more + details on each subcommand. + .SS SUBCOMMANDS +@@ -233,17 +233,17 @@ Copyright \(co 2006\(en2025 The Tahoe-LAFS Software Foundation. + Run 'tahoe \fB\-\-help\fR' for an overview of + commands and 'tahoe <command> \fB\-\-help\fR' for + more details on each command. +- ++.sp + See + .UR https://tahoe-lafs.readthedocs.io/en/tahoe-lafs-1.20.0/frontends/CLI.html + .UE + for user documentation specific to the 'tahoe' + command. +- ++.sp + See + .UR https://tahoe-lafs.readthedocs.io/ + .UE + for "the documentation" - in-depth, longer-form + explanations, specifications and step-by-step + tutorials. +- ++.sp + +From 133c820334e134adec725674ea22e4ce4a7158cc Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Mon, 28 Apr 2025 18:57:18 +0000 +Subject: [PATCH 09/18] It's April. + +--- + docs/man/man1/tahoe.1 | 2 +- + 1 file changed, 1 insertion(+), 1 deletion(-) + +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index 1b503a800a..2e708c7077 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -1,4 +1,4 @@ +-.TH TAHOE 1 "March 2025" "Tahoe-LAFS \[em] tahoe command" "User Commands" ++.TH TAHOE 1 "April 2025" "Tahoe-LAFS \[em] tahoe command" "User Commands" + .SH NAME + tahoe \- Secure distributed file store. + .SH SYNOPSIS + +From 69becdaeb91c07b21b807d5270d850cd64b6d4c0 Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Mon, 28 Apr 2025 19:00:37 +0000 +Subject: [PATCH 10/18] Try to be clearer + +--- + docs/man/man1/tahoe.1 | 2 +- + 1 file changed, 1 insertion(+), 1 deletion(-) + +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index 2e708c7077..cffd06caee 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -69,7 +69,7 @@ tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] + Create a node that acts as a client, server or both. + .TP + .B \f[B]create-client\f[] +-Create a client node (disabling providing storage to others). ++Create a client node (providing storage to others initially disabled). + .TP + .B \f[B]create-introducer\f[] + Create an introducer node. + +From b15edcb9d6e2d960245fa31f5519c1ff2db3eb9a Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Mon, 28 Apr 2025 19:11:31 +0000 +Subject: [PATCH 11/18] No news. + +--- + newsfragments/4168.minor | 0 + 1 file changed, 0 insertions(+), 0 deletions(-) + create mode 100644 newsfragments/4168.minor + +diff --git a/newsfragments/4168.minor b/newsfragments/4168.minor +new file mode 100644 +index 0000000000..e69de29bb2 + +From 4b9a2655868066ccea046ab70cf12f13c0590273 Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Thu, 1 May 2025 02:11:48 +0200 +Subject: [PATCH 12/18] tahoe (1) man page: Add short introductions to each + command group + +--- + docs/man/man1/tahoe.1 | 26 +++++++++++++++++++------- + 1 file changed, 19 insertions(+), 7 deletions(-) + +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index cffd06caee..6fbf8d4197 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -9,8 +9,9 @@ Tahoe-LAFS offers provider-independent security + for your data. You don't have to trust storage + nodes for confidentiality or integrity - both are + provided through cryptography. +-Additionally, Tahoe-LAFS can help with availability +-and anonymity (but cannot guarantee either by itself). ++Additionally, Tahoe-LAFS can help with ++availability and anonymity (but cannot guarantee ++either cryptographically). + .sp + The "tahoe" executable can be used to create and + manage client/server nodes, manipulate the file +@@ -63,6 +64,8 @@ on the command used: + .PP + tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] + .SH ADMINISTRATION ++.PP ++Create node configurations and securely invite clients to a grid. + .SS COMMANDS + .TP + .B \f[B]create-node\f[] +@@ -106,14 +109,15 @@ Default: `tcp:3456:interface=127.0.0.1' (\f[B]create-node\f[] and + Do not offer storage service to other nodes (\f[B]create-node\f[] + only). + .SH CONTROLLING NODES ++.PP ++In the past, the 'tahoe' command offered service watching (with ++start, restart, stop commands), but this was not very portable ++and has been deprecated. + .SS COMMANDS + .TP + .B \f[B]run\f[] + Run a node without daemonizing. + This is the only command for running nodes. +-In the past, tahoe offered service watching internally (with start, restart, +-stop commands), but this was and not very portable and has been +-deprecated. + .SS OPTIONS + .TP + .B \f[B]--allow-stdin-close\f[] +@@ -129,11 +133,16 @@ logging, profiling, et cetera that are left out of this manual page for + brevity. + .SH USING THE FILE STORE + .PP ++All the following commands require pointing tahoe to a running ++client node with the '--node-directory' ('-d') option (or, ++alternatively, using the default location). ++.sp + Please run `tahoe \f[I]COMMAND\f[] --help' for more details on each + command. + .SS COMMANDS ++.TP + .B \f[B]mkdir\f[] +-Create a directory and return its directory capability ("dircap"). ++Create a directory and return its capability ("dircap"). + .TP + .B \f[B]add-alias\f[] + Add an alias for an existing cap. +@@ -160,7 +169,7 @@ Copy one or more files or directories. + Unlink a file or directory on the grid. + .TP + .B \f[B]rm\f[] +-Unlink a file or directory on the grid (same as \f[B]unlink\f[]). ++Same as \f[B]unlink\f[]. + .TP + .B \f[B]mv\f[] + Move a file within the grid. +@@ -187,6 +196,9 @@ Check a single file or directory. + Check all files/directories reachable from a starting point + .SH DEBUGGING + .PP ++The following commands are useful for developers and for ++troubleshooting. ++.PP + tahoe debug \f[I]SUBCOMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]PARAMETER\f[]]... + .sp + Please run e.g.\ `tahoe debug dump-share --help' for more + +From 65da12edd1bbc8512ee2372066757036ebcbea12 Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Thu, 1 May 2025 02:18:25 +0200 +Subject: [PATCH 13/18] tahoe (1) man page: Introduction with less jargon + +Copy/pasted from https://tahoe-lafs.org/ +--- + docs/man/man1/tahoe.1 | 14 +++++++------- + 1 file changed, 7 insertions(+), 7 deletions(-) + +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index 6fbf8d4197..71c3104491 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -5,13 +5,13 @@ tahoe \- Secure distributed file store. + .B tahoe + [\fI\,global-options\/\fR] \fI\,<command> \/\fR[\fI\,command-options\/\fR] + .SH DESCRIPTION +-Tahoe-LAFS offers provider-independent security +-for your data. You don't have to trust storage +-nodes for confidentiality or integrity - both are +-provided through cryptography. +-Additionally, Tahoe-LAFS can help with +-availability and anonymity (but cannot guarantee +-either cryptographically). ++Tahoe-LAFS is a Free and Open decentralized cloud ++storage system. ++It distributes your data across multiple servers. ++Even if some of the servers fail or are taken over ++by an attacker, the entire file store continues to ++function correctly, preserving your privacy and ++security. + .sp + The "tahoe" executable can be used to create and + manage client/server nodes, manipulate the file + +From 87e073db008e0e61ba564c5abc932fc326e8d42b Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Thu, 1 May 2025 02:22:45 +0200 +Subject: [PATCH 14/18] tahoe (1) man page: Less fancy single quotes + +--- + docs/man/man1/tahoe.1 | 14 +++++++------- + 1 file changed, 7 insertions(+), 7 deletions(-) + +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index 71c3104491..94c2658ed7 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -18,7 +18,7 @@ manage client/server nodes, manipulate the file + store, and perform several debugging/maintenance + tasks. + .sp +-Please have a look at the `SEE ALSO' section at ++Please have a look at the 'SEE ALSO' section at + the end of this manual page for pointers to + further instructions. + . +@@ -32,7 +32,7 @@ points to some other Tahoe node. It should also + contain a file named 'private/aliases' which + contains the mapping from alias name to root + dirnode URI. [default for most commands: +-\&`$HOME/.tahoe'] ++\&'$HOME/.tahoe'] + .TP + \fB\-\-eliot\-destination=\fR + Add an Eliot logging destination. May be given +@@ -101,8 +101,8 @@ Hostname to automatically set --location/--port when + .TP + .B \f[B]-p,\ --webport=\f[] + Specify which TCP port to run the HTTP interface on. +-Use `none' to disable. +-Default: `tcp:3456:interface=127.0.0.1' (\f[B]create-node\f[] and ++Use 'none' to disable. ++Default: 'tcp:3456:interface=127.0.0.1' (\f[B]create-node\f[] and + \f[B]create-client\f[] only). + .TP + .B \f[B]--no-storage\f[] +@@ -128,7 +128,7 @@ This is required for some service runners (like systemd, for example). + Same as the global --node-directory option. + .TP + .B \f[B]--help\f[] +-Display help and exit. This includes lots of `twistd-options' for debugging, ++Display help and exit. This includes lots of 'twistd-options' for debugging, + logging, profiling, et cetera that are left out of this manual page for + brevity. + .SH USING THE FILE STORE +@@ -137,7 +137,7 @@ All the following commands require pointing tahoe to a running + client node with the '--node-directory' ('-d') option (or, + alternatively, using the default location). + .sp +-Please run `tahoe \f[I]COMMAND\f[] --help' for more details on each ++Please run 'tahoe \f[I]COMMAND\f[] --help' for more details on each + command. + .SS COMMANDS + .TP +@@ -201,7 +201,7 @@ troubleshooting. + .PP + tahoe debug \f[I]SUBCOMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]PARAMETER\f[]]... + .sp +-Please run e.g.\ `tahoe debug dump-share --help' for more ++Please run e.g.\ 'tahoe debug dump-share --help' for more + details on each subcommand. + .SS SUBCOMMANDS + .TP + +From 1eab35ae49d3184d97f03785bd086277242a8fb1 Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Thu, 1 May 2025 02:26:27 +0200 +Subject: [PATCH 15/18] Now it's already May (at least in my TZ) + +--- + docs/man/man1/tahoe.1 | 2 +- + 1 file changed, 1 insertion(+), 1 deletion(-) + +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index 94c2658ed7..ab89340dce 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -1,4 +1,4 @@ +-.TH TAHOE 1 "April 2025" "Tahoe-LAFS \[em] tahoe command" "User Commands" ++.TH TAHOE 1 "May 2025" "Tahoe-LAFS \[em] tahoe command" "User Commands" + .SH NAME + tahoe \- Secure distributed file store. + .SH SYNOPSIS + +From 9d8a77853062f2812bb98ce5461a94235dbb2bac Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Mon, 5 May 2025 14:03:46 +0000 +Subject: [PATCH 16/18] Maybe newsworthy after all? + +--- + newsfragments/4168.documentation | 1 + + newsfragments/4168.minor | 0 + 2 files changed, 1 insertion(+) + create mode 100644 newsfragments/4168.documentation + delete mode 100644 newsfragments/4168.minor + +diff --git a/newsfragments/4168.documentation b/newsfragments/4168.documentation +new file mode 100644 +index 0000000000..23f23b1dfa +--- /dev/null ++++ b/newsfragments/4168.documentation +@@ -0,0 +1 @@ ++Add man page for `grid-manager` and update the one for `tahoe`. +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index ab89340dce..8c3f2a5872 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -59,25 +59,32 @@ The magic wormhole server to use. [default: + ws://wormhole.tahoe\-lafs.org:4000/v1] + .SH COMMANDS + .PP +-The \f[B]tahoe\f[] runner can be used for various tasks depending +-on the command used: ++The \f[B]tahoe\f[] runner can be used for various ++tasks depending on the command used: + .PP + tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] + .SH ADMINISTRATION + .PP +-Create node configurations and securely invite clients to a grid. ++Create node configurations and securely invite ++clients to a grid. + .SS COMMANDS + .TP + .B \f[B]create-node\f[] +-Create a node that acts as a client, server or both. ++Create a node that acts as a client, server or ++both. + .TP + .B \f[B]create-client\f[] +-Create a client node (providing storage to others initially disabled). ++Create a client node (providing storage to others ++initially disabled). + .TP + .B \f[B]create-introducer\f[] + Create an introducer node. +-When the grid is large or very dynamic, introducers make it easier for clients to connect. +-See "Static Server Definitions" in the documentation on how to configure clients to connect to one or more storage servers without using an introdcuer. ++When the grid is large or very dynamic, ++introducers make it easier for clients to connect. ++See "Static Server Definitions" in the ++documentation on how to configure clients to ++connect to one or more storage servers without ++using an introdcuer. + .TP + .B \f[B]invite\f[] + Invite a new node to a grid. +@@ -110,9 +117,10 @@ Do not offer storage service to other nodes (\f[B]create-node\f[] + only). + .SH CONTROLLING NODES + .PP +-In the past, the 'tahoe' command offered service watching (with +-start, restart, stop commands), but this was not very portable +-and has been deprecated. ++In the past, the 'tahoe' command offered service ++watching (with start, restart, stop commands), but ++this was not very portable and has been ++deprecated. + .SS COMMANDS + .TP + .B \f[B]run\f[] +@@ -121,28 +129,33 @@ This is the only command for running nodes. + .SS OPTIONS + .TP + .B \f[B]--allow-stdin-close\f[] +-Do not exit when stdin closes ("tahoe run" otherwise will exit). +-This is required for some service runners (like systemd, for example). ++Do not exit when stdin closes ("tahoe run" ++otherwise will exit). ++This is required for some service runners (like ++systemd, for example). + .TP + .B \f[B]-C,\ --basedir=\f[] + Same as the global --node-directory option. + .TP + .B \f[B]--help\f[] +-Display help and exit. This includes lots of 'twistd-options' for debugging, +-logging, profiling, et cetera that are left out of this manual page for +-brevity. ++Display help and exit. ++This includes lots of 'twistd-options' for ++debugging, logging, profiling, et cetera that are ++left out of this manual page for brevity. + .SH USING THE FILE STORE + .PP +-All the following commands require pointing tahoe to a running +-client node with the '--node-directory' ('-d') option (or, +-alternatively, using the default location). ++All the following commands require pointing tahoe ++to a running client node with the '--node-directory' ++('-d') option (or, alternatively, using the default ++location). + .sp +-Please run 'tahoe \f[I]COMMAND\f[] --help' for more details on each +-command. ++Please run 'tahoe \f[I]COMMAND\f[] --help' for ++more details on each command. + .SS COMMANDS + .TP + .B \f[B]mkdir\f[] +-Create a directory and return its capability ("dircap"). ++Create a directory and return its capability ++("dircap"). + .TP + .B \f[B]add-alias\f[] + Add an alias for an existing cap. +@@ -187,22 +200,24 @@ Open a web browser to a grid file or directory. + List all files/directories in a subtree. + .TP + .B \f[B]stats\f[] +-Print statistics about all files/directories in a subtree. ++Print statistics about all files/directories in a ++subtree. + .TP + .B \f[B]check\f[] + Check a single file or directory. + .TP + .B \f[B]deep-check\f[] +-Check all files/directories reachable from a starting point ++Check all files/directories reachable from a ++starting point. + .SH DEBUGGING + .PP +-The following commands are useful for developers and for +-troubleshooting. ++The following commands are useful for developers ++and for troubleshooting. + .PP + tahoe debug \f[I]SUBCOMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]PARAMETER\f[]]... + .sp +-Please run e.g.\ 'tahoe debug dump-share --help' for more +-details on each subcommand. ++Please run e.g.\ 'tahoe debug dump-share --help' ++for more details on each subcommand. + .SS SUBCOMMANDS + .TP + .B \f[B]dump-share\f[] +@@ -224,8 +239,8 @@ Corrupt a share by flipping a bit. + Utilities to access log files. + .SH AUTHORS + .PP +-Tahoe-LAFS has been written by Brian Warner, Zooko Wilcox-O'Hearn +-and dozens of others. ++Tahoe-LAFS has been written by Brian Warner, Zooko ++Wilcox-O'Hearn and dozens of others. + This manpage was originally written by bertagaz. + .SH REPORTING BUGS + .PP + +From 438eb3e0ea1961e5a321914801db5b41bcf249c8 Mon Sep 17 00:00:00 2001 +From: Florian Sesser <[email protected]> +Date: Mon, 5 May 2025 14:16:45 +0000 +Subject: [PATCH 18/18] Spellcheck + +--- + docs/man/man1/tahoe.1 | 2 +- + 1 file changed, 1 insertion(+), 1 deletion(-) + +diff --git a/docs/man/man1/tahoe.1 b/docs/man/man1/tahoe.1 +index 8c3f2a5872..ee4e0c32b8 100644 +--- a/docs/man/man1/tahoe.1 ++++ b/docs/man/man1/tahoe.1 +@@ -84,7 +84,7 @@ introducers make it easier for clients to connect. + See "Static Server Definitions" in the + documentation on how to configure clients to + connect to one or more storage servers without +-using an introdcuer. ++using an introducer. + .TP + .B \f[B]invite\f[] + Invite a new node to a grid. diff -Nru tahoe-lafs-1.20.0/debian/patches/series tahoe-lafs-1.20.0/debian/patches/series --- tahoe-lafs-1.20.0/debian/patches/series 2025-04-14 08:39:41.000000000 -0400 +++ tahoe-lafs-1.20.0/debian/patches/series 2025-05-16 04:15:21.000000000 -0400 @@ -2,3 +2,4 @@ 1421.patch 1427.patch 1431.patch +1433.patch
