From 2b7ec90f09e2293c186bbda55ec83290b74513db Mon Sep 17 00:00:00 2001 From: "Masih H. Derkani" Date: Thu, 14 Nov 2024 23:43:19 +0700 Subject: [PATCH] Regenerate CLI docs --- cli/f3.go | 18 ++-- documentation/en/cli-lotus.md | 189 ++++++++++++++++++++++++++++++++-- 2 files changed, 190 insertions(+), 17 deletions(-) diff --git a/cli/f3.go b/cli/f3.go index 9c07643c9a..4861c80e1e 100644 --- a/cli/f3.go +++ b/cli/f3.go @@ -34,11 +34,7 @@ var ( { Name: "list-miners", Aliases: []string{"lm"}, - Usage: `Lists the miners that currently participate in F3 via this node. - -The instance may be specified as the first argument. If unspecified, -the latest instance is used. -`, + Usage: `Lists the miners that currently participate in F3 via this node.`, Action: func(cctx *cli.Context) error { api, closer, err := GetFullNodeAPIV1(cctx) if err != nil { @@ -84,9 +80,12 @@ the latest instance is used. Aliases: []string{"pt"}, Subcommands: []*cli.Command{ { - Name: "get", - Aliases: []string{"g"}, - Usage: "Get F3 power table at a specific instance ID or latest instance if none is specified.", + Name: "get", + Aliases: []string{"g"}, + Usage: `Get F3 power table at a specific instance ID or latest instance if none is specified. + +The instance may be specified as the first argument. If unspecified, +the latest instance is used.`, ArgsUsage: "[instance]", Flags: []cli.Flag{f3FlagPowerTableFromEC}, Before: func(cctx *cli.Context) error { @@ -184,8 +183,7 @@ the latest instance is used. The list of actors may be specified as Actor ID or miner address, space separated, pied to STDIN. Example: - $ echo "1413 t01234 f12345" | lotus f3 powertable get-proportion 42 -`, + $ echo "1413 t01234 f12345" | lotus f3 powertable get-proportion 42`, ArgsUsage: "[instance]", Flags: []cli.Flag{f3FlagPowerTableFromEC}, Before: func(cctx *cli.Context) error { diff --git a/documentation/en/cli-lotus.md b/documentation/en/cli-lotus.md index 6d62c05c8a..51c98f8110 100644 --- a/documentation/en/cli-lotus.md +++ b/documentation/en/cli-lotus.md @@ -2799,10 +2799,6 @@ USAGE: COMMANDS: list-miners, lm Lists the miners that currently participate in F3 via this node. - - The instance may be specified as the first argument. If unspecified, - the latest instance is used. - powertable, pt certs, c Manages interactions with F3 finality certificates. manifest Gets the current manifest used by F3. @@ -2818,12 +2814,191 @@ OPTIONS: NAME: lotus f3 list-miners - Lists the miners that currently participate in F3 via this node. - The instance may be specified as the first argument. If unspecified, - the latest instance is used. +USAGE: + lotus f3 list-miners [command options] [arguments...] + +OPTIONS: + --help, -h show help +``` +### lotus f3 powertable +``` +NAME: + lotus f3 powertable USAGE: - lotus f3 list-miners [command options] [arguments...] + lotus f3 powertable command [command options] [arguments...] + +COMMANDS: + get, g Get F3 power table at a specific instance ID or latest instance if none is specified. + + The instance may be specified as the first argument. If unspecified, + the latest instance is used. + get-proportion, gp Gets the total proportion of power for a list of actors at a given instance. + + The instance may be specified as the first argument. If unspecified, + the latest instance is used. + + The list of actors may be specified as Actor ID or miner address, space + separated, pied to STDIN. Example: + $ echo "1413 t01234 f12345" | lotus f3 powertable get-proportion 42 + help, h Shows a list of commands or help for one command + +OPTIONS: + --help, -h show help +``` + +#### lotus f3 powertable get +``` +NAME: + lotus f3 powertable get - Get F3 power table at a specific instance ID or latest instance if none is specified. + + The instance may be specified as the first argument. If unspecified, + the latest instance is used. + +USAGE: + lotus f3 powertable get [command options] [instance] + +OPTIONS: + --ec Whether to get the power table from EC. (default: false) + --help, -h show help +``` + +### lotus f3 certs +``` +NAME: + lotus f3 certs - Manages interactions with F3 finality certificates. + +USAGE: + lotus f3 certs command [command options] [arguments...] + +COMMANDS: + get Gets an F3 finality certificate to a given instance ID, or the latest certificate if no instance is specified. + list Lists a range of F3 finality certificates. + + By default the certificates are listed in newest to oldest order, + i.e. descending instance IDs. The order may be reversed using the + '--reverse' flag. + + A range may optionally be specified as the first argument to indicate + inclusive range of 'from' and 'to' instances in following notation: + '..'. Either or may be omitted, but not both. + An omitted value is always interpreted as 0, and an omitted + value indicates the latest instance. If both are specified, + must never exceed . + + If no range is specified, the latest 10 certificates are listed, i.e. + the range of '0..' with limit of 10. Otherwise, all certificates in + the specified range are listed unless limit is explicitly specified. + + Examples: + * All certificates from newest to oldest: + $ lotus f3 certs list 0.. + + * Three newest certificates: + $ lotus f3 certs list --limit 3 0.. + + * Three oldest certificates: + $ lotus f3 certs list --limit 3 --reverse 0.. + + * Up to three certificates starting from instance 1413 to the oldest: + $ lotus f3 certs list --limit 3 ..1413 + + * Up to 3 certificates starting from instance 1413 to the newest: + $ lotus f3 certs list --limit 3 --reverse 1413.. + + * All certificates from instance 3 to 1413 in order of newest to oldest: + $ lotus f3 certs list 3..1413 + + help, h Shows a list of commands or help for one command + +OPTIONS: + --help, -h show help +``` + +#### lotus f3 certs get +``` +NAME: + lotus f3 certs get - Gets an F3 finality certificate to a given instance ID, or the latest certificate if no instance is specified. + +USAGE: + lotus f3 certs get [command options] [instance] + +OPTIONS: + --output value The output format. Supported formats: text, json (default: "text") + --help, -h show help +``` + +#### lotus f3 certs list +``` +NAME: + lotus f3 certs list - Lists a range of F3 finality certificates. + + By default the certificates are listed in newest to oldest order, + i.e. descending instance IDs. The order may be reversed using the + '--reverse' flag. + + A range may optionally be specified as the first argument to indicate + inclusive range of 'from' and 'to' instances in following notation: + '..'. Either or may be omitted, but not both. + An omitted value is always interpreted as 0, and an omitted + value indicates the latest instance. If both are specified, + must never exceed . + + If no range is specified, the latest 10 certificates are listed, i.e. + the range of '0..' with limit of 10. Otherwise, all certificates in + the specified range are listed unless limit is explicitly specified. + + Examples: + * All certificates from newest to oldest: + $ lotus f3 certs list 0.. + + * Three newest certificates: + $ lotus f3 certs list --limit 3 0.. + + * Three oldest certificates: + $ lotus f3 certs list --limit 3 --reverse 0.. + + * Up to three certificates starting from instance 1413 to the oldest: + $ lotus f3 certs list --limit 3 ..1413 + + * Up to 3 certificates starting from instance 1413 to the newest: + $ lotus f3 certs list --limit 3 --reverse 1413.. + + * All certificates from instance 3 to 1413 in order of newest to oldest: + $ lotus f3 certs list 3..1413 + + +USAGE: + lotus f3 certs list [command options] [range] + +OPTIONS: + --output value The output format. Supported formats: text, json (default: "text") + --limit value The maximum number of instances. A value less than 0 indicates no limit. (default: 10 when no range is specified. Otherwise, unlimited.) + --reverse Reverses the default order of output. (default: false) + --help, -h show help +``` + +### lotus f3 manifest +``` +NAME: + lotus f3 manifest - Gets the current manifest used by F3. + +USAGE: + lotus f3 manifest [command options] [arguments...] + +OPTIONS: + --output value The output format. Supported formats: text, json (default: "text") + --help, -h show help +``` + +### lotus f3 status +``` +NAME: + lotus f3 status - Checks the F3 status. + +USAGE: + lotus f3 status [command options] [arguments...] OPTIONS: --help, -h show help