.\" Automatically generated by Pandoc 3.1.11.1
.\"
.TH "uncov-web" "1" "January 20, 2024" "uncov v0.5" ""
.SH NAME
uncov\-web is a HTTP\-server that provides Web\-UI for browsing coverage
information collected by \f[B]uncov(1)\f[R].
.SH SYNOPSIS
\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]
Displays short usage help.
.SS \f[B]\-\-version, \-v\f[R]
Displays version information.
.SS \f[B]\-\-vhost\f[R] <host\-name>
Sets virtual host name.
This option is mandatory.
.SS \f[B]\-\-ip\f[R] [=0.0.0.0]
IP address to bind to.
The default is to bind to all interfaces.
.SS \f[B]\-\-repo\f[R] [=.]
Path to repository.
.SS \f[B]\-\-port\f[R] [=8000]
Post to listen on.
.SH DESCRIPTION
Once started provides HTTP\-server to view coverage reports.
Does not daemonize itself.
.SS Notations
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
\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
\f[B]uncov\f[R](1), \f[B]uncov\-gcov\f[R](1)
.SH AUTHORS
xaizek <xaizek@posteo.net>.