[documentation] Minor updates.

This commit is contained in:
Ciprian Dorin Craciun 2022-08-26 14:20:18 +03:00
parent 34b22a9e61
commit 53445228b7
7 changed files with 41 additions and 38 deletions

View file

@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "KAWIPIKO-ARCHIVER" "1" "2021-12-23" "volution.ro" "kawipiko"
.SH NAME
kawipiko -- blazingly fast static HTTP server \- kawipiko-archiver
. .
.nr rst2man-indent-level 0 .nr rst2man-indent-level 0
. .
@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "KAWIPIKO-ARCHIVER" "1" "2022-08-26" "volution.ro" "kawipiko"
.SH NAME
kawipiko -- blazingly fast static HTTP server \- kawipiko-archiver
.INDENT 0.0 .INDENT 0.0
.INDENT 3.5 .INDENT 3.5
.sp .sp
@ -59,9 +59,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
\-\-exclude\-cache \-\-exclude\-cache
\-\-include\-etag \-\-include\-etag
\-\-exclude\-file\-listing
\-\-include\-folder\-listing \-\-include\-folder\-listing
\-\-exclude\-paths\-index
\-\-progress \-\-debug \-\-progress \-\-debug
\-\-help (show this short help) \-\-help (show this short help)
@ -168,17 +169,17 @@ By not including the \fBETag\fP header (i.e. the default), and because identical
.UNINDENT .UNINDENT
.UNINDENT .UNINDENT
.sp .sp
\fB\-\-exclude\-file\-listing\fP
.INDENT 0.0
.INDENT 3.5
Disables the creation of an internal list of files that can be used in conjunction with the \fB\-\-index\-all\fP flag of the \fBkawipiko\-server\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-\-include\-folder\-listing\fP \fB\-\-include\-folder\-listing\fP
.INDENT 0.0 .INDENT 0.0
.INDENT 3.5 .INDENT 3.5
Enables the creation of an internal list of folders. (Currently not used by the \fBkawipiko\-server\fP tool.) Enables the creation of an internal list of folders.
.UNINDENT
.UNINDENT
.sp
\fB\-\-exclude\-paths\-index\fP
.INDENT 0.0
.INDENT 3.5
Disables the creation of an internal list of references that can be used in conjunction with the \fB\-\-index\-all\fP flag of the \fBkawipiko\-server\fP\&.
.UNINDENT .UNINDENT
.UNINDENT .UNINDENT
.sp .sp

View file

@ -31,9 +31,10 @@ kawipiko -- blazingly fast static HTTP server
--exclude-cache --exclude-cache
--include-etag --include-etag
--exclude-file-listing
--include-folder-listing --include-folder-listing
--exclude-paths-index
--progress --debug --progress --debug
--help (show this short help) --help (show this short help)
@ -106,13 +107,13 @@ Flags
By not including the ``ETag`` header (i.e. the default), and because identical headers are stored only one, if one has many files of the same type (that in turn without ``ETag`` generates the same headers), this can lead to significant reduction in stored headers blocks, including reducing RAM usage. By not including the ``ETag`` header (i.e. the default), and because identical headers are stored only one, if one has many files of the same type (that in turn without ``ETag`` generates the same headers), this can lead to significant reduction in stored headers blocks, including reducing RAM usage.
(At this moment it does not support HTTP conditional requests, i.e. the ``If-None-Match``, ``If-Modified-Since`` and their counterparts; however this ``ETag`` header might be used in conjuction with ``HEAD`` requests to see if the resource has changed.) (At this moment it does not support HTTP conditional requests, i.e. the ``If-None-Match``, ``If-Modified-Since`` and their counterparts; however this ``ETag`` header might be used in conjuction with ``HEAD`` requests to see if the resource has changed.)
``--exclude-file-listing``
Disables the creation of an internal list of files that can be used in conjunction with the ``--index-all`` flag of the ``kawipiko-server``.
``--include-folder-listing`` ``--include-folder-listing``
Enables the creation of an internal list of folders. (Currently not used by the ``kawipiko-server`` tool.) Enables the creation of an internal list of folders.
``--exclude-paths-index``
Disables the creation of an internal list of references that can be used in conjunction with the ``--index-all`` flag of the ``kawipiko-server``.
``--progress`` ``--progress``

