docs
docs copied to clipboard
syncthing
Document the cli subcommand
Include required information
Hi guys,
First off goes my thanks to dev and particularly for documentation you make - not all devs get(for some inexplicable reason) how crucial man pages are to the all the rest of us(whole-world - devs =) I run my Syncthing on Centos and I'm not sure if it's just distro's package issues but in case it's not - then please do with the 'cli' subcommand what you have done with the rest of 'Syncthing': Give it a nice juicy man page!!!
Please be sure to include at least:
- what problem your new feature would solve
- how or why you think it is generally useful (i.e., not just for you)
- what alternatives or workarounds you considered
It has -help, so I am not sure there is any value in a man page . Plenty of command line tools only have -help.
By the way, documentation is community maintained, so "be the change you want to see"
I am going to close this.
I don't think there is much content that could go in a man page, most of the cli is auto-generated reflectively anyway, so keeping a man page manually would be a never ending catch up game, and I'd rather not have a man page then have an outdated one.
If you want to see a change here, I suggest you file a PR.
The man page could explain the basics and how to explore the config and operations subcommands. Since stcli itself knows these structures I could imagine a --long-help which outputs all the variants in indented format. Our other man pages are also generated from something so auto generating a man page based on template and --long-help seems doable.
Sure, I guess there could be explanations on where it gets credentials etc too.
It looks like stcli no longer exists, and has been merged into the cli subcommand of the syncthing binary.
