cli: help formatting

This commit is contained in:
zelig 2015-03-24 16:05:27 +00:00
parent 1c4c71dcff
commit 34d5a6c156
2 changed files with 19 additions and 14 deletions

View File

@ -83,9 +83,6 @@ The output of this command is supposed to be machine-readable.
Action: accountList, Action: accountList,
Name: "list", Name: "list",
Usage: "print account addresses", Usage: "print account addresses",
Description: `
`,
}, },
{ {
Action: accountCreate, Action: accountCreate,
@ -111,12 +108,14 @@ For non-interactive use the passphrase can be specified with the --password flag
ethereum account import <keyfile> ethereum account import <keyfile>
Imports a private key from <keyfile> and creates a new account with the address derived from the key. Imports a private key from <keyfile> and creates a new account with the address
The keyfile is assumed to contain an unencrypted private key in canonical EC format. derived from the key.
The keyfile is assumed to contain an unencrypted private key in canonical EC
format.
The account is saved in encrypted format, you are prompted for a passphrase. The account is saved in encrypted format, you are prompted for a passphrase.
You must remember this passphrase to unlock your account in future. You must remember this passphrase to unlock your account in future.
For non-interactive use the passphrase can be specified with the --password flag: For non-interactive use the passphrase can be specified with the -password flag:
ethereum --password <passwordfile> account import <keyfile> ethereum --password <passwordfile> account import <keyfile>
@ -130,14 +129,18 @@ For non-interactive use the passphrase can be specified with the --password flag
ethereum account export <address> <keyfile> ethereum account export <address> <keyfile>
Exports the given account's private key into keyfile using the canonical EC format. Exports the given account's private key into keyfile using the canonical EC
The account needs to be unlocked, if it is not the user is prompted for a passphrase to unlock it. format.
For non-interactive use, the password can be specified with the --unlock flag: The account needs to be unlocked, if it is not the user is prompted for a
passphrase to unlock it.
For non-interactive use, the passphrase can be specified with the --unlock flag:
ethereum --password <passwrdfile> account export <address> <keyfile> ethereum --password <passwrdfile> account export <address> <keyfile>
Note: Note:
Since you can directly copy your encrypted accounts to another ethereum instance, this import/export mechanism is not needed when you transfer an account between nodes. As you can directly copy your encrypted accounts to another ethereum instance,
this import/export mechanism is not needed when you transfer an account between
nodes.
`, `,
}, },
}, },
@ -156,16 +159,18 @@ Use "ethereum dump 0" to dump the genesis block.
Name: "console", Name: "console",
Usage: `Ethereum Console: interactive JavaScript environment`, Usage: `Ethereum Console: interactive JavaScript environment`,
Description: ` Description: `
Console is an interactive shell for the Ethereum JavaScript runtime environment which exposes a node admin interface as well as the DAPP JavaScript API. Console is an interactive shell for the Ethereum 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 See https://github.com/ethereum/go-ethereum/wiki/Frontier-Console
`, `,
}, },
{ {
Action: execJSFiles, Action: execJSFiles,
Name: "js", Name: "js",
Usage: `executes the given JavaScript files in the Ethereum Frontier JavaScript VM`, Usage: `executes the given JavaScript files in the Ethereum JavaScript VM`,
Description: ` Description: `
The Ethereum JavaScript VM exposes a node admin interface as well as the DAPP JavaScript API. See https://github.com/ethereum/go-ethereum/wiki/Frontier-Console The Ethereum JavaScript VM exposes a node admin interface as well as the DAPP
JavaScript API. See https://github.com/ethereum/go-ethereum/wiki/Javascipt-Console
`, `,
}, },
{ {

View File

@ -109,7 +109,7 @@ var (
} }
PasswordFileFlag = cli.StringFlag{ PasswordFileFlag = cli.StringFlag{
Name: "password", Name: "password",
Usage: "Password used when saving a new account and unlocking an existing account. If you create a new account make sure you remember this password.", Usage: "Path to password file for (un)locking an existing account.",
Value: "", Value: "",
} }