refcard.tex

debug source code under unix platform.

command line options in a similar way to the UNIX \function{getopt} function.
Only the long names of the options are shown here.  If an option has a single
character equivalent it will be listed in the \flag{help} output.  Options that
accept numeric arguments can have their value specified in binary, octal,
decimal or hexadecimal notation.

\vskip 12pt
\heading{mpatrol command options}
\vskip 6pt

\begin{description}
\item[\flagpar{alloc-byte}{unsigned integer}]
\hfill See \option{ALLOCBYTE}.
\item[\flagpar{alloc-stop}{unsigned integer}]
\hfill See \option{ALLOCSTOP}.
\item[\flag{allow-oflow}]
\hfill See \option{ALLOWOFLOW}.
\item[\flagpar{auto-save}{unsigned integer}]
\hfill See \option{AUTOSAVE}.
\item[\flagpar{check}{unsigned range}]
\hfill See \option{CHECK}.
\item[\flag{check-all}]
\hfill See \option{CHECKALL}.
\item[\flag{check-allocs}]
\hfill See \option{CHECKALLOCS}.
\item[\flag{check-fork}]
\hfill See \option{CHECKFORK}.
\item[\flag{check-frees}]
\hfill See \option{CHECKFREES}.
\item[\flag{check-memory}]
\hfill See \option{CHECKMEMORY}.
\item[\flag{check-reallocs}]
\hfill See \option{CHECKREALLOCS}.
\item[\flagpar{def-align}{unsigned integer}]
\hfill See \option{DEFALIGN}.
\item[\flag{dynamic}]
Specifies that programs which were not linked with the mpatrol library should
also be traced, but only if they were dynamically linked.
\item[\flag{edit}]
\hfill See \option{EDIT}.
\item[\flagpar{fail-freq}{unsigned integer}]
\hfill See \option{FAILFREQ}.
\item[\flagpar{fail-seed}{unsigned integer}]
\hfill See \option{FAILSEED}.
\item[\flagpar{free-byte}{unsigned integer}]
\hfill See \option{FREEBYTE}.
\item[\flagpar{free-stop}{unsigned integer}]
\hfill See \option{FREESTOP}.
\item[\flag{help}]
Displays a quick-reference option summary.
\item[\flagpar{large-bound}{unsigned integer}]
\hfill See \option{LARGEBOUND}.
\item[\flag{leak-table}]
\hfill See \option{LEAKTABLE}.
\item[\flagpar{limit}{unsigned integer}]
\hfill See \option{LIMIT}.
\item[\flag{list}]
\hfill See \option{LIST}.
\item[\flag{log-all}]
\hfill See \option{LOGALL}.
\item[\flag{log-allocs}]
\hfill See \option{LOGALLOCS}.
\item[\flagpar{log-file}{string}]
\hfill See \option{LOGFILE}.
\item[\flag{log-frees}]
\hfill See \option{LOGFREES}.
\item[\flag{log-memory}]
\hfill See \option{LOGMEMORY}.
\item[\flag{log-reallocs}]
\hfill See \option{LOGREALLOCS}.
\item[\flagpar{medium-bound}{unsigned integer}]
\hfill See \option{MEDIUMBOUND}.
\item[\flagpar{no-free}{unsigned integer}]
\hfill See \option{NOFREE}.
\item[\flag{no-protect}]
\hfill See \option{NOPROTECT}.
\item[\flagpar{oflow-byte}{unsigned integer}]
\hfill See \option{OFLOWBYTE}.
\item[\flagpar{oflow-size}{unsigned integer}]
\hfill See \option{OFLOWSIZE}.
\item[\flag{oflow-watch}]
\hfill See \option{OFLOWWATCH}.
\item[\flag{page-alloc-lower}]
\hfill See \option{PAGEALLOC=LOWER}.
\item[\flag{page-alloc-upper}]
\hfill See \option{PAGEALLOC=UPPER}.
\item[\flag{preserve}]
\hfill See \option{PRESERVE}.
\item[\flag{prof}]
\hfill See \option{PROF}.
\item[\flagpar{prof-file}{string}]
\hfill See \option{PROFFILE}.
\item[\flagpar{prog-file}{string}]
\hfill See \option{PROGFILE}.
\item[\flag{read-env}]
Reads and passes through the contents of the \texttt{MPATROL\_OPTIONS}
environment variable.
\item[\flagpar{realloc-stop}{unsigned integer}]
\hfill See \option{REALLOCSTOP}.
\item[\flag{safe-signals}]
\hfill See \option{SAFESIGNALS}.
\item[\flag{show-all}]
\hfill See \option{SHOWALL}.
\item[\flag{show-env}]
Displays the contents of the \texttt{MPATROL\_OPTIONS} environment variable.
\item[\flag{show-free}]
\hfill See \option{SHOWFREE}.
\item[\flag{show-freed}]
\hfill See \option{SHOWFREED}.
\item[\flag{show-map}]
\hfill See \option{SHOWMAP}.
\item[\flag{show-symbols}]
\hfill See \option{SHOWSYMBOLS}.
\item[\flag{show-unfreed}]
\hfill See \option{SHOWUNFREED}.
\item[\flagpar{small-bound}{unsigned integer}]
\hfill See \option{SMALLBOUND}.
\item[\flag{threads}]
Specifies that the program to be run is multithreaded if the \flag{dynamic}
option is used.
\item[\flag{trace}]
\hfill See \option{TRACE}.
\item[\flagpar{trace-file}{string}]
\hfill See \option{TRACEFILE}.
\item[\flagpar{unfreed-abort}{unsigned integer}]
\hfill See \option{UNFREEDABORT}.
\item[\flag{use-debug}]
\hfill See \option{USEDEBUG}.
\item[\flag{use-mmap}]
\hfill See \option{USEMMAP}.
\item[\flag{version}]
Displays the version number of the \command{mpatrol} command.
\end{description}

