diff doc/admin_guide.txt @ 6173:82f58ae89142

Add new section onroundup-admin. Ad indexing.
author John Rouillard <rouilj@ieee.org>
date Sat, 16 May 2020 13:39:47 -0400
parents c2fd254c9257
children 72a69753f49a
line wrap: on
line diff
--- a/doc/admin_guide.txt	Sat May 16 12:06:49 2020 -0400
+++ b/doc/admin_guide.txt	Sat May 16 13:39:47 2020 -0400
@@ -290,6 +290,7 @@
 
 
 .. index:: database; convert from one database backend to another
+   single: roundup-admin; import and export
 
 Migrating Backends
 ------------------
@@ -443,6 +444,32 @@
 2. Set the scheduled task to run in the context of this user instead
    of your normal login
 
+.. index:: ! roundup-admin
+   single: roundup-admin; man page reference
+
+Using roundup-admin
+===================
+
+Part of the installation includes a man page for roundup-admin.  Ypu
+should be able to ead it using ``man roundup-admin``. As shown above,
+it is a generic tool for manipulating the underlying database for you
+tracker.
+
+Examples above show how to use it to:
+
+   * install and initialize a new tracker
+   * export/import tracker data for migrating between backends
+   * creating a new user fom the command line
+   * list/find users in the tracker
+
+A brief summary is::
+
+    roundup-admin help
+    roundup-admin -i <tracker_dir> get [-list] designator[, designator,...] propname
+    roundup-admin -i <tracker_dir> set designator[, designator,...] propname=value ...
+    roundup-admin -i <tracker_dir> find [-list] classname propname=value ...
+
+See ``roundup-admin help commands`` for a complete list of commands.
 
 .. _`customisation documentation`: customizing.html
 .. _`upgrading documentation`: upgrading.html

Roundup Issue Tracker: http://roundup-tracker.org/