Merge pull request #5714 from alexischr/update_bockbuild

[mono.git] / man / mono-symbolicate.1

diff --git a/man/mono-symbolicate.1 b/man/mono-symbolicate.1
index e5f8ee54d3206f96eec2e73a2567b2ec9d7bd055..e386b3d804d7587d0b33e9c309ef94848236d58d 100644 (file)
--- a/man/mono-symbolicate.1
+++ b/man/mono-symbolicate.1
@@ -9,26 +9,23 @@
 mono-symbolicate \- Mono Symbolicate Tool
 .SH SYNOPSIS
 .PP
-.B mono-symbolicate exefile stacktracesfile [directories...]
+.B mono-symbolicate <msym dir> <input file>
+.PP
+.B mono-symbolicate store-symbols <msym dir> [<dir>]+
 .SH DESCRIPTION
 mono-symbolicate is a tool that converts a stack trace with <filename unknown>:0
 into one with file names and line numbers.
 .PP
-The output of calling this tool will be the provided
-.I stacktracesfile
-where <filename unknown>:0 parts are replaced by
-a file name and a line number.
+When mono-symbolicate is called with a symbol directory and a file containing a stacktrace:
+.P
+.B mono-symbolicate <msym dir> <input file>
 .PP
-For the tool to work it needs to load referenced assemblies, it will first look
-in the same folder as
-.I exefile
-then from one of the provided
-.I directories.
+The tool writes into stdout the file contents while adding file location to stack frames when
+it is possible to symbolicate with the symbols available on the symbol directory.
 .PP
-The tool assumes that the folder with a referenced assembly called for example
-name.dll will also include name.dll.mdb,
-if the referenced assembly is AOT compiled then the tool is also expecting to find
-name.dll.msym.
+Managed symbols .exe/.dll can be added to the symbol directory by doing:
+.P
+.B mono-symbolicate store-symbols <msym dir> [<dir>]+
 .SH AUTHOR
 Written by Marcos Henrich
 .SH COPYRIGHT