USAGE for get_helix_binaries.sh v1.6.0: get_helix_binaries.sh [-r <HelixMajorVersion>] [-b <Binary1>,<Binary2>,...] [-api] [-sbd <StageBinDir>] [-n] [-d|-D] or get_helix_binaries.sh -h|-man DESCRIPTION: This script acquires Perforce Helix binaries from the Perforce FTP server. The four Helix binaries that can be acquired are: * p4, the command line client * p4d, the Helix Core server * p4p, the Helix Proxy * p4broker, the Helix Broker In addition, P4API, the C++ client API, can be downloaded. This script gets the latest patch of binaries for the current major Helix version. It is intended to acquire the latest patch for an existing install, or to get initial binaries for a fresh new install. It must be run from the /hxdepots/sdp/helix_binaries directory (or similar; the /hxdepots directory is the default but is subject to local configuration). The helix_binaries directory is used for staging binaries for later upgrade with the SDP 'upgrade.sh' script (documented separately). This helix_binaries directory is used to stage binaries on the current machine, while the 'upgrade.sh' script updates a single SDP instance (of which there might be several on a machine). The helix_binaries directory may not be in the PATH. As a safety feature, the 'verify_sdp.sh' will report an error if the 'p4d' binary is found outside /p4/common/bin in the PATH. The SDP 'upgrade.sh' check uses 'verify_sdp.sh' as part of its preflight checks, and will refuse to upgrade if any 'p4d' is found outside /p4/common/bin. When a newer major version of Helix binaries is needed, this script should not be modified directly. Instead, get the latest version of SDP first, which will included a newer version of this script, as well as the latest 'upgrade.sh' The 'upgrade.sh' script is updated with each major SDP version to be aware of any changes in the upgrade procedure for the corresponding p4d version. Upgrading SDP first ensures you have a version of the SDP that works with newer versions of p4d and other Helix binaries. PLATFORM DETECTION The 'uname' command is used to determine the architecture for the current machine on which this script is run. This script and supporting P4*.json release list files know what platforms for which builds are available for each Helix Core binary (p4, p4d, p4broker, p4p). If the 'jq' utility is available, this script uses the P4*.json files to verify that a build is available for the current platform, and in some cases selects an alternate platform. For example, if the detected platform is for OSX 12+ for the x86_64 architecture, no build is available for binaries such as p4d for that platform, so a compatible alternative is used instead, in this case macosx1015x86_64. This script handles only the UNIX/Linux platforms (to include OSX). RELEASE LIST FILES: For each binary, there is a corresponding release list file (in json format) that indicates the platforms available for the given binary. These files are: P4.json (for the 'p4' binary) P4D.json (for the 'p4d' binary) P4Broker.json (for the 'p4broker' binary) P4Proxy.json (for the 'p4p' binary) These P4*.json release list files are aware of a wide list of supported platforms for a range of Helix Core binaries. These release list files are packaged with the SDP, and updated for each major release. OPTIONS: -r <HelixMajorVersion> Specify the Helix Version, using the short form. The form is rYY.N, e.g. r21.2 to denote the 2021.2 release. The default: is r24.1 -b <Binary1>[,<Binary2>,...] Specify a comma-delimited list of Helix binaries. The default is: p4 p4d p4broker p4p Alternately, specify '-b none' in conjunction with '-api' to download only APIs and none of the p4* binaries. -api Specify '-api' to download P4API, the C++ client API. This will acquire one or more client API tarballs, depending on the current platform. The API files will look something like these examples: * p4api-glibc2.3-openssl1.1.1.tgz * p4api-glibc2.3-openssl3.tgz * p4api-glibc2.12-openssl1.1.1.tgz * p4api-glibc2.12-openssl3.tgz * p4api-openssl1.1.1.tgz * p4api-openssl3.tgz All binaries that match 'p4api*tgz' in the relevant directory on the Perforce FTP server for the current architecture and Helix Core version are downloaded. Unlike binary downloads, the old versions are not checked, because file names are fixed as they are with binares. APIs are not needed for normal operations, and are only downloaded if requested with the '-api' option. They may be useful for developing custom automation such as custom triggers. Be warned, custom triggers are not supported by Perforce Support. -sbd <StageBinDir> Specify the staging directory to install downloaded binaries. By default, this script downloads files into the current directory, which is expected and required to be /p4/sdp/helix_binaries. Documented workflows for using this script involve first cd'ing to that directory. Using this option disables the expected directory check and allows binaries to be installed in any directory. This option also sets the location in which this script searches for the P4*.json release list files. -n Specify the '-n' (No Operation) option to show the commands needed to fetch the Helix binaries from the Perforce FTP server without attempting to execute them. -d Set debugging verbosity. -D Set extreme debugging verbosity using bash 'set -x' mode. Implies '-d'. HELP OPTIONS: -h Display short help message -man Display this manual page EXAMPLES: Note: All examples assume the SDP is in the standard location, /hxdepots/sdp. Example 1 - Typical Usage with no arguments: cd /hxdepots/sdp/helix_binaries ./get_helix_binaries.sh This acquires the latest patch of all 4 binaries for the r24.1 release (aka 2024.1). This will not download APIs, which are not needed for general operation. Example 2 - Specify the major version: cd /hxdepots/sdp/helix_binaries ./get_helix_binaries.sh -r r21.2 This gets the latest patch of for the 2021.2 release of all 4 binaries. Note: Only supported Helix binaries are guaranteed to be available from the Perforce FTP server. Note: Only the latest patch of any given binary is available from the Perforce FTP server. Example 3 - Get r22.2 and skip the proxy binary (p4p): cd /hxdepots/sdp/helix_binaries ./get_helix_binaries.sh -r r22.2 -b p4,p4d,p4broker Example 4 - Download r23.1 binaries in a non-default directory. cd /any/directory/you/want ./get_helix_binaries.sh -r r23.1 -sbd . or: ./get_helix_binaries.sh -r r23.2 -sbd /any/directory/you/want Example 5 - Download C++ client API only: ./get_helix_binaries.sh -r r24.1 -b none -api DEPENDENCIES: This script requires outbound internet access. Depending on your environment, it may also require HTTPS_PROXY to be defined, or may not work at all. If this script doesn't work due to lack of outbound internet access, it is still useful illustrating the locations on the Perforce FTP server where Helix Core binaries can be found. If outbound internet access is not available, use the '-n' flag to see where on the Perforce FTP server the files must be pulled from, and then find a way to get the files from the Perforce FTP server to the correct directory on your local machine, /hxdepots/sdp/helix_binaries by default. EXIT CODES: An exit code of 0 indicates no errors were encountered. An non-zero exit code indicates errors were encountered.
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#14 | 30912 | C. Thomas Tyler | Updated generated script man pages. | ||
#13 | 30384 | C. Thomas Tyler | Updated generated script man pages. | ||
#12 | 30291 | C. Thomas Tyler | Updated generated script man pages. | ||
#11 | 30030 | C. Thomas Tyler | Updated generated script man pages. | ||
#10 | 29610 | C. Thomas Tyler | Updated generated script man pages. | ||
#9 | 29250 | C. Thomas Tyler | Updated generated script man pages. | ||
#8 | 28987 | C. Thomas Tyler | Updated generated script man pages. | ||
#7 | 28839 | C. Thomas Tyler | Updated generated script man pages. | ||
#6 | 28410 | C. Thomas Tyler | Updated generated script man pages. | ||
#5 | 27899 | C. Thomas Tyler | Updated generated script man pages. | ||
#4 | 27724 | C. Thomas Tyler | Updated generated script man pages. | ||
#3 | 27524 | C. Thomas Tyler | Updated generated script man pages. | ||
#2 | 27052 | C. Thomas Tyler | Updated generated script man pages. | ||
#1 | 27041 | Robert Cowham |
Windows Guide directly includes chunks of the Unix guide for replication etc, with a little ifdef to avoid Unix only comments. Fix Makefile and add missing generated man page. |