\vskip 12pt
\heading{mprof command options}
\vskip 6pt

\begin{description}
\item[\flag{addresses}]
Specifies that different call sites from within the same function are to be
differentiated and that the names of all functions should be displayed with
their call site offset in bytes.
\item[\flag{call-graph}]
Specifies that the allocation call graph should be displayed.
\item[\flag{counts}]
Specifies that certain tables should be sorted by the number of allocations or
deallocations rather than the total number of bytes allocated or deallocated.
\item[\flagpar{graph-file}{file}]
Specifies that the allocation call graph should also be written to a graph
specification file for later visualisation with \command{dot}.
\item[\flag{help}]
Displays a quick-reference option summary.
\item[\flag{leaks}]
Specifies that memory leaks rather than memory allocations are to be written to
the graph specification file.
\item[\flagpar{stack-depth}{depth}]
Specifies the maximum stack depth to use when calculating if one call site has
the same call stack as another call site.  This also specifies the maximum
number of functions to display in a call stack.
\item[\flag{version}]
Displays the version number of the \command{mprof} command.
\end{description}

\vskip 12pt
\heading{mptrace command options}
\vskip 6pt

The \command{mptrace} command can be built with GUI support on certain
platforms.  Any of the following options that are marked as being specific to
the GUI version of \command{mptrace} will be read by the X command line parser
rather than directly by \command{mptrace}.  As a result they are parsed
according to X toolkit rules and do not appear in the quick-reference option
summary produced by the \flag{--help} option.  The application class for setting
\command{mptrace} X resources is called \texttt{MPTrace}.

\begin{description}
\item[\flagpar{alloc}{colour}]
Specifies the colour to use for displaying allocated memory (GUI only).
\item[\flagpar{base}{address}]
Specifies the base address of the visible address space displayed in the memory
map (GUI only).
\item[\flagpar{delay}{length}]
Specifies that a small delay of a certain length should be added after drawing
each memory allocation event (GUI only).
\item[\flagpar{free}{colour}]
Specifies the colour to use for displaying free memory (GUI only).
\item[\flag{gui}]
Displays the GUI (if supported).
\item[\flagpar{height}{size}]
Specifies the height (in pixels) of the drawing area (GUI only).
\item[\flagpar{hatf-file}{file}]
Specifies that the trace should also be written to a file in Heap Allocation
Trace Format (HATF).
\item[\flag{help}]
Displays a quick-reference option summary.
\item[\flagpar{internal}{colour}]
Specifies the colour to use for displaying internal heap memory (GUI only).
\item[\flagpar{sim-file}{file}]
Specifies that a trace-driven memory allocation simulation program written in C
should be written to a file.
\item[\flag{source}]
Displays source-level information for each event in the tracing table, if
available.
\item[\flagpar{space}{size}]
Specifies the size (in megabytes) of the visible address space displayed in the
memory map (GUI only).
\item[\flagpar{unalloc}{colour}]
Specifies the colour to use for displaying unallocated heap memory (GUI only).
\item[\flagpar{view-height}{size}]
Specifies the height (in pixels) of the window (GUI only).
\item[\flagpar{view-width}{size}]
Specifies the width (in pixels) of the window (GUI only).
\item[\flagpar{width}{size}]
Specifies the width (in pixels) of the drawing area (GUI only).
\item[\flag{verbose}]
Specifies that the tracing table should be displayed.
\item[\flag{version}]
Displays the version number of the \command{mptrace} command.
\end{description}

\vskip 12pt
\heading{mleak command options}
\vskip 6pt

\begin{description}
\item[\flag{help}]
Displays a quick-reference option summary.
\item[\flag{ignore}]
Specifies that the list of unfreed allocations in the log file should be
ignored.
\item[\flagpar{max-stack}{depth}]
Specifies the maximum stack depth to display.
\item[\flag{version}]
Displays the version number of the \command{mleak} command.
\end{description}

\vskip 12pt
\heading{mpsym command options}
\vskip 6pt

\begin{description}
\item[\flag{help}]
Displays a quick-reference option summary.
\item[\flag{skip}]
Skip symbols marked as \texttt{???} in the log file.
\item[\flag{version}]
Displays the version number of the \command{mpsym} command.
\end{description}

\vskip 12pt
\heading{mpedit command options}
\vskip 6pt

The \command{mpedit} command recognises the \texttt{EDITOR} environment variable
which can be used to specify the text editor that it should use to edit source
files.  It also recognises the \texttt{MPATROL\_SOURCEPATH} environment variable
which can be used to specify a colon-separated list of directories that should
be used to help search for source files.

\begin{description}
\item[\flagpar{editor}{filename}]
Specifies the text editor to use.
\item[\flag{help}]
Displays a quick-reference option summary.
\item[\flag{listing}]
Displays a context listing of the source line instead of invoking the text
editor.
\item[\flagpar{source-dir}{directory}]
Adds a directory to the search path used to locate the source file.
\item[\flag{version}]
Displays the version number of the \command{mpedit} command.
\end{description}

\vskip 12pt
\heading{hexwords command options}
\vskip 6pt

\begin{description}
\item[\flag{help}]
Displays a quick-reference option summary.
\item[\flagpar{match}{exact\texttt{|}lower\texttt{|}upper\texttt{|}any}]
Sets the type of case-sensitivity to use.
\item[\flagpar{maximum}{count}]
Sets the maximum number of letters to match.
\item[\flagpar{minimum}{count}]
Sets the minimum number of letters to match.
\item[\flag{version}]
Displays the version number of the \command{hexwords} command.
\end{description}

\vskip 12pt
Copyright \copyright 1997-2002 Graeme S. Roy.
\vskip 6pt

This reference card may be freely distributed under the terms of the GNU General
Public License.

\end{multicols}

\end{document}