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

[documentation] Regenerate documentation.

Browse source
This commit is contained in:
Ciprian Dorin Craciun 2023-03-05 17:04:07 +02:00
parent 2f4c584aaa
commit a5bcfb5d8c
9 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -27,7 +27,7 @@ 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-09-11" "volution.ro" "kawipiko" .TH "KAWIPIKO-ARCHIVER" "1" "2023-03-05" "volution.ro" "kawipiko"
.SH NAME .SH NAME
kawipiko -- blazingly fast static HTTP server \- kawipiko-archiver kawipiko -- blazingly fast static HTTP server \- kawipiko-archiver
.INDENT 0.0 .INDENT 0.0
@ -117,7 +117,7 @@ The compression level can be chosen, the value depending on the algorithm:
.IP \(bu 2 .IP \(bu 2
\fBbrotli\fP \-\- \fB\-1\fP for algorithm default, \fB0\fP to \fB9\fP for fast to slow, \fB\-2\fP for extreme; \fBbrotli\fP \-\- \fB\-1\fP for algorithm default, \fB0\fP to \fB9\fP for fast to slow, \fB\-2\fP for extreme;
.IP \(bu 2 .IP \(bu 2
(by "algorithm default", it is meant "what that algorithm considers the recommended default compression level";) (by \(dqalgorithm default\(dq, it is meant \(dqwhat that algorithm considers the recommended default compression level\(dq;)
.IP \(bu 2 .IP \(bu 2
\fBkawipiko\fP by default uses the maximum compression level for each algorithm; (i.e. \fB9\fP for \fBgzip\fP, \fB30\fP for \fBzopfli\fP, and \fB\-2\fP for \fBbrotli\fP;) \fBkawipiko\fP by default uses the maximum compression level for each algorithm; (i.e. \fB9\fP for \fBgzip\fP, \fB30\fP for \fBzopfli\fP, and \fB\-2\fP for \fBbrotli\fP;)
.UNINDENT .UNINDENT
@ -146,7 +146,7 @@ Using these caches allows one to very quickly rebuild an archive when only a cou
.INDENT 0.0 .INDENT 0.0
.INDENT 3.5 .INDENT 3.5
Disables using \fB_index.*\fP and \fBindex.*\fP files (where \fB\&.*\fP is one of \fB\&.html\fP, \fB\&.htm\fP, \fB\&.xhtml\fP, \fB\&.xht\fP, \fB\&.txt\fP, \fB\&.json\fP, and \fB\&.xml\fP) to respond to a request whose URL path ends in \fB/\fP (corresponding to the folder wherein \fB_index.*\fP or \fBindex.*\fP file is located). Disables using \fB_index.*\fP and \fBindex.*\fP files (where \fB\&.*\fP is one of \fB\&.html\fP, \fB\&.htm\fP, \fB\&.xhtml\fP, \fB\&.xht\fP, \fB\&.txt\fP, \fB\&.json\fP, and \fB\&.xml\fP) to respond to a request whose URL path ends in \fB/\fP (corresponding to the folder wherein \fB_index.*\fP or \fBindex.*\fP file is located).
(This can be used to implement "slash" blog style URL\(aqs like \fB/blog/whatever/\fP which maps to \fB/blog/whatever/index.html\fP\&.) (This can be used to implement \(dqslash\(dq blog style URL\(aqs like \fB/blog/whatever/\fP which maps to \fB/blog/whatever/index.html\fP\&.)
.UNINDENT .UNINDENT
.UNINDENT .UNINDENT
.sp .sp
@ -154,7 +154,7 @@ Disables using \fB_index.*\fP and \fBindex.*\fP files (where \fB\&.*\fP is one o
.INDENT 0.0 .INDENT 0.0
.INDENT 3.5 .INDENT 3.5
Disables using a file with the suffix \fB\&.html\fP, \fB\&.htm\fP, \fB\&.xhtml\fP, \fB\&.xht\fP, and \fB\&.txt\fP to respond to a request whose URL does not exactly match an existing file. Disables using a file with the suffix \fB\&.html\fP, \fB\&.htm\fP, \fB\&.xhtml\fP, \fB\&.xht\fP, and \fB\&.txt\fP to respond to a request whose URL does not exactly match an existing file.
(This can be used to implement "suffix\-less" blog style URL\(aqs like \fB/blog/whatever\fP which maps to \fB/blog/whatever.html\fP\&.) (This can be used to implement \(dqsuffix\-less\(dq blog style URL\(aqs like \fB/blog/whatever\fP which maps to \fB/blog/whatever.html\fP\&.)
.UNINDENT .UNINDENT
.UNINDENT .UNINDENT
.sp .sp
@ -226,7 +226,7 @@ any file that exactly matches the following: \fBThumbs.db\fP, \fB\&.DS_Store\fP;
.UNINDENT .UNINDENT
.SH WILDCARD FILES .SH WILDCARD FILES
.sp .sp
By placing a file whose name matches \fB_wildcard.*\fP (i.e. with the prefix \fB_wildcard.\fP and any other suffix), it will be used to respond to any request whose URL fails to find a "better" match. By placing a file whose name matches \fB_wildcard.*\fP (i.e. with the prefix \fB_wildcard.\fP and any other suffix), it will be used to respond to any request whose URL fails to find a \(dqbetter\(dq match.
.sp .sp
These wildcard files respect the folder hierarchy, in that wildcard files in (direct or transitive) subfolders override the wildcard file in their parents (direct or transitive). These wildcard files respect the folder hierarchy, in that wildcard files in (direct or transitive) subfolders override the wildcard file in their parents (direct or transitive).
.sp .sp
@ -260,7 +260,7 @@ https://example.com/some\-path https://example.com/ 308
.UNINDENT .UNINDENT
.SH SYMLINKS, HARDLINKS, LOOPS, AND DUPLICATED FILES .SH SYMLINKS, HARDLINKS, LOOPS, AND DUPLICATED FILES
.sp .sp
You freely use symlinks (including pointing outside of the content root) and they will be crawled during archival respecting the "logical" hierarchy they introduce. You freely use symlinks (including pointing outside of the content root) and they will be crawled during archival respecting the \(dqlogical\(dq hierarchy they introduce.
(Any loop that you introduce into the hierarchy will be ignored and a warning will be issued.) (Any loop that you introduce into the hierarchy will be ignored and a warning will be issued.)
.sp .sp
You can safely symlink or hardlink the same file (or folder) in multiple places (within the content hierarchy), and its data will be stored only once. You can safely symlink or hardlink the same file (or folder) in multiple places (within the content hierarchy), and its data will be stored only once.

6
documentation/manuals/archiver.html
View file

@ -3,18 +3,18 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>kawipiko -- blazingly fast static HTTP server</title> <title>kawipiko -- blazingly fast static HTTP server</title>
<style type="text/css"> <style type="text/css">
/* /*
:Author: David Goodger (goodger@python.org) :Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $ :Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Copyright: This stylesheet has been placed in the public domain. :Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils. Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet. customize this style sheet.
*/ */

2
documentation/manuals/archiver.txt
View file

@ -213,4 +213,4 @@ SYMLINKS, HARDLINKS, LOOPS, AND DUPLICATED FILES
volution.ro 2022-09-11 KAWIPIKO-ARCHIVER(1) volution.ro 2023-03-05 KAWIPIKO-ARCHIVER(1)

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

@ -27,7 +27,7 @@ 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-09-11" "volution.ro" "kawipiko" .TH "KAWIPIKO-SERVER" "1" "2023-03-05" "volution.ro" "kawipiko"
.SH NAME .SH NAME
kawipiko -- blazingly fast static HTTP server \- kawipiko-server kawipiko -- blazingly fast static HTTP server \- kawipiko-server
.INDENT 0.0 .INDENT 0.0
@ -339,7 +339,7 @@ Enables all logging messages.
\fB\-\-dummy\fP, \fB\-\-dummy\-empty\fP \fB\-\-dummy\fP, \fB\-\-dummy\-empty\fP
.INDENT 0.0 .INDENT 0.0
.INDENT 3.5 .INDENT 3.5
It starts the server in a "dummy" mode, ignoring all archive related arguments and always responding with \fBhello world!\en\fP (unless \fB\-\-dummy\-empty\fP was used) and without additional headers except the HTTP status line and \fBContent\-Length\fP\&. It starts the server in a \(dqdummy\(dq mode, ignoring all archive related arguments and always responding with \fBhello world!\en\fP (unless \fB\-\-dummy\-empty\fP was used) and without additional headers except the HTTP status line and \fBContent\-Length\fP\&.
.sp .sp
This argument can be used to benchmark the raw performance of the underlying \fBfasthttp\fP, Go\(aqs \fBnet/http\fP, 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 \fBfasthttp\fP, Go\(aqs \fBnet/http\fP, or QUIC performance; this is the upper limit of the achievable performance given the underlying technologies.
(From my own benchmarks \fBkawipiko\fP\(aqs adds only about ~15% overhead when actually serving the \fBhello\-world.cdb\fP archive.) (From my own benchmarks \fBkawipiko\fP\(aqs adds only about ~15% overhead when actually serving the \fBhello\-world.cdb\fP archive.)

6
documentation/manuals/server.html
View file

@ -3,18 +3,18 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>kawipiko -- blazingly fast static HTTP server</title> <title>kawipiko -- blazingly fast static HTTP server</title>
<style type="text/css"> <style type="text/css">
/* /*
:Author: David Goodger (goodger@python.org) :Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $ :Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Copyright: This stylesheet has been placed in the public domain. :Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils. Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet. customize this style sheet.
*/ */

2
documentation/manuals/server.txt
View file

@ -280,4 +280,4 @@ FLAGS
volution.ro 2022-09-11 KAWIPIKO-SERVER(1) volution.ro 2023-03-05 KAWIPIKO-SERVER(1)

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

@ -213,4 +213,4 @@ SYMLINKS, HARDLINKS, LOOPS, AND DUPLICATED FILES
volution.ro 2022-09-11 KAWIPIKO-ARCHIVER(1) volution.ro 2023-03-05 KAWIPIKO-ARCHIVER(1)

6
sources/cmd/server/manual.html
View file

@ -3,18 +3,18 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>kawipiko -- blazingly fast static HTTP server</title> <title>kawipiko -- blazingly fast static HTTP server</title>
<style type="text/css"> <style type="text/css">
/* /*
:Author: David Goodger (goodger@python.org) :Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $ :Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Copyright: This stylesheet has been placed in the public domain. :Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils. Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet. customize this style sheet.
*/ */

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

@ -280,4 +280,4 @@ FLAGS
volution.ro 2022-09-11 KAWIPIKO-SERVER(1) volution.ro 2023-03-05 KAWIPIKO-SERVER(1)