From 53445228b7f27d20a16a96cda7e8ca0a27fb4c5e Mon Sep 17 00:00:00 2001 From: Ciprian Dorin Craciun Date: Fri, 26 Aug 2022 14:20:18 +0300 Subject: [PATCH] [documentation] Minor updates. --- documentation/manuals/archiver.1.man | 25 +++++++++++++------------ documentation/manuals/archiver.rst | 13 +++++++------ documentation/manuals/archiver.txt | 17 +++++++++-------- documentation/manuals/server.1.man | 6 +++--- documentation/manuals/server.txt | 2 +- sources/cmd/archiver/manual.txt | 14 +++++++------- sources/cmd/server/manual.txt | 2 +- 7 files changed, 41 insertions(+), 38 deletions(-) diff --git a/documentation/manuals/archiver.1.man b/documentation/manuals/archiver.1.man index 4b4b214..26d7b76 100644 --- a/documentation/manuals/archiver.1.man +++ b/documentation/manuals/archiver.1.man @@ -1,8 +1,5 @@ .\" 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 . @@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .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 3.5 .sp @@ -59,9 +59,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] \-\-exclude\-cache \-\-include\-etag -\-\-exclude\-file\-listing \-\-include\-folder\-listing +\-\-exclude\-paths\-index + \-\-progress \-\-debug \-\-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 .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 .INDENT 0.0 .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 .sp diff --git a/documentation/manuals/archiver.rst b/documentation/manuals/archiver.rst index f13c604..ec3d102 100644 --- a/documentation/manuals/archiver.rst +++ b/documentation/manuals/archiver.rst @@ -31,9 +31,10 @@ kawipiko -- blazingly fast static HTTP server --exclude-cache --include-etag - --exclude-file-listing --include-folder-listing + --exclude-paths-index + --progress --debug --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. (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`` - 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`` diff --git a/documentation/manuals/archiver.txt b/documentation/manuals/archiver.txt index 68c61dc..e6bbef0 100644 --- a/documentation/manuals/archiver.txt +++ b/documentation/manuals/archiver.txt @@ -21,9 +21,10 @@ NAME --exclude-cache --include-etag - --exclude-file-listing --include-folder-listing + --exclude-paths-index + --progress --debug --help (show this short help) @@ -128,13 +129,13 @@ FLAGS 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 - 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 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) diff --git a/documentation/manuals/server.1.man b/documentation/manuals/server.1.man index 225a8a1..d5d7782 100644 --- a/documentation/manuals/server.1.man +++ b/documentation/manuals/server.1.man @@ -1,8 +1,5 @@ .\" 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 . @@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .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 3.5 .sp diff --git a/documentation/manuals/server.txt b/documentation/manuals/server.txt index 6fb865d..4212cce 100644 --- a/documentation/manuals/server.txt +++ b/documentation/manuals/server.txt @@ -231,4 +231,4 @@ FLAGS -volution.ro 2021-12-23 KAWIPIKO-SERVER(1) +volution.ro 2022-08-26 KAWIPIKO-SERVER(1) diff --git a/sources/cmd/archiver/manual.txt b/sources/cmd/archiver/manual.txt index 13632a8..e6bbef0 100644 --- a/sources/cmd/archiver/manual.txt +++ b/sources/cmd/archiver/manual.txt @@ -129,13 +129,13 @@ FLAGS 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 - 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 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) diff --git a/sources/cmd/server/manual.txt b/sources/cmd/server/manual.txt index 6fb865d..4212cce 100644 --- a/sources/cmd/server/manual.txt +++ b/sources/cmd/server/manual.txt @@ -231,4 +231,4 @@ FLAGS -volution.ro 2021-12-23 KAWIPIKO-SERVER(1) +volution.ro 2022-08-26 KAWIPIKO-SERVER(1)