View file

@ -21,9 +21,10 @@ NAME
--exclude-cache --exclude-cache
--include-etag --include-etag
--exclude-file-listing
--include-folder-listing --include-folder-listing
--exclude-paths-index
--progress --debug --progress --debug
--help (show this short help) --help (show this short help)
@ -128,13 +129,13 @@ FLAGS
and their counterparts; however this ETag header might be used in and their counterparts; however this ETag header might be used in
conjuction with HEAD requests to see if the resource has changed.) conjuction with HEAD requests to see if the resource has changed.)
--exclude-file-listing
Disables the creation of an internal list of files that can be used
in conjunction with the --index-all flag of the kawipiko-server.
--include-folder-listing --include-folder-listing
Enables the creation of an internal list of folders. (Currently not Enables the creation of an internal list of folders.
used by the kawipiko-server tool.)
--exclude-paths-index
Disables the creation of an internal list of references that can be
used in conjunction with the --index-all flag of the
kawipiko-server.
--progress --progress
Enables periodic reporting of various metrics. Enables periodic reporting of various metrics.
@ -177,4 +178,4 @@ SYMLINKS, HARDLINKS, LOOPS, AND DUPLICATED FILES
volution.ro 2021-12-23 KAWIPIKO-ARCHIVER(1) volution.ro 2022-08-26 KAWIPIKO-ARCHIVER(1)

View file

@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "KAWIPIKO-SERVER" "1" "2021-12-23" "volution.ro" "kawipiko"
.SH NAME
kawipiko -- blazingly fast static HTTP server \- kawipiko-server
. .
.nr rst2man-indent-level 0 .nr rst2man-indent-level 0
. .
@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "KAWIPIKO-SERVER" "1" "2022-08-26" "volution.ro" "kawipiko"
.SH NAME
kawipiko -- blazingly fast static HTTP server \- kawipiko-server
.INDENT 0.0 .INDENT 0.0
.INDENT 3.5 .INDENT 3.5
.sp .sp

View file

@ -231,4 +231,4 @@ FLAGS
volution.ro 2021-12-23 KAWIPIKO-SERVER(1) volution.ro 2022-08-26 KAWIPIKO-SERVER(1)

View file

@ -129,13 +129,13 @@ FLAGS
and their counterparts; however this ETag header might be used in and their counterparts; however this ETag header might be used in
conjuction with HEAD requests to see if the resource has changed.) conjuction with HEAD requests to see if the resource has changed.)
--exclude-file-listing
Disables the creation of an internal list of files that can be used
in conjunction with the --index-all flag of the kawipiko-server.
--include-folder-listing --include-folder-listing
Enables the creation of an internal list of folders. (Currently not Enables the creation of an internal list of folders.
used by the kawipiko-server tool.)
--exclude-paths-index
Disables the creation of an internal list of references that can be
used in conjunction with the --index-all flag of the
kawipiko-server.
--progress --progress
Enables periodic reporting of various metrics. Enables periodic reporting of various metrics.
@ -178,4 +178,4 @@ SYMLINKS, HARDLINKS, LOOPS, AND DUPLICATED FILES
volution.ro 2021-12-23 KAWIPIKO-ARCHIVER(1) volution.ro 2022-08-26 KAWIPIKO-ARCHIVER(1)

View file

@ -231,4 +231,4 @@ FLAGS
volution.ro 2021-12-23 KAWIPIKO-SERVER(1) volution.ro 2022-08-26 KAWIPIKO-SERVER(1)