Explain required argument disambiguation with -u

Fixes #919.
This commit is contained in:
Sven-Hendrik Haase 2022-10-12 21:52:46 +02:00
parent 978038a16e
commit dba2f9ea7e
No known key found for this signature in database
GPG Key ID: 39E4B877E62EB915

View File

@ -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