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

31
doc/man1/timew-fill.1.in
View file

@ -1,31 +0,0 @@
.TH timew-fill 1 "${PACKAGE_DATE}" "${PACKAGE_STRING}" "User Manuals"
.
.SH NAME
timew-fill \- adjust intervals to fill in surrounding gaps
.
.SH SYNOPSIS
.B timew fill
.I <id>
.B ...
.
.SH DESCRIPTION
The 'fill' command is used to adjust any interval to fill in surrounding gaps.
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
Using the right ID, you can identify an interval to fill.
.
.SH EXAMPLES
For example, show the IDs:
.RS
$ timew summary :week :ids
.RE
Then having selected '@2' as the interval you wish to fill:
.RS
$ timew fill @2
.RE
Note that you can fill multiple intervals:
.RS
$ timew fill @2 @10 @23
.RE
.
.SH "SEE ALSO"
.BR timew-hints (1)