hms_ts_setup.sh.man.txt #1

USAGE for hms_ts_setup.sh v3.2.0:

hms_ts_setup.sh -i <instance1>[,<instance2>...] [-y] [-L <log>] [-n] [-debug|-D]

or

hms_ts_setup.sh [-h|-man|-V]


DESCRIPTION:
	The HMS "Tight Ship" setup script installs 
	HMS server, or adds an 'hms' SDP instance to an existing SDP
	installation.  into a tight-ship style installation on the master
	server machine.

	This is best done immediately after a running the SDP install_sdp.sh
       	script to initialize the hms instance on a dedicated p4hms machine
	with no data.

	A tight ship installation is one in which:
	* The key SDP folders, e.g. /p4/common and /p4/N/bin (for
	each instance) are versioned locally using SDP.<hostname>
	workspaces in a local HMS instance, /p4/hms, which this script
	creates and initializes.

	* The crontab for the Perforce user is versioned.

	* Any local configuration and/or customizations of the SDP
	are versioned.

	* The HMS instance is aware of The Workshop, a public
	P4 Server hosted by Perforce Software.  It fetches SDP
	updates from The Workshop into the local hms instance using
	P4 native DVCS features.

	This simplifies future updates of the SDP, allowing them
	to be done with a 'p4 fetch' followed by a 'p4 merge'
	on your local server (if the server can reach The
	Workshop directly; if not an alternative
	approach using an interim personal repo can be used to
	bridge 'air gap' networks).

PRE-REQUISITES:
	The following are pre-requisites to running hms_ts_setup.sh:

	1. The SDP install_sdp.sh script must have been run to create
	the hms instance.

ADDITIONAL SETUP:
	The following setup is necessary before operating in a tight
	ship environment, but are not necessary before running this
	script.

	1. The SSH keys must be configured enabling the 'perforce' user
	to ssh without a password to all machines listed in sdp_hosts.cfg
	configured above, including the current host (i.e. it must be
	able to ssh to itself using the current hostname).

OPTIONS:
 -i <instance1>[,<instance2>...]
 	Specify a comma-delimited list of SDP instances to manage.

 -y	Continue past the preflight without an interactive prompt.

 -d <sdp_dir>
	Specify the root of the directory tree where the SDP package
	is available.  The default is: 

	The version of the SDP installed must be recent enough to
	contain the 'hms' setup directory:
	/Server/Unix/setup/hms.

 -s	Specify '-s' if sudo access is available.  If sudo access
	is available, HMS can manage more things than it can without
	sudo access, e.g. Swarm.

	Adding '-s' adds a preflight check to verify sudo access.

 -d	Set debug verbosity.

 -L <log>
	Specify the path to a log file, or the special value 'off' to disable
	logging.  By default, all output (stdout and stderr) goes to:
	/Users/ttyler/hms_ts_setup.<timestamp>.log

	NOTE: This script is self-logging.  That is, output displayed on the screen
	is simultaneously captured in the log file.  Do not run this script with
	redirection operators like '> log' or '2>&1', and do not use 'tee.'

 -n	No-Op.  Prints commands instead of running them.

 -D     Use bash 'set -x' extreme debugging verbosity. Implies -d.

HELP OPTIONS:
 -h	Display short help message
 -man	Display man-style help message
 -V	Dispay version info for this script and its libraries.

FILES:

EXAMPLES: