update the man page too match last changes
[mono.git] / mono / dis / monodis.1
blob35d57776ef15a21c6d6978af23dcf1e191b6bd6f
1 .\" 
2 .\" monodis manual page.
3 .\" (C) Ximian, Inc. 
4 .\" Author:
5 .\"   Miguel de Icaza (miguel@gnu.org)
6 .\"
7 .TH Mono "Mono 1.1.x"
8 .SH NAME
9 monodis \- CIL image content dumper and disassembler.
10 .SH SYNOPSIS
11 .PP
12 .B monodis
13 [\-h] [\-\-help] 
14 [\-\-output=FILENAME]
15 [\-\-mscorlib]
16 [\-\-assembly]
17 [\-\-assemblyref]
18 [\-\-classlayout]
19 [\-\-constant]
20 [\-\-customattr]
21 [\-\-declsec]
22 [\-\-event]
23 [\-\-exported]
24 [\-\-fields]
25 [\-\-file]
26 [\-\-forward-decls]
27 [\-\-genericpar]
28 [\-\-implmap]
29 [\-\-interface]
30 [\-\-manifest]
31 [\-\-marshal]
32 [\-\-memberref]
33 [\-\-method]
34 [\-\-methodimpl]
35 [\-\-methodsem]
36 [\-\-methodspec]
37 [\-\-module]
38 [\-\-moduleref]
39 [\-\-mresources]
40 [\-\-nested]
41 [\-\-param]
42 [\-\-parconst]
43 [\-\-property]
44 [\-\-propertymap]
45 [\-\-standalonesig]
46 [\-\-typedef]
47 [\-\-typeref]
48 [\-\-typespec]
49 [\-\-blob]
50 [\-\-strings]
51 [\-\-userstrings]
52 [FILES...]
53 .SH DESCRIPTION
54 The \fImonodis\fP program is used to dump the contents a CIL image
55 (contained in .EXE files that contain extended PE/COFF CIL code).  
56 .PP
57 To roundtrip assemblies using ilasm, it is best to use the --output
58 argument, as that will make monodis save the embedded resources in
59 files that can later be properly embedded back by ilasm. 
60 .SH OPTIONS
61 The following Generic options are supported:
62 .TP
63 .I "--help", "-h"
64 Displays usage instructions.
65 .TP
66 .I "--output=FILENAME"
67 Write output into \fIFILENAME\fP and dump any embedded managed resources.
68 .TP
69 .I "--mscorlib"
70 For non-corlib assemblies, use "mscorlib" as the assembly name. This
71 is useful for round-tripping the IL with ilasm.
72 .TP
73 .I "--show-method-tokens"
74 Display tokens for disassembled methods.
75 .TP
76 .I "--assembly"
77 Dumps the contents of the Assembly table.
78 .TP
79 .I "--assemblyref"
80 Dumps the contents of the AssemblyRef table.
81 .TP
82 .I "--classlayout"
83 Dumps the contents of the ClassLayout table.
84 .TP
85 .I "--constant"
86 Dumps the contents of the Constant table.
87 .TP
88 .I "--customattr"
89 Dumps the contents of the CustomAttribute table.
90 .TP
91 .I "--declsec"
92 Dumps the contents of the DeclSec table.
93 .TP
94 .I "--event"
95 Dumps the contents of the Event table.
96 .TP
97 .I "--exported"
98 Dumps the contents of the ExportedType table.
99 .TP
100 .I "--fields"
101 Dumps the contents of the Field table.
103 .I "--file"
104 Dumps the contents of the File table.
106 .I "--forward-decls"
107 Dumps forward declarations for classes.
109 .I "--genericpar"
110 Dumps the contents of the GenericParam table.
112 .I "--implmap"
113 Dumps the contents of the ImplMap table.
115 .I "--interface"
116 Dumps the contents of the InterfaceImpl table.
118 .I "--manifest"
119 Dumps the contents of the ManifestResource table.
121 .I "--marshal"
122 Dumps the contents of the FieldMarshal table.
124 .I "--memberref"
125 Dumps the contents of the MemberRef table.
127 .I "--method"
128 Dumps the contents of the MethodDef table.
130 .I "--methodimpl"
131 Dumps the contents of the MethodImpl table.
133 .I "--methodspec"
134 Dumps the contents of the MethodSpec table.
136 .I "--methodsem"
137 Dumps the contents of the MethodSemantics table.
139 .I "--module"
140 Dumps the contents of the Module table.
142 .I "--moduleref"
143 Dumps the contents of the ModuleRef table.
145 .I "--mresources"
146 Dumps the managed resources embedded in the assembly.
148 .I "--nested"
149 Dumps the contents of the NestedClass table.
151 .I "--param"
152 Dumps the contents of the Param table.
154 .I "--parconst"
155 Dumps the contents of the GenericParameterConstraint table.
157 .I "--property"
158 Dumps the contents of the Property table.
160 .I "--propertymap"
161 Dumps the contents of the PropertyMap table.
163 .I "--standalonesig"
164 Dumps the contents of the StandAloneSig table.
166 .I "--typedef"
167 Dumps the contents of the TypeDef table.
169 .I "--typespec"
170 Dumps the contents of the TypeSpec table.
172 .I "--typeref"
173 Dumps the contents of the TypeRef table.
175 .I "--blob"
176 Dumps the entire contents of the blob stream as hex.
178 .I "--strings"
179 Dumps the contents of the Strings heap.
181 .I "--userstrings"
182 Dumps the contents of the User-Strings heap
184 If no flags are specified the program dumps the content of the image
185 in a format that can be used to rountrip the code.
187 .SH ENVIRONMENT VARIABLES
189 .I "MONO_PATH"
190 Provides a search path to mono and mint where to look for library files.
191 Directories are separated by the platform path separator (colons on unix). Example:
192 .B /home/username/lib:/usr/local/mono/lib
194 .SH AUTHOR
195 monodis was written by Miguel de Icaza, Paolo Molaro and Dietmar Maurer.
196 .SH SEE ALSO
197 .BR pedump(1)