/extra/elf/nm/nm-docs.factor

 1! Copyright (C) 2010 Erik Charlebois.
 2! See http://factorcode.org/license.txt for BSD license.
 3USING: elf help.markup help.syntax ;
 4IN: elf.nm
 5
 6HELP: elf-nm
 7{ $values
 8    { "path" "a pathname string" }
 9}
10{ $description "Prints information about the symbols in the ELF object at the given path." } ;
11
12HELP: print-symbol
13{ $values
14    { "sections" "sequence of section" } { "symbol" symbol }
15}
16{ $description "Prints the value, section and name of the given symbol." } ;
17
18ARTICLE: "elf.nm" "ELF nm"
19"The " { $vocab-link "elf.nm" } " vocab prints the values, sections and names of the symbols in a given ELF file. In an ELF executable or shared library, the symbol values are typically their virtual addresses. In a relocatable ELF object, they are section-relative offsets."
20{ $subsections elf-nm }
21;
22
23ABOUT: "elf.nm"