diff options
Diffstat (limited to 'manpages')
| -rw-r--r-- | manpages/dogecoin-cli.1 | 63 | ||||
| -rw-r--r-- | manpages/dogecoin-qt.1 | 206 | ||||
| -rw-r--r-- | manpages/dogecoin.conf.5 | 89 | ||||
| -rw-r--r-- | manpages/dogecoind.1 | 209 |
4 files changed, 567 insertions, 0 deletions
diff --git a/manpages/dogecoin-cli.1 b/manpages/dogecoin-cli.1 new file mode 100644 index 0000000..ceebf7b --- /dev/null +++ b/manpages/dogecoin-cli.1 @@ -0,0 +1,63 @@ +.TH DOGECOIN-CLI "1" "November 2014" "dogecoin-cli 1.8" "User Commands" +.SH NAME +dogecoin-cli \- Dogecoin Core RPC client +.SH DESCRIPTION +Dogecoin Core RPC client +.SS "Usage:" +.TP +dogecoin\-cli [options] <command> [params] +Send command to Dogecoin Core +.TP +dogecoin\-cli [options] help +List commands +.TP +dogecoin\-cli [options] help <command> +Get help for a command +.SH OPTIONS +.TP +\-? +This help message +.TP +\fB\-conf=\fR<file> +Specify configuration file (default: dogecoin.conf) +.TP +\fB\-datadir=\fR<dir> +Specify data directory +.TP +\fB\-testnet\fR +Use the test network +.TP +\fB\-regtest\fR +Enter regression test mode, which uses a special chain in which blocks can be solved instantly. This is intended for regression testing tools and app development. +.TP +\fB\-rpcconnect=\fR<ip> +Send commands to node running on <ip> (default: 127.0.0.1) +.TP +\fB\-rpcport=\fR<port> +Connect to JSON\-RPC on <port> (default: 22555 or testnet: 44555) +.TP +\fB\-rpcwait\fR +Wait for RPC server to start +.TP +\fB\-rpcuser=\fR<user> +Username for JSON\-RPC connections +.TP +\fB\-rpcpassword=\fR<pw> +Password for JSON\-RPC connections +.PP +SSL options: (see the Bitcoin Wiki for SSL setup instructions) +.TP +\fB\-rpcssl\fR +Use OpenSSL (https) for JSON\-RPC connections +.SH "SEE ALSO" +The full documentation for +.B dogecoin-cli +is maintained as a Texinfo manual. If the +.B info +and +.B dogecoin-cli +programs are properly installed at your site, the command +.IP +.B info dogecoin-cli +.PP +should give you access to the complete manual. diff --git a/manpages/dogecoin-qt.1 b/manpages/dogecoin-qt.1 new file mode 100644 index 0000000..0a4137c --- /dev/null +++ b/manpages/dogecoin-qt.1 @@ -0,0 +1,206 @@ +.TH DOGECOIN-QT "1" "November 2014" "dogecoin-qt 1.8" +.SH NAME +dogecoin-qt \- peer-to-peer network based digital currency +.SH DESCRIPTION +.SS "Usage:" +.IP +dogecoin\-qt [command\-line options] +.SH OPTIONS +.TP +\-? +This help message +.TP +\fB\-conf=\fR<file> +Specify configuration file (default: dogecoin.conf) +.TP +\fB\-pid=\fR<file> +Specify pid file (default: dogecoind.pid) +.TP +\fB\-gen\fR +Generate coins +.TP +\fB\-gen\fR=\fI0\fR +Don't generate coins +.TP +\fB\-datadir=\fR<dir> +Specify data directory +.TP +\fB\-dbcache=\fR<n> +Set database cache size in megabytes (default: 25) +.TP +\fB\-timeout=\fR<n> +Specify connection timeout in milliseconds (default: 5000) +.TP +\fB\-proxy=\fR<ip:port> +Connect through socks proxy +.TP +\fB\-socks=\fR<n> +Select the version of socks proxy to use (4\-5, default: 5) +.TP +\fB\-tor=\fR<ip:port> +Use proxy to reach tor hidden services (default: same as \fB\-proxy\fR) +.TP +\fB\-dns\fR +Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR +.TP +\fB\-port=\fR<port> +Listen for connections on <port> (default: 8333 or testnet: 18333) +.TP +\fB\-maxconnections=\fR<n> +Maintain at most <n> connections to peers (default: 125) +.TP +\fB\-addnode=\fR<ip> +Add a node to connect to and attempt to keep the connection open +.TP +\fB\-connect=\fR<ip> +Connect only to the specified node(s) +.TP +\fB\-seednode=\fR<ip> +Connect to a node to retrieve peer addresses, and disconnect +.TP +\fB\-externalip=\fR<ip> +Specify your own public address +.TP +\fB\-onlynet=\fR<net> +Only connect to nodes in network <net> (IPv4, IPv6 or Tor) +.TP +\fB\-discover\fR +Discover own IP address (default: 1 when listening and no \fB\-externalip\fR) +.TP +\fB\-checkpoints\fR +Only accept block chain matching built\-in checkpoints (default: 1) +.TP +\fB\-listen\fR +Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR) +.TP +\fB\-bind=\fR<addr> +Bind to given address and always listen on it. Use [host]:port notation for IPv6 +.TP +\fB\-dnsseed\fR +Find peers using DNS lookup (default: 1 unless \fB\-connect\fR) +.TP +\fB\-banscore=\fR<n> +Threshold for disconnecting misbehaving peers (default: 100) +.TP +\fB\-bantime=\fR<n> +Number of seconds to keep misbehaving peers from reconnecting (default: 86400) +.TP +\fB\-maxreceivebuffer=\fR<n> +Maximum per\-connection receive buffer, <n>*1000 bytes (default: 5000) +.TP +\fB\-maxsendbuffer=\fR<n> +Maximum per\-connection send buffer, <n>*1000 bytes (default: 1000) +.TP +\fB\-upnp\fR +Use UPnP to map the listening port (default: 1 when listening) +.TP +\fB\-paytxfee=\fR<amt> +Fee per KB to add to transactions you send +.TP +\fB\-server\fR +Accept command line and JSON\-RPC commands +.TP +\fB\-testnet\fR +Use the test network +.TP +\fB\-debug\fR +Output extra debugging information. Implies all other \fB\-debug\fR* options +.TP +\fB\-debugnet\fR +Output extra network debugging information +.TP +\fB\-logtimestamps\fR +Prepend debug output with timestamp +.TP +\fB\-shrinkdebugfile\fR +Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR) +.TP +\fB\-printtoconsole\fR +Send trace/debug info to console instead of debug.log file +.TP +\fB\-rpcuser=\fR<user> +Username for JSON\-RPC connections +.TP +\fB\-rpcpassword=\fR<pw> +Password for JSON\-RPC connections +.TP +\fB\-rpcport=\fR<port> +Listen for JSON\-RPC connections on <port> (default: 8332 or testnet: 18332) +.TP +\fB\-rpcallowip=\fR<ip> +Allow JSON\-RPC connections from specified IP address +.TP +\fB\-rpcthreads=\fR<n> +Set the number of threads to service RPC calls (default: 4) +.TP +\fB\-blocknotify=\fR<cmd> +Execute command when the best block changes (%s in cmd is replaced by block hash) +.TP +\fB\-walletnotify=\fR<cmd> +Execute command when a wallet transaction changes (%s in cmd is replaced by TxID) +.TP +\fB\-alertnotify=\fR<cmd> +Execute command when a relevant alert is received (%s in cmd is replaced by message) +.TP +\fB\-upgradewallet\fR +Upgrade wallet to latest format +.TP +\fB\-keypool=\fR<n> +Set key pool size to <n> (default: 100) +.TP +\fB\-rescan\fR +Rescan the block chain for missing wallet transactions +.TP +\fB\-salvagewallet\fR +Attempt to recover private keys from a corrupt wallet.dat +.TP +\fB\-checkblocks=\fR<n> +How many blocks to check at startup (default: 288, 0 = all) +.TP +\fB\-checklevel=\fR<n> +How thorough the block verification is (0\-4, default: 3) +.TP +\fB\-txindex\fR +Maintain a full transaction index (default: 0) +.TP +\fB\-loadblock=\fR<file> +Imports blocks from external blk000??.dat file +.TP +\fB\-reindex\fR +Rebuild block chain index from current blk000??.dat files +.TP +\fB\-par=\fR<n> +Set the number of script verification threads (1\-16, 0=auto, default: 0) +.SS "Block creation options:" +.TP +\fB\-blockminsize=\fR<n> +Set minimum block size in bytes (default: 0) +.TP +\fB\-blockmaxsize=\fR<n> +Set maximum block size in bytes (default: 250000) +.HP +\fB\-blockprioritysize=\fR<n> Set maximum size of high\-priority/low\-fee transactions in bytes (default: 27000) +.PP +SSL options: (see the Dogecoin Wiki for SSL setup instructions) +.TP +\fB\-rpcssl\fR +Use OpenSSL (https) for JSON\-RPC connections +.TP +\fB\-rpcsslcertificatechainfile=\fR<file.cert> +Server certificate file (default: server.cert) +.TP +\fB\-rpcsslprivatekeyfile=\fR<file.pem> +Server private key (default: server.pem) +.TP +\fB\-rpcsslciphers=\fR<ciphers> +Acceptable ciphers (default: TLSv1+HIGH:!SSLv2:!aNULL:!eNULL:!AH:!3DES:@STRENGTH) +.SS "UI options:" +.TP +\fB\-lang=\fR<lang> +Set language, for example "de_DE" (default: system locale) +.TP +\fB\-min\fR +Start minimized +.TP +\fB\-splash\fR +Show splash screen on startup (default: 1) diff --git a/manpages/dogecoin.conf.5 b/manpages/dogecoin.conf.5 new file mode 100644 index 0000000..73a18da --- /dev/null +++ b/manpages/dogecoin.conf.5 @@ -0,0 +1,89 @@ +.TH DOGECOIN.CONF "5" "November 2014" "dogecoin.conf 1.8" +.SH NAME +dogecoin.conf \- dogecoin configuration file +.SH SYNOPSIS +All command-line options (except for '\-datadir' and '\-conf') may be specified in a configuration file, and all configuration file options may also be specified on the command line. Command-line options override values set in the configuration file. +.TP +The configuration file is a list of 'setting=value' pairs, one per line, with optional comments starting with the '#' character. +.TP +The configuration file is not automatically created; you can create it using your favorite plain-text editor. By default, dogecoind(1) will look for a file named dogecoin.conf(5) in the dogecoin data directory, but both the data directory and the configuration file path may be changed using the '\-datadir' and '\-conf' command-line arguments. +.SH LOCATION +dogecoin.conf should be located in $HOME/.dogecoin +.SH NETWORK-RELATED SETTINGS +.TP +.TP +\fBtestnet=\fR[\fI'1'\fR|\fI'0'\fR] +Enable or disable run on the test network instead of the real *dogecoin* network. +.TP +\fBproxy=\fR\fI'127.0.0.1:9050'\fR +Connect via a socks4 proxy. +.TP +\fBaddnode=\fR\fI'10.0.0.2:8333'\fR +Use as many *addnode=* settings as you like to connect to specific peers. +.TP +\fBconnect=\fR\fI'10.0.0.1:8333'\fR +Use as many *connect=* settings as you like to connect ONLY to specific peers. +.TP +\fRmaxconnections=\fR\fI'value'\fR +Maximum number of inbound+outbound connections. +.SH JSON-RPC OPTIONS +.TP +\fBserver=\fR[\fI'1'\fR|\fI'0'\fR] +Tells *dogecoin* to accept or not accept JSON-RPC commands. +.TP +\fBrpcuser=\fR\fI'username'\fR +You must set *rpcuser* to secure the JSON-RPC api. +.TP +\fBrpcpassword=\fR\fI'password'\fR +You must set *rpcpassword* to secure the JSON-RPC api. +.TP +\fBrpcallowip=\fR\fI'192.168.1.*'\fR +By default, only RPC connections from localhost are allowed. Specify as many *rpcallowip=* settings as you like to allow connections from other hosts (and you may use * as a wildcard character). +.TP +\fBrpcport=\fR\fI'8332'\fR +Listen for RPC connections on this TCP port. +.TP +\fBrpcconnect=\fR\fI'127.0.0.1'\fR +You can use *dogecoin* or *dogecoind(1)* to send commands to *dogecoin*/*dogecoind(1)* running on another host using this option. +.TP +\fBrpcssl=\fR\fI'1'\fR +Use Secure Sockets Layer (also known as TLS or HTTPS) to communicate with *dogecoin* '\-server' or *dogecoind(1)*. Example of OpenSSL settings used when *rpcssl*='1': +.TP +\fB\-rpcsslciphers=\fR<ciphers> +Acceptable ciphers (default: TLSv1+HIGH:\:!SSLv2:\:!aNULL:\:!eNULL:\:!AH:\:!3DES:\:@STRENGTH) +.TP +\fBrpcsslcertificatechainfile=\fR\fI'server.cert'\fR +.TP +\fBrpcsslprivatekeyfile=\fR\fI'server.pem'\fR +.TP +.SH MISCELLANEOUS OPTIONS +.TP +\fBgen=\fR[\fI'0'\fR|\fI'1'\fR] +Enable or disable attempt to generate dogecoins. +.TP +\fB4way=\fR[\fI'0'\fR|\fI'1'\fR] +Enable or disable use SSE instructions to try to generate dogecoins faster. +.TP +\fBkeypool=\fR\fI'100'\fR +Pre-generate this many public/private key pairs, so wallet backups will be valid for both prior transactions and several dozen future transactions. +.TP +\fBpaytxfee=\fR\fI'0.00'\fR +Pay an optional transaction fee every time you send dogecoins. Transactions with fees are more likely than free transactions to be included in generated blocks, so may be validated sooner. +.TP +\fBallowreceivebyip=\fR\fI'1'\fR +Allow direct connections for the 'pay via IP address' feature. +.TP +.SH USER INTERFACE OPTIONS +.TP +\fBmin=\fR[\fI'0'\fR|\fI'1'\fR] +Enable or disable start dogecoind minimized. +.TP +\fBminimizetotray=\fR[\fI'0'\fR|\fI'1'\fR] +Enable or disable minimize to the system tray. +.SH "SEE ALSO" +dogecoind(1) +.SH AUTHOR +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. + +On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL. + diff --git a/manpages/dogecoind.1 b/manpages/dogecoind.1 new file mode 100644 index 0000000..5bef0c4 --- /dev/null +++ b/manpages/dogecoind.1 @@ -0,0 +1,209 @@ +.TH DOGECOIND "1" "November 2014" "dogecoind 1.8" +.SH NAME +dogecoind \- peer-to-peer network based digital currency +.SH SYNOPSIS +dogecoin [options] <command> [params] +.TP +dogecoin [options] help <command> \- Get help for a command +.SH DESCRIPTION +This manual page documents the dogecoind program. Dogecoin 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: + +Dogecoins 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 Dogecoin system’s money supply is distributed evenly (by CPU power) throughout the network, not monopolized by banks. + +.SH OPTIONS +.TP +\fB\-conf=\fR<file> +Specify configuration file (default: dogecoin.conf) +.TP +\fB\-gen\fR +Generate coins +.TP +\fB\-gen\fR=\fI0\fR +Don't generate coins +.TP +\fB\-min\fR +Start minimized +.TP +\fB\-datadir=\fR<dir> +Specify data directory +.TP +\fB\-proxy=\fR<ip:port> +Connect through socks4 proxy +.TP +\fB\-addnode=\fR<ip> +Add a node to connect to +.TP +\fB\-connect=\fR<ip> +Connect only to the specified node +.TP +\fB\-paytxfee=\fR<amt> +Fee per KB to add to transactions you send +.TP +\fB\-server\fR +Accept command line and JSON\-RPC commands +.TP +\fB\-daemon\fR +Run in the background as a daemon and accept commands +.TP +\fB\-testnet\fR +Use the test network +.TP +\fB\-rpcuser=\fR<user> +Username for JSON\-RPC connections +.TP +\fB\-rpcpassword=\fR<pw> +Password for JSON\-RPC connections +.TP +\fB\-rpcport=\fR<port> +Listen for JSON\-RPC connections on <port> +.TP +\fB\-rpcallowip=\fR<ip> +Allow JSON\-RPC connections from specified IP address +.TP +\fB\-rpcconnect=\fR<ip> +Send commands to node running on <ip> +.PP +SSL options: (see the Dogecoin Wiki for SSL setup instructions) +.TP +\fB\-rpcssl\fR=\fI1\fR +Use OpenSSL (https) for JSON\-RPC connections +.TP +\fB\-rpcsslcertificatchainfile=\fR<file.cert> +Server certificate file (default: server.cert) +.TP +\fB\-rpcsslprivatekeyfile=\fR<file.pem> +Server private key (default: server.pem) +.TP +\fB\-rpcsslciphers=\fR<ciphers> +Acceptable ciphers (default: TLSv1+HIGH:\:!SSLv2:\:!aNULL:\:!eNULL:\:!AH:\:!3DES:\:@STRENGTH) +.TP +\-? +This help message +.SH COMMANDS +.TP +\fBbackupwallet 'destination'\fR +Safely copies *wallet.dat* to 'destination', which can be a directory or a path with filename. +.TP +\fBgetaccount 'dogecoinaddress'\fR +Returns the account associated with the given address. +.TP +\fBsetaccount 'dogecoinaddress' ['account']\fR +Sets the ['account'] associated with the given address. ['account'] may be omitted to remove an address from ['account']. +.TP +\fBgetaccountaddress 'account'\fR +Returns a new dogecoin address for 'account'. +.TP +\fBgetaddressesbyaccount 'account'\fR +Returns the list of addresses associated with the given 'account'. +.TP +\fBgetbalance 'account'\fR +Returns the server's available balance, or the balance for 'account'. +.TP +\fBgetblockcount\fR +Returns the number of blocks in the longest block chain. +.TP +\fBgetblocknumber\fR +Returns the block number of the latest block in the longest block chain. +.TP +\fBgetconnectioncount\fR +Returns the number of connections to other nodes. +.TP +\fBgetdifficulty\fR +Returns the proof-of-work difficulty as a multiple of the minimum difficulty. +.TP +\fBgetgenerate\fR +Returns boolean true if server is trying to generate dogecoins, false otherwise. +.TP +\fBsetgenerate 'generate' ['genproclimit']\fR +Generation is limited to ['genproclimit'] processors, \-1 is unlimited. +.TP +\fBgethashespersec\fR +Returns a recent hashes per second performance measurement while generating. +.TP +\fBgetinfo\fR +Returns an object containing server information. +.TP +\fBgetnewaddress 'account'\fR +Returns a new dogecoin 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'. +.TP +\fBgetreceivedbyaccount 'account' ['minconf=1']\fR +Returns the total amount received by addresses associated with 'account' in transactions with at least ['minconf'] confirmations. +.TP +\fBgetreceivedbyaddress 'dogecoinaddress' ['minconf=1']\fR +Returns the total amount received by 'dogecoinaddress' in transactions with at least ['minconf'] confirmations. +.TP +\fBgettransaction 'txid'\fR +Returns information about a specific transaction, given hexadecimal transaction ID. +.TP +\fBgetwork 'data'\fR +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: + + "midstate" : precomputed hash state after hashing the first half of the data. + "data" : block data. + "hash1" : formatted hash buffer for second hash. + "target" : little endian hash target. +.TP +\fBhelp 'command'\fR +List commands, or get help for a command. +.TP +\fBlistaccounts ['minconf=1']\fR +List accounts and their current balances. + *note: requires dogecoin 0.3.20 or later. +.TP +\fBlistreceivedbyaccount ['minconf=1'] ['includeempty=false']\fR +['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: + + "account" : the account of the receiving address. + "amount" : total amount received by the address. + "confirmations" : number of confirmations of the most recent transaction included. +.TP +\fBlistreceivedbyaddress ['minconf=1'] ['includeempty=false']\fR +['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: + + "address" : receiving address. + "account" : the account of the receiving address. + "amount" : total amount received by the address. + "confirmations" : number of confirmations of the most recent transaction included. +.TP +\fBlisttransactions 'account' ['count=10']\fR +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: + + "category" : will be generate, send, receive, or move. + "amount" : amount of transaction. + "fee" : Fee (if any) paid (only for send transactions). + "confirmations" : number of confirmations (only for generate/send/receive). + "txid" : transaction ID (only for generate/send/receive). + "otheraccount" : account funds were moved to or from (only for move). + "message" : message associated with transaction (only for send). + "to" : message-to associated with transaction (only for send). + + *note: requires dogecoin 0.3.20 or later. +.TP +\fBmove <'fromaccount'> <'toaccount'> <'amount'> ['minconf=1'] ['comment']\fR +Moves funds between accounts. +.TP +\fBsendfrom* <'account'> <'dogecoinaddress'> <'amount'> ['minconf=1'] ['comment'] ['comment-to']\fR +Sends amount from account's balance to 'dogecoinaddress'. This method will fail if there is less than amount dogecoins 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. +.TP +\fBsendtoaddress 'dogecoinaddress' 'amount' ['comment'] ['comment-to']\fR +Sends amount from the server's available balance to 'dogecoinaddress'. amount is a real and is rounded to the nearest 0.01. Returns transaction id on success. +.TP +\fBstop\fR +Stops the dogecoin server. +.TP +\fBvalidateaddress 'dogecoinaddress'\fR +Checks that 'dogecoinaddress' looks like a proper dogecoin address. Returns an object containing: + + "isvalid" : true or false. + "ismine" : true if the address is in the server's wallet. + "address" : dogecoinaddress. + + *note: ismine and address are only returned if the address is valid. + +.SH "SEE ALSO" +dogecoin.conf(5) +.SH AUTHOR +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. + +On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL. + |