Mercurial > p > roundup > code
comparison doc/design.txt @ 4368:f4a863d88a99
fix
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Tue, 30 Mar 2010 22:57:42 +0000 |
| parents | 7ad0918ee8bd |
| children | 32b24abfe98e |
comparison
equal
deleted
inserted
replaced
| 4367:fa5587802af9 | 4368:f4a863d88a99 |
|---|---|
| 1006 | 1006 |
| 1007 | 1007 |
| 1008 Command Interface Specification | 1008 Command Interface Specification |
| 1009 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 1009 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1010 | 1010 |
| 1011 A single command, roundup, provides basic access to the hyperdatabase | 1011 A single command, ``roundup-admin``, provides basic access to the hyperdatabase |
| 1012 from the command line:: | 1012 from the command line:: |
| 1013 | 1013 |
| 1014 roundup-admin help | 1014 roundup-admin help |
| 1015 roundup-admin get [-list] designator[, designator,...] propname | 1015 roundup-admin get [-list] designator[, designator,...] propname |
| 1016 roundup-admin set designator[, designator,...] propname=value ... | 1016 roundup-admin set designator[, designator,...] propname=value ... |
| 1037 - Multilink values are printed as lists of item designators joined by | 1037 - Multilink values are printed as lists of item designators joined by |
| 1038 commas. When given as an argument, item designators and key strings | 1038 commas. When given as an argument, item designators and key strings |
| 1039 are both accepted; an empty string, a single item, or a list of items | 1039 are both accepted; an empty string, a single item, or a list of items |
| 1040 joined by commas is accepted. | 1040 joined by commas is accepted. |
| 1041 | 1041 |
| 1042 When multiple items are specified to the roundup get or roundup set | 1042 When multiple items are specified to the roundup-admin get or roundup-admin set |
| 1043 commands, the specified properties are retrieved or set on all the | 1043 commands, the specified properties are retrieved or set on all the |
| 1044 listed items. | 1044 listed items. |
| 1045 | 1045 |
| 1046 When multiple results are returned by the roundup get or roundup find | 1046 When multiple results are returned by the roundup-admin get or |
| 1047 roundup-admin find | |
| 1047 commands, they are printed one per line (default) or joined by commas | 1048 commands, they are printed one per line (default) or joined by commas |
| 1048 (with the -list) option. | 1049 (with the -list) option. |
| 1049 | 1050 |
| 1050 | 1051 |
| 1051 Usage Example | 1052 Usage Example |
| 1053 | 1054 |
| 1054 To find all messages regarding in-progress issues that contain the word | 1055 To find all messages regarding in-progress issues that contain the word |
| 1055 "spam", for example, you could execute the following command from the | 1056 "spam", for example, you could execute the following command from the |
| 1056 directory where the database dumps its files:: | 1057 directory where the database dumps its files:: |
| 1057 | 1058 |
| 1058 shell% for issue in `roundup find issue status=in-progress`; do | 1059 shell% for issue in `roundup-admin find issue status=in-progress`; do |
| 1059 > grep -l spam `roundup get $issue messages` | 1060 > grep -l spam `roundup-admin get $issue messages` |
| 1060 > done | 1061 > done |
| 1061 msg23 | 1062 msg23 |
| 1062 msg49 | 1063 msg49 |
| 1063 msg50 | 1064 msg50 |
| 1064 msg61 | 1065 msg61 |
| 1065 shell% | 1066 shell% |
| 1066 | 1067 |
| 1067 Or, using the -list option, this can be written as a single command:: | 1068 Or, using the -list option, this can be written as a single command:: |
| 1068 | 1069 |
| 1069 shell% grep -l spam `roundup get \ | 1070 shell% grep -l spam `roundup-admin get \ |
| 1070 \`roundup find -list issue status=in-progress\` messages` | 1071 \`roundup-admin find -list issue status=in-progress\` messages` |
| 1071 msg23 | 1072 msg23 |
| 1072 msg49 | 1073 msg49 |
| 1073 msg50 | 1074 msg50 |
| 1074 msg61 | 1075 msg61 |
| 1075 shell% | 1076 shell% |
| 1154 ~~~~~~~~~~~~~~~~~~ | 1155 ~~~~~~~~~~~~~~~~~~ |
| 1155 | 1156 |
| 1156 The e-mail interface also provides a simple way to set properties on | 1157 The e-mail interface also provides a simple way to set properties on |
| 1157 issues. At the end of the subject line, ``propname=value`` pairs can be | 1158 issues. At the end of the subject line, ``propname=value`` pairs can be |
| 1158 specified in square brackets, using the same conventions as for the | 1159 specified in square brackets, using the same conventions as for the |
| 1159 roundup ``set`` shell command. | 1160 roundup-admin ``set`` shell command. |
| 1160 | 1161 |
| 1161 | 1162 |
| 1162 Web User Interface | 1163 Web User Interface |
| 1163 ------------------ | 1164 ------------------ |
| 1164 | 1165 |