From b1307d12b8284108c9fbbbe03a5574264036b7f5 Mon Sep 17 00:00:00 2001 From: Patrick Quist Date: Tue, 24 Nov 2020 00:30:46 +0100 Subject: [PATCH] Update README.md --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9e00144..f170935 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -# asm-parser \ No newline at end of file +# asm-parser + +Categorises and filters assembly in a way that's understood by Compiler Explorer. + +Possible filters as command line parameters: + +* `-binary` changes to the Binary mode filtering that's based on the assembly output from GNU Objdump +* `-unused_labels` +* `-directives` +* `-comment_only` +* `-whitespace` +* `-library_functions` + +Other parameters: + +* `-plt` Also leaves out labels that End with `@plt` (without this, only labels that Start with `.plt` are left out) +* `-nocompat` Leaves some experimental extra information and returns correct sourcefile/line information in `-binary` mode +* `-stdin` Reads assembly from STDIN instead of from a given file + + +### Example usage + +Feeding an objdump via stdin into asm-parser: + +`objdump --d a.out -l --insn-width=16 | asm-parser -stdin -binary`