Flush (work in progress)
[mono.git] / man / monop.1
1 .TH "monop" 1
2 .SH NAME
3 monop, monop2 \- Mono Class Outline Viewer
4 .SH SYNOPSIS
5 .B monop
6 [-r:assembly] [--search] class
7 .SH OPTIONS
8 .TP
9 .I \-r:assembly
10 Specifies the assembly to use for looking up the type
11 .TP
12 .I \-a
13 Renders all of the types in the specified assembly.
14 .TP
15 .I \-\-search, \-s, \-k
16 Searches through all known assemblies for types containing `class'.
17 .TP
18 .I \-\-refs
19 Prints a list of the referenced assemblies for an assembly.
20 Requires an assembly to be specified with -r:assembly.
21 .TP
22 .I \-\-filter-obsolete, \-f
23 Do not show obsolete types and members.
24 .TP
25 .I \-\-declared-only, \-d
26 Only show members declared in the type.
27 .TP
28 .I \-\-private, \-p
29 Show private members.
30 .TP
31 .I \-\-runtime\-version
32 Print runtime version.
33 .PP
34 .SH DESCRIPTION
35 Monop is a tool that allows you to view the outline of a class. You can see the
36 signature of each member of the class.   Use \fImonop\fP to explore 1.0
37 assemblies, use \fImonop2\fP to explore 2.0 assemblies.
38 .PP
39 The tool takes one option, the class to view. You must specify the full name of the
40 class, including namespace.
41 .PP
42 For generic classes, you must specify the generic arguments, for
43 example:
44 .nf
45 monop2 'System.Collections.Generic.List`1'
46 .fi
47 The above is the string representation for the List<T> in System.Collections.Generic
48 .PP
49 If you are unsure of the full name of the class, you can use the
50 `--search' option to search through all known assemblies.
51 .PP
52 .SH MAILING LISTS
53 Visit http://lists.ximian.com/mailman/listinfo/mono-devel-list for details.
54 .SH WEB SITE
55 Visit http://www.mono-project.com for details