wossname

wossname

---

wossname finds programs by keywords in their one-line documentation.

Here are some sample sessions with wossname:

Search for programs with "restrict" in their description:

% wossname restrict

Display a listing of programs in their groups:

% wossname -search ''

Display an alphabetic listing of all programs:

% wossname -search '' -alphabetic

Display only the groups that the programs can belong to:

% wossname -search '' -groups

Output html tags around the list of program groups:

% wossname '' -groups -html -prelink '#'

Output html tags around the list of programs:

% wossname '' -html -prelink 'http://www.sanger.ac.uk/Software/EMBOSS/Apps/'  -postlink '.shtml'

Mandatory qualifiers:

[-search] (string)

Enter a word or words here to perform a case-independent search of the one-line documentation provided by all EMBOSS programs. If no keyword is specified, all programs are listed.

Optional qualifiers (bold if not always prompted):

-explode (boolean)

The groups EMBOSS applications belong to have two forms: exploded and non- exploded. The exploded group names are more numerous and often more vaguely phrased than the non-exploded ones. The exploded names are formed from definitions of the group names that start in the form NAME1:NAME2 and are then expanded into many combinations of the names, such as: NAME1, NAME2, NAME1 NAME2, NAME2 NAME1. The non-expanded names are simply listed as: NAME1 NAME2. Using exploded group names finds many more programs that share at least some of the exploded names. More programs will be reported as sharing a similar function if you use use non-exploded names.

-outfile (outfile)

If you enter the name of a file here, this program will write the program names and brief descriptions into that file.

-html (boolean)

If you are sending the output to a file, this qualifier will format it for displaying as a table in a WWW document.

-prelink (string)

If you are outputting to a file in HTML format, you can make the program names into hyperlinks by setting this qualifier to be the first half of the URL. If you want the program name to be a hyperlink to the URL http://www.uk.embnet.org/Software/EMBOSS/Apps/programname.html, enter http://www.uk.embnet.org/Software/EMBOSS/Apps/ to set the first half of the URL before the program name.

-postlink (string)

If you are outputting to a file in HTML format, you can make the program names into hyperlinks by setting this qualifier to be the second half of the URL. If you want the program name to be a hyperlink to the URL: http://www.uk.embnet.org/Software/EMBOSS/Apps/programname.html, enter .html to set the second half of the URL after the program name.

-groups boolean

If you use this option, only the group names will output to the file.

-alphabetic boolean

If you use this option, you will get a single list of the program names and descriptions instead of the programs being listed in their functional groups.

Advanced qualifiers:

-[no]emboss (boolean)

If you use this option, EMBOSS program documentation is searched. If this option is set to be false, only the EMBASSY programs are searched (if the -embassy option is true). EMBASSY programs are not strictly part of EMBOSS, but use the same code libraries and share the same look and feel. These programs are generally developed by people who want their programs to be outside of the GNU Public License scheme, i.e., they may want to charge a license fee.

-[no]embassy (boolean)

If you use this option, EMBASSY program documentation is searched. If this option is set to be false, only the EMBOSS programs will be searched (if the -emboss option is true). EMBASSY programs are not strictly part of EMBOSS, but use the same code libraries and share the same look and feel, but are generally developed by people who want the programs to be outside of the GNU Public License scheme, i.e., they may want to charge a license fee.

-colon (boolean)

The groups EMBOSS applications belong to may have up to two levels For example, the primary group ALIGNMENT has several sub-groups, or second-level groups: CONSENSUS, DIFFERENCES, DOT PLOTS, GLOBAL, LOCAL, and MULTIPLE. To aid programs that parse the output of seealso (and require the names of these subgroups), a colon is placed between the first and second level of the group name if this option is true.

-gui boolean

This option is intended to help those who are designing Graphical User Interfaces (GUIs) to the EMBOSS applications. Some EMBOSS programs are inappropriate for running in a GUI, these include other menu programs and interactive editors. This option allows you to report only those programs that can be run from a GUI.