docs(cmd): update proxy flag comments

iyear · Sep 5, 2022 · 8c719c3 · 8c719c3
1 parent 61dc24c
commit 8c719c3
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/cmd/root.go b/cmd/root.go
@@ -27,7 +27,7 @@ var cmd = &cobra.Command{
 
 func init() {
  cmd.AddCommand(version.Cmd, login.Cmd, dl.Cmd)
- cmd.PersistentFlags().String("proxy", "", "proxy address, only socks5 is supported")
+ cmd.PersistentFlags().String("proxy", "", "proxy address, only socks5 is supported, format: protocol://username:password@host:port")
  cmd.PersistentFlags().StringP("ns", "n", "", "namespace for Telegram session")
 
  docs := filepath.Join(consts.DocsPath, "command")

diff --git a/docs/command/tdl.md b/docs/command/tdl.md
@@ -13,7 +13,7 @@ tdl -h
 ```
  -h, --help help for tdl
  -n, --ns string namespace for Telegram session
- --proxy string proxy address, only socks5 is supported
+ --proxy string proxy address, only socks5 is supported, format: protocol://username:password@host:port
 ```
 
 ### SEE ALSO

diff --git a/docs/command/tdl_dl.md b/docs/command/tdl_dl.md
@@ -27,7 +27,7 @@ tdl dl
 
 ```
  -n, --ns string namespace for Telegram session
- --proxy string proxy address, only socks5 is supported
+ --proxy string proxy address, only socks5 is supported, format: protocol://username:password@host:port
 ```
 
 ### SEE ALSO

diff --git a/docs/command/tdl_login.md b/docs/command/tdl_login.md
@@ -22,7 +22,7 @@ tdl login
 
 ```
  -n, --ns string namespace for Telegram session
- --proxy string proxy address, only socks5 is supported
+ --proxy string proxy address, only socks5 is supported, format: protocol://username:password@host:port
 ```
 
 ### SEE ALSO

diff --git a/docs/command/tdl_version.md b/docs/command/tdl_version.md
@@ -22,7 +22,7 @@ tdl version
 
 ```
  -n, --ns string namespace for Telegram session
- --proxy string proxy address, only socks5 is supported
+ --proxy string proxy address, only socks5 is supported, format: protocol://username:password@host:port
 ```
 
 ### SEE ALSO