Nulo/kawipiko
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[documentation] Minor manuals updates.

Browse source
This commit is contained in:
Ciprian Dorin Craciun 2021-12-23 20:39:06 +02:00
parent 1c9d09f859
commit 5c605c79ac
9 changed files with 76 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
documentation/manuals/archiver.1.man
View file

@ -36,6 +36,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nf .nf
.ft C .ft C
>> kawipiko\-archiver \-\-help >> kawipiko\-archiver \-\-help
>> kawipiko\-archiver \-\-man
.ft P .ft P
.fi .fi
.UNINDENT .UNINDENT
@ -61,8 +62,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
\-\-exclude\-file\-listing \-\-exclude\-file\-listing
\-\-include\-folder\-listing \-\-include\-folder\-listing
\-\-progress \-\-progress \-\-debug
\-\-debug
\-\-help (show this short help)
\-\-man (show the full manual)
.ft P .ft P
.fi .fi
.UNINDENT .UNINDENT

7
documentation/manuals/archiver.rst
View file

@ -14,6 +14,7 @@ kawipiko -- blazingly fast static HTTP server
:: ::
>> kawipiko-archiver --help >> kawipiko-archiver --help
>> kawipiko-archiver --man
:: ::
@ -33,8 +34,10 @@ kawipiko -- blazingly fast static HTTP server
--exclude-file-listing --exclude-file-listing
--include-folder-listing --include-folder-listing
--progress --progress --debug
--debug
--help (show this short help)
--man (show the full manual)

7
documentation/manuals/archiver.txt
View file

@ -6,6 +6,7 @@ NAME
kawipiko -- blazingly fast static HTTP server - kawipiko-archiver kawipiko -- blazingly fast static HTTP server - kawipiko-archiver
>> kawipiko-archiver --help >> kawipiko-archiver --help
>> kawipiko-archiver --man
--sources <path> --sources <path>
@ -23,8 +24,10 @@ NAME
--exclude-file-listing --exclude-file-listing
--include-folder-listing --include-folder-listing
--progress --progress --debug
--debug
--help (show this short help)
--man (show the full manual)
---- ----

19
documentation/manuals/server.1.man
View file

