aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSven-Hendrik Haase <svenstaro@gmail.com>2022-10-12 19:52:46 +0000
committerSven-Hendrik Haase <svenstaro@gmail.com>2022-10-12 20:07:30 +0000
commitdba2f9ea7e70b72f886e9aa56744304659f4bbca (patch)
tree6a84299c0ec967d508eebf0e4dfbb1c0f0e98006
parentUpgrade clap to v4 (diff)
downloadminiserve-dba2f9ea7e70b72f886e9aa56744304659f4bbca.tar.gz
miniserve-dba2f9ea7e70b72f886e9aa56744304659f4bbca.zip
Explain required argument disambiguation with -u
Fixes #919.
-rw-r--r--README.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.md b/README.md
index e952485..910f89f 100644
--- a/README.md
+++ b/README.md
@@ -64,12 +64,19 @@ Sometimes this is just a more practical and quick way than doing things properly
### Upload a file using `curl`:
# in one terminal
- miniserve -u .
+ miniserve -u -- .
# in another terminal
curl -F "path=@$FILE" http://localhost:8080/upload\?path\=/
(where `$FILE` is the path to the file. This uses miniserve's default port of 8080)
+Note that for uploading, we have to use `--` to disambiguate the argument to `-u`.
+This is because `-u` can also take a path (or multiple). If a path argument to `-u` is given,
+uploading will only be possible to the provided paths as opposed to every path.
+
+Another effect of this is that you can't just combine flags like this `-uv` when `-u` is used. In
+this example, you'd need to use `-u -v`.
+
### Create a directory using `curl`:
# in one terminal