EMBOSS: servertell

| servertell

## Wiki

The master copies of EMBOSS documentation are available at http://emboss.open-bio.org/wiki/Appdocs on the EMBOSS Wiki.

Please help by correcting and extending the Wiki pages.

## Function

Display information about a public server

## Description

servertell displays on-screen information on a server with the specific ID. Optionally, the information may be written to an output file in plain text or HTML.

## Usage

Here is a sample session with servertell

    % servertell srs
    Display information about a public server

    # srs is defined in standard
    # access levels id: Yes query: Yes all: Yes
    # scope: text
    # cache file: /homes/user/local/share/EMBOSS/server.srs
    # databases: 21

    SERVER srs [
       method:         "srswww"
       type:           "unknown"
       cachefile:      "server.srs"
       comment:        "SRS from EBI"
       serverversion:  "7.1.3"
       url:            "http://srs.ebi.ac.uk/srsbin/cgi-bin/wgetz"
    ]

## Command line arguments

    Display information about a public server
    Version: EMBOSS:6.5.6.0

       Standard (Mandatory) qualifiers:
      [-server]            string     The name of the server defined locally for
                                      use by EMBOSS. (Any string)

       Additional (Optional) qualifiers:
       -full               boolean    [N] The default behaviour is to report for
                                      relevant servers only basic information from
                                      the EMBOSS server definition
       -outfile            outfile    [stdout] Output file name

       Advanced (Unprompted) qualifiers: (none)
       Associated qualifiers:

       "-outfile" associated qualifiers
       -odirectory         string     Output directory

       General qualifiers:
       -auto               boolean    Turn off prompts
       -stdout             boolean    Write first file to standard output
       -filter             boolean    Read first file from standard input, write
                                      first file to standard output
       -options            boolean    Prompt for standard and additional values
       -debug              boolean    Write debug output to program.dbg
       -verbose            boolean    Report some/full command line options
       -help               boolean    Report command line options and exit. More
                                      information on associated and general
                                      qualifiers can be found with -help -verbose
       -warning            boolean    Report warnings
       -error              boolean    Report errors
       -fatal              boolean    Report fatal errors
       -die                boolean    Report dying program messages
       -version            boolean    Report version number and exit

Qualifier | Type | Description | Allowed values | Default
--- | --- | --- | --- | ---
Standard (Mandatory) qualifiers
[-server] (Parameter 1) | string | The name of the server defined locally for use by EMBOSS. | Any string |
Additional (Optional) qualifiers
-full | boolean | The default behaviour is to report for relevant servers only basic information from the EMBOSS server definition | Boolean value Yes/No | No
-outfile | outfile | Output file name | Output file | stdout
Advanced (Unprompted) qualifiers
(none)
Associated qualifiers
"-outfile" associated outfile qualifiers
-odirectory | string | Output directory | Any string |
General qualifiers
-auto | boolean | Turn off prompts | Boolean value Yes/No | N
-stdout | boolean | Write first file to standard output | Boolean value Yes/No | N
-filter | boolean | Read first file from standard input, write first file to standard output | Boolean value Yes/No | N
-options | boolean | Prompt for standard and additional values | Boolean value Yes/No | N
-debug | boolean | Write debug output to program.dbg | Boolean value Yes/No | N
-verbose | boolean | Report some/full command line options | Boolean value Yes/No | Y
-help | boolean | Report command line options and exit. More information on associated and general qualifiers can be found with -help -verbose | Boolean value Yes/No | N
-warning | boolean | Report warnings | Boolean value Yes/No | Y
-error | boolean | Report errors | Boolean value Yes/No | Y
-fatal | boolean | Report fatal errors | Boolean value Yes/No | Y
-die | boolean | Report dying program messages | Boolean value Yes/No | Y
-version | boolean | Report version number and exit | Boolean value Yes/No | N

## Input file format

None.

## Output file format

servertell outputs a report of a server configuration.

## Data files

None.

## Notes

None.

## References

None.

## Warnings

None.

## Diagnostic Error Messages

None.

## Exit status

It always exits with status 0.

## Known bugs

None.

## See also

Program name | Description
--- | ---
cachedas | Generate server cache file for DAS servers or for the DAS registry
cachedbfetch | Generate server cache file for Dbfetch/WSDbfetch data sources
cacheebeyesearch | Generate server cache file for EB-eye search domains
cacheensembl | Generate server cache file for an Ensembl server
dbtell | Display information about a public database
showdb | Display information on configured databases
showserver | Display information on configured servers

## Author(s)

Peter Rice
European Bioinformatics Institute, Wellcome Trust Genome Campus, Hinxton, Cambridge CB10 1SD, UK

Please report all bugs to the EMBOSS bug team (emboss-bug © emboss.open-bio.org) not to the original author.

## History

## Target users

This program is intended to be used by everyone and everything, from naive users to embedded scripts.

## Comments

None