electrum icon indicating copy to clipboard operation
electrum copied to clipboard

Man Page

Open sorenstoutner opened this issue 1 year ago • 9 comments

I am writing a Man Page for Electrum, which is the primary documentation format used on Debian systems.

https://en.wikipedia.org/wiki/Man_page

I was able to get most of the information I needed from the excellent help commands. But there are a few things that aren't clear to me.

  1. What are the possible arguments for the -v VERBOSTIY global option? I am used to using log levels between 0-7, but trying any of those numbers produces an error.
  2. What are the possible arguments for the -V VERBOSITY global option? It says it should be a shortcut-filter list, but I wasn't able to find any documentation of what that is.
  3. Is electrum gui -g text expected to work? On my machine, I receive an error saying that the paperclip module is missing.
  4. electrum gui -L es_ES does not appear to do anything, as Electrum is still launched in English. However, the -L option does work as expected with the make_seed command.
  5. electrum gui -m, which is supposed to hide the GUI on startup, does not appear to work. Electrum launches but isn't hidden. Am I missing something from the syntax?
  6. I assume that clear_ln_blacklist clears the Lightning blacklist. Is that correct?
  7. convert_xkey lists an example of xpub -> ypub. Are there any other types of keys beyond these two?
  8. --seed_type lists standard and segwit as possible options. Are there any other options? Which is the default if none is specified?
  9. Does createmultisig create a MultiSig address or a MultiSig wallet? The documentation in Electrum says MultiSig address, but all the general Bitcoin information I found online only talks about MultiSig wallets. What are the possible values for the num argument? What is the syntax (delimiter) for using multiple public keys?
  10. What does dumpgraph do?
  11. How is get_ssl_domain used? It returns blank for me, and it is unclear to me what ssl_keyfile and ssl_certificate it is using.
  12. What are the possible fee methods that can be passed to electrum getfeerate --fee_method FEE_METHOD?
  13. What is the syntax for passing a list of wallet addresses to getprivatekeys? All of the variations I tried produced errors.
  14. What is the syntax for passing a list of private keys to signtransaction_with_privkey?
  15. How is inject_fees used?
  16. Is there a specific syntax for searchcontacts or does it just simply match partial strings?
  17. Is there a list of configuration variables that can be set with setconfig?

For those who are interested, I have attached the current draft of the Man Page (the system doesn't like the .1 extension, so there is an extra .txt at the end). As a side note, I would be happy to contribute the Man Page to the Electrum project if desired. Otherwise, I can maintain it in the Debian packaging.

electrum.1.txt

sorenstoutner avatar Jul 19 '23 00:07 sorenstoutner