Permalink
Browse files

doc: Add manpage for modify command.

  • Loading branch information...
sruffell authored and lauft committed Nov 25, 2018
1 parent ceca4c8 commit c416b4861232fd6f7dbf7e77be962135fe4a3008
@@ -28,6 +28,7 @@ Note that you can lengthen multiple intervals,:
$ timew lengthen @2 @10 @23 1hour
.
.SH "SEE ALSO"
.BR timew-modify (1),
.BR timew-resize (1),
.BR timew-shorten (1),
.BR timew-summary (1),
@@ -0,0 +1,35 @@
.TH timew-modify 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals"
.
.SH NAME
timew-modify \- change start or end date of an interval
.
.SH SYNOPSIS
.B timew modify (
.I start
|
.I end
)
.I <id>
.I <date>
.
.SH DESCRIPTION
The 'modify' command is used to change the start or end date of an interval.
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
Using the right ID, you can identify an interval to modify.
.
.SH EXAMPLES
For example, show the IDs:
.
$ timew summary :week :ids
.
.PP
Then having selected '@3' as the interval you wish to modify:
.
$ timew modify end @3 2018-02-03T17:00:00
.
.SH "SEE ALSO"
.BR timew-lengthen (1),
.BR timew-move (1),
.BR timew-resize (1)
.BR timew-shorten (1),
.BR timew-summary (1)
@@ -23,6 +23,7 @@ Then having selected '@2' as the interval you wish to move:
.
.SH "SEE ALSO"
.BR timew-lengthen (1),
.BR timew-modify (1),
.BR timew-resize (1),
.BR timew-shorten (1),
.BR timew-summary (1),
@@ -29,6 +29,7 @@ Note that you can resize multiple intervals,:
.
.SH "SEE ALSO"
.BR timew-lengthen (1),
.BR timew-modify (1),
.BR timew-shorten (1),
.BR timew-summary (1),
.BR timew-tag (1),
@@ -29,6 +29,7 @@ Note that you can shorten multiple intervals,:
.
.SH "SEE ALSO"
.BR timew-lengthen (1),
.BR timew-modify (1),
.BR timew-resize (1),
.BR timew-summary (1),
.BR timew-tag (1),
@@ -25,6 +25,7 @@ The ':ids' hint adds an 'ID' column to the summary report output for interval mo
.SH "SEE ALSO"
.BR timew-day (1),
.BR timew-lengthen (1),
.BR timew-modify (1),
.BR timew-month (1),
.BR timew-shorten (1),
.BR timew-tag (1),
@@ -98,6 +98,11 @@ Join intervals
Lengthen intervals
.RE
.TP
.BR timew-modify (1)
.RS
Change start or end time of an interval
.RE
.TP
.BR timew-month (1)
.RS
Display month chart

0 comments on commit c416b48

Please sign in to comment.