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

Add SYNOPSIS section

Browse source
This commit is contained in:
Thomas Lauf 2018-06-23 16:21:28 +02:00
parent 642fa26cb4
commit 91f02a4866
29 changed files with 211 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
doc/man/timew-cancel.1.in
View file

@ -3,6 +3,9 @@
.SH NAME .SH NAME
timew-cancel \- cancel time tracking timew-cancel \- cancel time tracking
.SH SYNOPSIS
.B timew cancel
.TP .TP
.B timew cancel .B timew cancel
If there is an open interval, it is abandoned. If there is an open interval, it is abandoned.

11
doc/man/timew-config.1.in
View file

@ -3,6 +3,17 @@
.SH NAME .SH NAME
timew-config \- get and set Timewarrior configuration timew-config \- get and set Timewarrior configuration
.SH SYNOPSIS
.B timew config
[
.I <name>
{
.I <value>
|
.B ''
}
]
.TP .TP
.B timew config [<name> [<value> | '']] .B timew config [<name> [<value> | '']]
Allows setting and removing configuration values, as an alternative to directly Allows setting and removing configuration values, as an alternative to directly

12
doc/man/timew-continue.1.in
View file

@ -3,6 +3,18 @@
.SH NAME .SH NAME
timew-continue \- resume tracking of existing interval timew-continue \- resume tracking of existing interval
.SH SYNOPSIS
.B timew continue
[
.I <id>
] [
{
.I <date>
|
.I <range>
}
]
.TP .TP
.B timew continue [@<id>] [<date>|<interval>] .B timew continue [@<id>] [<date>|<interval>]
Resumes tracking of closed intervals. For example: Resumes tracking of closed intervals. For example:

9
doc/man/timew-day.1.in
View file

@ -3,6 +3,15 @@
.SH NAME .SH NAME
timew-day \- display day chart timew-day \- display day chart
.SH SYNOPSIS
.B timew day
[
.I <range>
] [
.I <tag>
.B ...
]
.TP .TP
.B timew day [<interval>] [<tag> ...] .B timew day [<interval>] [<tag> ...]
The day command shows a chart depicting a single day (today by default), with The day command shows a chart depicting a single day (today by default), with

5
doc/man/timew-delete.1.in
View file

@ -3,6 +3,11 @@
.SH NAME .SH NAME
timew-delete \- delete intervals timew-delete \- delete intervals
.SH SYNOPSIS
.B timew delete
.I <id>
.B ...
.TP .TP
.B timew delete @<id> [@<id> ...] .B timew delete @<id> [@<id> ...]
Deletes an interval. Using the 'summary' command, and specifying the ':ids' hint Deletes an interval. Using the 'summary' command, and specifying the ':ids' hint

3
doc/man/timew-diagnostics.1.in
View file

@ -3,6 +3,9 @@
.SH NAME .SH NAME
timew-diagnostics \- show diagnostic information timew-diagnostics \- show diagnostic information
.SH SYNOPSIS
.B timew diagnostics
.TP .TP
.B timew diagnostics .B timew diagnostics
This command shows details about your version of Timewarrior, your platform, how This command shows details about your version of Timewarrior, your platform, how

8
doc/man/timew-export.1.in
View file

@ -3,6 +3,14 @@
.SH NAME .SH NAME
timew-export \- export tracked time in JSON timew-export \- export tracked time in JSON
.SH SYNOPSIS
.B timew export
[
.I <range>
] [
.I <tag> ...
]
.TP .TP
.B timew export [<interval>] [<tag> ...] .B timew export [<interval>] [<tag> ...]
Exports all the tracked time in JSON format. Supports filtering. For example: Exports all the tracked time in JSON format. Supports filtering. For example:

3
doc/man/timew-extensions.1.in
View file

@ -3,6 +3,9 @@
.SH NAME .SH NAME
timew-extension \- list available extensions timew-extension \- list available extensions
.SH SYNOPSIS
.B timew extensions
.TP .TP
.B timew extensions .B timew extensions
Displays the directory containing the extension programs and a table showing Displays the directory containing the extension programs and a table showing

5
doc/man/timew-fill.1.in
View file

@ -3,6 +3,11 @@
.SH NAME .SH NAME
timew-fill \- adjust intervals to fill in surrounding gaps timew-fill \- adjust intervals to fill in surrounding gaps
.SH SYNOPSIS
.B timew fill
.I <id>
.B ...
.TP .TP
.B timew fill @<id> [@<id> ...] .B timew fill @<id> [@<id> ...]

9
doc/man/timew-gaps.1.in
View file

@ -3,6 +3,15 @@
.SH NAME .SH NAME
timew-gaps \- display time tracking gaps timew-gaps \- display time tracking gaps
.SH SYNOPSIS
.B timew gaps
[
.I <range>
] [
.I <tag>
.B ...
]
.TP .TP
.B timew gaps [<interval>] [<tag> ...] .B timew gaps [<interval>] [<tag> ...]
Displays a summary of time that is neither tracked nor excluded from tracking. Displays a summary of time that is neither tracked nor excluded from tracking.

