mirror of
https://github.com/GothenburgBitFactory/timewarrior.git
synced 2025-07-07 20:06:39 +02:00
Replace roff man pages with asciidoctor
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:
parent
65ef38658b
commit
b189ccb020
80 changed files with 1256 additions and 1527 deletions
22
doc/man1/timew-help.1.adoc
Normal file
22
doc/man1/timew-help.1.adoc
Normal file
|
@ -0,0 +1,22 @@
|
|||
= timew-help(1)
|
||||
|
||||
== NAME
|
||||
timew-help - display help
|
||||
|
||||
== SYNOPSIS
|
||||
[verse]
|
||||
*timew help* {_<command>_|*interval*|*hints*|*date*|*duration*}
|
||||
|
||||
== DESCRIPTION
|
||||
The help command shows detailed descriptions and examples of commands, interval syntax, supported hints, date and duration formats and DOM references.
|
||||
|
||||
== EXAMPLES
|
||||
For example:
|
||||
|
||||
$ timew help
|
||||
$ timew help start
|
||||
$ timew help hints
|
||||
$ timew help interval
|
||||
$ timew help date
|
||||
$ timew help duration
|
||||
$ timew help dom
|
Loading…
Add table
Add a link
Reference in a new issue