Put each sentence into separate line

This commit is contained in:
Thomas Lauf 2018-06-23 20:38:26 +02:00
parent e36f658f37
commit e048d63d15
27 changed files with 85 additions and 91 deletions

View file

@ -15,20 +15,19 @@ timew-config \- get and set Timewarrior configuration
]
.
.SH DESCRIPTION
Allows setting and removing configuration values, as an alternative to directly
editing your ~/.timewarrior/timewarrior.cfg file. For example:
Allows setting and removing configuration values, as an alternative to directly editing your ~/.timewarrior/timewarrior.cfg file.
For example:
.
$ timew config verbose yes
$ timew config verbose ''
$ timew config verbose
.
The first command sets 'verbose' to 'yes'. The second sets it to a blank value
which overrides the default value. The third example deletes the 'verbose'
setting.
The first command sets 'verbose' to 'yes'.
The second sets it to a blank value which overrides the default value.
The third example deletes the 'verbose' setting.
.
When modifying configuration in this way, interactive confirmation will be
sought. To override this confirmation, use the ':yes' hint, which means you
intend to answer 'yes' to the confirmation questions:
When modifying configuration in this way, interactive confirmation will be sought.
To override this confirmation, use the ':yes' hint, which means you intend to answer 'yes' to the confirmation questions:
.
$ timew config verbose '' :yes
.

View file

@ -16,17 +16,16 @@ timew-continue \- resume tracking of existing interval
]
.
.SH DESCRIPTION
Resumes tracking of closed intervals. For example:
Resumes tracking of closed intervals.
For example:
.
$ timew track 9am - 10am tag1 tag2
$ timew track 11am - 1pm tag3
$ timew continue @2
.
The 'continue' command creates a new interval, starting now, and using the
tags 'tag1' and 'tag2'.
The 'continue' command creates a new interval, starting now, and using the tags 'tag1' and 'tag2'.
Using the 'summary' command and specifying the ':ids' hint shows interval IDs.
This command is a convenient way to resume work without re-entering the
tags.
This command is a convenient way to resume work without re-entering the tags.
.
See also 'start', 'stop'.
.

View file

@ -13,9 +13,8 @@ timew-day \- display day chart
]
.
.SH DESCRIPTION
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
untracked time.
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 untracked time.
.
Charts accept date ranges and tags for filtering, or shortcut hints:
.
@ -26,8 +25,8 @@ Charts accept date ranges and tags for filtering, or shortcut hints:
The 'reports.day.range' configuration setting overrides the default date range.
The default date range shown is ':day'.
.
The ':blank' hint causes only the excluded time to be shown, with no tracked
time. This can be used to see the exclusions.
The ':blank' hint causes only the excluded time to be shown, with no tracked time.
This can be used to see the exclusions.
.
For more details, and precise times, use the 'summary' report.
.

View file

@ -9,8 +9,9 @@ timew-delete \- delete intervals
.B ...
.
.SH DESCRIPTION
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.
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.
For example, show the IDs:
.
$ timew summary :week :ids

View file

@ -7,8 +7,7 @@ timew-diagnostics \- show diagnostic information
.B timew diagnostics
.
.SH DESCRIPTION
This command shows details about your version of Timewarrior, your platform, how
it was built, compiler features, configuration, file access, extensions and more.
The purpose of this command is to help diagnose configuration problems and
provide supplemental information when reporting a problem. See also 'extensions'.
This command shows details about your version of Timewarrior, your platform, how it was built, compiler features, configuration, file access, extensions and more.
The purpose of this command is to help diagnose configuration problems and provide supplemental information when reporting a problem.
See also 'extensions'.
.

View file

@ -12,7 +12,9 @@ timew-export \- export tracked time in JSON
]
.
.SH DESCRIPTION
Exports all the tracked time in JSON format. Supports filtering. For example:
Exports all the tracked time in JSON format.
Supports filtering.
For example:
.
$ timew export from 2016-01-01 for 3wks tag1
.

View file

@ -7,6 +7,6 @@ timew-extension \- list available extensions
.B timew extensions
.
.SH DESCRIPTION
Displays the directory containing the extension programs and a table showing
each extension and its status. See also 'diagnostics'.
Displays the directory containing the extension programs and a table showing each extension and its status.
See also 'diagnostics'.
.

