docs: specify correct usage of timeout flag

mr-karan · Jul 2, 2024 · 89a0114 · 89a0114
1 parent 96242dc
commit 89a0114
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 14 deletions.
diff --git a/cmd/doggo/help.go b/cmd/doggo/help.go
@@ -105,7 +105,7 @@ func renderCustomHelp() {
 			{"--strategy=STRATEGY", "Specify strategy to query nameserver listed in etc/resolv.conf. (all, random, first)."},
 			{"--ndots=INT", "Specify ndots parameter. Takes value from /etc/resolv.conf if using the system namesever or 1 otherwise."},
 			{"--search", "Use the search list defined in resolv.conf. Defaults to true. Set --search=false to disable search list."},
-			{"--timeout", "Specify timeout (in seconds) for the resolver to return a response."},
+			{"--timeout=DURATION", "Specify timeout for the resolver to return a response (e.g., 5s, 400ms, 1m)."},
 			{"-4 --ipv4", "Use IPv4 only."},
 			{"-6 --ipv6", "Use IPv6 only."},
 			{"--tls-hostname=HOSTNAME", "Provide a hostname for verification of the certificate if the provided DoT nameserver is an IP."},

diff --git a/docs/src/content/docs/guide/examples.md b/docs/src/content/docs/guide/examples.md
@@ -80,7 +80,7 @@ These examples showcase how to combine different features for powerful DNS query
 
 14. Use IPv6 only with a specific timeout and DNSSEC checking:
     ```bash
-    doggo AAAA example.com -6 --timeout 5 --do
+    doggo AAAA example.com -6 --timeout 3s --do
     ```
 
 

diff --git a/docs/src/content/docs/guide/reference.md b/docs/src/content/docs/guide/reference.md
@@ -23,16 +23,16 @@ doggo [--] [query options] [arguments...]
 
 ## Resolver Options
 
-| Option                         | Description                                                        |
-| ------------------------------ | ------------------------------------------------------------------ |
-| `--strategy=STRATEGY`          | Specify strategy to query nameservers (all, random, first)         |
-| `--ndots=INT`                  | Specify ndots parameter                                            |
-| `--search`                     | Use the search list defined in resolv.conf (default: true)         |
-| `--timeout`                    | Specify timeout (in seconds) for the resolver to return a response |
-| `-4, --ipv4`                   | Use IPv4 only                                                      |
-| `-6, --ipv6`                   | Use IPv6 only                                                      |
-| `--tls-hostname=HOSTNAME`      | Provide a hostname for TLS certificate verification                |
-| `--skip-hostname-verification` | Skip TLS Hostname Verification for DoT lookups                     |
+| Option                         | Description                                                                 |
+| ------------------------------ | --------------------------------------------------------------------------- |
+| `--strategy=STRATEGY`          | Specify strategy to query nameservers (all, random, first)                  |
+| `--ndots=INT`                  | Specify ndots parameter                                                     |
+| `--search`                     | Use the search list defined in resolv.conf (default: true)                  |
+| `--timeout=DURATION`           | Specify timeout for the resolver to return a response (e.g., 5s, 400ms, 1m) |
+| `-4, --ipv4`                   | Use IPv4 only                                                               |
+| `-6, --ipv6`                   | Use IPv6 only                                                               |
+| `--tls-hostname=HOSTNAME`      | Provide a hostname for TLS certificate verification                         |
+| `--skip-hostname-verification` | Skip TLS Hostname Verification for DoT lookups                              |
 
 ## Query Flags
 

diff --git a/docs/src/content/docs/resolvers/system.md b/docs/src/content/docs/resolvers/system.md
@@ -60,7 +60,7 @@ Available strategies:
 --ndots=INT             Specify ndots parameter. Takes value from /etc/resolv.conf if using the system nameserver or 1 otherwise.
 --search                Use the search list defined in resolv.conf. Defaults to true. Set --search=false to disable search list.
 --strategy=STRATEGY     Specify strategy to query nameservers listed in /etc/resolv.conf. Options: all, first, random. Defaults to all.
---timeout=SECONDS       Set the timeout for resolver responses.
+--timeout=DURATION    Set the timeout for resolver responses (e.g., 5s, 400ms, 1m).
 ```
 
 ## Examples
@@ -77,7 +77,7 @@ Available strategies:
 
 3. Use system resolver with 'first' strategy and custom timeout:
    ```bash
-   doggo example.com --strategy=first --timeout=5
+   doggo example.com --strategy=first --timeout=2s
    ```
 
 4. Override system resolver and use specific nameservers:
-Original file line number
+Diff line change
@@ Expand Up @@
 . Use IPv6 only with a specific timeout and DNSSEC checking:
         ```bash
-        doggo AAAA example.com -6 --timeout 5 --do
+        doggo AAAA example.com -6 --timeout 3s --do
         ```
@@ Expand Down @@