瀏覽代碼

cli: clean up flag descriptions, usage docs, account list uses primary and indexes, add help line to account subcnd usage

zelig 10 年之前
父節點
當前提交
7b2f25b578
共有 3 個文件被更改,包括 25 次插入29 次删除
  1. 0 4
      cmd/geth/admin.go
  2. 9 9
      cmd/geth/main.go
  3. 16 16
      cmd/utils/flags.go

+ 0 - 4
cmd/geth/admin.go

@@ -283,10 +283,6 @@ func (js *jsre) unlock(call otto.FunctionCall) otto.Value {
 		}
 	}
 	am := js.ethereum.AccountManager()
-	// err := am.Unlock(common.FromHex(split[0]), split[1])
-	// if err != nil {
-	// 	utils.Fatalf("Unlock account failed '%v'", err)
-	// }
 	err = am.TimedUnlock(common.FromHex(addr), passphrase, time.Duration(seconds)*time.Second)
 	if err != nil {
 		fmt.Printf("Unlock account failed '%v'\n", err)

+ 9 - 9
cmd/geth/main.go

@@ -97,6 +97,8 @@ The output of this command is supposed to be machine-readable.
 Manage accounts lets you create new accounts, list all existing accounts,
 import a private key into a new account.
 
+'account help' shows a list of subcommands or help for one subcommand.
+
 It supports interactive mode, when you are prompted for password as well as
 non-interactive mode where passwords are supplied via a given password file.
 Non-interactive mode is only meant for scripted use on test networks or known
@@ -186,8 +188,8 @@ Use "ethereum dump 0" to dump the genesis block.
 			Usage:  `Geth Console: interactive JavaScript environment`,
 			Description: `
 The Geth console is an interactive shell for the JavaScript runtime environment
-which exposes a node admin interface as well as the DAPP JavaScript API.
-See https://github.com/ethereum/go-ethereum/wiki/Frontier-Console
+which exposes a node admin interface as well as the Ðapp JavaScript API.
+See https://github.com/ethereum/go-ethereum/wiki/Javascipt-Console
 `,
 		},
 		{
@@ -195,7 +197,7 @@ See https://github.com/ethereum/go-ethereum/wiki/Frontier-Console
 			Name:   "js",
 			Usage:  `executes the given JavaScript files in the Geth JavaScript VM`,
 			Description: `
-The JavaScript VM exposes a node admin interface as well as the DAPP
+The JavaScript VM exposes a node admin interface as well as the Ðapp
 JavaScript API. See https://github.com/ethereum/go-ethereum/wiki/Javascipt-Console
 `,
 		},
@@ -261,10 +263,6 @@ JavaScript API. See https://github.com/ethereum/go-ethereum/wiki/Javascipt-Conso
 	// flag.BoolVar(&DiffTool, "difftool", false, "creates output for diff'ing. Sets LogLevel=0")
 	// flag.StringVar(&DiffType, "diff", "all", "sets the level of diff output [vm, all]. Has no effect if difftool=false")
 
