GothenburgBitFactory/timewarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/timewarrior.git synced 2025-07-07 20:06:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Replace roff man pages with asciidoctor

Browse source 
This replaces the generation of man pages on project setup
by a on-demand generation via asciidoctor.
An exception are the man pages for the commands `day`, `month`, and `week`
which are simply redirects to the man page `timew-chart.1`. Those are now
static files in the Timewarrior repository.

A CMake find module to detect asciidoctor was added.
If asciidoctor is found, the targets `doc`, `man1`, and `man7` are created.
Those targets are also added to the default build target.

If asciidoctor is not available, the target `doc` is available, but it only
emits a message to install asciidoctor first.

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
This commit is contained in:
Thomas Lauf 2021-01-26 20:36:49 +01:00 • committed by Thomas Lauf
parent 65ef38658b
commit b189ccb020
80 changed files with 1256 additions and 1527 deletions
Download patch file Download diff file Expand all files Collapse all files

34
doc/man1/timew-gaps.1.in
View file

@ -1,34 +0,0 @@
.TH timew-gaps 1 "${PACKAGE_DATE}" "${PACKAGE_STRING}" "User Manuals"
.
.SH NAME
timew-gaps \- display time tracking gaps
.
.SH SYNOPSIS
.B timew gaps
[
.I <range>
] [
.I <tag>
.B ...
]
.
.SH DESCRIPTION
Displays a summary of time that is neither tracked nor excluded from tracking.
.
The 'reports.gaps.range' configuration setting overrides the default date range.
The ':blank' hint causes only the excluded time to be shown, with no tracked time.
The default date range shown is ':day'.
.
The ':blank' hint causes only the excluded time to be shown, with no tracked time.
.
.SH CONFIGURATION
.TP
.B reports.gaps.range
.RS
For reports that show a range of data, this setting will override the default value.
The value should be a range hint, see
.BR timew-hints (7).
.RE
.
.SH "SEE ALSO"
.BR timew-summary (1)