diff --git a/doc/tool_add.php b/doc/tool_add.php index 13b3ba1ac5..eabe65881a 100644 --- a/doc/tool_add.php +++ b/doc/tool_add.php @@ -2,11 +2,49 @@ // $Id$ require_once("docutil.php"); page_head("add Tool"); -?> + ?> - TODO: document add.py +`add' adds objects to the BOINC database. +Usages: +
+
+add project      --name=yah --long_name="YETI @ home"
+
+add platform     --name=c64 [ --user_friendly_name="Commodore 64" ]
+
+add core_version --platform=c64 --version_num=717
+                    --exec_file=/path/to/boinc_7.17_c64
+                    [--message="Message"] [--message_priority="Priority"]
+
+add app          --name=YetiApp [--min_version=716]
+
+add app_version  --app=YetiApp --platform=c64 --version_num=717
+                    --exec_file=/path/to/yeti_7.17_c64
+                      [--signature_file=/path/to/sig_file]
+                    [--exec_file=/path/to/more_bins
+                      [--signature_file=/tmp/sig_file2]] ...
+
+add user         --name="Carl Sagan" --email_addr="carl.sagan@example.com"
+                    --authenticator="deadbeef"
+                    [--country=Estonia --postal_code=94703
+                     --global_prefs_file=/path/to/prefs.xml]
+
+
+ +For detailed help, type `add' (with no arguments) or `add +app_version' for help on adding an app_version, etc. +

+ +Typically you will only add platforms +and apps, and only at the inception of the project. A project is +created with make_project. Core_version and app_version are +automatically added by the update_versions tool. Users are usually +created through the html interface. +