From efbfdb804e77209cc74e643a4001a27426e13a30 Mon Sep 17 00:00:00 2001 From: Ciprian Dorin Craciun Date: Sun, 28 Aug 2022 11:34:46 +0300 Subject: [PATCH] [documentation] Document `--exclude-slash-redirects`. --- documentation/manuals/archiver.1.man | 12 ++++++++++-- documentation/manuals/archiver.rst | 7 ++++++- documentation/manuals/archiver.txt | 9 +++++++-- documentation/manuals/server.1.man | 2 +- documentation/manuals/server.txt | 2 +- sources/cmd/archiver/manual.txt | 9 +++++++-- sources/cmd/archiver/usage.txt | 2 +- sources/cmd/server/manual.txt | 2 +- 8 files changed, 34 insertions(+), 11 deletions(-) diff --git a/documentation/manuals/archiver.1.man b/documentation/manuals/archiver.1.man index 26d7b76..4b5245b 100644 --- a/documentation/manuals/archiver.1.man +++ b/documentation/manuals/archiver.1.man @@ -27,7 +27,7 @@ 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" +.TH "KAWIPIKO-ARCHIVER" "1" "2022-08-28" "volution.ro" "kawipiko" .SH NAME kawipiko -- blazingly fast static HTTP server \- kawipiko-archiver .INDENT 0.0 @@ -59,8 +59,8 @@ kawipiko -- blazingly fast static HTTP server \- kawipiko-archiver \-\-exclude\-cache \-\-include\-etag +\-\-exclude\-slash\-redirects \-\-include\-folder\-listing - \-\-exclude\-paths\-index \-\-progress \-\-debug @@ -169,6 +169,14 @@ By not including the \fBETag\fP header (i.e. the default), and because identical .UNINDENT .UNINDENT .sp +\fB\-\-exclude\-slash\-redirects\fP +.INDENT 0.0 +.INDENT 3.5 +Disables adding redirects to/from paths with/without \fI/\fP +(For example, by default, if \fI/file\fP exists, then there is also a \fI/file/\fP redirect towards \fI/file\fP; and vice\-versa from \fI/folder\fP towards \fI/folder/\fP\&.) +.UNINDENT +.UNINDENT +.sp \fB\-\-include\-folder\-listing\fP .INDENT 0.0 .INDENT 3.5 diff --git a/documentation/manuals/archiver.rst b/documentation/manuals/archiver.rst index ec3d102..e659c95 100644 --- a/documentation/manuals/archiver.rst +++ b/documentation/manuals/archiver.rst @@ -31,8 +31,8 @@ kawipiko -- blazingly fast static HTTP server --exclude-cache --include-etag + --exclude-slash-redirects --include-folder-listing - --exclude-paths-index --progress --debug @@ -107,6 +107,11 @@ 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-slash-redirects`` + + Disables adding redirects to/from paths with/without `/` + (For example, by default, if `/file` exists, then there is also a `/file/` redirect towards `/file`; and vice-versa from `/folder` towards `/folder/`.) + ``--include-folder-listing`` Enables the creation of an internal list of folders. diff --git a/documentation/manuals/archiver.txt b/documentation/manuals/archiver.txt index e6bbef0..1648a75 100644 --- a/documentation/manuals/archiver.txt +++ b/documentation/manuals/archiver.txt @@ -21,8 +21,8 @@ NAME --exclude-cache --include-etag + --exclude-slash-redirects --include-folder-listing - --exclude-paths-index --progress --debug @@ -129,6 +129,11 @@ FLAGS and their counterparts; however this ETag header might be used in conjuction with HEAD requests to see if the resource has changed.) + --exclude-slash-redirects + Disables adding redirects to/from paths with/without / (For example, + by default, if /file exists, then there is also a /file/ redirect + towards /file; and vice-versa from /folder towards /folder/.) + --include-folder-listing Enables the creation of an internal list of folders. @@ -178,4 +183,4 @@ SYMLINKS, HARDLINKS, LOOPS, AND DUPLICATED FILES -volution.ro 2022-08-26 KAWIPIKO-ARCHIVER(1) +volution.ro 2022-08-28 KAWIPIKO-ARCHIVER(1) diff --git a/documentation/manuals/server.1.man b/documentation/manuals/server.1.man index a0cf2d9..ff6e24f 100644 --- a/documentation/manuals/server.1.man +++ b/documentation/manuals/server.1.man @@ -27,7 +27,7 @@ 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" +.TH "KAWIPIKO-SERVER" "1" "2022-08-28" "volution.ro" "kawipiko" .SH NAME kawipiko -- blazingly fast static HTTP server \- kawipiko-server .INDENT 0.0 diff --git a/documentation/manuals/server.txt b/documentation/manuals/server.txt index cca989c..a1cb842 100644 --- a/documentation/manuals/server.txt +++ b/documentation/manuals/server.txt @@ -236,4 +236,4 @@ FLAGS -volution.ro 2022-08-26 KAWIPIKO-SERVER(1) +volution.ro 2022-08-28 KAWIPIKO-SERVER(1) diff --git a/sources/cmd/archiver/manual.txt b/sources/cmd/archiver/manual.txt index e6bbef0..1648a75 100644 --- a/sources/cmd/archiver/manual.txt +++ b/sources/cmd/archiver/manual.txt @@ -21,8 +21,8 @@ NAME --exclude-cache --include-etag + --exclude-slash-redirects --include-folder-listing - --exclude-paths-index --progress --debug @@ -129,6 +129,11 @@ FLAGS and their counterparts; however this ETag header might be used in conjuction with HEAD requests to see if the resource has changed.) + --exclude-slash-redirects + Disables adding redirects to/from paths with/without / (For example, + by default, if /file exists, then there is also a /file/ redirect + towards /file; and vice-versa from /folder towards /folder/.) + --include-folder-listing Enables the creation of an internal list of folders. @@ -178,4 +183,4 @@ SYMLINKS, HARDLINKS, LOOPS, AND DUPLICATED FILES -volution.ro 2022-08-26 KAWIPIKO-ARCHIVER(1) +volution.ro 2022-08-28 KAWIPIKO-ARCHIVER(1) diff --git a/sources/cmd/archiver/usage.txt b/sources/cmd/archiver/usage.txt index 9761d08..a490a84 100644 --- a/sources/cmd/archiver/usage.txt +++ b/sources/cmd/archiver/usage.txt @@ -16,8 +16,8 @@ --exclude-cache --include-etag + --exclude-slash-redirects --include-folder-listing - --exclude-paths-index --progress --debug diff --git a/sources/cmd/server/manual.txt b/sources/cmd/server/manual.txt index cca989c..a1cb842 100644 --- a/sources/cmd/server/manual.txt +++ b/sources/cmd/server/manual.txt @@ -236,4 +236,4 @@ FLAGS -volution.ro 2022-08-26 KAWIPIKO-SERVER(1) +volution.ro 2022-08-28 KAWIPIKO-SERVER(1)