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
31
doc/man1/timew-start.1.adoc
Normal file
31
doc/man1/timew-start.1.adoc
Normal file
|
@ -0,0 +1,31 @@
|
|||
= timew-start(1)
|
||||
|
||||
== NAME
|
||||
timew-start - start time tracking
|
||||
|
||||
== SYNOPSIS
|
||||
[verse]
|
||||
*timew start* [_<date>_] [_<tag>_**...**]
|
||||
|
||||
== DESCRIPTION
|
||||
Begins tracking using the current time with any specified set of tags.
|
||||
If a tag contains multiple words, therefore containing spaces, use quotes to surround the whole tag.
|
||||
|
||||
== EXAMPLES
|
||||
For example, this command specifies two tags ('weekend' and 'Home & Garden'), the second of which requires quotes.
|
||||
|
||||
$ timew start weekend 'Home & Garden'
|
||||
|
||||
An optional date may be specified to indicate the intended start of the tracked time:
|
||||
|
||||
$ timew start 8am weekend 'Home & Garden'
|
||||
|
||||
If there is a previous open interval, it will be closed at the given start time.
|
||||
|
||||
Quotes are harmless if used unnecessarily.
|
||||
|
||||
== SEE ALSO
|
||||
**timew-cancel**(1),
|
||||
**timew-continue**(1),
|
||||
**timew-stop**(1),
|
||||
**timew-track**(1)
|
Loading…
Add table
Add a link
Reference in a new issue