; LDasm - Helpfile
;
; Format:
;
; [l:<name>]       - Destination-link for an anchor
; [a:<name>]<text> - Anchor
; [t]<text>        - Title
; [s]<text>        - Section-label
; [i:<filename>]   - Insert image (complete path: 'RCPath'/<filename>)
; [p]              - Line-break
;
[l:Top]
[t]LDasm Help

;-----------------------------------------------------------------------------
; Table of content
;-----------------------------------------------------------------------------
[a:General]1.General
[a:General_What]  1.1.What is LDasm ?
[a:General_History]  1.2 History
[a:General_Bugs]  1.3.Known bugs
[a:General_Mail]  1.4.Bugs
[a:General_Future]  1.5.Maybe in the future
[a:General_Copyleft]  1.6.Copyright

[a:Menu]2.Menu-commands
[a:Menu_Disassembler]  2.1."Disassembler"
[a:Menu_Project]  2.2."Project"
[a:Menu_Search]  2.3."Search"
[a:Menu_Goto]  2.4."Goto"
[a:Menu_Exec]  2.5."Execute Text"
[a:Menu_Funcs]  2.6."Functions"
[a:Menu_Data]  2.7."HexData" (Not supported yet)
[a:Menu_Refs]  2.8."Refs"
[a:Menu_Help]  2.9."Help"

[a:Src]3.The Source
[a:Src_Normal]  3.1.A normal line selected
[a:Src_Jmp]  3.2.Line with a call or jump selected
[a:Src_Ref]  3.3.Addressed referenced by another
[a:Src_Str]  3.4.A reference to a specific address and a string
[a:Src_Func]  3.5.A exported function

[a:Tut]4.Small Tutorial

;-----------------------------------------------------------------------------
; General
;-----------------------------------------------------------------------------
[l:General]
[t]1. General

[l:General_What]
[s]1.1. What is LDasm ?
LDasm (Linux Disassembler) is a Perl/Tk-based GUI for objdump/binutils that
tries to imitate the look'n'feel of W32Dasm. It searchs for cross-references
(e.g. strings), converts the code from GAS to a MASM-like style, traces
programs and much more.

[l:General_History]
[s]1.2. History
See CHANGE_LOG.

[l:General_Bugs]
[s]1.3. Known bugs
* No real clipboard

[l:General_Mail]
[s]1.4. Bugs
If a error occured then please write a small bug-report, describe what happend
and maybe how i can reproduce it. Mail it to "ravemax@dextrose.com", but
please don't attach huge files.

[l:General_Future]
[s]1.5. Maybe in the future
Port to C++/QT.
Ideas are welcome.

[l:General_Copyleft]
[s]1.6. Copyright
LDasm is copyright (C) 2000-2 Ravemax <ravemax@dextrose.com> and is published
under the GPL2 (see COPYING for details).

[a:Top](back to top)

;-----------------------------------------------------------------------------
; The Menu
;-----------------------------------------------------------------------------
[l:Menu]
[t]2. Menu-commands

[l:Menu_Disassembler]
[s]2.1. "Disassembler"
[i:icons/open]
"Open File to Disassemble"

   Displays a file-dialog where you can select a file to disassemble.

[i:icons/save]
"Save Disassembly Text File"

   Saves the assembler-listing into a ".alf"-textfile and LDASM-specific
   informations into a ".lpj"-projectfile. Any trace-informations aren't
   saved.

"HTML-Export"

   Exports the whole listing or a part as HTML-file. If you applied a trace-
   file, it will show up in the HTML.

"Apply Trace file"

   Reads a from ptrace (read the "README" for more informations on the tracer)
   file and highlights affected addresses.

[i:icons/copy]
"Copy Selected Line"

   Prints the selected line to stdout.

"Exit"

   Bye!

[l:Menu_Project]
[s]2.2. "Project"
"Open Disassembled File"

   Opens a previously created project-file (".lpj"). Note that the listing
   must be in the same directory as the projectfile.

[l:Menu_Search]
[s]2.3. "Search"
"Search"

   Searchs for a user-defined pattern.

"Find Next"

   Jumps to the next search-result.

"Show result-window"

   Unhides the search-result window. Available only if checked in "Search"-
   Dialog.

[l:Menu_Goto]
[s]2.4. "Goto"
[i:icons/gotocode]
"Goto Code Start"

   Seeks to the code-start (".init").

[i:icons/gotoentry]
"Goto Program Entry Point"

   Seeks to the entry-point (".text").

[i:icons/gotoloc]
"Goto Code Location"

   Seeks to a user-defined code-address.

[l:Menu_Exec]
[s]2.5. "Execute Text"
[i:icons/jump]
"Execute Jump"

   Simulates a jump. Only available if the selected line contains a jump-op.

[i:icons/retjmp]
"Return From Last Jump"

   Undo the last jump if possible.

[i:icons/call]
"Execute Call"

   Simulate a call. Only available if the selected line contains a call-op.

[i:icons/retcall]
"Return From Call"

   Undo the last call if possible.

[l:Menu_Funcs]
[s]2.6. "Functions"
[i:icons/functions]
"Imports"

   Displays a dialog with all "imported functions".

[i:icons/exports]
"Exports"

   Displays a dialog with all "exported functions".

[i:icons/internal]
"Internals"

   Displays a dialog with all "internal functions".

[l:Menu_Data]
[s]2.7. "HexData" (Not supported yet)

[l:Menu_Refs]
[s]2.8. "Refs"
[i:icons/strings]
"String Data References"

   Displays a dialog with all "string-references".

[l:Menu_Help]
[s]2.9. "Help"
"Content"

   Shows the FM.

"About"

   Doesn't every application have one...

[a:Top](back to top)

;-----------------------------------------------------------------------------
; The source
;-----------------------------------------------------------------------------
[l:Src]
[t]3.The Source

[l:Src_Normal]
[s]3.1. A normal line selected
[i:pics/src_nojump]
[p]

[l:Src_Jmp]
[s]3.2. Line with a call or jump selected
[i:pics/src_jump]
[p]

[l:Src_Ref]
[s]3.3. Addressed referenced by another
[i:pics/src_refby]
[p]

[l:Src_Str]
[s]3.4. A reference to a specific address and a string
[i:pics/src_imp_n_str]
[p]

[l:Src_Func]
[s]3.5. A exported function
[i:pics/src_exported]
[p]

[l:Src_Trace]
[s]3.6. Address after applying a trace-file
[i:pics/src_trace]
[p]

[a:Top](back to top)

;-----------------------------------------------------------------------------
; Tutorial
;-----------------------------------------------------------------------------
[l:Tut]
[t]4. Small Tutorial

Maybe later, LDasm should be self-explaining.

[a:Top](back to top)
