3.1. Application Documentation

3.1.1. Online Documentation

As a user of EMBOSS you will need to familiarise yourself with the applications. Documentation is available for the application groups (see below), EMBASSY packages and, of course, the applications themselves. Documentation is available for the CVS (Developers) Release and major versions of the Stable Release: Application Groups

All applications are organised into logical groups according to their function. For descriptions of the groups see Section B.2, “Application Groups (release R6)”. EMBASSY Packages

An EMBASSY package groups together applications of related functionality that are kept separate from EMBOSS either for convenience or because difference licensing conditions are in effect. For descriptions of the packages see Section B.3, “EMBASSY Packages (release R6)”. Applications

The documentation includes usage examples, which give the command line session and example input and output files for typical uses of the application. EMBOSS contains many applications and this can be daunting at first. A guide to navigating the documentation is given later (Section 3.2, “Navigating the Application Documentation”).

See the following tables:

3.1.2. AJAX Command Definition (ACD) Language

Each application has a complete description of its command line interface given in its ACD (AJAX Command Definition) file. The ACD file defines all the information the application needs to run and how it will behave at the command line, It controls such things as default values and whether the user is prompted for parameter values. ACD files are written in the ACD language, designed specifically for EMBOSS.

Users of EMBOSS normally need not concern themselves with the ACD file at all. In some cases, especially where you want to customise the applications you use, for instance, changing default values or input sequence types, some familiarity with the syntax is very helpful. The syntax is described in detail in the EMBOSS Developers Guide.

3.1.3. Interfaces

There are many interfaces (Section 7.1, “Introduction”) to EMBOSS which you might wish to use as an alternative to the command line. There are in-depth guides to two popular interfaces: