arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2025-01-09 06:50:58 +00:00
Code Issues Releases Wiki Activity

docs: change "_" to "-" in command names

Browse Source
This commit is contained in:
walkjivefly 2018-11-30 12:02:10 +07:00 committed by matejcik
parent 4ab8bec901
commit a0340c94eb
2 changed files with 55 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/EXAMPLES.rst
View File

@ -12,7 +12,7 @@ Retrieve features, settings and coin types supported by your device:
.. code:: .. code::
trezorctl get_features trezorctl get-features
Bitcoin examples Bitcoin examples
@ -22,25 +22,25 @@ Get first receiving address of first account for Bitcoin (Legacy / non-SegWit):
.. code:: .. code::
trezorctl get_address --coin Bitcoin --script-type address --address "m/44'/0'/0'/0/0" trezorctl get-address --coin Bitcoin --script-type address --address "m/44'/0'/0'/0/0"
Get first receiving address of first account for Bitcoin (SegWit-in-P2SH): Get first receiving address of first account for Bitcoin (SegWit-in-P2SH):
.. code:: .. code::
trezorctl get_address --coin Bitcoin --script-type p2shsegwit --address "m/49'/0'/0'/0/0" trezorctl get-address --coin Bitcoin --script-type p2shsegwit --address "m/49'/0'/0'/0/0"
Get first receiving address of first account for Bitcoin (Bech32 native SegWit P2WPKH): Get first receiving address of first account for Bitcoin (Bech32 native SegWit P2WPKH):
.. code:: .. code::
trezorctl get_address --coin Bitcoin --script-type segwit --address "m/84'/0'/0'/0/0" trezorctl get-address --coin Bitcoin --script-type segwit --address "m/84'/0'/0'/0/0"
Get Legacy Bitcoin ``xpub`` (can be used to create a watch-only wallet): Get Legacy Bitcoin ``xpub`` (can be used to create a watch-only wallet):
.. code:: .. code::
trezorctl get_public_node --coin Bitcoin --address "m/44'/0'/0'" trezorctl get-public-node --coin Bitcoin --address "m/44'/0'/0'"
Transaction signing Transaction signing
@ -63,7 +63,7 @@ After authenticating, open the "Send" tab, fill-out all details, then open the "
.. code:: .. code::
trezorctl sign_tx -c Bitcoin trezorctl sign-tx -c Bitcoin
Input (prevhash:previndex, empty to move on): a5ea715aa99ca30516f3af6f622dfe7399d883d49ad74b1fe33fdf73d201e64e:0 Input (prevhash:previndex, empty to move on): a5ea715aa99ca30516f3af6f622dfe7399d883d49ad74b1fe33fdf73d201e64e:0
Node path to sign with (e.g.- Bitcoin/0'/0/0): Bitcoin/0'/0/0 Node path to sign with (e.g.- Bitcoin/0'/0/0): Bitcoin/0'/0/0
@ -101,13 +101,13 @@ Get first receiving address of first account for Litecoin (SegWit-in-P2SH):
.. code:: .. code::
trezorctl get_address --coin Litecoin --script-type p2shsegwit --address "m/49'/2'/0'/0/0" trezorctl get-address --coin Litecoin --script-type p2shsegwit --address "m/49'/2'/0'/0/0"
Get first receiving address of first account for Litecoin (Bech32 native SegWit P2WPKH): Get first receiving address of first account for Litecoin (Bech32 native SegWit P2WPKH):
.. code:: .. code::
trezorctl get_address --coin Litecoin --script-type segwit --address "m/84'/2'/0'/0/0" trezorctl get-address --coin Litecoin --script-type segwit --address "m/84'/2'/0'/0/0"
Notes Notes
----- -----

91
docs/OPTIONS.rst
View File

@ -23,47 +23,50 @@ Use the following command to see all options:
--help Show this message and exit. --help Show this message and exit.
Commands: Commands:
backup_device Perform device seed backup. backup-device Perform device seed backup.
change_pin Change new PIN or remove existing. change-pin Change new PIN or remove existing.
clear_session Clear session (remove cached PIN, passphrase,... clear-session Clear session (remove cached PIN, passphrase,...
cosi_commit Ask device to commit to CoSi signing. cosi-commit Ask device to commit to CoSi signing.
cosi_sign Ask device to sign using CoSi. cosi-sign Ask device to sign using CoSi.
decrypt_keyvalue Decrypt value by given key and path. decrypt-keyvalue Decrypt value by given key and path.
decrypt_message Decrypt message. decrypt-message Decrypt message.
disable_passphrase Disable passphrase. disable-passphrase Disable passphrase.
enable_passphrase Enable passphrase. enable-passphrase Enable passphrase.
encrypt_keyvalue Encrypt value by given key and path. encrypt-keyvalue Encrypt value by given key and path.
encrypt_message Encrypt message. encrypt-message Encrypt message.
ethereum_get_address Get Ethereum address in hex encoding. ethereum-get-address Get Ethereum address in hex encoding.
ethereum_sign_message Sign message with Ethereum address. ethereum-sign-message Sign message with Ethereum address.
ethereum_sign_tx Sign (and optionally publish) Ethereum... ethereum-sign-tx Sign (and optionally publish) Ethereum...
ethereum_verify_message Verify message signed with Ethereum address. ethereum-verify-message Verify message signed with Ethereum address.
firmware_update Upload new firmware to device (must be in... firmware-update Upload new firmware to device (must be in...
get_address Get address for specified path. get-address Get address for specified path.
get_entropy Get example entropy. get-entropy Get example entropy.
get_features Retrieve device features and settings. get-features Retrieve device features and settings.
get_public_node Get public node of given path. get-public-node Get public node of given path.
list List connected TREZOR devices. lisk-get-address Get Lisk address for specified path.
list_coins List all supported coin types by the device. lisk-get-public-key Get Lisk public key for specified path.
load_device Load custom configuration to the device. lisk-sign-message Sign message with Lisk address.
nem_get_address Get NEM address for specified path. lisk-sign-tx Sign Lisk transaction.
nem_sign_tx Sign (and optionally broadcast) NEM... lisk-verify-message Verify message signed with Lisk address.
ontology_get_address Get Ontology address for specified path. list List connected TREZOR devices.
ontology_get_public_key Get Ontology public key for specified path. load-device Load custom configuration to the device.
ontology_sign_transfer Sign Ontology Transfer... nem-get-address Get NEM address for specified path.
ontology_sign_withdraw Sign Ontology Withdraw Ong... nem-sign-tx Sign (and optionally broadcast) NEM transaction.
ontology_sign_register Sign Ontology ONT ID Registration... ping Send ping message.
ontology_sign_add_attr Sign Ontology ONT ID Attributes adding... recovery-device Start safe recovery workflow.
ping Send ping message. reset-device Perform device setup and generate new seed.
recovery_device Start safe recovery workflow. self-test Perform a self-test.
reset_device Perform device setup and generate new seed. set-auto-lock-delay Set auto-lock delay (in seconds).
self_test Perform a self-test. set-flags Set device flags.
set_flags Set device flags. set-homescreen Set new homescreen.
set_homescreen Set new homescreen. set-label Set new device label.
set_label Set new device label. set-passphrase-source Set passphrase source.
set_u2f_counter Set U2F counter. set-u2f-counter Set U2F counter.
sign_message Sign message using address of given path. sign-message Sign message using address of given path.
sign_tx Sign transaction. sign-tx Sign transaction.
verify_message Verify message. stellar-get-address Get Stellar public address
version Show version of trezorctl/trezorlib. stellar-get-public-key Get Stellar public key
wipe_device Reset device to factory defaults and remove... stellar-sign-transaction Sign a base64-encoded transaction envelope
verify-message Verify message.
version Show version of trezorctl/trezorlib.
wipe-device Reset device to factory defaults and remove all...