Mercurial > p > roundup > code
comparison README.txt @ 266:e0a54a571f78
more doc cleanup
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Fri, 05 Oct 2001 07:42:46 +0000 |
| parents | 2099d0d052ed |
| children | 7b5d63306bc9 |
comparison
equal
deleted
inserted
replaced
| 265:0a28169a61b0 | 266:e0a54a571f78 |
|---|---|
| 31 For installation notes, please see the file INSTALL.TXT | 31 For installation notes, please see the file INSTALL.TXT |
| 32 | 32 |
| 33 | 33 |
| 34 3. Usage | 34 3. Usage |
| 35 ======== | 35 ======== |
| 36 The system is designed to accessed through the command-line, e-mail or web | 36 See the index.html file in the "doc" directory. |
| 37 interface. Roundup has some useful doucmentation in its docstrings, so | |
| 38 "pydoc roundup" will give useful information. | |
| 39 | |
| 40 3.1 Command-line | |
| 41 ---------------- | |
| 42 The command-line tool is called "roundup-admin" and is used for most low-level | |
| 43 database manipulations such as: | |
| 44 . creating a database instance | |
| 45 . redefining the list of products ("create" and "retire" commands) | |
| 46 . adding users manually, or setting their passwords ("create" and "set") | |
| 47 . other stuff - run it with no arguments to get a better description of | |
| 48 what it does. | |
| 49 | |
| 50 | |
| 51 3.2 E-mail | |
| 52 ---------- | |
| 53 See the docstring at the start of the roundup/mailgw.py source file. | |
| 54 Use "pydoc roundup.mailgw". | |
| 55 | |
| 56 | |
| 57 3.3 Web | |
| 58 ------- | |
| 59 Hopefully, this interface is pretty self-explanatory... | |
| 60 | |
| 61 Index views may be modified by the following arguments: | |
| 62 :sort - sort by prop name, optionally preceeded with '-' | |
| 63 to give descending or nothing for ascending sorting. | |
| 64 :group - group by prop name, optionally preceeded with '-' or | |
| 65 to sort in descending or nothing for ascending order. | |
| 66 :filter - selects which props should be displayed in the filter | |
| 67 section. Default is all. | |
| 68 :columns - selects the columns that should be displayed. | |
| 69 Default is all. | |
| 70 propname - selects the values the node properties given by propname | |
| 71 must have (very basic search/filter). | |
| 72 | |
| 73 | 37 |
| 74 | 38 |
| 75 3. Design | 39 3. Design |
| 76 ========= | 40 ========= |
| 77 See the information in the "doc" directory. | 41 See the information in the "doc" directory. |