From 26baea535cb98d3adf5b3ce891cb1aa3b085abb1 Mon Sep 17 00:00:00 2001 From: Ryo Ota Date: Wed, 9 Aug 2023 09:19:27 +0900 Subject: [PATCH] docs: "--help" --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index be55969..16b8b62 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,21 @@ handy-sshd -p 2222 --user "john:" --user "alice:" # Listen on unix domain socket handy-sshd --unix-socket /tmp/my-unix-socket --user "john:" ``` + +## --help + +```bash +Portable SSH server + +Usage: + handy-sshd [flags] + +Flags: + -h, --help help for handy-sshd + --host string SSH server host (e.g. 127.0.0.1) + -p, --port uint16 SSH server port (default 2222) + --shell string Shell + --unix-socket string Unix-domain socket + --user stringArray SSH user name (e.g. "john:mypassword") + -v, --version show version +```