| status | Get the status of a particular retailer. If you are having a problem using the client, use this function to make sure your Retailer is on-line. This option can also be used to find out what Advanced Options a particular retailer supports, such as Bounding Box. Use the '-r' option to select a retailer. Example: gsac-client -f status -r gsac.ucsd.edu. | |
| info | Information. Retrieve a list of records matching your query. Rather than downloading data, this option provides a list of URL's based on the results of your query. Relevant options for this function are -d, -y, -sy, -sd, -ey, -ed, -t, -s | |
| count | Display the number of GSAC records matching a query. It is a good idea to use this before downloading data to make sure you are not downloading 2,500,000 files (actually the -m options should protect you.) Relevant options for this function are simialar to the 'info' function. | |
| data | Fetch the data. Important options for this function are similar to those used in the 'info' function along with -e and -od. Data is downloaded into your current directory unless you use the -od (output directory) option. | |
| -h, --help | Help | |
| -f <function> | Function. REQUIRED. What function should be performed: status, count, info, or data. | |
| -t <data type> | Data Types to consider. Important option. Used to narrow your query to certain data types. See the section on Data Types for a list of data types. | |
| -xt <data type> | Data Types to ignore. | |
| -v, --verbose | Invoke verbose mode. Popular when using the client interactively. | |
| -q, --quiet | Quiet mode, no stderr output. Great for cron jobs. | |
| --debug | Debug mode, full libwww debugging. When you are having trouble, give this a try. | |
| -r, --retailer | Retailer hostname to query. Can also be set in a GSAC_RETAILER environment variable. Defaults to gsac.ucsd.edu. | |
| -e, --email <email address> | E-mail address used for compatibility and access to many public ftp servers. Some attempts to collect data may fail without this option set. Can be set in a GSAC_USER_EMAIL_ADDRESS environment variable. | |
| -l | Log transactions to GSAC_LOG set in environment. | |
| -ol <path> | Off-Line Data. Path to file containing off-line data. | |
| -od <directory> | Output directory. Directory to write fetched files rather than the current directory. Can also be set in the GSAC_OUTPUT_DIRECTORY environment variable. | |
| -mf <number> | Maximum Files. Maximum number of files to fetch. The default is 10. | |
| -mm <megabytes> | Maximum Megabytes. Maximum number of cumulative megabytes to fetch in one session. The default is 10MB. | |
| -mph <number> | Maximum Parallel Hosts. Maximum number of hosts to collect files from in parallel. The default is 10 hosts. | |
| -mpr <number> | Maximum Parallel Requests. Maximum number of parallel file requests to the same host. The default is 3 requests simulatenous requests. Be gentle. | |
| -d <3-digit day> | Day of year. Used to limit query. For example, to get data from the 45th day of the year, you would use '-d 045'. Of course, you also need to limit your search to a particular year, see '-y'. Three-digit days are popular in the GPS community. | |
| -y <4-digit year> | Year. Used to limit query. For example, to get data from the 45th day of the year, you would use '-d 045 -y 2002'. | |
| -sd <3-digit day> | Start Day. Used to limit query between a span of time. For example, to get data from the 45th day of the year through the 47th day of the year, you would use '-sd 045 -ed 047'. | |
| -sy <4-digit year> | Start Year. Used to limit query between a time span. You should also use the End Year (-ey) option. | |
| -ed <3-digit day> | End Day. Used to limit query between a span of time. For example, to get data from the 45th day of the year through the 47th day of the year, you would use '-sd 045 -ed 047'. | |
| -ey <4-digit year> | End Year. Used to limit query between a time span. You should also use the Start Year (-sy) option. Searches including many years will probably be for information versus gathering data. | |
| -w <wholesaler> | Wholesaler. Used to limit query to a certain wholesaler. | |
| -xw <wholesaler> | Wholesaler to ignore. Used to ignore a certain wholesaler. | |
| -s <wholesaler> | Unique Site Id. Unique site identifier to consider in a query. (NOTE: use the Get Single Site Information utility to get the SOPAC site ID for a four-character site code.) | |
| -xs <wholesaler> | Unique Site Id to Ignore. | |
| -bb <x1,y1,x2,y2> | Bounding Box. Bounding box in longitude latitude decimal degree used to limit the query to a particular area. This is an Advanced Option available at certain Retailers. Use the Status function to find out if a retailer supports Bounding_Box. | |
