diff options
| author | Sven-Hendrik Haase <svenstaro@gmail.com> | 2022-02-06 15:23:15 +0000 |
|---|---|---|
| committer | Sven-Hendrik Haase <svenstaro@gmail.com> | 2022-02-06 15:23:15 +0000 |
| commit | 803bdb96c599b150912d0e2ae0556ce7bac5fb42 (patch) | |
| tree | e5709a9b933b8db0fa9fdeb42529b0e4aa63575f /README.md | |
| parent | Fix release instructions (diff) | |
| download | miniserve-803bdb96c599b150912d0e2ae0556ce7bac5fb42.tar.gz miniserve-803bdb96c599b150912d0e2ae0556ce7bac5fb42.zip | |
Update README --help output
Diffstat (limited to '')
| -rw-r--r-- | README.md | 19 |
1 files changed, 13 insertions, 6 deletions
@@ -87,7 +87,7 @@ Sometimes this is just a more practical and quick way than doing things properly ## Usage - miniserve 0.18.0 + miniserve 0.19.0 Sven-Hendrik Haase <svenstaro@gmail.com>, Boastful Squirrel <boastful.squirrel@gmail.com> @@ -102,7 +102,8 @@ Sometimes this is just a more practical and quick way than doing things properly OPTIONS: -a, --auth <AUTH> - Set authentication. Currently supported formats: username:password, username:sha256:hash, username:sha512:hash (e.g. joe:123, + Set authentication. Currently supported formats: username:password, username:sha256:hash, + username:sha512:hash (e.g. joe:123, joe:sha256:a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3) -c, --color-scheme <COLOR_SCHEME> @@ -141,7 +142,8 @@ Sometimes this is just a more practical and quick way than doing things properly --index <index_file> The name of a directory index file to serve, like "index.html" - Normally, when miniserve serves a directory, it creates a listing for that directory. However, if a directory contains this file, miniserve will serve that file instead. + Normally, when miniserve serves a directory, it creates a listing for that directory. + However, if a directory contains this file, miniserve will serve that file instead. -l, --show-symlink-info Show symlink info @@ -171,11 +173,15 @@ Sometimes this is just a more practical and quick way than doing things properly --random-route Generate a random 6-hexdigit route + --route-prefix <ROUTE_PREFIX> + Use a specific route prefix + --spa Activate SPA (Single Page Application) mode - This will cause the file given by --index to be served for all non-existing file paths. In effect, this will serve the index file whenever a 404 would otherwise occur in order to allow the SPA - router to handle the request instead. + This will cause the file given by --index to be served for all non-existing file paths. In + effect, this will serve the index file whenever a 404 would otherwise occur in order to + allow the SPA router to handle the request instead. -t, --title <TITLE> Shown instead of host in page title and heading @@ -201,7 +207,8 @@ Sometimes this is just a more practical and quick way than doing things properly -z, --enable-zip Enable zip archive generation - WARNING: Zipping large directories can result in out-of-memory exception because zip generation is done in memory and cannot be sent on the fly + WARNING: Zipping large directories can result in out-of-memory exception because zip + generation is done in memory and cannot be sent on the fly ## How to install |