View file

@ -11,8 +11,8 @@ timew-fill \- adjust intervals to fill in surrounding gaps
.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. For example, show
the IDs:
Using the right ID, you can identify an interval to fill.
For example, show the IDs:
.
$ timew summary :week :ids
.

View file

@ -16,12 +16,10 @@ timew-gaps \- display time tracking gaps
Displays a summary of time that is neither tracked nor excluded from tracking.
.
The 'reports.gaps.range' configuration setting overrides the default date range.
The ':blank' hint causes only the excluded time to be shown, with no tracked
time.
The ':blank' hint causes only the excluded time to be shown, with no tracked time.
The default date range shown is ':day'.
.
The ':blank' hint causes only the excluded time to be shown, with no tracked
time.
The ':blank' hint causes only the excluded time to be shown, with no tracked time.
.
See also 'summary'.
.

View file

@ -9,7 +9,8 @@ timew-get \- display DOM values
.B ...
.
.SH DESCRIPTION
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:
.
$ timew get dom.active
1

View file

@ -18,8 +18,7 @@ timew-help \- display help
}
.
.SH DESCRIPTION
The help command shows detailed descriptions and examples of commands,
interval syntax, supported hints, date and duration formats and DOM references.
The help command shows detailed descriptions and examples of commands, interval syntax, supported hints, date and duration formats and DOM references.
For example:
.
$ timew help

View file

@ -8,10 +8,10 @@ timew-join \- join intervals
.I <id> <id>
.
.SH DESCRIPTION
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,
and specifying the ':ids' hint shows interval IDs. Using the correct IDs, you
can identify an intervals to join. For example, show the IDs:
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, and specifying the ':ids' hint shows interval IDs.
Using the correct IDs, you can identify an intervals to join.
For example, show the IDs:
.
$ timew summary :week :ids
.

View file

@ -12,8 +12,8 @@ timew-lengthen \- lengthen intervals
.SH DESCRIPTION
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.
Using the right ID, you can identify an interval to lengthen. For example, show
the IDs:
Using the right ID, you can identify an interval to lengthen.
For example, show the IDs:
.
$ timew summary :week :ids
.

View file

@ -13,9 +13,8 @@ timew-month \- display month chart
]
.
.SH DESCRIPTION
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
tracked and untracked time.
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 tracked and untracked time.
.
Accepts date ranges and tags for filtering, or shortcut hints:
.
@ -25,8 +24,7 @@ Accepts date ranges and tags for filtering, or shortcut hints:
The 'reports.month.range' configuration setting overrides the default date range.
The default date range shown is ':month'.
.
The ':blank' hint causes only the excluded time to be shown, with no tracked
time.
The ':blank' hint causes only the excluded time to be shown, with no tracked time.
.
For more details, and precise times, use the 'summary' report.
.

View file

@ -10,8 +10,8 @@ timew-move \- change interval start-time
.SH DESCRIPTION
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.
Using the right ID, you can identify an interval to move. For example, show
the IDs:
Using the right ID, you can identify an interval to move.
For example, show the IDs:
.
$ timew summary :week :ids
.

View file

@ -18,8 +18,7 @@ timew-report \- run an extension report
.
.SH DESCRIPTION
Runs an extension report, and supports filtering data.
The 'report' command itself is optional, which means that these two commands
are equivalent:
The 'report' command itself is optional, which means that these two commands are equivalent:
.
$ timew report foo :week
$ timew foo :week

View file

@ -12,8 +12,8 @@ timew-resize \- set interval duration
.SH DESCRIPTION
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.
Using the right ID, you can identify an interval to resize. For example, show
the IDs:
Using the right ID, you can identify an interval to resize.
For example, show the IDs:
.
$ timew summary :week :ids
.

View file

@ -12,8 +12,8 @@ timew-shorten \- shorten intervals
.SH DESCRIPTION
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.
Using the right ID, you can identify an interval to shorten. For example, show
the IDs:
Using the right ID, you can identify an interval to shorten.
For example, show the IDs:
.
$ timew summary :week :ids
.

View file

