Annotation of hatari/tools/debugger/gst2ascii.1, revision 1.1.1.3

1.1       root        1: .\" Hey, EMACS: -*- nroff -*-
                      2: .\" First parameter, NAME, should be all caps
                      3: .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
                      4: .\" other parameters are allowed: see man(7), man(1)
1.1.1.3 ! root        5: .TH "GST2ASCII" "1" "2017-11-11" "Hatari" "Hatari utilities"
1.1       root        6: .SH "NAME"
1.1.1.3 ! root        7: gst2ascii \- Filter and output Atari program symbol table as ASCII
1.1       root        8: .SH "SYNOPSIS"
                      9: .B gst2ascii
                     10: .RI  [options]
                     11: .RI  <program>
                     12: .SH "DESCRIPTION"
1.1.1.3 ! root       13: \fIgst2ascii\fP reads (GNU-style a.out or traditional DRI/GST) symbol
        !            14: table from given Atari program and outputs it in the ASCII format
        !            15: understood by Hatari debugger and its profiler data post-processor
        !            16: (latter doesn't accept any other format).
1.1       root       17: .PP
1.1.1.3 ! root       18: All symbol addresses output by the tool are TEXT relative, so
        !            19: when loading them in Hatari debugger, one needs to give just TEXT
        !            20: as offset for the 'symbols' command.
        !            21: .PP
        !            22: There are some options for filtering the symbol table content, and
        !            23: the resulting ASCII output is easy to edit also by hand, in case other
        !            24: symbols (e.g. loop labels) need to be removed from it, or missing
        !            25: function symbols need to be added to it.
1.1       root       26: .SH "OPTIONS"
                     27: .TP
1.1.1.3 ! root       28: \fB-a\fP
        !            29: Filter absolute (= value, not address) symbols out from the output.
1.1       root       30: .TP
                     31: \fB-b\fP
                     32: Filter BSS symbols out from the output.
                     33: .TP
1.1.1.3 ! root       34: \fB-d\fP
1.1       root       35: Filter DATA symbols out from the output.
                     36: .TP
                     37: \fB-t\fP
                     38: Filter TEXT symbols out from the output.
                     39: .TP
                     40: \fB-l\fP
                     41: Filter local (.L*) symbols out.  Usually they're useless because
                     42: they don't have names, just numbers.
                     43: .TP
                     44: \fB-o\fP
                     45: Filter symbols for object files (*.o) out.
1.1.1.3 ! root       46: .TP
        !            47: \fB-n\fP
        !            48: Sort symbol output by symbol name, not by their addresses.
1.1.1.2   root       49: .SH "NOTES"
                     50: If you have problems, try with 'nm -n <program>' instead
                     51: (Atari or cross-compiler version). If \fInm\fP works,
                     52: but \fIgst2ascii\fP doesn't, please report a bug on it.
1.1       root       53: .SH "EXAMPLES"
                     54: Save 'program.prg' symbol table in ASCII format with
                     55: local symbols filtered out:
                     56: .br
                     57:        gst2ascii -l program.prg > program.sym
1.1.1.2   root       58: .PP
                     59: Load generated ASCII symbols file in Hatari debugger:
                     60: .br
                     61:        symbols program.sym TEXT DATA BSS
1.1       root       62: .SH "SEE ALSO"
                     63: .IR hatari (1),
                     64: .IR hatari_profile (1)
                     65: .SH "AUTHOR"
                     66: Written by Eero Tamminen <oak at helsinkinet fi>.
                     67: .SH "LICENSE"
                     68: This program is free software; you can redistribute it and/or modify
                     69: it under the terms of the GNU General Public License as published by
                     70: the Free Software Foundation; either version 2 of the License, or (at
                     71: your option) any later version.
                     72: .SH "NO WARRANTY"
                     73: This program is distributed in the hope that it will be useful, but
                     74: WITHOUT ANY WARRANTY; without even the implied warranty of
                     75: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
                     76: General Public License for more details.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.