playground/suckless-quark
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
suckless-quark/quark.1

66 lines
1.2 KiB
Groff
Raw Normal View History

Refine manpage concerning the UNIX-domain socket file
2018-02-05 16:15:05 +00:00
.Dd 2018-02-05
Initial commit of quark rewrite Roughly 700 LOC (half of the old quark on the Hiltjo branch) in size, this rewrite supports partial content and other good stuff that will make it fun again to use quark for simple static purposes. The error checking is rigorous and strict and it will report proper error codes back to the client whenever there was a problem or the request was invalid in some way. A cool feature is the support for listening on a UNIX-domain socket, which will in the long run allow us to solve problems with virtual hosts and other things in separate programs. But until then, this should be robust enough for most use-cases. This resets quark's version to 0, but this was no problem as there haven't been any quark releases yet. Feedback is appreciated.
2016-09-02 07:59:02 +00:00
.Dt QUARK 1
.Sh NAME
.Nm quark
.Nd simple web server
.Sh SYNOPSIS
.Nm
Allow switching vhosts using flags and rework the usage
2017-07-11 13:02:00 +00:00
.Op Fl l | L
.Op Fl v | V
.Oo
.Oo
Initial commit of quark rewrite Roughly 700 LOC (half of the old quark on the Hiltjo branch) in size, this rewrite supports partial content and other good stuff that will make it fun again to use quark for simple static purposes. The error checking is rigorous and strict and it will report proper error codes back to the client whenever there was a problem or the request was invalid in some way. A cool feature is the support for listening on a UNIX-domain socket, which will in the long run allow us to solve problems with virtual hosts and other things in separate programs. But until then, this should be robust enough for most use-cases. This resets quark's version to 0, but this was no problem as there haven't been any quark releases yet. Feedback is appreciated.
2016-09-02 07:59:02 +00:00
.Op Fl h Ar host
.Op Fl p Ar port
Allow switching vhosts using flags and rework the usage
2017-07-11 13:02:00 +00:00
.Oc
|
Change -U udsname to -U sockfile for clarification.
2017-07-11 11:58:55 +00:00
.Op Fl U Ar sockfile
Allow switching vhosts using flags and rework the usage
2017-07-11 13:02:00 +00:00
.Oc
Initial commit of quark rewrite Roughly 700 LOC (half of the old quark on the Hiltjo branch) in size, this rewrite supports partial content and other good stuff that will make it fun again to use quark for simple static purposes. The error checking is rigorous and strict and it will report proper error codes back to the client whenever there was a problem or the request was invalid in some way. A cool feature is the support for listening on a UNIX-domain socket, which will in the long run allow us to solve problems with virtual hosts and other things in separate programs. But until then, this should be robust enough for most use-cases. This resets quark's version to 0, but this was no problem as there haven't been any quark releases yet. Feedback is appreciated.
2016-09-02 07:59:02 +00:00
.Op Fl d Ar dir
.Op Fl u Ar user
.Op Fl g Ar group
.Sh DESCRIPTION
.Nm
is a simple HTTP GET only web server that can be multiplexed using
UNIX-domain sockets.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl d Ar dir
Serve
.Ar dir
after chrooting into it.
make directory listing a run-time flag remove const in the config.h since it can be changed at run-time now.
2017-06-27 21:17:44 +00:00
.It Fl l
Disable directory listing.
.It Fl L
Enable directory listing.
Initial commit of quark rewrite Roughly 700 LOC (half of the old quark on the Hiltjo branch) in size, this rewrite supports partial content and other good stuff that will make it fun again to use quark for simple static purposes. The error checking is rigorous and strict and it will report proper error codes back to the client whenever there was a problem or the request was invalid in some way. A cool feature is the support for listening on a UNIX-domain socket, which will in the long run allow us to solve problems with virtual hosts and other things in separate programs. But until then, this should be robust enough for most use-cases. This resets quark's version to 0, but this was no problem as there haven't been any quark releases yet. Feedback is appreciated.
2016-09-02 07:59:02 +00:00
.It Fl g Ar group
Set group ID to the ID of
.Ar group
when dropping privileges.
.It Fl h Ar host
Use
.Ar host
as the server hostname.
.It Fl p Ar port
Listen on port
.Ar port
for incoming connections.
.It Fl u Ar user
Set user ID to the ID of
.Ar user
when dropping privileges.
Change -U udsname to -U sockfile for clarification.
2017-07-11 11:58:55 +00:00
.It Fl U Ar sockfile
Create the UNIX-domain socket file
Refine manpage concerning the UNIX-domain socket file
2018-02-05 16:15:05 +00:00
.Ar sockfile ,
listen on it for incoming connections and remove it on exit.
Its user and group owners are equal to the user and group IDs used for dropping
privileges to.
Initial commit of quark rewrite Roughly 700 LOC (half of the old quark on the Hiltjo branch) in size, this rewrite supports partial content and other good stuff that will make it fun again to use quark for simple static purposes. The error checking is rigorous and strict and it will report proper error codes back to the client whenever there was a problem or the request was invalid in some way. A cool feature is the support for listening on a UNIX-domain socket, which will in the long run allow us to solve problems with virtual hosts and other things in separate programs. But until then, this should be robust enough for most use-cases. This resets quark's version to 0, but this was no problem as there haven't been any quark releases yet. Feedback is appreciated.
2016-09-02 07:59:02 +00:00
.It Fl v
Allow switching vhosts using flags and rework the usage
2017-07-11 13:02:00 +00:00
Disable virtual hosts.
.It Fl V
Enable virtual hosts.
Initial commit of quark rewrite Roughly 700 LOC (half of the old quark on the Hiltjo branch) in size, this rewrite supports partial content and other good stuff that will make it fun again to use quark for simple static purposes. The error checking is rigorous and strict and it will report proper error codes back to the client whenever there was a problem or the request was invalid in some way. A cool feature is the support for listening on a UNIX-domain socket, which will in the long run allow us to solve problems with virtual hosts and other things in separate programs. But until then, this should be robust enough for most use-cases. This resets quark's version to 0, but this was no problem as there haven't been any quark releases yet. Feedback is appreciated.
2016-09-02 07:59:02 +00:00
.El
.Sh CUSTOMIZATION
.Nm
can be customized by creating a custom config.h from config.def.h and
(re)compiling the source code. This keeps it fast, secure and simple.
Reference in a new issue Copy permalink