5
doc/man/timew-get.1.in
View file

@ -3,6 +3,11 @@
.SH NAME .SH NAME
timew-get \- display DOM values timew-get \- display DOM values
.SH SYNOPSIS
.B timew get
.I <DOM>
.B ...
.TP .TP
.B timew get <DOM> [<DOM> ...] .B timew get <DOM> [<DOM> ...]
Validates the DOM reference, then obtains the value and displays it. For example: Validates the DOM reference, then obtains the value and displays it. For example:

14
doc/man/timew-help.1.in
View file

@ -3,6 +3,20 @@
.SH NAME .SH NAME
timew-help \- display help timew-help \- display help
.SH SYNOPSIS
.B timew help
{
.I <command>
|
.B interval
|
.B hints
|
.B date
|
.B duration
}
.TP .TP
.B timew help [<command> | interval | hints | date | duration] .B timew help [<command> | interval | hints | date | duration]
The help command shows detailed descriptions and examples of commands, The help command shows detailed descriptions and examples of commands,

4
doc/man/timew-join.1.in
View file

@ -3,6 +3,10 @@
.SH NAME .SH NAME
timew-join \- join intervals timew-join \- join intervals
.SH SYNOPSIS
.B timew join
.I <id> <id>
.TP .TP
.B timew join @<id> @<id> .B timew join @<id> @<id>
Joins two intervals, by using the earlier of the two start times, and the later Joins two intervals, by using the earlier of the two start times, and the later

6
doc/man/timew-lengthen.1.in
View file

@ -3,6 +3,12 @@
.SH NAME .SH NAME
timew-lengthen \- lengthen intervals timew-lengthen \- lengthen intervals
.SH SYNOPSIS
.B timew lengthen
.I <id>
.B ...
.I <duration>
.TP .TP
.B timew lengthen @<id> [@<id> ...] <duration> .B timew lengthen @<id> [@<id> ...] <duration>
The 'lengthen' command is used to defer the end date of a closed interval. The 'lengthen' command is used to defer the end date of a closed interval.

9
doc/man/timew-month.1.in
View file

