From 219c01e29e6c716bf9ea5cd0e156ca58908e2a4f Mon Sep 17 00:00:00 2001
From: Karl Chen <quarl@quarl.org>
Date: Fri, 3 Oct 2003 09:13:30 +0000
Subject: [PATCH] *** empty log message ***

svn path=/trunk/boinc/; revision=2408
---
 doc/tool_add.php | 42 ++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 40 insertions(+), 2 deletions(-)

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("<code>add</code> Tool");
-?>
+   ?>
 
-   TODO: document add.py
+`<code>add</code>' adds objects to the BOINC database.
 
 
+Usages:
+<pre>
+
+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]
+
+</pre>
+
+For detailed help, type `<code>add</code>' (with no arguments) or `<code>add
+app_version</code>' for help on adding an app_version, etc.
+<p>
+
+Typically you will only <code>add</code> <code>platform</code>s
+and <code>app</code>s, and only at the inception of the project.  A project is
+created with <a
+href=tool_make_project.php>make_project</a>.  Core_version and app_version are
+automatically added by the <a
+href=tool_update_versions.php>update_versions</a> tool.  Users are usually
+created through the html interface.
+
 <?
    page_tail();
 ?>