diff --git a/documentation/manuals/archiver.1.man b/documentation/manuals/archiver.1.man index 93b6ea4..4b4b214 100644 --- a/documentation/manuals/archiver.1.man +++ b/documentation/manuals/archiver.1.man @@ -36,6 +36,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .nf .ft C >> kawipiko\-archiver \-\-help +>> kawipiko\-archiver \-\-man .ft P .fi .UNINDENT @@ -61,8 +62,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] \-\-exclude\-file\-listing \-\-include\-folder\-listing -\-\-progress -\-\-debug +\-\-progress \-\-debug + +\-\-help (show this short help) +\-\-man (show the full manual) .ft P .fi .UNINDENT diff --git a/documentation/manuals/archiver.rst b/documentation/manuals/archiver.rst index d9726ed..f13c604 100644 --- a/documentation/manuals/archiver.rst +++ b/documentation/manuals/archiver.rst @@ -14,6 +14,7 @@ kawipiko -- blazingly fast static HTTP server :: >> kawipiko-archiver --help + >> kawipiko-archiver --man :: @@ -33,8 +34,10 @@ kawipiko -- blazingly fast static HTTP server --exclude-file-listing --include-folder-listing - --progress - --debug + --progress --debug + + --help (show this short help) + --man (show the full manual) diff --git a/documentation/manuals/archiver.txt b/documentation/manuals/archiver.txt index f08344b..68c61dc 100644 --- a/documentation/manuals/archiver.txt +++ b/documentation/manuals/archiver.txt @@ -6,6 +6,7 @@ NAME kawipiko -- blazingly fast static HTTP server - kawipiko-archiver >> kawipiko-archiver --help + >> kawipiko-archiver --man --sources @@ -23,8 +24,10 @@ NAME --exclude-file-listing --include-folder-listing - --progress - --debug + --progress --debug + + --help (show this short help) + --man (show the full manual) ---- diff --git a/documentation/manuals/server.1.man b/documentation/manuals/server.1.man index e73ac99..225a8a1 100644 --- a/documentation/manuals/server.1.man +++ b/documentation/manuals/server.1.man @@ -36,6 +36,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .nf .ft C >> kawipiko\-server \-\-help +>> kawipiko\-server \-\-man .ft P .fi .UNINDENT @@ -78,10 +79,18 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] \-\-limit\-memory \-\-timeout\-disable -\-\-profile\-cpu ; \-\-profile\-mem -\-\-report ; \-\-quiet ; \-\-debug -\-\-dummy ; \-\-dummy\-empty ; \-\-dummy\-delay +\-\-report \-\-quiet \-\-debug + +\-\-help (show this short help) +\-\-man (show the full manual) + +\-\-dummy +\-\-dummy\-empty +\-\-dummy\-delay + +\-\-profile\-cpu +\-\-profile\-mem .ft P .fi .UNINDENT @@ -272,7 +281,7 @@ This argument can be used to benchmark the raw performance of the underlying \fB .UNINDENT .UNINDENT .sp -\fB\-\-delay \fP +\fB\-\-dummy\-delay \fP .INDENT 0.0 .INDENT 3.5 Enables delaying each response with a certain amount (for example \fB1s\fP, \fB1ms\fP, etc.) @@ -282,7 +291,7 @@ It can be used to simulate the real\-world network latencies, perhaps to see how .UNINDENT .UNINDENT .sp -\fB\-\-profile\-cpu \fP and \fB\-\-profile\-mem \fP +\fB\-\-profile\-cpu \fP, and \fB\-\-profile\-mem \fP .INDENT 0.0 .INDENT 3.5 Enables CPU and memory profiling using Go\(aqs profiling infrastructure. diff --git a/documentation/manuals/server.rst b/documentation/manuals/server.rst index 4c7fc37..ab885d1 100644 --- a/documentation/manuals/server.rst +++ b/documentation/manuals/server.rst @@ -13,6 +13,7 @@ kawipiko -- blazingly fast static HTTP server :: >> kawipiko-server --help + >> kawipiko-server --man :: @@ -49,10 +50,18 @@ kawipiko -- blazingly fast static HTTP server --limit-memory --timeout-disable - --profile-cpu ; --profile-mem - --report ; --quiet ; --debug - --dummy ; --dummy-empty ; --dummy-delay + --report --quiet --debug + + --help (show this short help) + --man (show the full manual) + + --dummy + --dummy-empty + --dummy-delay + + --profile-cpu + --profile-mem @@ -174,14 +183,14 @@ Flags This argument can be used to benchmark the raw performance of the underlying ``fasthttp``, Go's ``net/http``, or QUIC performance; this is the upper limit of the achievable performance given the underlying technologies. (From my own benchmarks ``kawipiko``'s adds only about ~15% overhead when actually serving the ``hello-world.cdb`` archive.) -``--delay `` +``--dummy-delay `` Enables delaying each response with a certain amount (for example ``1s``, ``1ms``, etc.) It can be used to simulate the real-world network latencies, perhaps to see how a site with many resources loads in various conditions. (For example, see `an experiment `__ I made with an image made out of 1425 tiles.) -``--profile-cpu `` and ``--profile-mem `` +``--profile-cpu ``, and ``--profile-mem `` Enables CPU and memory profiling using Go's profiling infrastructure. diff --git a/documentation/manuals/server.txt b/documentation/manuals/server.txt index 2ecf120..6fb865d 100644 --- a/documentation/manuals/server.txt +++ b/documentation/manuals/server.txt @@ -6,6 +6,7 @@ NAME kawipiko -- blazingly fast static HTTP server - kawipiko-server >> kawipiko-server --help + >> kawipiko-server --man --archive --archive-inmem (memory-loaded archive file) @@ -40,10 +41,18 @@ NAME --limit-memory --timeout-disable - --profile-cpu ; --profile-mem - --report ; --quiet ; --debug - --dummy ; --dummy-empty ; --dummy-delay + --report --quiet --debug + + --help (show this short help) + --man (show the full manual) + + --dummy + --dummy-empty + --dummy-delay + + --profile-cpu + --profile-mem ---- @@ -207,7 +216,7 @@ FLAGS technologies. (From my own benchmarks kawipiko's adds only about ~15% overhead when actually serving the hello-world.cdb archive.) - --delay + --dummy-delay Enables delaying each response with a certain amount (for example 1s, 1ms, etc.) @@ -216,7 +225,7 @@ FLAGS (For example, see an experiment I made with an image made out of 1425 tiles.) - --profile-cpu and --profile-mem + --profile-cpu , and --profile-mem Enables CPU and memory profiling using Go's profiling infrastructure. diff --git a/sources/cmd/archiver/manual.txt b/sources/cmd/archiver/manual.txt index f08344b..68c61dc 100644 --- a/sources/cmd/archiver/manual.txt +++ b/sources/cmd/archiver/manual.txt @@ -6,6 +6,7 @@ NAME kawipiko -- blazingly fast static HTTP server - kawipiko-archiver >> kawipiko-archiver --help + >> kawipiko-archiver --man --sources @@ -23,8 +24,10 @@ NAME --exclude-file-listing --include-folder-listing - --progress - --debug + --progress --debug + + --help (show this short help) + --man (show the full manual) ---- diff --git a/sources/cmd/server/manual.txt b/sources/cmd/server/manual.txt index 2ecf120..6fb865d 100644 --- a/sources/cmd/server/manual.txt +++ b/sources/cmd/server/manual.txt @@ -6,6 +6,7 @@ NAME kawipiko -- blazingly fast static HTTP server - kawipiko-server >> kawipiko-server --help + >> kawipiko-server --man --archive --archive-inmem (memory-loaded archive file) @@ -40,10 +41,18 @@ NAME --limit-memory --timeout-disable - --profile-cpu ; --profile-mem - --report ; --quiet ; --debug - --dummy ; --dummy-empty ; --dummy-delay + --report --quiet --debug + + --help (show this short help) + --man (show the full manual) + + --dummy + --dummy-empty + --dummy-delay + + --profile-cpu + --profile-mem ---- @@ -207,7 +216,7 @@ FLAGS technologies. (From my own benchmarks kawipiko's adds only about ~15% overhead when actually serving the hello-world.cdb archive.) - --delay + --dummy-delay Enables delaying each response with a certain amount (for example 1s, 1ms, etc.) @@ -216,7 +225,7 @@ FLAGS (For example, see an experiment I made with an image made out of 1425 tiles.) - --profile-cpu and --profile-mem + --profile-cpu , and --profile-mem Enables CPU and memory profiling using Go's profiling infrastructure. diff --git a/sources/cmd/server/usage.txt b/sources/cmd/server/usage.txt index 48047fc..0107e86 100644 --- a/sources/cmd/server/usage.txt +++ b/sources/cmd/server/usage.txt @@ -35,8 +35,6 @@ --limit-memory --timeout-disable - --profile-cpu - --profile-mem --report --quiet --debug