source: branches/tree/HELP_SOURCE/source/xterm.hlp

Last change on this file was 18766, checked in by westram, 3 years ago
  • move two helpfiles (test).
File size: 1.5 KB
Line 
1#Please insert up references in the next lines (line starts with keyword UP)
2UP      arb.hlp
3UP      glossary.hlp
4
5#Please insert subtopic references  (line starts with keyword SUB)
6#SUB    subtopic.hlp
7
8# Hypertext links in helptext can be added like this: LINK{ref.hlp|http://add|bla@domain}
9
10#************* Title of helpfile !! and start of real helpfile ********
11TITLE           Start a console
12
13OCCURRENCE      ARB_NT/Tools/Start XTERM
14
15DESCRIPTION     Starts a console window from ARB.
16
17                The shell in the console uses the same environment as the running arb session.
18                From this environment you may call perl-scripts
19                     - delivered with ARB (e.g. in $ARBHOME/PERL_SCRIPTS) or
20                     - your own scripts.
21
22                The main reason for the execution environment is the ability to easily access the
23                database currently loaded into ARB.
24
25NOTES           The console window is started in the same way
26                as done to call external tools (like RAxML).
27
28                See ARB_XTERM in LINK{arb_envar.hlp} to customize the
29                way arb starts consoles.
30
31EXAMPLES        of existing scripts:
32
33                * listMarkedSpecies.pl (save names of currently marked species to a textfile)
34                * markSpecies.pl (mark species according to content of a textfile)
35                * arb_read_tree (import tree from newick treefile)
36
37WARNINGS        None
38
39BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.