xaizek / uncov (License: AGPLv3+) (since 2018-12-07)
Uncov(er) is a tool that collects and processes code coverage reports.
<root> / docs / uncov-web.1 (03bc9b7121fcffd7d046e3c74d2abc07e48b6f79) (1,445B) (mode 100644) [raw]
.\" Automatically generated by Pandoc 1.17.0.3
.\"
.TH "uncov-web" "1" "September 23, 2017" "uncov v0.2" ""
.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[].
.SH SYNOPSIS
.PP
\f[B]uncov\-web\f[] \f[B]\-h|\-\-help\f[]
.PP
\f[B]uncov\-web\f[] \f[B]\-v|\-\-version\f[]
.PP
\f[B]uncov\-web\f[] \f[B]\-\-vhost\f[] <host\-name> \f[B]\-\-ip\f[]
[=0.0.0.0] \f[B]\-\-repo\f[] [=.] \f[B]\-\-port\f[] [=8000]
.SH OPTIONS
.SS \f[B]\-\-help, \-h\f[]
.PP
Displays short usage help.
.SS \f[B]\-\-version, \-v\f[]
.PP
Displays version information.
.SS \f[B]\-\-vhost\f[] <host\-name>
.PP
Sets virtual host name.
This option is mandatory.
.SS \f[B]\-\-ip\f[] [=0.0.0.0]
.PP
IP address to bind to.
The default is to bind to all interfaces.
.SS \f[B]\-\-repo\f[] [=.]
.PP
Path to repository.
.SS \f[B]\-\-port\f[] [=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 \- coverage;
.IP \[bu] 2
Ref \- reference (of VCS);
.IP \[bu] 2
C \- covered;
.IP \[bu] 2
M \- missed;
.IP \[bu] 2
R \- relevant.
.SH FILES
.PP
\f[B]<repository\-directory>/uncov.sqlite\f[] \-\- storage of coverage
data.
.SH SEE ALSO
.PP
\f[B]uncov(1)\f[], \f[B]uncov\-gcov\f[](1)
.SH AUTHORS
xaizek <xaizek@posteo.net>.
Hints

Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/uncov

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/uncov

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master