commit 4ecb8f897e8af2d807382ffdf4e1951b1f145789
parent 8e6be820b57ce4fd952cf81c2506a69c5480892e
Author: ThomasV <thomasv1@gmx.de>
Date: Tue, 23 Apr 2013 04:55:53 -0700
Merge pull request #206 from JulianTosh/TuxHelpMods
Slightly modifying help output for clarity
Diffstat:
2 files changed, 14 insertions(+), 13 deletions(-)
diff --git a/electrum b/electrum
@@ -64,7 +64,7 @@ def prompt_password(prompt, confirm=True):
return password
def arg_parser():
- usage = "usage: %prog [options] command\nCommands: "+ (', '.join(known_commands))
+ usage = "%prog [options] command"
parser = optparse.OptionParser(prog=usage)
parser.add_option("-g", "--gui", dest="gui", help="User interface: qt, lite, gtk or text")
parser.add_option("-w", "--wallet", dest="wallet_path", help="wallet path (default: electrum.dat)")
diff --git a/lib/commands.py b/lib/commands.py
@@ -37,22 +37,23 @@ def register_command(name, min_args, max_args, is_protected, is_offline, descrip
payto_options = ' --fee, -f: set transaction fee\n --fromaddr, -s: send from address -\n --changeaddr, -c: send change to address'
listaddr_options = " -a: show all addresses, including change addresses\n -b: include balance in results\n -l: include labels in results"
-
+restore_options = " accepts a seed or master public key."
+config_options = " accounts, addr_history, auto_cycle, column_widths, console-history, contacts,\n fee_per_kb, frozen_addresses, gap_limit, imported_keys, labels,\n master_public_key, num_zeros, prioritized_addresses, proxy, seed,\n seed_version, server, transactions, use_change, use_encryption, winpos-qt"
register_command('contacts', 0, 0, False, True, 'Show your list of contacts')
register_command('create', 0, 0, False, True, 'Create a new wallet')
register_command('createmultisig', 2, 2, False, True, 'similar to bitcoind\'s command')
register_command('createrawtransaction', 2, 2, False, True, 'similar to bitcoind\'s command')
-register_command('deseed', 0, 0, False, True, 'Create a seedless, watching-only wallet.')
+register_command('deseed', 0, 0, False, True, 'Remove seed from wallet, creating a seedless, watching-only wallet.')
register_command('decoderawtransaction', 1, 1, False, True, 'similar to bitcoind\'s command')
-register_command('dumpprivkey', 1, 1, True, True, 'similar to bitcoind\'s command')
+register_command('dumpprivkey', 1, 1, True, True, 'Dumps a specified private key for a given address', 'dumpprivkey <bitcoin address>')
register_command('dumpprivkeys', 0, 0, True, True, 'dump all private keys')
register_command('eval', 1, 1, False, True, 'Run python eval() on an object', 'eval <expression>\nExample: eval \"wallet.aliases\"')
-register_command('freeze', 1, 1, False, True, 'Freeze the funds at one of your wallet\'s addresses')
+register_command('freeze', 1, 1, False, True, 'Freeze the funds at one of your wallet\'s addresses', 'freeze <address>')
register_command('getbalance', 0, 1, False, False, 'Return the balance of your wallet, or of one account in your wallet', 'getbalance [<account>]')
register_command('getaddressbalance', 1, 1, False, False, 'Return the balance of an address', 'getbalance <address>')
-register_command('getaddresshistory', 1, 1, False, False, 'Return the transaction history of an address')
-register_command('getconfig', 1, 1, False, True, 'Return a configuration variable', 'getconfig <name>')
+register_command('getaddresshistory', 1, 1, False, False, 'Return the transaction history of an address', 'getaddresshistory <address>')
+register_command('getconfig', 1, 1, False, True, 'Return a configuration variable', 'getconfig <name>', config_options)
register_command('getseed', 0, 0, True, True, 'Print the generation seed of your wallet.')
register_command('help', 0, 1, False, True, 'Prints this help')
register_command('history', 0, 0, False, False, 'Returns the transaction history of your wallet')
@@ -63,15 +64,15 @@ register_command('mktx', 5, 5, True, True, 'Create a signed tr
register_command('payto', 5, 5, True, False, 'Create and broadcast a transaction.', "payto <recipient> <amount> [label]\n<recipient> can be a bitcoin address or a label", payto_options)
register_command('password', 0, 0, True, True, 'Change your password')
register_command('prioritize', 1, 1, False, True, 'Coins at prioritized addresses are spent first.', 'prioritize <address>')
-register_command('restore', 0, 0, False, False, 'Restore a wallet')
-register_command('setconfig', 2, 2, False, True, 'Set a configuration variable', 'setconfig <name> <value>')
+register_command('restore', 0, 0, False, False, 'Restore a wallet', '', restore_options)
+register_command('setconfig', 2, 2, False, True, 'Set a configuration variable', 'setconfig <name> <value>', config_options)
register_command('setlabel', 2,-1, False, True, 'Assign a label to an item', 'setlabel <tx_hash> <label>')
register_command('sendrawtransaction', 1, 1, False, False, 'Broadcasts a transaction to the network.', 'sendrawtransaction <tx in hexadecimal>')
register_command('signrawtransaction', 1, 3, True, True, 'similar to bitcoind\'s command')
register_command('signmessage', 2,-1, True, True, 'Sign a message with a key', 'signmessage <address> <message>\nIf you want to lead or end a message with spaces, or want double spaces inside the message make sure you quote the string. I.e. " Hello This is a weird String "')
-register_command('unfreeze', 1, 1, False, True, '')
-register_command('unprioritize', 1, 1, False, True, '')
-register_command('validateaddress', 1, 1, False, True, 'Check that the address is valid')
+register_command('unfreeze', 1, 1, False, True, 'Unfreeze the funds at one of your wallet\'s address', 'unfreeze <address>')
+register_command('unprioritize', 1, 1, False, True, 'Unprioritize an address', 'unprioritize <address>')
+register_command('validateaddress', 1, 1, False, True, 'Check that the address is valid', 'validateaddress <address>')
register_command('verifymessage', 3,-1, False, True, 'Verifies a signature', 'verifymessage <address> <signature> <message>\nIf you want to lead or end a message with spaces, or want double spaces inside the message make sure you quote the string. I.e. " Hello This is a weird String "')
@@ -302,7 +303,7 @@ class Commands:
def help(self, cmd2=None):
if cmd2 not in known_commands:
- print_msg("List of commands:", ', '.join(known_commands))
+ print_msg("\nList of commands:", ', '.join(sorted(known_commands)))
else:
_, _, description, syntax, options_syntax = known_commands[cmd2]
print_msg(description)
