Personal tools
You are here: Home Documentation Users Guide 1. Introduction 1.8 HELP
Document Actions

1.8 HELP

by rohan — last modified 2010-12-30 13:07

1.8.1 Examples and demonstrations

As discussed earlier in this chapter (Getting Started, GO files), the demonstrations that come with the Ferret distribution are a source of help. See the introductory chapter, section "Demonstration files," for a list of demonstrations, or look in $FER_DIR/examples; you may find something that addresses your problem.

1.8.2 Help from within Ferret

Typing "help" while running Ferret will show a list of commands that are useful for getting information from within Ferret.

The Ferret SHOW command is useful for getting information about Ferret's commands, and Ferret's current state.

  • The Ferret command SHOW COMMANDS will list all Ferret commands; SHOW COMMAND "command" will display all qualifiers for the specified command.
  • The Ferret command SHOW FUNCTIONS lists all Ferret functions and their arguemnts. SHOW FUNCTION *string* will show all functions containing the string "string". SHOW FUNCTIONS EXTERNAL shows the names and arguments of external functions (see External Functions Chapter).
  • The Ferret command SHOW TRANSFORMS lists all Ferret transforms, including variable transforms and regridding transforms.
  • The Ferret command SHOW DATA lists information about datasets that are currently open, or specify a single dataset.
  • The Ferret command SHOW VARIABLES lists information about user-defined variables that are in effect. SHOW VARIABLE varname lists information about a single variable.

If you want to get details on a script, type "GO/HELP scriptname" at the Ferret command line to see the documentation at the start of the script. For example:

GO/HELP land

When writing scripts, include documentation listing the purpose of the script and its arguments in the first few lines of the script. Then this feature will let you and others who may use the script get instant information about it.

1.8.3 Unix-based commands

The Ferret environment includes several Unix commands including Fdata for finding names and locations of datasets; Fgo for finding the names and location of scripts; Fpalette for names and locations of color palettes; and Fenv for listing the names and values of environment variables used by Ferret. These are described in the previous section.

1.8.4 Web-based information

From the Ferret web page, at see these sections:

1. Ferret support policy outlines the support available to users and sources of information.

2. FAQ section discusses many topics where questions often arise.

3. Email archives, which are search-able and contain questions and solutions from the Ferret users group.

4. Documentation section, including release notes, this manual which is updated regularly on the web, and on-line information on demonstration scripts, data formats, and the Plot Plus graphics used by Ferret.

Powered by Plone CMS, the Open Source Content Management System

This site conforms to the following standards: