contrib/debian/manpages/novacoind.1

   1 .TH NOVACOIND "7" "April 2013" "novacoind 3.19"
   2 .SH NAME
   3 novacoind \- peer-to-peer network based digital currency
   4 .SH SYNOPSIS
   5 novacoin [options] <command> [params]
   6 .TP
   7 novacoin [options] help <command> - Get help for a command
   8 .SH DESCRIPTION
   9 This  manual page documents the novacoind program. Novacoin is a peer-to-peer digital currency. Peer-to-peer (P2P) means that there is no central authority to issue new money or keep track of transactions. Instead, these tasks are managed collectively by the nodes of the network. Advantages:
  10
  11 Novacoins can be sent easily through the Internet, without having to trust middlemen. Transactions are designed to be irreversible. Be safe from instability caused by fractional reserve banking and central banks. The limited inflation of the Novacoin system’s money supply is distributed evenly (by CPU power) throughout the network, not monopolized by banks.
  12
  13 .SH OPTIONS
  14 .TP
  15 \fB\-conf=\fR<file>
  16 Specify configuration file (default: novacoin.conf)
  17 .TP
  18 \fB\-gen\fR
  19 Generate coins
  20 .TP
  21 \fB\-gen\fR=\fI0\fR
  22 Don't generate coins
  23 .TP
  24 \fB\-min\fR
  25 Start minimized
  26 .TP
  27 \fB\-datadir=\fR<dir>
  28 Specify data directory
  29 .TP
  30 \fB\-proxy=\fR<ip:port>
  31 Connect through socks4 proxy
  32 .TP
  33 \fB\-addnode=\fR<ip>
  34 Add a node to connect to
  35 .TP
  36 \fB\-connect=\fR<ip>
  37 Connect only to the specified node
  38 .TP
  39 \fB\-paytxfee=\fR<amt>
  40 Fee per KB to add to transactions you send
  41 .TP
  42 \fB\-server\fR
  43 Accept command line and JSON\-RPC commands
  44 .TP
  45 \fB\-daemon\fR
  46 Run in the background as a daemon and accept commands
  47 .TP
  48 \fB\-testnet\fR
  49 Use the test network
  50 .TP
  51 \fB\-rpcuser=\fR<user>
  52 Username for JSON\-RPC connections
  53 .TP
  54 \fB\-rpcpassword=\fR<pw>
  55 Password for JSON\-RPC connections
  56 .TP
  57 \fB\-rpcport=\fR<port>
  58 Listen for JSON\-RPC connections on <port>
  59 .TP
  60 \fB\-rpcallowip=\fR<ip>
  61 Allow JSON\-RPC connections from specified IP address
  62 .TP
  63 \fB\-rpcconnect=\fR<ip>
  64 Send commands to node running on <ip>
  65 .PP
  66 SSL options: (see the Bitcoin Wiki for SSL setup instructions)
  67 .TP
  68 \fB\-rpcssl\fR=\fI1\fR
  69 Use OpenSSL (https) for JSON\-RPC connections
  70 .TP
  71 \fB\-rpcsslcertificatchainfile=\fR<file.cert>
  72 Server certificate file (default: server.cert)
  73 .TP
  74 \fB\-rpcsslprivatekeyfile=\fR<file.pem>
  75 Server private key (default: server.pem)
  76 .TP
  77 \fB\-rpcsslciphers=\fR<ciphers>
  78 Acceptable ciphers (default: TLSv1+HIGH:!SSLv2:!aNULL:!eNULL:!AH:!3DES:@STRENGTH)
  79 .TP
  80 \-?
  81 This help message
  82 .SH COMMANDS
  83 .TP
  84 \fBbackupwallet 'destination'\fR
  85 Safely copies *wallet.dat* to 'destination', which can be a directory or a path with filename.
  86 .TP
  87 \fBgetaccount 'novacoinaddress'\fR
  88 Returns the account associated with the given address.
  89 .TP
  90 \fBsetaccount 'novacoinaddress' ['account']\fR
  91 Sets the ['account'] associated with the given address. ['account'] may be omitted to remove an address from ['account'].
  92 .TP
  93 \fBgetaccountaddress 'account'\fR
  94 Returns a new novacoin address for 'account'.
  95 .TP
  96 \fBgetaddressesbyaccount 'account'\fR
  97 Returns the list of addresses associated with the given 'account'.
  98 .TP
  99 \fBgetbalance 'account'\fR
 100 Returns the server's available balance, or the balance for 'account'.
 101 .TP
 102 \fBgetblockcount\fR
 103 Returns the number of blocks in the longest block chain.
 104 .TP
 105 \fBgetblocknumber\fR
 106 Returns the block number of the latest block in the longest block chain.
 107 .TP
 108 \fBgetconnectioncount\fR
 109 Returns the number of connections to other nodes.
 110 .TP
 111 \fBgetdifficulty\fR
 112 Returns the proof-of-work difficulty as a multiple of the minimum difficulty.
 113 .TP
 114 \fBgetgenerate\fR
 115 Returns boolean true if server is trying to generate novacoins, false otherwise.
 116 .TP
 117 \fBsetgenerate 'generate' ['genproclimit']\fR
 118 Generation is limited to ['genproclimit'] processors, -1 is unlimited.
 119 .TP
 120 \fBgethashespersec\fR
 121 Returns a recent hashes per second performance measurement while generating.
 122 .TP
 123 \fBgetinfo\fR
 124 Returns an object containing server information.
 125 .TP
 126 \fBgetnewaddress 'account'\fR
 127 Returns a new novacoin address for receiving payments. If 'account' is specified (recommended), it is added to the address book so payments received with the address will be credited to 'account'.
 128 .TP
 129 \fBgetreceivedbyaccount 'account' ['minconf=1']\fR
 130 Returns the total amount received by addresses associated with 'account' in transactions with at least ['minconf'] confirmations.
 131 .TP
 132 \fBgetreceivedbyaddress 'novacoinaddress' ['minconf=1']\fR
 133 Returns the total amount received by 'novacoinaddress' in transactions with at least ['minconf'] confirmations.
 134 .TP
 135 \fBgettransaction 'txid'\fR
 136 Returns information about a specific transaction, given hexadecimal transaction ID.
 137 .TP
 138 \fBgetwork 'data'\fR
 139 If 'data' is specified, tries to solve the block and returns true if it was successful. If 'data' is not specified, returns formatted hash 'data' to work on:
 140
 141     "midstate" : precomputed hash state after hashing the first half of the data.
 142     "data"     : block data.
 143     "hash1"    : formatted hash buffer for second hash.
 144     "target"   : little endian hash target.
 145 .TP
 146 \fBhelp 'command'\fR
 147 List commands, or get help for a command.
 148 .TP
 149 \fBlistaccounts ['minconf=1']\fR
 150 List accounts and their current balances.
 151 .TP
 152 \fBlistreceivedbyaccount ['minconf=1'] ['includeempty=false']\fR
 153 ['minconf'] is the minimum number of confirmations before payments are included. ['includeempty'] whether to include addresses that haven't received any payments. Returns an array of objects containing:
 154
 155     "account"       : the account of the receiving address.
 156     "amount"        : total amount received by the address.
 157     "confirmations" : number of confirmations of the most recent transaction included.
 158 .TP
 159 \fBlistreceivedbyaddress ['minconf=1'] ['includeempty=false']\fR
 160 ['minconf'] is the minimum number of confirmations before payments are included. ['includeempty'] whether to include addresses that haven't received any payments. Returns an array of objects containing:
 161
 162     "address"       : receiving address.
 163     "account"       : the account of the receiving address.
 164     "amount"        : total amount received by the address.
 165     "confirmations" : number of confirmations of the most recent transaction included.
 166 .TP
 167 \fBlisttransactions 'account' ['count=10']\fR
 168 Returns a list of the last ['count'] transactions for 'account' - for all accounts if 'account' is not specified or is "*". Each entry in the list may contain:
 169
 170     "category"      : will be generate, send, receive, or move.
 171     "amount"        : amount of transaction.
 172     "fee"           : Fee (if any) paid (only for send transactions).
 173     "confirmations" : number of confirmations (only for generate/send/receive).
 174     "txid"          : transaction ID (only for generate/send/receive).
 175     "otheraccount"  : account funds were moved to or from (only for move).
 176     "message"       : message associated with transaction (only for send).
 177     "to"            : message-to associated with transaction (only for send).
 178 .TP
 179 \fBmove <'fromaccount'> <'toaccount'> <'amount'> ['minconf=1'] ['comment']\fR
 180 Moves funds between accounts.
 181 .TP
 182 \fBsendfrom* <'account'> <'novacoinaddress'> <'amount'> ['minconf=1'] ['comment'] ['comment-to']\fR
 183 Sends amount from account's balance to 'novacoinaddress'. This method will fail if there is less than amount novacoins with ['minconf'] confirmations in the account's balance (unless account is the empty-string-named default account; it behaves like the *sendtoaddress* method). Returns transaction ID on success.
 184 .TP
 185 \fBsendtoaddress 'novacoinaddress' 'amount' ['comment'] ['comment-to']\fR
 186 Sends amount from the server's available balance to 'novacoinaddress'. amount is a real and is rounded to the nearest 0.01. Returns transaction id on success.
 187 .TP
 188 \fBstop\fR
 189 Stops the novacoin server.
 190 .TP
 191 \fBvalidateaddress 'novacoinaddress'\fR
 192 Checks that 'novacoinaddress' looks like a proper novacoin address. Returns an object containing:
 193
 194     "isvalid" : true or false.
 195     "ismine"  : true if the address is in the server's wallet.
 196     "address" : novacoinaddress.
 197
 198     *note: ismine and address are only returned if the address is valid.
 199
 200 .SH "SEE ALSO"
 201 novacoin.conf(5)
 202 .SH AUTHOR
 203 This manual page was written by Micah Anderson <micah@debian.org> for the Debian system (but may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or any later version published by the Free Software Foundation.
 204
 205 On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.
 206