Mercurial > p > roundup > code
comparison doc/user_guide.txt @ 1599:cc96bf971b33
extended date syntax to make range searches even more useful
| author | Andrey Lebedev <kedder@users.sourceforge.net> |
|---|---|
| date | Tue, 22 Apr 2003 20:53:55 +0000 |
| parents | 33a0d94c7658 |
| children | 7b680b906417 |
comparison
equal
deleted
inserted
replaced
| 1598:b3263567b8c6 | 1599:cc96bf971b33 |
|---|---|
| 1 ========== | 1 ========== |
| 2 User Guide | 2 User Guide |
| 3 ========== | 3 ========== |
| 4 | 4 |
| 5 :Version: $Revision: 1.20 $ | 5 :Version: $Revision: 1.21 $ |
| 6 | 6 |
| 7 .. contents:: | 7 .. contents:: |
| 8 | 8 |
| 9 Note: this document will refer to *issues* as the primary store of information | 9 Note: this document will refer to *issues* as the primary store of information |
| 10 in the tracker. This is the default of the classic template, bubt may vary in | 10 in the tracker. This is the default of the classic template, bubt may vary in |
| 97 in the database. We may also accept ranges of dates. You can specify range | 97 in the database. We may also accept ranges of dates. You can specify range |
| 98 of dates in one of two formats: | 98 of dates in one of two formats: |
| 99 | 99 |
| 100 1. English syntax:: | 100 1. English syntax:: |
| 101 | 101 |
| 102 [[From] <value>][ To <value>] | 102 [From <value>][To <value>] |
| 103 | 103 |
| 104 Keywords "From" and "To" are case insensitive. Keyword "From" is optional. | 104 Keywords "From" and "To" are case insensitive. Keyword "From" is optional. |
| 105 | 105 |
| 106 2. "Geek" syntax:: | 106 2. "Geek" syntax:: |
| 107 | 107 |
| 108 [<value>][; <value>] | 108 [<value>];[<value>] |
| 109 | 109 |
| 110 Either first or second ``<value>`` can be omitted in both syntaxes. | 110 Either first or second ``<value>`` can be omitted in both syntaxes. |
| 111 | 111 |
| 112 For example, if you enter string "from 9:00" to "Creation date" field, | 112 For example, if you enter string "from 9:00" to "Creation date" field, |
| 113 roundup will find all issues, that were created today since 9 AM. | 113 roundup will find all issues, that were created today since 9 AM. |
| 115 Searching of "-2m; -1m" on activity field gives you issues which were | 115 Searching of "-2m; -1m" on activity field gives you issues which were |
| 116 active between period of time since 2 months up-till month ago. | 116 active between period of time since 2 months up-till month ago. |
| 117 | 117 |
| 118 Other possible examples (consider local time is Sat Mar 8 22:07:48 2003):: | 118 Other possible examples (consider local time is Sat Mar 8 22:07:48 2003):: |
| 119 | 119 |
| 120 >>> Range("from 2-12 to 4-2") | 120 >>> Range("from 2-12 to 4-2") |
| 121 <Range from 2003-02-12.00:00:00 to 2003-04-02.00:00:00> | 121 <Range from 2003-02-12.00:00:00 to 2003-04-02.00:00:00> |
| 122 | 122 |
| 123 >>> Range("18:00 TO +2m") | 123 >>> Range("FROM 18:00 TO +2m") |
| 124 <Range from 2003-03-08.18:00:00 to 2003-05-08.20:07:48> | 124 <Range from 2003-03-08.18:00:00 to 2003-05-08.20:07:48> |
| 125 | 125 |
| 126 >>> Range("12:00") | 126 >>> Range("12:00;") |
| 127 <Range from 2003-03-08.12:00:00 to None> | 127 <Range from 2003-03-08.12:00:00 to None> |
| 128 | 128 |
| 129 >>> Range("tO +3d") | 129 >>> Range("tO +3d") |
| 130 <Range from None to 2003-03-11.20:07:48> | 130 <Range from None to 2003-03-11.20:07:48> |
| 131 | 131 |
| 132 >>> Range("2002-11-10; 2002-12-12") | 132 >>> Range("2002-11-10; 2002-12-12") |
| 133 <Range from 2002-11-10.00:00:00 to 2002-12-12.00:00:00> | 133 <Range from 2002-11-10.00:00:00 to 2002-12-12.00:00:00> |
| 134 | 134 |
| 135 >>> Range("; 20:00 +1d") | 135 >>> Range("; 20:00 +1d") |
| 136 <Range from None to 2003-03-09.20:00:00> | 136 <Range from None to 2003-03-09.20:00:00> |
| 137 | 137 |
| 138 >>> Range("2003") | |
| 139 <Range from 2003-01-01.00:00:00 to 2003-12-31.23:59:59> | |
| 140 | |
| 141 >>> Range("2003-04") | |
| 142 <Range from 2003-04-01.00:00:00 to 2003-04-30.23:59:59> | |
| 143 | |
| 138 | 144 |
| 139 Interval properties | 145 Interval properties |
| 140 ~~~~~~~~~~~~~~~~~~~ | 146 ~~~~~~~~~~~~~~~~~~~ |
| 141 | 147 |
| 142 XXX explain... | 148 XXX explain... |
| 484 Options: | 490 Options: |
| 485 -i instance home -- specify the issue tracker "home directory" to administer | 491 -i instance home -- specify the issue tracker "home directory" to administer |
| 486 -u -- the user[:password] to use for commands | 492 -u -- the user[:password] to use for commands |
| 487 -d -- print full designators not just class id numbers | 493 -d -- print full designators not just class id numbers |
| 488 -c -- when outputting lists of data, comma-separate them. | 494 -c -- when outputting lists of data, comma-separate them. |
| 489 Same as '-S ","'. | 495 Same as '-S ","'. |
| 490 -S <string> -- when outputting lists of data, string-separate them | 496 -S <string> -- when outputting lists of data, string-separate them |
| 491 -s -- when outputting lists of data, space-separate them. | 497 -s -- when outputting lists of data, space-separate them. |
| 492 Same as '-S " "'. | 498 Same as '-S " "'. |
| 493 | 499 |
| 494 Only one of -s, -c or -S can be specified. | 500 Only one of -s, -c or -S can be specified. |
| 495 | 501 |
| 496 Help: | 502 Help: |
| 497 roundup-admin -h | 503 roundup-admin -h |
| 547 "01-25" yyyy-01-25.00:00:00 | 553 "01-25" yyyy-01-25.00:00:00 |
| 548 "08-13.22:13" yyyy-08-14.03:13:00 | 554 "08-13.22:13" yyyy-08-14.03:13:00 |
| 549 "11-07.09:32:43" yyyy-11-07.14:32:43 | 555 "11-07.09:32:43" yyyy-11-07.14:32:43 |
| 550 "14:25" yyyy-mm-dd.19:25:00 | 556 "14:25" yyyy-mm-dd.19:25:00 |
| 551 "8:47:11" yyyy-mm-dd.13:47:11 | 557 "8:47:11" yyyy-mm-dd.13:47:11 |
| 558 "2003" 2003-01-01.00:00:00 | |
| 559 "2003-04" 2003-04-01.00:00:00 | |
| 552 "." "right now" | 560 "." "right now" |
| 553 | 561 |
| 554 - Link values are printed as item designators. When given as an argument, | 562 - Link values are printed as item designators. When given as an argument, |
| 555 item designators and key strings are both accepted. | 563 item designators and key strings are both accepted. |
| 556 - Multilink values are printed as lists of item designators joined by | 564 - Multilink values are printed as lists of item designators joined by |
| 623 summary: jlkfjadsf | 631 summary: jlkfjadsf |
| 624 | 632 |
| 625 or status:: | 633 or status:: |
| 626 | 634 |
| 627 shell% roundup-admin get name `/tools/roundup/bin/roundup-admin \ | 635 shell% roundup-admin get name `/tools/roundup/bin/roundup-admin \ |
| 628 -dc -i /var/roundup/sysadmin get status issue3,issue1` | 636 -dc -i /var/roundup/sysadmin get status issue3,issue1` |
| 629 unread | 637 unread |
| 630 deferred | 638 deferred |
| 631 | 639 |
| 632 or status on a single line:: | 640 or status on a single line:: |
| 633 | 641 |
| 642 unread deferred | 650 unread deferred |
| 643 | 651 |
| 644 Also the tautological:: | 652 Also the tautological:: |
| 645 | 653 |
| 646 shell% roundup-admin get name \ | 654 shell% roundup-admin get name \ |
| 647 `roundup-admin -dc get status \`roundup-admin -dc find issue \ | 655 `roundup-admin -dc get status \`roundup-admin -dc find issue \ |
| 648 status=chatting\`` | 656 status=chatting\`` |
| 649 chatting | 657 chatting |
| 650 chatting | 658 chatting |
| 651 | 659 |
| 652 Remember the roundup commands that accept multiple designators accept | 660 Remember the roundup commands that accept multiple designators accept |