@ -36,6 +36,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nf .nf
.ft C .ft C
>> kawipiko\-server \-\-help >> kawipiko\-server \-\-help
>> kawipiko\-server \-\-man
.ft P .ft P
.fi .fi
.UNINDENT .UNINDENT
@ -78,10 +79,18 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
\-\-limit\-memory <MiB> \-\-limit\-memory <MiB>
\-\-timeout\-disable \-\-timeout\-disable
\-\-profile\-cpu <path> ; \-\-profile\-mem <path>
\-\-report ; \-\-quiet ; \-\-debug \-\-report \-\-quiet \-\-debug
\-\-dummy ; \-\-dummy\-empty ; \-\-dummy\-delay <duration>
\-\-help (show this short help)
\-\-man (show the full manual)
\-\-dummy
\-\-dummy\-empty
\-\-dummy\-delay <duration>
\-\-profile\-cpu <path>
\-\-profile\-mem <path>
.ft P .ft P
.fi .fi
.UNINDENT .UNINDENT
@ -272,7 +281,7 @@ This argument can be used to benchmark the raw performance of the underlying \fB
.UNINDENT .UNINDENT
.UNINDENT .UNINDENT
.sp .sp
\fB\-\-delay <duration>\fP \fB\-\-dummy\-delay <duration>\fP
.INDENT 0.0 .INDENT 0.0
.INDENT 3.5 .INDENT 3.5
Enables delaying each response with a certain amount (for example \fB1s\fP, \fB1ms\fP, etc.) 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
.UNINDENT .UNINDENT
.sp .sp
\fB\-\-profile\-cpu <path>\fP and \fB\-\-profile\-mem <path>\fP \fB\-\-profile\-cpu <path>\fP, and \fB\-\-profile\-mem <path>\fP
.INDENT 0.0 .INDENT 0.0
.INDENT 3.5 .INDENT 3.5
Enables CPU and memory profiling using Go\(aqs profiling infrastructure. Enables CPU and memory profiling using Go\(aqs profiling infrastructure.

19
documentation/manuals/server.rst
View file

@ -13,6 +13,7 @@ kawipiko -- blazingly fast static HTTP server
:: ::
>> kawipiko-server --help >> kawipiko-server --help
>> kawipiko-server --man
:: ::
@ -49,10 +50,18 @@ kawipiko -- blazingly fast static HTTP server
--limit-memory <MiB> --limit-memory <MiB>
--timeout-disable --timeout-disable
--profile-cpu <path> ; --profile-mem <path>
--report ; --quiet ; --debug --report --quiet --debug
--dummy ; --dummy-empty ; --dummy-delay <duration>
--help (show this short help)
--man (show the full manual)
--dummy
--dummy-empty
--dummy-delay <duration>
--profile-cpu <path>
--profile-mem <path>
@ -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. 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.) (From my own benchmarks ``kawipiko``'s adds only about ~15% overhead when actually serving the ``hello-world.cdb`` archive.)
``--delay <duration>`` ``--dummy-delay <duration>``
Enables delaying each response with a certain amount (for example ``1s``, ``1ms``, etc.) 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. 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 <https://notes.volution.ro/v1/2019/08/notes/e8700e9a/>`__ I made with an image made out of 1425 tiles.) (For example, see `an experiment <https://notes.volution.ro/v1/2019/08/notes/e8700e9a/>`__ I made with an image made out of 1425 tiles.)
``--profile-cpu <path>`` and ``--profile-mem <path>`` ``--profile-cpu <path>``, and ``--profile-mem <path>``
Enables CPU and memory profiling using Go's profiling infrastructure. Enables CPU and memory profiling using Go's profiling infrastructure.

19
documentation/manuals/server.txt
View file

@ -6,6 +6,7 @@ NAME
kawipiko -- blazingly fast static HTTP server - kawipiko-server kawipiko -- blazingly fast static HTTP server - kawipiko-server
>> kawipiko-server --help >> kawipiko-server --help
>> kawipiko-server --man
--archive <path> --archive <path>
--archive-inmem (memory-loaded archive file) --archive-inmem (memory-loaded archive file)
@ -40,10 +41,18 @@ NAME
--limit-memory <MiB> --limit-memory <MiB>
--timeout-disable --timeout-disable
--profile-cpu <path> ; --profile-mem <path>
--report ; --quiet ; --debug --report --quiet --debug
--dummy ; --dummy-empty ; --dummy-delay <duration>
--help (show this short help)
--man (show the full manual)
--dummy
--dummy-empty
--dummy-delay <duration>
--profile-cpu <path>
--profile-mem <path>
---- ----
@ -207,7 +216,7 @@ FLAGS
technologies. (From my own benchmarks kawipiko's adds only about technologies. (From my own benchmarks kawipiko's adds only about
~15% overhead when actually serving the hello-world.cdb archive.) ~15% overhead when actually serving the hello-world.cdb archive.)
--delay <duration> --dummy-delay <duration>
Enables delaying each response with a certain amount (for example Enables delaying each response with a certain amount (for example
1s, 1ms, etc.) 1s, 1ms, etc.)
@ -216,7 +225,7 @@ FLAGS
(For example, see an experiment I made with an image made out of (For example, see an experiment I made with an image made out of
1425 tiles.) 1425 tiles.)
--profile-cpu <path> and --profile-mem <path> --profile-cpu <path>, and --profile-mem <path>
Enables CPU and memory profiling using Go's profiling Enables CPU and memory profiling using Go's profiling
infrastructure. infrastructure.

7
sources/cmd/archiver/manual.txt
View file

@ -6,6 +6,7 @@ NAME
kawipiko -- blazingly fast static HTTP server - kawipiko-archiver kawipiko -- blazingly fast static HTTP server - kawipiko-archiver
>> kawipiko-archiver --help >> kawipiko-archiver --help
>> kawipiko-archiver --man
--sources <path> --sources <path>
@ -23,8 +24,10 @@ NAME
--exclude-file-listing --exclude-file-listing
--include-folder-listing --include-folder-listing
--progress --progress --debug
--debug
--help (show this short help)
--man (show the full manual)
---- ----

19
sources/cmd/server/manual.txt
View file

@ -6,6 +6,7 @@ NAME
kawipiko -- blazingly fast static HTTP server - kawipiko-server kawipiko -- blazingly fast static HTTP server - kawipiko-server
>> kawipiko-server --help >> kawipiko-server --help
>> kawipiko-server --man
--archive <path> --archive <path>
--archive-inmem (memory-loaded archive file) --archive-inmem (memory-loaded archive file)
@ -40,10 +41,18 @@ NAME
--limit-memory <MiB> --limit-memory <MiB>
--timeout-disable --timeout-disable
--profile-cpu <path> ; --profile-mem <path>
--report ; --quiet ; --debug --report --quiet --debug
--dummy ; --dummy-empty ; --dummy-delay <duration>
--help (show this short help)
--man (show the full manual)
--dummy
--dummy-empty
--dummy-delay <duration>
--profile-cpu <path>
--profile-mem <path>
---- ----
@ -207,7 +216,7 @@ FLAGS
technologies. (From my own benchmarks kawipiko's adds only about technologies. (From my own benchmarks kawipiko's adds only about
~15% overhead when actually serving the hello-world.cdb archive.) ~15% overhead when actually serving the hello-world.cdb archive.)
--delay <duration> --dummy-delay <duration>
Enables delaying each response with a certain amount (for example Enables delaying each response with a certain amount (for example
1s, 1ms, etc.) 1s, 1ms, etc.)
@ -216,7 +225,7 @@ FLAGS
(For example, see an experiment I made with an image made out of (For example, see an experiment I made with an image made out of
1425 tiles.) 1425 tiles.)
--profile-cpu <path> and --profile-mem <path> --profile-cpu <path>, and --profile-mem <path>
Enables CPU and memory profiling using Go's profiling Enables CPU and memory profiling using Go's profiling
infrastructure. infrastructure.

2
sources/cmd/server/usage.txt
View file

@ -35,8 +35,6 @@
--limit-memory <MiB> --limit-memory <MiB>
--timeout-disable --timeout-disable
--profile-cpu <path>
--profile-mem <path>
--report --quiet --debug --report --quiet --debug