<?xml version="1.0" encoding="iso-8859-1"?>
<application name="4ss_manager" file="/work/a/ports/textproc/py-4suite/work/4Suite-1.0b1/build/lib.freebsd-7.1-RELEASE-i386-2.4/Ft/Server/Server/Commands/__init__.py">
  <description>4Suite repository management tools</description>
  <verbose-description>This command-line application allows a 4Suite repository administrator to perform management tasks on the repository as a whole, including setup, server control, backup, and other operations.</verbose-description>
  <options>
    <option short-name="h" long-name="help">
      <description>show detailed help message</description>
    </option>
    <option long-name="show-commands">
      <description>show system command tree</description>
    </option>
  </options>
  <subcommands>
    <command name="status">
      <description>Report on the state of a repository and its servers</description>
      <verbose-description>This command lists the status of each server in a 4Suite repository (running or stopped) as well as the state of the repository itself (data store existence and initialization status).</verbose-description>
      <options>
        <option short-name="h" long-name="help">
          <description>show detailed help message</description>
        </option>
        <option short-name="u" long-name="username">
          <description>authenticate using the given user name</description>
          <argument name="USER">
          </argument>
        </option>
        <option short-name="p" long-name="password">
          <description>authenticate using the given password</description>
          <argument name="PASSWORD">
          </argument>
        </option>
        <option short-name="I" long-name="core-id">
          <description>use a specific core in config file (default: Core)</description>
          <argument name="CORE">
          </argument>
        </option>
        <option short-name="C" long-name="config-file">
          <description>use alternative repository configuration file</description>
          <argument name="FILEPATH">
          </argument>
        </option>
      </options>
    </command>
    <command name="log">
      <description>Commands to work with the logs</description>
      <verbose-description>Manager commands to work with the log files</verbose-description>
      <options>
        <option short-name="h" long-name="help">
          <description>show detailed help message</description>
        </option>
        <option short-name="u" long-name="username">
          <description>authenticate using the given user name</description>
          <argument name="USER">
          </argument>
        </option>
        <option short-name="p" long-name="password">
          <description>authenticate using the given password</description>
          <argument name="PASSWORD">
          </argument>
        </option>
        <option short-name="I" long-name="core-id">
          <description>use a specific core in config file (default: Core)</description>
          <argument name="CORE">
          </argument>
        </option>
        <option short-name="C" long-name="config-file">
          <description>use alternative repository configuration file</description>
          <argument name="FILEPATH">
          </argument>
        </option>
      </options>
      <subcommands>
        <command name="clear">
          <description>Clear a 4SS Log</description>
          <verbose-description>Clear the logs</verbose-description>
          <options>
            <option short-name="h" long-name="help">
              <description>show detailed help message</description>
            </option>
            <option short-name="u" long-name="username">
              <description>authenticate using the given user name</description>
              <argument name="USER">
              </argument>
            </option>
            <option short-name="p" long-name="password">
              <description>authenticate using the given password</description>
              <argument name="PASSWORD">
              </argument>
            </option>
            <option short-name="I" long-name="core-id">
              <description>use a specific core in config file (default: Core)</description>
              <argument name="CORE">
              </argument>
            </option>
            <option short-name="C" long-name="config-file">
              <description>use alternative repository configuration file</description>
              <argument name="FILEPATH">
              </argument>
            </option>
          </options>
        </command>
        <command name="view">
          <description>View a 4SS Log</description>
          <verbose-description>View the logs</verbose-description>
          <options>
            <option short-name="h" long-name="help">
              <description>show detailed help message</description>
            </option>
            <option short-name="u" long-name="username">
              <description>authenticate using the given user name</description>
              <argument name="USER">
              </argument>
            </option>
            <option short-name="p" long-name="password">
              <description>authenticate using the given password</description>
              <argument name="PASSWORD">
              </argument>
            </option>
            <option short-name="I" long-name="core-id">
              <description>use a specific core in config file (default: Core)</description>
              <argument name="CORE">
              </argument>
            </option>
            <option short-name="C" long-name="config-file">
              <description>use alternative repository configuration file</description>
              <argument name="FILEPATH">
              </argument>
            </option>
            <option short-name="c" long-name="bytes">
              <description>output the last N bytes</description>
              <argument name="N">
              </argument>
            </option>
            <option short-name="n" long-name="lines">
              <description>output the last N lines, instead of the last 10</description>
              <argument name="N">
              </argument>
            </option>
            <option short-name="s" long-name="sleep-interval">
              <description>sleep for approximately S seconds (default 1.0) between iterations</description>
              <argument name="S">
              </argument>
            </option>
          </options>
        </command>
      </subcommands>
    </command>
    <command name="recompile">
      <description>Recompile all stylesheets</description>
      <verbose-description>The recompile command will walk the entire repository and 