-	// potential subcommands:
-	// flag.StringVar(&SecretFile, "import", "", "imports the file given (hex or mnemonic formats)")
-	// flag.StringVar(&ExportDir, "export", "", "exports the session keyring to files in the directory given")
-	// flag.BoolVar(&GenAddr, "genaddr", false, "create a new priv/pub key")
 }
 
 func main() {
@@ -369,8 +367,10 @@ func accountList(ctx *cli.Context) {
 	if err != nil {
 		utils.Fatalf("Could not list accounts: %v", err)
 	}
-	for _, acct := range accts {
-		fmt.Printf("Address: %x\n", acct)
+	name := "Primary"
+	for i, acct := range accts {
+		fmt.Printf("%s #%d: %x\n", name, i, acct)
+		name = "Account"
 	}
 }
 

+ 16 - 16
cmd/utils/flags.go

@@ -79,22 +79,22 @@ var (
 	}
 	ProtocolVersionFlag = cli.IntFlag{
 		Name:  "protocolversion",
-		Usage: "ETH protocol version",
+		Usage: "ETH protocol version (integer)",
 		Value: eth.ProtocolVersion,
 	}
 	NetworkIdFlag = cli.IntFlag{
 		Name:  "networkid",
-		Usage: "Network Id",
+		Usage: "Network Id (integer)",
 		Value: eth.NetworkId,
 	}
 	BlockchainVersionFlag = cli.IntFlag{
 		Name:  "blockchainversion",
-		Usage: "Blockchain version",
+		Usage: "Blockchain version (integer)",
 		Value: core.BlockChainVersion,
 	}
 	IdentityFlag = cli.StringFlag{
 		Name:  "identity",
-		Usage: "node name",
+		Usage: "Custom node name",
 	}
 	NatspecEnabledFlag = cli.BoolFlag{
 		Name:  "natspec",
@@ -113,18 +113,18 @@ var (
 	}
 	EtherbaseFlag = cli.StringFlag{
 		Name:  "etherbase",
-		Usage: "public address for block mining rewards. By default the address of your primary account is used",
+		Usage: "Public address for block mining rewards. By default the address of your primary account is used",
 		Value: "primary",
 	}
 
 	UnlockedAccountFlag = cli.StringFlag{
 		Name:  "unlock",
-		Usage: "unlock the account given until this program exits (prompts for password). '--unlock primary' unlocks the primary account",
+		Usage: "Unlock the account given until this program exits (prompts for password). '--unlock primary' unlocks the primary account",
 		Value: "",
 	}
 	PasswordFileFlag = cli.StringFlag{
 		Name:  "password",
-		Usage: "Path to password file for (un)locking an existing account.",
+		Usage: "Path to password file to use with options and subcommands needing a password",
 		Value: "",
 	}
 
@@ -135,7 +135,7 @@ var (
 	}
 	LogLevelFlag = cli.IntFlag{
 		Name:  "loglevel",
-		Usage: "0-5 (silent, error, warn, info, debug, debug detail)",
+		Usage: "Logging verbosity: 0-6 (0=silent, 1=error, 2=warn, 3=info, 4=core, 5=debug, 6=debug detail)",
 		Value: int(logger.InfoLevel),
 	}
 	LogJSONFlag = cli.StringFlag{
@@ -149,7 +149,7 @@ var (
 	}
 	LogVModuleFlag = cli.GenericFlag{
 		Name:  "vmodule",
-		Usage: "The syntax of the argument is a comma-separated list of pattern=N, where pattern is a literal file name (minus the \".go\" suffix) or \"glob\" pattern and N is a V level.",
+		Usage: "The syntax of the argument is a comma-separated list of pattern=N, where pattern is a literal file name (minus the \".go\" suffix) or \"glob\" pattern and N is a log verbosity level.",
 		Value: glog.GetVModule(),
 	}
 	VMDebugFlag = cli.BoolFlag{
@@ -158,12 +158,12 @@ var (
 	}
 	BacktraceAtFlag = cli.GenericFlag{
 		Name:  "backtrace_at",
-		Usage: "When set to a file and line number holding a logging statement a stack trace will be written to the Info log",
+		Usage: "If set to a file and line number (e.g., \"block.go:271\") holding a logging statement, a stack trace will be logged",
 		Value: glog.GetTraceLocation(),
 	}
 	PProfEanbledFlag = cli.BoolFlag{
 		Name:  "pprof",
-		Usage: "Whether the profiling server should be enabled",
+		Usage: "Enable the profiling server on localhost",
 	}
 	PProfPortFlag = cli.IntFlag{
 		Name:  "pprofport",
@@ -174,7 +174,7 @@ var (
 	// RPC settings
 	RPCEnabledFlag = cli.BoolFlag{
 		Name:  "rpc",
-		Usage: "Whether RPC server is enabled",
+		Usage: "Enable the JSON-RPC server",
 	}
 	RPCListenAddrFlag = cli.StringFlag{
 		Name:  "rpcaddr",
@@ -194,7 +194,7 @@ var (
 	// Network Settings
 	MaxPeersFlag = cli.IntFlag{
 		Name:  "maxpeers",
-		Usage: "Maximum number of network peers",
+		Usage: "Maximum number of network peers (network disabled if set to 0)",
 		Value: 16,
 	}
 	ListenPortFlag = cli.IntFlag{
@@ -204,7 +204,7 @@ var (
 	}
 	BootnodesFlag = cli.StringFlag{
 		Name:  "bootnodes",
-		Usage: "Space-separated enode URLs for discovery bootstrap",
+		Usage: "Space-separated enode URLs of initial peers to connect to",
 		Value: "",
 	}
 	NodeKeyFileFlag = cli.StringFlag{
@@ -217,12 +217,12 @@ var (
 	}
 	NATFlag = cli.StringFlag{
 		Name:  "nat",
-		Usage: "Port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
+		Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
 		Value: "any",
 	}
 	WhisperEnabledFlag = cli.BoolFlag{
 		Name:  "shh",
-		Usage: "Whether the whisper sub-protocol is enabled",
+		Usage: "Enable whisper",
 	}
 	JSpathFlag = cli.StringFlag{
 		Name:  "jspath",