source: branches/lib/HELP_SOURCE/source/console.hlp

Last change on this file was 19532, checked in by westram, 4 months ago
  • reintegrates 'help' into 'trunk'
    • tweak arb documentation:
      • automatically link
        • ticket references to arb bug tracker (only affects html version).
        • found URLs.
      • page titles
        • warn about long titles.
        • introduce SUBTITLEs (automatically triggered by multi-line titles in source files).
        • increase allowed length (limited by subwindow width).
      • cleanup header sections in all helpfiles.
      • fix and/or update several help files.
      • document syntax of help sources.
      • build issues:
        • when xml validation fails, next build no longer uses invalid xml ⇒ keeps failing.
        • remove output files on error (including files below ARBHOME/lib).
        • pipe output through logs to ensure proper wrapping in Entering/Leaving lines.
    • moves Tree admin + NDS menu entries to top of menu
  • adds: log:branches/help@18783:19531
File size: 1.6 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4
5#       sub topics:
6#SUB     subtopic.hlp
7
8# format described in ../help.readme
9
10
11TITLE           View ARB logs
12
13OCCURRENCE      ARB_NT/Tools/View ARB log
14                ARB_NT/Tools/View server log
15
16DESCRIPTION     "View ARB log" shows the logfile of the current arb session.
17
18                The logfile contains any output from ARB itself and
19                from some sub-processes, e.g.
20                 * diagnostic messages (e.g. 'trace' from LINK{aci.hlp})
21                 * errors not reported via GUI
22
23                "View server log" shows the logfile of all ptservers and nameservers
24                started from the current arb session.
25
26                    e.g. shows the detailed progress while building a ptserver
27
28                "View sysinfo" shows system information collected by arb about your system.
29
30NOTES           The log will be displayed using the shell command 'less'.
31
32                Pressing Ctrl-C in the log, will allow to use
33                         * page-up / page-down to traverse through the log
34                         * 'q' to quit and close the window
35
36SECTION         ARB session log archive
37
38                - all 3 files mentioned above are packed into session archives when arb terminates.
39                - the most recent session is linked in your home directory as ARB_last_session.tgz.
40                - all session log archives are stored in ~/.arb_prop/logs
41
42EXAMPLES        None
43
44WARNINGS        Only works if arb has been started via the script 'arb'
45                (which is the standard way to run arb).
46
47BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.