@ -9,10 +9,10 @@ timew-split \- split intervals
.B ...
.
.SH DESCRIPTION
Ѕplits an interval into two equally sized adjacent intervals, having the same
tags. Using the 'summary' command, and specifying the ':ids' hint shows interval
IDs. Using the right ID, you can identify an interval to split. For example,
show the IDs:
Ѕplits an interval into two equally sized adjacent intervals, having the same tags.
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
Using the right ID, you can identify an interval to split.
For example, show the IDs:
.
$ timew summary :week :ids
.

View file

@ -14,18 +14,17 @@ timew-start \- start time tracking
.
.SH 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. For example, this command specifies two tags ('weekend'
and 'Home & Garden'), the second of which requires quotes.
If a tag contains multiple words, therefore containing spaces, use quotes to surround the whole tag.
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:
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 'continue', 'stop', 'track'.
Quotes are harmless if used unnecessarily.
See also 'continue', 'stop', 'track'.
.

View file

@ -13,15 +13,17 @@ timew-stop \- stop time tracking
]
.
.SH DESCRIPTION
Stops tracking time. If tags are specified, then they are no longer tracked.
If no tags are specified, all tracking stops. For example:
Stops tracking time.
If tags are specified, then they are no longer tracked.
If no tags are specified, all tracking stops.
For example:
.
$ timew start tag1 tag2
...
$ timew stop tag1
.
Initially time is tracked for both 'tag1' and 'tag2', then 'tag1' tracking is
stopped, leaving tag2 active. To stop all tracking:
Initially time is tracked for both 'tag1' and 'tag2', then 'tag1' tracking is stopped, leaving tag2 active.
To stop all tracking:
.
$ timew stop
.

View file

@ -13,15 +13,14 @@ timew-summary \- display a time-tracking summary
]
.
.SH DESCRIPTION
Displays a report summarizing tracked and untracked time for the current day by
default. Accepts date ranges and tags for filtering, or shortcut hints:
Displays a report summarizing tracked and untracked time for the current day by default.
Accepts date ranges and tags for filtering, or shortcut hints:
.
$ timew summary monday - today
$ timew summary :week
$ timew summary :month
.
The ':ids' hint adds an 'ID' column to the summary report output for interval
modification.
The ':ids' hint adds an 'ID' column to the summary report output for interval modification.
.
See also 'day', 'week', 'month', 'shorten', 'lengthen', 'tag', 'untag'.
.

View file

@ -13,9 +13,10 @@ timew-tag \- add tags to intervals
.B ...
.
.SH DESCRIPTION
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,
you can identify an interval to tag. For example, show the IDs:
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, you can identify an interval to tag.
For example, show the IDs:
.
$ timew summary :week :ids
.

View file

@ -10,6 +10,6 @@ timew-tags \- display a list of tags
]
.
.SH DESCRIPTION
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.
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.
.

View file

@ -12,13 +12,13 @@ timew-track \- add intervals to the database
]
.
.SH DESCRIPTION
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:
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:
.
$ timew track :yesterday 'Training Course'
$ timew track 9am - 11am 'Staff Meeting'
.
Note that the track command expects a closed interval (start and end time), when
recording. If a closed interval is not provided, the 'track' command behaves the
same as the 'start' command.
Note that the track command expects a closed interval (start and end time), when recording.
If a closed interval is not provided, the 'track' command behaves the same as the 'start' command.
.

View file

@ -13,9 +13,10 @@ timew-untag \- remove tags from intervals
.B ...
.
.SH DESCRIPTION
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,
you can identify an interval to untag. For example, show the IDs:
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, you can identify an interval to untag.
For example, show the IDs:
.
$ timew summary :week :ids
.

View file

@ -13,9 +13,8 @@ timew-week \- display week chart
]
.
.SH DESCRIPTION
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
tracked and untracked time.
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 tracked and untracked time.
.
Accepts date ranges and tags for filtering, or shortcut hints:
.
@ -25,8 +24,7 @@ Accepts date ranges and tags for filtering, or shortcut hints:
The 'reports.week.range' configuration setting overrides the default date range.
The default date range shown is ':week'.
.
The ':blank' hint causes only the excluded time to be shown, with no tracked
time.
The ':blank' hint causes only the excluded time to be shown, with no tracked time.
.
For more details, and precise times, use the 'summary' report.
.