doc doc doc

README.md

@@ -61,7 +61,7 @@ Options:
   -z <DURATION>                      Duration of application to send requests. If duration is specified, n is ignored.
                                      Examples: -z 10s -z 3m.
   -q <QUERY_PER_SECOND>              Rate limit for all, in queries per second (QPS)
-      --rand-regex-url               Generate URL by rand_regex crate but dot is disabled for each query e.g. http://127.0.0.1/[a-z][a-z][0-9]. Currently dynamic scheme, host and port with keep-alive are not works well. See https://docs.rs/rand_regex/latest/rand_regex/struct.Regex.html for details of syntax.
+      --rand-regex-url               Generate URL by rand_regex crate but dot is disabled for each query e.g. http://127.0.0.1/[a-z][a-z][0-9]. See https://docs.rs/rand_regex/latest/rand_regex/struct.Regex.html for details of syntax.
       --max-repeat <MAX_REPEAT>      A parameter for the '--rand-regex-url'. The max_repeat parameter gives the maximum extra repeat counts the x*, x+ and x{n,} operators will become. [default: 4]
       --latency-correction           Correct latency to avoid coordinated omission problem. It's ignored if -q is not set.
       --no-tui                       No realtime tui
@@ -109,6 +109,20 @@ oha <-z or -n> -c <number of concurrent connections> -q <query per seconds> --la
 
     You can avoid `Coordinated Omission Problem` by using `--latency-correction`.
 
+## Dynamic url feature
+
+You can use `--rand-regex-url` option to generate random url for each connection.
+
+```sh
+oha --rand-regex-url http://127.0.0.1/[a-z][a-z][0-9]
+```
+
+Each Urls are generated by [rand_regex](https://github.com/kennytm/rand_regex) crate but regex's dot is disabled since it's not useful for this purpose and it's very incovenient if url's dots are interpreted as regex's dot.
+
+Optionaly you can set `--max-repeat` option to limit max repeat count for each regex. e.g http://127.0.0.1/[a-z]* with `--max-repeat 4` will generate url like http://127.0.0.1/[a-z]{0,4}
+
+If keep-alive is enabled, path and query are generated for each request but shceme, host and port are fixed during connection.
+
 # Contribution
 
 Feel free to help us!

src/main.rs

@@ -50,7 +50,7 @@ Examples: -z 10s -z 3m.",
     #[clap(help = "Rate limit for all, in queries per second (QPS)", short = 'q')]
     query_per_second: Option<usize>,
     #[clap(
-        help = "Generate URL by rand_regex crate but dot is disabled for each query e.g. http://127.0.0.1/[a-z][a-z][0-9]. Currently dynamic scheme, host and port with keep-alive are not works well. See https://docs.rs/rand_regex/latest/rand_regex/struct.Regex.html for details of syntax.",
+        help = "Generate URL by rand_regex crate but dot is disabled for each query e.g. http://127.0.0.1/[a-z][a-z][0-9]. See https://docs.rs/rand_regex/latest/rand_regex/struct.Regex.html for details of syntax.",
         default_value = "false",
         long
     )]