From d9de6b85afc1917d5b09c1d0ed562f9cf0dc0592 Mon Sep 17 00:00:00 2001 From: Ciprian Dorin Craciun Date: Fri, 2 Sep 2022 15:32:17 +0300 Subject: [PATCH] [documentation] Document `--sources-md5` and `--sources-cpio`; plus minor fixups. --- documentation/manuals/archiver.1.man | 8 ++++++-- documentation/manuals/archiver.rst | 8 ++++++-- documentation/manuals/archiver.txt | 8 ++++++-- documentation/manuals/server.1.man | 12 ++++++++---- documentation/manuals/server.rst | 12 ++++++++---- documentation/manuals/server.txt | 12 ++++++++---- sources/cmd/archiver/manual.txt | 8 ++++++-- sources/cmd/server/manual.txt | 12 ++++++++---- 8 files changed, 56 insertions(+), 24 deletions(-) diff --git a/documentation/manuals/archiver.1.man b/documentation/manuals/archiver.1.man index 73f6c2e..0b1e7b9 100644 --- a/documentation/manuals/archiver.1.man +++ b/documentation/manuals/archiver.1.man @@ -65,8 +65,12 @@ kawipiko -- blazingly fast static HTTP server \- kawipiko-archiver \-\-progress \-\-debug -\-\-help (show this short help) -\-\-man (show the full manual) +\-\-version +\-\-help (show this short help) +\-\-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 .fi .UNINDENT diff --git a/documentation/manuals/archiver.rst b/documentation/manuals/archiver.rst index a23113a..a8a6b38 100644 --- a/documentation/manuals/archiver.rst +++ b/documentation/manuals/archiver.rst @@ -37,8 +37,12 @@ kawipiko -- blazingly fast static HTTP server --progress --debug - --help (show this short help) - --man (show the full manual) + --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) diff --git a/documentation/manuals/archiver.txt b/documentation/manuals/archiver.txt index f09aed4..dccb035 100644 --- a/documentation/manuals/archiver.txt +++ b/documentation/manuals/archiver.txt @@ -27,8 +27,12 @@ NAME --progress --debug - --help (show this short help) - --man (show the full manual) + --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) ---- diff --git a/documentation/manuals/server.1.man b/documentation/manuals/server.1.man index e705f9e..b54dd11 100644 --- a/documentation/manuals/server.1.man +++ b/documentation/manuals/server.1.man @@ -85,15 +85,19 @@ kawipiko -- blazingly fast static HTTP server \- kawipiko-server \-\-report \-\-quiet \-\-debug -\-\-help (show this short help) -\-\-man (show the full manual) - \-\-dummy \-\-dummy\-empty \-\-dummy\-delay \-\-profile\-cpu \-\-profile\-mem + +\-\-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 .fi .UNINDENT @@ -117,7 +121,7 @@ The IP and port to listen for requests with: .IP \(bu 2 (secure) HTTP/1.1 over TLS for \fB\-\-bind\-tls\fP, leveraging \fBfasthttp\fP library; .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 (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 diff --git a/documentation/manuals/server.rst b/documentation/manuals/server.rst index 1d4d604..5235584 100644 --- a/documentation/manuals/server.rst +++ b/documentation/manuals/server.rst @@ -56,9 +56,6 @@ kawipiko -- blazingly fast static HTTP server --report --quiet --debug - --help (show this short help) - --man (show the full manual) - --dummy --dummy-empty --dummy-delay @@ -66,6 +63,13 @@ kawipiko -- blazingly fast static HTTP server --profile-cpu --profile-mem + --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; * (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) 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 ``;) diff --git a/documentation/manuals/server.txt b/documentation/manuals/server.txt index f155b2a..a0fbb3f 100644 --- a/documentation/manuals/server.txt +++ b/documentation/manuals/server.txt @@ -47,9 +47,6 @@ NAME --report --quiet --debug - --help (show this short help) - --man (show the full manual) - --dummy --dummy-empty --dummy-delay @@ -57,6 +54,13 @@ NAME --profile-cpu --profile-mem + --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 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;) • (secure) H2 or HTTP/1.1 over TLS for --bind-tls-2, leveraging Go's diff --git a/sources/cmd/archiver/manual.txt b/sources/cmd/archiver/manual.txt index f09aed4..dccb035 100644 --- a/sources/cmd/archiver/manual.txt +++ b/sources/cmd/archiver/manual.txt @@ -27,8 +27,12 @@ NAME --progress --debug - --help (show this short help) - --man (show the full manual) + --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) ---- diff --git a/sources/cmd/server/manual.txt b/sources/cmd/server/manual.txt index f155b2a..a0fbb3f 100644 --- a/sources/cmd/server/manual.txt +++ b/sources/cmd/server/manual.txt @@ -47,9 +47,6 @@ NAME --report --quiet --debug - --help (show this short help) - --man (show the full manual) - --dummy --dummy-empty --dummy-delay @@ -57,6 +54,13 @@ NAME --profile-cpu --profile-mem + --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 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;) • (secure) H2 or HTTP/1.1 over TLS for --bind-tls-2, leveraging Go's