mirror of
https://github.com/GothenburgBitFactory/timewarrior.git
synced 2025-07-07 20:06:39 +02:00
Add DESCRIPTION section
This commit is contained in:
parent
91f02a4866
commit
58ed4d9ba8
29 changed files with 29 additions and 29 deletions
|
@ -6,7 +6,7 @@ timew-cancel \- cancel time tracking
|
|||
.SH SYNOPSIS
|
||||
.B timew cancel
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew cancel
|
||||
If there is an open interval, it is abandoned.
|
||||
See also 'stop'.
|
||||
|
|
|
@ -14,7 +14,7 @@ timew-config \- get and set Timewarrior configuration
|
|||
}
|
||||
]
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew config [<name> [<value> | '']]
|
||||
Allows setting and removing configuration values, as an alternative to directly
|
||||
editing your ~/.timewarrior/timewarrior.cfg file. For example:
|
||||
|
|
|
@ -15,7 +15,7 @@ timew-continue \- resume tracking of existing interval
|
|||
}
|
||||
]
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew continue [@<id>] [<date>|<interval>]
|
||||
Resumes tracking of closed intervals. For example:
|
||||
|
||||
|
|
|
@ -12,7 +12,7 @@ timew-day \- display day chart
|
|||
.B ...
|
||||
]
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew day [<interval>] [<tag> ...]
|
||||
The day command shows a chart depicting a single day (today by default), with
|
||||
colored blocks drawn on a timeline. The chart summarizes the tracked and
|
||||
|
|
|
@ -8,7 +8,7 @@ timew-delete \- delete intervals
|
|||
.I <id>
|
||||
.B ...
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew delete @<id> [@<id> ...]
|
||||
Deletes an interval. Using the 'summary' command, and specifying the ':ids' hint
|
||||
shows interval IDs. Using the right ID, you can identify an interval to delete.
|
||||
|
|
|
@ -6,7 +6,7 @@ timew-diagnostics \- show diagnostic information
|
|||
.SH SYNOPSIS
|
||||
.B timew diagnostics
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew diagnostics
|
||||
This command shows details about your version of Timewarrior, your platform, how
|
||||
it was built, compiler features, configuration, file access, extensions and more.
|
||||
|
|
|
@ -11,7 +11,7 @@ timew-export \- export tracked time in JSON
|
|||
.I <tag> ...
|
||||
]
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew export [<interval>] [<tag> ...]
|
||||
Exports all the tracked time in JSON format. Supports filtering. For example:
|
||||
|
||||
|
|
|
@ -6,7 +6,7 @@ timew-extension \- list available extensions
|
|||
.SH SYNOPSIS
|
||||
.B timew extensions
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew extensions
|
||||
Displays the directory containing the extension programs and a table showing
|
||||
each extension and its status. See also 'diagnostics'.
|
||||
|
|
|
@ -8,7 +8,7 @@ timew-fill \- adjust intervals to fill in surrounding gaps
|
|||
.I <id>
|
||||
.B ...
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew fill @<id> [@<id> ...]
|
||||
|
||||
The 'fill' command is used to adjust any interval to fill in surrounding gaps.
|
||||
|
|
|
@ -12,7 +12,7 @@ timew-gaps \- display time tracking gaps
|
|||
.B ...
|
||||
]
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew gaps [<interval>] [<tag> ...]
|
||||
Displays a summary of time that is neither tracked nor excluded from tracking.
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ timew-get \- display DOM values
|
|||
.I <DOM>
|
||||
.B ...
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew get <DOM> [<DOM> ...]
|
||||
Validates the DOM reference, then obtains the value and displays it. For example:
|
||||
|
||||
|
|
|
@ -17,7 +17,7 @@ timew-help \- display help
|
|||
.B duration
|
||||
}
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew help [<command> | interval | hints | date | duration]
|
||||
The help command shows detailed descriptions and examples of commands,
|
||||
interval syntax, supported hints, date and duration formats and DOM references.
|
||||
|
|
|
@ -7,7 +7,7 @@ timew-join \- join intervals
|
|||
.B timew join
|
||||
.I <id> <id>
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew join @<id> @<id>
|
||||
Joins two intervals, by using the earlier of the two start times, and the later
|
||||
of the two end times, and the combined set of tags. Using the 'summary' command,
|
||||
|
|
|
@ -9,7 +9,7 @@ timew-lengthen \- lengthen intervals
|
|||
.B ...
|
||||
.I <duration>
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew lengthen @<id> [@<id> ...] <duration>
|
||||
The 'lengthen' command is used to defer the end date of a closed interval.
|
||||
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
|
||||
|
|
|
@ -12,7 +12,7 @@ timew-month \- display month chart
|
|||
.B ...
|
||||
]
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew month [<interval>] [<tag> ...]
|
||||
The month command shows a chart depicting a single month (current month by
|
||||
default), with colored blocks drawn on a timeline. The chart summarizes the
|
||||
|
|
|
@ -7,7 +7,7 @@ timew-move \- change interval start-time
|
|||
.B timew move
|
||||
.I <id> <date>
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew move @<id> <date>
|
||||
The 'move' command is used to reposition an interval at a new start time.
|
||||
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
|
||||
|
|
|
@ -16,7 +16,7 @@ timew-report \- run an extension report
|
|||
.B ...
|
||||
]
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew [report] <report> [<interval>] [<tag> ...]
|
||||
Runs an extension report, and supports filtering data.
|
||||
The 'report' command itself is optional, which means that these two commands
|
||||
|
|
|
@ -9,7 +9,7 @@ timew-resize \- set interval duration
|
|||
.B ...
|
||||
.I <duration>
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew resize @<id> [@<id> ...] <duration>
|
||||
The 'resize' command is used to change the duration of a closed interval.
|
||||
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
|
||||
|
|
|
@ -9,7 +9,7 @@ timew-shorten \- shorten intervals
|
|||
.B ...
|
||||
.I <duration>
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew shorten @<id> [@<id> ...] <duration>
|
||||
The 'shorten' command is used to advance the end date of a closed interval.
|
||||
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
|
||||
|
|
|
@ -6,7 +6,7 @@ timew-show \- display configuration
|
|||
.SH SYNOPSIS
|
||||
.B timew show
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew show
|
||||
Displays the effective configuration in hierarchical form.
|
||||
See also 'config'.
|
||||
|
|
|
@ -8,7 +8,7 @@ timew-split \- split intervals
|
|||
.I <id>
|
||||
.B ...
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew split @<id> [@<id> ...]
|
||||
Ѕplits an interval into two equally sized adjacent intervals, having the same
|
||||
tags. Using the 'summary' command, and specifying the ':ids' hint shows interval
|
||||
|
|
|
@ -12,7 +12,7 @@ timew-start \- start time tracking
|
|||
.B ...
|
||||
]
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew start [<date>] [<tag> ...]
|
||||
Begins tracking using the current time with any specified set of tags.
|
||||
If a tag contains multiple words, therefore containing spaces, use quotes to
|
||||
|
|
|
@ -12,7 +12,7 @@ timew-stop \- stop time tracking
|
|||
.B ...
|
||||
]
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew stop [<tag> ...]
|
||||
Stops tracking time. If tags are specified, then they are no longer tracked.
|
||||
If no tags are specified, all tracking stops. For example:
|
||||
|
|
|
@ -12,7 +12,7 @@ timew-summary \- display a time-tracking summary
|
|||
.B ...
|
||||
]
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew summary [<interval>] [<tag> ...]
|
||||
Displays a report summarizing tracked and untracked time for the current day by
|
||||
default. Accepts date ranges and tags for filtering, or shortcut hints:
|
||||
|
|
|
@ -12,7 +12,7 @@ timew-tag \- add tags to intervals
|
|||
.I <tag>
|
||||
.B ...
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew tag [@<id> ...] <tag> ...
|
||||
The 'tag' command is used to add a tag to an interval. Using the 'summary'
|
||||
command, and specifying the ':ids' hint shows interval IDs. Using the right ID,
|
||||
|
|
|
@ -9,7 +9,7 @@ timew-tags \- display a list of tags
|
|||
.I <range>
|
||||
]
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew tags [<interval>] [<tag> ...]
|
||||
Displays all the tags that have been used by default. When a filter is specified,
|
||||
shows only the tags that were used during that time.
|
||||
|
|
|
@ -11,7 +11,7 @@ timew-track \- add intervals to the database
|
|||
.B ...
|
||||
]
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew track <interval> [<tag> ...]
|
||||
The track command is used to add tracked time in the past. Perhaps you forgot
|
||||
to record time, or are just filling in old entries. For example:
|
||||
|
|
|
@ -12,7 +12,7 @@ timew-untag \- remove tags from intervals
|
|||
.I <tag>
|
||||
.B ...
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew untag [@<id> ...] <tag> ...
|
||||
The 'untag' command is used to remove a tag from an interval. Using the 'summary'
|
||||
command, and specifying the ':ids' hint shows interval IDs. Using the right ID,
|
||||
|
|
|
@ -12,7 +12,7 @@ timew-week \- display week chart
|
|||
.B ...
|
||||
]
|
||||
|
||||
.TP
|
||||
.SH DESCRIPTION
|
||||
.B timew week [<interval>] [<tag> ...]
|
||||
The week command shows a chart depicting a single week (current week by
|
||||
default), with colored blocks drawn on a timeline. The chart summarizes the
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue