[documentation] Document --sources-md5 and --sources-cpio; plus minor fixups.

This commit is contained in:
Ciprian Dorin Craciun 2022-09-02 15:32:17 +03:00
parent c889c90c5b
commit d9de6b85af
8 changed files with 56 additions and 24 deletions

View file

@ -65,8 +65,12 @@ kawipiko -- blazingly fast static HTTP server \- kawipiko-archiver
\-\-progress \-\-debug \-\-progress \-\-debug
\-\-version
\-\-help (show this short help) \-\-help (show this short help)
\-\-man (show the full manual) \-\-man (show the full manual)
\-\-sources\-md5 (dump an \(ga\(gamd5sum\(ga\(ga of the sources)
\-\-sources\-cpio (dump a \(ga\(gacpio.gz\(ga\(ga of the sources)
.ft P .ft P
.fi .fi
.UNINDENT .UNINDENT

View file

@ -37,9 +37,13 @@ kawipiko -- blazingly fast static HTTP server
--progress --debug --progress --debug
--version
--help (show this short help) --help (show this short help)
--man (show the full manual) --man (show the full manual)
--sources-md5 (dump an ``md5sum`` of the sources)
--sources-cpio (dump a ``cpio.gz`` of the sources)

View file

@ -27,9 +27,13 @@ NAME
--progress --debug --progress --debug
--version
--help (show this short help) --help (show this short help)
--man (show the full manual) --man (show the full manual)
--sources-md5 (dump an ``md5sum`` of the sources)
--sources-cpio (dump a ``cpio.gz`` of the sources)
---- ----

View file

@ -85,15 +85,19 @@ kawipiko -- blazingly fast static HTTP server \- kawipiko-server
\-\-report \-\-quiet \-\-debug \-\-report \-\-quiet \-\-debug
\-\-help (show this short help)
\-\-man (show the full manual)
\-\-dummy \-\-dummy
\-\-dummy\-empty \-\-dummy\-empty
\-\-dummy\-delay <duration> \-\-dummy\-delay <duration>
\-\-profile\-cpu <path> \-\-profile\-cpu <path>
\-\-profile\-mem <path> \-\-profile\-mem <path>
\-\-version
\-\-help (show this short help)
\-\-man (show the full manual)
\-\-sources\-md5 (dump an \(gamd5sum\(ga of the sources)
\-\-sources\-cpio (dump a \(gacpio.gz\(ga of the sources)
.ft P .ft P
.fi .fi
.UNINDENT .UNINDENT
@ -117,7 +121,7 @@ The IP and port to listen for requests with:
.IP \(bu 2 .IP \(bu 2
(secure) HTTP/1.1 over TLS for \fB\-\-bind\-tls\fP, leveraging \fBfasthttp\fP library; (secure) HTTP/1.1 over TLS for \fB\-\-bind\-tls\fP, leveraging \fBfasthttp\fP library;
.IP \(bu 2 .IP \(bu 2
(insecure) HTTP/1.1 for \fI\-\-bind\-2\(ga\fP, leveraging Go\(aqs \fBnet/http\fP library; (not as performant as the \fBfasthttp\fP powered endpoint;) (insecure) HTTP/1.1 for \fB\-\-bind\-2\fP, leveraging Go\(aqs \fBnet/http\fP library; (not as performant as the \fBfasthttp\fP powered endpoint;)
.IP \(bu 2 .IP \(bu 2
(secure) H2 or HTTP/1.1 over TLS for \fB\-\-bind\-tls\-2\fP, leveraging Go\(aqs \fBnet/http\fP; (not as performant as the \fBfasthttp\fP powered endpoint;) (secure) H2 or HTTP/1.1 over TLS for \fB\-\-bind\-tls\-2\fP, leveraging Go\(aqs \fBnet/http\fP; (not as performant as the \fBfasthttp\fP powered endpoint;)
.IP \(bu 2 .IP \(bu 2

View file

@ -56,9 +56,6 @@ kawipiko -- blazingly fast static HTTP server
--report --quiet --debug --report --quiet --debug
--help (show this short help)
--man (show the full manual)
--dummy --dummy
--dummy-empty --dummy-empty
--dummy-delay <duration> --dummy-delay <duration>
@ -66,6 +63,13 @@ kawipiko -- blazingly fast static HTTP server
--profile-cpu <path> --profile-cpu <path>
--profile-mem <path> --profile-mem <path>
--version
--help (show this short help)
--man (show the full manual)
--sources-md5 (dump an `md5sum` of the sources)
--sources-cpio (dump a `cpio.gz` of the sources)
@ -84,7 +88,7 @@ Flags
* (insecure) HTTP/1.1 for ``--bind``, leveraging ``fasthttp`` library; * (insecure) HTTP/1.1 for ``--bind``, leveraging ``fasthttp`` library;
* (secure) HTTP/1.1 over TLS for ``--bind-tls``, leveraging ``fasthttp`` library; * (secure) HTTP/1.1 over TLS for ``--bind-tls``, leveraging ``fasthttp`` library;
* (insecure) HTTP/1.1 for `--bind-2``, leveraging Go's ``net/http`` library; (not as performant as the ``fasthttp`` powered endpoint;) * (insecure) HTTP/1.1 for ``--bind-2``, leveraging Go's ``net/http`` library; (not as performant as the ``fasthttp`` powered endpoint;)
* (secure) H2 or HTTP/1.1 over TLS for ``--bind-tls-2``, leveraging Go's ``net/http``; (not as performant as the ``fasthttp`` powered endpoint;) * (secure) H2 or HTTP/1.1 over TLS for ``--bind-tls-2``, leveraging Go's ``net/http``; (not as performant as the ``fasthttp`` powered endpoint;)
* (secure) H3 over QUIC for ``--bind-quic``, leveraging ``github.com/lucas-clemente/quic-go`` library; (given that H3 is still a new protocol, this must be used with caution; also one should use the ``--http3-alt-svc <ip:port>``;) * (secure) H3 over QUIC for ``--bind-quic``, leveraging ``github.com/lucas-clemente/quic-go`` library; (given that H3 is still a new protocol, this must be used with caution; also one should use the ``--http3-alt-svc <ip:port>``;)

View file

@ -47,9 +47,6 @@ NAME
--report --quiet --debug --report --quiet --debug
--help (show this short help)
--man (show the full manual)
--dummy --dummy
--dummy-empty --dummy-empty
--dummy-delay <duration> --dummy-delay <duration>
@ -57,6 +54,13 @@ NAME
--profile-cpu <path> --profile-cpu <path>
--profile-mem <path> --profile-mem <path>
--version
--help (show this short help)
--man (show the full manual)
--sources-md5 (dump an `md5sum` of the sources)
--sources-cpio (dump a `cpio.gz` of the sources)
---- ----
@ -73,7 +77,7 @@ FLAGS
• (secure) HTTP/1.1 over TLS for --bind-tls, leveraging fasthttp • (secure) HTTP/1.1 over TLS for --bind-tls, leveraging fasthttp
library; library;
• (insecure) HTTP/1.1 for --bind-2`, leveraging Go's net/http • (insecure) HTTP/1.1 for --bind-2, leveraging Go's net/http
library; (not as performant as the fasthttp powered endpoint;) library; (not as performant as the fasthttp powered endpoint;)
• (secure) H2 or HTTP/1.1 over TLS for --bind-tls-2, leveraging Go's • (secure) H2 or HTTP/1.1 over TLS for --bind-tls-2, leveraging Go's

View file

@ -27,9 +27,13 @@ NAME
--progress --debug --progress --debug
--version
--help (show this short help) --help (show this short help)
--man (show the full manual) --man (show the full manual)
--sources-md5 (dump an ``md5sum`` of the sources)
--sources-cpio (dump a ``cpio.gz`` of the sources)
---- ----

View file

@ -47,9 +47,6 @@ NAME
--report --quiet --debug --report --quiet --debug
--help (show this short help)
--man (show the full manual)
--dummy --dummy
--dummy-empty --dummy-empty
--dummy-delay <duration> --dummy-delay <duration>
@ -57,6 +54,13 @@ NAME
--profile-cpu <path> --profile-cpu <path>
--profile-mem <path> --profile-mem <path>
--version
--help (show this short help)
--man (show the full manual)
--sources-md5 (dump an `md5sum` of the sources)
--sources-cpio (dump a `cpio.gz` of the sources)
---- ----
@ -73,7 +77,7 @@ FLAGS
• (secure) HTTP/1.1 over TLS for --bind-tls, leveraging fasthttp • (secure) HTTP/1.1 over TLS for --bind-tls, leveraging fasthttp
library; library;
• (insecure) HTTP/1.1 for --bind-2`, leveraging Go's net/http • (insecure) HTTP/1.1 for --bind-2, leveraging Go's net/http
library; (not as performant as the fasthttp powered endpoint;) library; (not as performant as the fasthttp powered endpoint;)
• (secure) H2 or HTTP/1.1 over TLS for --bind-tls-2, leveraging Go's • (secure) H2 or HTTP/1.1 over TLS for --bind-tls-2, leveraging Go's