r3 setup Commands

These commands are used to initialize an r3 project and to save or retrieve a complete r3 project dataset to archive.

Usage for r3 setup:

usage:r3 [-c <arg>] [-u] [-x] [-q] setup
administrative commands

dimension             dimension administration
setuphome [-f]        create an r3 home environment
installdb             install/setup r3 database
installgui [-g] <a..  install/setup gui
save [-f]             save complete r3 dataset to file
load                  load complete r3 dataset from file
import [-s]           import directory tree to location 
upgrade               upgrade database schema to current version

r3 setup setuphome

r3 setup setuphome path

Specifies the root directory to setup a workspace for r3. For example, if you want to set the workspace in the /tmp/r3 directory, run this command:

$ r3 setup setuphome /tmp/r3

This installs two empty directories in /r3, tmp and plugins, and places the file r3.conf.xml into it. The file r3.conf.xml contains information about the r3 installation such as the database type (SQLite or MYSQL), the database name, etc. A typical r3.conf.xml looks like this:

<?xml version="1.0" encoding="UTF-8"?>

 <!-- Copyright (c) 2007 Yahoo! Inc.  All rights reserved.                           -->
 <!-- The copyrights embodied in the content of this file are licensed under the BSD -->
 <!-- open source license                                                            -->

<conf>
  <DB>
    <type>sqlite</type>
    <host>localhost</host>
    <dbname>r3</dbname>
    <user>root</user>
    <pass></pass>
  </DB>
 </conf>

Edit r3.conf.xml to suit your configuration.

Set the environment variable R3HOME to the path set by setuphome, if you want to avoid using r3 -c path for each command. This document uses $R3HOME to refer to the root directory for the r3 project.

aliases

none

flags

-f: forces a reinstall of r3.conf.xml into /tmp/r3. This does not affect any data already created in the database. The user must use SQLite or MYSQL commands to clear the database.

r3 Reference Guide