'\" t
.\"     Title: averell
.\"    Author: Jean Parpaillon <jean.parpaillon@free.fr>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 04/18/2016
.\"    Manual: averell User Manual
.\"    Source: averell
.\"  Language: English
.\"
.TH "AVERELL" "1" "04/18/2016" "averell" "averell User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
averell \- An incredibly stupid (but fast) web server
.SH "SYNOPSIS"
.HP \w'\fBaverell\fR\ 'u
\fBaverell\fR [\fB\-h\fR\ |\ \fB\-\-help\fR] [\fB\-p\ \fR\fB\fIPORT\fR\fR\ |\ \fB\-\-port=\fR\fB\fIPORT\fR\fR] [\fB\-c\fR\ |\ \fB\-\-cors\fR] [\fB\-v\fR\ |\ \fB\-\-verbose\fR] [\fB\-d\fR\ |\ \fB\-\-debug\fR] [\fB\-a\fR\ |\ \fB\-\-access\fR] [\fB\-I\fR\ |\ \fB\-\-no\-index\fR] [\fIdirectory\fR]
.SH "DESCRIPTION"
.PP
This manual page documents briefly the
\fBaverell\fR\&.
.PP
\fBaverell\fR
is an incredibly simple web server, aiming at serving a single directory, fast\&.
.SH "OPTIONS"
.PP
The program follows the usual GNU command line syntax, with long options starting with two dashes (`\-\*(Aq)\&. A summary of options is included below\&.
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Show help and exit\&.
.RE
.PP
\fB\-p \fR\fB\fIPORT\fR\fR, \fB\-\-port=\fR\fB\fIPORT\fR\fR
.RS 4
Set listening port (default: 8000)\&.
.RE
.PP
\fB\-c\fR, \fB\-\-cors\fR
.RS 4
Enable CORS (allowed origins: *)\&.
.RE
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
Be more verbose\&.
.RE
.PP
\fB\-d\fR, \fB\-\-debug\fR
.RS 4
Debug mode (override verbose mode if any): print request and response headers\&.
.RE
.PP
\fB\-a\fR, \fB\-\-access\fR
.RS 4
Read \&.avlaccess for per\-directory properties\&.
.RE
.PP
\fB\-I\fR, \fB\-\-no\-index\fR
.RS 4
Do not serve index\&.html file automatically (can be overridden by \&.avlaccess)\&.
.RE
.PP
directory
.RS 4
Directory to server (default: current dir)\&.
.RE
.SH "\&.AVLACCESS FILE FORMAT"
.PP
This section describes the
\&.avlaccess
file format\&.
.PP
\&.avlaccess
files can be placed anywhere in a directory served by averell\&. It contains properties applicable to this directory\&. Properties are inherited from parent directories\&.
.SS "SYNTAX"
.PP
File is parsed using the
\fIfile:consult/1\fR
function of erlang/OTP (see
\m[blue]\fBerlang/OTP documentation\fR\m[]\&\s-2\u[1]\d\s+2)\&. Parser is strict, be careful with ending dot, comma between tuples and no comma after last tuple\&.
.PP
Example of such file is given below:
.sp
.if n \{\
.RS 4
.\}
.nf
	  [
  	    {option1, value1},
	    {option2, value2}
	  ]\&.
	
.fi
.if n \{\
.RE
.\}
.sp
.SS "OPTIONS"
.PP
{index, <<"index\&.html">>}
.RS 4
When requesting a directory path, look for the given filename and serves it if it exists\&. 403 otherwise\&.
.RE
.PP
{index, noindex}
.RS 4
Do not server any index file when requesting a directory path\&. Such requests will return 403\&.
.RE
.SH "AUTHOR"
.PP
\fBJean Parpaillon\fR <\&jean\&.parpaillon@free\&.fr\&>
.RS 4
Author of averell and this marvellous manpage\&.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2014 Jean Parpaillon
.br
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the Apache License Version 2 or (at your option) any later version published by the Apache Foundation\&.
.PP
On Debian systems, the complete text of the Apache can be found in
/usr/share/common\-licenses/Apache\-2\&.0\&.
.sp
.SH "NOTES"
.IP " 1." 4
erlang/OTP documentation
.RS 4
\%http://www.erlang.org/doc/man/file.html#consult-1
.RE