.\" Automatically generated by Pandoc 2.17.1.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "uncov-web" "1" "November 18, 2022" "uncov v0.5" ""
.hy
.SH NAME
.PP
uncov-web is a HTTP-server that provides Web-UI for browsing coverage
information collected by \f[B]uncov(1)\f[R].
.SH SYNOPSIS
.PP
\f[B]uncov-web\f[R] \f[B]-h|--help\f[R]
.PP
\f[B]uncov-web\f[R] \f[B]-v|--version\f[R]
.PP
\f[B]uncov-web\f[R] \f[B]--vhost\f[R] <host-name> \f[B]--ip\f[R]
[=0.0.0.0] \f[B]--repo\f[R] [=.]
\f[B]--port\f[R] [=8000]
.SH OPTIONS
.SS \f[B]--help, -h\f[R]
.PP
Displays short usage help.
.SS \f[B]--version, -v\f[R]
.PP
Displays version information.
.SS \f[B]--vhost\f[R] <host-name>
.PP
Sets virtual host name.
This option is mandatory.
.SS \f[B]--ip\f[R] [=0.0.0.0]
.PP
IP address to bind to.
The default is to bind to all interfaces.
.SS \f[B]--repo\f[R] [=.]
.PP
Path to repository.
.SS \f[B]--port\f[R] [=8000]
.PP
Post to listen on.
.SH DESCRIPTION
.PP
Once started provides HTTP-server to view coverage reports.
Does not daemonize itself.
.SS Notations
.PP
For the sake of brevity interface uses several intuitive abbreviations:
.IP \[bu] 2
Cov \[en] coverage;
.IP \[bu] 2
Ref \[en] reference (of VCS);
.IP \[bu] 2
C \[en] covered;
.IP \[bu] 2
M \[en] missed;
.IP \[bu] 2
R \[en] relevant.
.SH FILES
.PP
\f[B]<data-directory>\f[R] in the following is either git-directory for
a worktree (see \f[B]git-worktree\f[R](1)) or for the repository that
owns it, whichever has either of those files when checking directories
in the order they are mentioned.
If no files found, repository\[cq]s git-directory is used.
.PP
\f[B]<data-directory>/uncov.sqlite\f[R] \[en] storage of coverage data.
.PP
\f[B]<data-directory>/uncov.ini\f[R] \[en] configuration.
.SH SEE ALSO
.PP
\f[B]uncov\f[R](1), \f[B]uncov-gcov\f[R](1)
.SH AUTHORS
xaizek <xaizek@posteo.net>.