recompile all stylesheets. It is useful when changes to the underling 
code base require that stylesheets be reinited in the system.</verbose-description>
      <options>
        <option short-name="h" long-name="help">
          <description>show detailed help message</description>
        </option>
        <option short-name="u" long-name="username">
          <description>authenticate using the given user name</description>
          <argument name="USER">
          </argument>
        </option>
        <option short-name="p" long-name="password">
          <description>authenticate using the given password</description>
          <argument name="PASSWORD">
          </argument>
        </option>
        <option short-name="I" long-name="core-id">
          <description>use a specific core in config file (default: Core)</description>
          <argument name="CORE">
          </argument>
        </option>
        <option short-name="C" long-name="config-file">
          <description>use alternative repository configuration file</description>
          <argument name="FILEPATH">
          </argument>
        </option>
      </options>
      <arguments>
        <argument required="no" multiple="no" name="path">
          <description>The root path for the operation.  Only resources within this path will get recompiled.</description>
        </argument>
      </arguments>
    </command>
    <command name="stop">
      <description>Stop the 4Suite server (controller)</description>
      <verbose-description>The stop command is used to stop any or all of the 4SS servers.  To stop
all the servers, execute the stop command with out any arguments.  To stop
an individual server, specify their names as command line arguments.  You
will be prompted for authentication before you can stop the servers.
</verbose-description>
      <options>
        <option short-name="h" long-name="help">
          <description>show detailed help message</description>
        </option>
        <option short-name="u" long-name="username">
          <description>authenticate using the given user name</description>
          <argument name="USER">
          </argument>
        </option>
        <option short-name="p" long-name="password">
          <description>authenticate using the given password</description>
          <argument name="PASSWORD">
          </argument>
        </option>
        <option short-name="I" long-name="core-id">
          <description>use a specific core in config file (default: Core)</description>
          <argument name="CORE">
          </argument>
        </option>
        <option short-name="C" long-name="config-file">
          <description>use alternative repository configuration file</description>
          <argument name="FILEPATH">
          </argument>
        </option>
      </options>
      <arguments>
        <argument required="no" multiple="no" name="server-uri">
          <description>If specified, set the running state of this server to 'off'.  This does not stop the 4ss daemon</description>
        </argument>
      </arguments>
    </command>
    <command name="start">
      <description>Start the 4Suite server (controller)</description>
      <verbose-description>The start command can be used to start any or all protocol servers.  To start
all of the servers, execute the start command with no paramters.  To bring up
individual servers, list them on the command line.
</verbose-description>
      <options>
        <option short-name="h" long-name="help">
          <description>show detailed help message</description>
        </option>
        <option short-name="u" long-name="username">
          <description>authenticate using the given user name</description>
          <argument name="USER">
          </argument>
        </option>
        <option short-name="p" long-name="password">
          <description>authenticate using the given password</description>
          <argument name="PASSWORD">
          </argument>
        </option>
        <option short-name="I" long-name="core-id">
          <description>use a specific core in config file (default: Core)</description>
          <argument name="CORE">
          </argument>
        </option>
        <option short-name="C" long-name="config-file">
          <description>use alternative repository configuration file</description>
          <argument name="FILEPATH">
          </argument>
        </option>
        <option short-name="n" long-name="no-daemon">
          <description>Do not detach from the terminal</description>
        </option>
      </options>
      <arguments>
        <argument required="no" multiple="no" name="server-uri">
          <description>If specified, set the running state of this server to 'on'.  This does not start the 4ss daemon</description>
        </argument>
      </arguments>
    </command>
    <command name="init">
      <description>Initialize the 4Suite repository</description>
      <verbose-description>Initialize the repository.  This involves reformatting the storage back end (e.g. Postgres database or FlatFile root directory) and then adding the core data structures. You will LOSE ALL DATA when you execute the init, unless you use the --update option.  You can only init on the machine on which the command is executed.  You must have write access to where the back end stores its data (e.g., your userid must be able to write to the Postgres database if the back end is Postgres).  You may be prompted for additional information to complete the init.</verbose-description>
      <example>Data Servers Dashboard</example>
      <options>
        <option short-name="h" long-name="help">
          <description>show detailed help message</description>
        </option>
        <option short-name="u" long-name="username">
          <description>authenticate using the given user name</description>
          <argument name="USER">
          </argument>
        </option>
        <option short-name="p" long-name="password">
          <description>authenticate using the given password</description>
          <argument name="PASSWORD">
          </argument>
        </option>
        <option short-name="I" long-name="core-id">
          <description>use a specific core in config file (default: Core)</description>
          <argument name="CORE">
          </argument>
        </option>
        <option short-name="C" long-name="config-file">
          <description>use alternative repository configuration file</description>
          <argument name="FILEPATH">
          </argument>
        </option>
        <option short-name="c" long-name="confirm">
          <description>Confirm before performing each sub-task.</description>
        </option>
        <option short-name="r" long-name="update">
          <description>Don't destroy the current repository, just update the data.</description>
        </option>
        <option short-name="o" long-name="repo-only">
          <description>Only create the bare repository (destroying any current one), and don't install any components. Only useful for development.</description>
        </option>
      </options>
      <arguments>
        <argument required="no" multiple="yes" name="components">
          <description>Specify which components to add/update in the repository. Allowed values are:

'Commands' - 4ss and 4ss_manager commands and documentation; these are needed to be able to use the 4ss and  4ss_manager command-line tools;
'Docs' - All 4Suite documentation;
'Servers' - The default FtRpc and Ftp Server;
'Demos' - The default 4Suite Repository Demonstration applications and the server to access them;
'Dashboard' - The web-based control panel for 4Suite;
'Data' - Commonly used 4Suite data and icons (required; must be  first component installed).</description>
        </argument>
      </arguments>
    </command>
    <command name="backup">
      <description>Create a low level backup of the entire system.</description>
      <verbose-description>Create a low level system backup of the entire repository
</verbose-description>
      <options>
        <option short-name="h" long-name="help">
          <description>show detailed help message</description>
        </option>
        <option short-name="u" long-name="username">
          <description>authenticate using the given user name</description>
          <argument name="USER">
          </argument>
        </option>
        <option short-name="p" long-name="password">
          <description>authenticate using the given password</description>
          <argument name="PASSWORD">
          </argument>
        </option>
        <option short-name="I" long-name="core-id">
          <description>use a specific core in config file (default: Core)</description>
          <argument name="CORE">
          </argument>
        </option>
        <option short-name="C" long-name="config-file">
          <description>use alternative repository configuration file</description>
          <argument name="FILEPATH">
          </argument>
        </option>
        <option short-name="e" long-name="exclude">
          <description>Exclude a path (and all children) from backup (multiple allowed)</description>
          <argument name="exclude">
          </argument>
        </option>
        <option short-name="d" long-name="directory">
          <description>Directory to backup too.</description>
          <argument name="directory">
          </argument>
        </option>
        <option short-name="m" long-name="modified-since">
          <description>Only backup files modified since specified ISO datetime</description>
          <argument name="modified-since">
          </argument>
        </option>
        <option short-name="q" long-name="quiet">
          <description>No extra output</description>
        </option>
        <option long-name="user-model">
          <description>Also dump the user model</description>
        </option>
        <option long-name="archive">
          <description>Create an archive (not all options will work on all platforms!!)</description>
          <argument name="archive">
            <value name="gztar">
              <description>gzip'ed tar-file</description>
            </value>
            <value name="ztar">
              <description>compressed tar file</description>
            </value>
            <value name="bztar">
              <description>bzip2'ed tar-file</description>
            </value>
            <value name="zip">
              <description>ZIP file</description>
            </value>
            <value name="tar">
              <description>uncompressed tar file</description>
            </value>
          </argument>
        </option>
      </options>
      <arguments>
        <argument required="no" multiple="yes" name="base-path">
          <description>Initial resources to start the backup at.</description>
        </argument>
      </arguments>
    </command>
    <command name="restart">
      <description>Restart the 4Suite server (controller)</description>
      <verbose-description>Restart the 4Suite server (controller).</verbose-description>
      <options>
        <option short-name="h" long-name="help">
          <description>show detailed help message</description>
        </option>
        <option short-name="u" long-name="username">
          <description>authenticate using the given user name</description>
          <argument name="USER">
          </argument>
        </option>
        <option short-name="p" long-name="password">
          <description>authenticate using the given password</description>
          <argument name="PASSWORD">
          </argument>
        </option>
        <option short-name="I" long-name="core-id">
          <description>use a specific core in config file (default: Core)</description>
          <argument name="CORE">
          </argument>
        </option>
        <option short-name="C" long-name="config-file">
          <description>use alternative repository configuration file</description>
          <argument name="FILEPATH">
          </argument>
        </option>
      </options>
    </command>
  </subcommands>
</application>