@ -3,6 +3,15 @@
.SH NAME .SH NAME
timew-month \- display month chart timew-month \- display month chart
.SH SYNOPSIS
.B timew month
[
.I <range>
] [
.I <tag>
.B ...
]
.TP .TP
.B timew month [<interval>] [<tag> ...] .B timew month [<interval>] [<tag> ...]
The month command shows a chart depicting a single month (current month by The month command shows a chart depicting a single month (current month by

4
doc/man/timew-move.1.in
View file

@ -3,6 +3,10 @@
.SH NAME .SH NAME
timew-move \- change interval start-time timew-move \- change interval start-time
.SH SYNOPSIS
.B timew move
.I <id> <date>
.TP .TP
.B timew move @<id> <date> .B timew move @<id> <date>
The 'move' command is used to reposition an interval at a new start time. The 'move' command is used to reposition an interval at a new start time.

13
doc/man/timew-report.1.in
View file

@ -3,6 +3,19 @@
.SH NAME .SH NAME
timew-report \- run an extension report timew-report \- run an extension report
.SH SYNOPSIS
.B timew
[
.B report
]
.I <report>
[
.I <range>
] [
.I <tag>
.B ...
]
.TP .TP
.B timew [report] <report> [<interval>] [<tag> ...] .B timew [report] <report> [<interval>] [<tag> ...]
Runs an extension report, and supports filtering data. Runs an extension report, and supports filtering data.

6
doc/man/timew-resize.1.in
View file

@ -3,6 +3,12 @@
.SH NAME .SH NAME
timew-resize \- set interval duration timew-resize \- set interval duration
.SH SYNOPSIS
.B timew resize
.I <id>
.B ...
.I <duration>
.TP .TP
.B timew resize @<id> [@<id> ...] <duration> .B timew resize @<id> [@<id> ...] <duration>
The 'resize' command is used to change the duration of a closed interval. The 'resize' command is used to change the duration of a closed interval.

6
doc/man/timew-shorten.1.in
View file

@ -3,6 +3,12 @@
.SH NAME .SH NAME
timew-shorten \- shorten intervals timew-shorten \- shorten intervals
.SH SYNOPSIS
.B timew shorten
.I <id>
.B ...
.I <duration>
.TP .TP
.B timew shorten @<id> [@<id> ...] <duration> .B timew shorten @<id> [@<id> ...] <duration>
The 'shorten' command is used to advance the end date of a closed interval. The 'shorten' command is used to advance the end date of a closed interval.

3
doc/man/timew-show.1.in
View file

@ -3,6 +3,9 @@
.SH NAME .SH NAME
timew-show \- display configuration timew-show \- display configuration
.SH SYNOPSIS
.B timew show
.TP .TP
.B timew show .B timew show
Displays the effective configuration in hierarchical form. Displays the effective configuration in hierarchical form.

5
doc/man/timew-split.1.in
View file

@ -3,6 +3,11 @@
.SH NAME .SH NAME
timew-split \- split intervals timew-split \- split intervals
.SH SYNOPSIS
.B timew split
.I <id>
.B ...
.TP .TP
.B timew split @<id> [@<id> ...] .B timew split @<id> [@<id> ...]
Ѕplits an interval into two equally sized adjacent intervals, having the same Ѕplits an interval into two equally sized adjacent intervals, having the same

9
doc/man/timew-start.1.in
View file

@ -3,6 +3,15 @@
.SH NAME .SH NAME
timew-start \- start time tracking timew-start \- start time tracking
.SH SYNOPSIS
.B timew start
[
.I <date>
] [
.I <tag>
.B ...
]
.TP .TP
.B timew start [<date>] [<tag> ...] .B timew start [<date>] [<tag> ...]
Begins tracking using the current time with any specified set of tags. Begins tracking using the current time with any specified set of tags.

9
doc/man/timew-stop.1.in
View file

@ -3,6 +3,15 @@
.SH NAME .SH NAME
timew-stop \- stop time tracking timew-stop \- stop time tracking
.SH SYNOPSIS
.B timew stop
[
.I <date>
] [
.I <tag>
.B ...
]
.TP .TP
.B timew stop [<tag> ...] .B timew stop [<tag> ...]
Stops tracking time. If tags are specified, then they are no longer tracked. Stops tracking time. If tags are specified, then they are no longer tracked.

9
doc/man/timew-summary.1.in
View file

@ -3,6 +3,15 @@
.SH NAME .SH NAME
timew-summary \- display a time-tracking summary timew-summary \- display a time-tracking summary
.SH SYNOPSIS
.B timew summary
[
.I <range>
] [
.I <tag>
.B ...
]
.TP .TP
.B timew summary [<interval>] [<tag> ...] .B timew summary [<interval>] [<tag> ...]
Displays a report summarizing tracked and untracked time for the current day by Displays a report summarizing tracked and untracked time for the current day by

9
doc/man/timew-tag.1.in
View file

@ -3,6 +3,15 @@
.SH NAME .SH NAME
timew-tag \- add tags to intervals timew-tag \- add tags to intervals
.SH SYNOPSIS
.B timew tag
[
.I <id>
.B ...
]
.I <tag>
.B ...
.TP .TP
.B timew tag [@<id> ...] <tag> ... .B timew tag [@<id> ...] <tag> ...
The 'tag' command is used to add a tag to an interval. Using the 'summary' The 'tag' command is used to add a tag to an interval. Using the 'summary'

6
doc/man/timew-tags.1.in
View file

@ -3,6 +3,12 @@
.SH NAME .SH NAME
timew-tags \- display a list of tags timew-tags \- display a list of tags
.SH SYNOPSIS
.B timew tags
[
.I <range>
]
.TP .TP
.B timew tags [<interval>] [<tag> ...] .B timew tags [<interval>] [<tag> ...]
Displays all the tags that have been used by default. When a filter is specified, Displays all the tags that have been used by default. When a filter is specified,

8
doc/man/timew-track.1.in
View file

@ -3,6 +3,14 @@
.SH NAME .SH NAME
timew-track \- add intervals to the database timew-track \- add intervals to the database
.SH SYNOPSIS
.B timew track
.I <range>
[
.I <tag>
.B ...
]
.TP .TP
.B timew track <interval> [<tag> ...] .B timew track <interval> [<tag> ...]
The track command is used to add tracked time in the past. Perhaps you forgot The track command is used to add tracked time in the past. Perhaps you forgot

9
doc/man/timew-untag.1.in
View file

@ -3,6 +3,15 @@
.SH NAME .SH NAME
timew-untag \- remove tags from intervals timew-untag \- remove tags from intervals
.SH SYNOPSIS
.B timew untag
[
.I <id>
.B ...
]
.I <tag>
.B ...
.TP .TP
.B timew untag [@<id> ...] <tag> ... .B timew untag [@<id> ...] <tag> ...
The 'untag' command is used to remove a tag from an interval. Using the 'summary' The 'untag' command is used to remove a tag from an interval. Using the 'summary'

9
doc/man/timew-week.1.in
View file

@ -3,6 +3,15 @@
.SH NAME .SH NAME
timew-week \- display week chart timew-week \- display week chart
.SH SYNOPSIS
.B timew week
[
.I <range>
] [
.I <tag>
.B ...
]
.TP .TP
.B timew week [<interval>] [<tag> ...] .B timew week [<interval>] [<tag> ...]
The week command shows a chart depicting a single week (current week by The week command shows a chart depicting a single week (current week by