Wednesday, April 02, 2008

GSAC Help Documents


USAGE: gsac-client --f[unction] {options}
ABOUT: This is a the front-end (client) interface for the GSAC.
It essentially provides a GSAC user with a "basic"
means of acquiring either information or actual data files
from a GSAC Retailer (specified via -r{etailer} )
matching the user's criteria.
FUNCTIONS: status {acquire basic information about given retailer}
count {display number of GSAC data records matching request}
info {retrieve and display GSAC data records matching request}
sites {retrieve and display GSAC monument records matching request}
data {retrieve actual data files matching request}
help {display this usage}
version {version of this executable}
OPTIONS:
--Operational Configuration Options--
--v[erbose] {Invoke verbose mode; Synonymous flags: --v or -v}
--q[uiet] {No stderr output whatsoever; Synonymous flags: --q or -q}
--debug {Turn on detailed debugging}
--r[etailer]
{Specify which GSAC Retailer Server to use. Can also be set
in $GSAC_RETAILER environment variable, where multiple
retailer hosts are separated by colons; Defaults
to :
#1 choice : gsac.ucsd.edu
#2 choice : gsac01.unavco.org
Synonymous flags: --r or -r}
--e[mail]
{Used for compatibility/identification purposes at most
public ftp servers; No default - attempts to collect
data from some ftp servers may fail without this option;
Can also be set in $GSAC_USER_EMAIL_ADDRESS
environment variable; Synonymous flags: --e or -e}
--un[compress] {Valid only with the "data" function; Indicates an attempt
will be made to uncompress fetched files before writing to filesystem;
Assumes "gzip" utility is available and in users $PATH environment
variable; Synonymous flags: --un or -un}
--unhat {Valid only with the "data" function; Indicates an attempt
will be made to remove "Hatanaka" rinex compression from rinex observation
files (whereever applicable) before writing to local filesystem;
Assumes "crx2rnx" utility is available and in users $PATH environment
variable; Synonymouc flags: --uh or -uh}
--du[plicates] {Valid only with the "data" function; Indicates duplicate
files from different wholesalers should be collected and written with
wholesaler prefixes; Synonymous flags: --du or -du}
--delim[iter] {Specify the character you wish to have output
fields delimited by; Default is "," (comma)}
--l[og] {Log transactions to file specified by $GSAC_LOG environment variable;
No default; Synonymous flags: --l or -l}
--offline-log-file
{Path to file containing references to offline data;
No default; Synonymous flags: --ol or -ol}
--output-directory
{Directory to write fetched files; Can also be set using
$GSAC_OUTPUT_DIRECTORY environment variable;
{Default: .; Synonymous flags: --od or -od}
--max-files <# files>
{Maximum number of files to fetch; Default: 10;
Synonymous flags: --mf or -mf}
--max-mb
{Maximum cumulative size of files to retrieve, in megabytes;
Default: 10; Synonymous flags: --mm or -mm}
--max-parallel-hosts <# hosts>
{Max number of hosts to collect files from in parallel;
Default: 10; Synonymous flags: --mph or -mph}
--max-parallel-requests <# requests>
{Maximum number of parallel file requests per host; Default: 3;
Synonymous flags: --mpr or -mpr}

--Query Constraint Options--
--d[ay] <3-digit day> {Day of data to consider; No default;
Synonymous flags: --d or -d}
--y[ear] <4-digit year> {Year of data to consider; No default;
Synonymous flags: --y or -y}
--start-year <4-digit startyear> {Earliest year of data to consider;
No default; Synonymous flags: --sy or -sy}
--start-day <3-digit startday> {Earliest day of data to consider;
No default; Synonymous flags: --sd or -sd}
--end-year <4-digit endyear> {Most recent year of data to consider;
No default; Synonymous flags: --ey or -ey}
--end-day <3-digit endday> {Most recent day of data to consider;
No default; Synonymous flags: --ed or -ed}
--data-type {Data type to consider; Default is all data types;
Can be used more than once; Synonymous flags: --t or -t}
--exclude-data-type {Data type to explicitly ignore;
No default; Can be used more than once; Synonymous flags: --xt or -xt}
--w[holesaler] {GSAC wholesaler to consider; Default
is all wholesalers; Can be used more than once;
Synonymous flags: --w or -w}
--exclude-wholesaler {GSAC wholesaler to explicitly ignore;
No default; Synonymous flags: --xw or -xw}
--site-id {Unique site identifier to consider;
Default is all sites/monuments; Can be used more than once;
Synonymous flags: --s or -s}
--exclude-site-id {Unique site identifier to
explicitly ignore; No default; Can be used more than once;
Synonymous flags: --xs or -xs}
--char-id {Site character identifier to consider;
Default is all sites/monuments; Can be used more than once;
Synonymous flags: --c or -c}
--exclude-char-id {Site character identifier to
explicitly ignore; No default; Can be used more than once;
Synonymous flags: --xc or -xc}
--b[ounding-box] {Bounding box in longitude latitude
decimal degrees; No default; Synonymous flags: --b or -b or --bb or -bb}
--pr[oximity] {Longitude,latitude in decimal degrees plus radius
in kilometers; No default; Synonymous flags: --pr or -pr}
DATA TYPES: rinex_obs, rinex_met, rinex_nav, raw_gps, igs_site_log, orbit_sp3, sinex


No comments: