Updated all man pages and renamed install-mh.man to mmh.man.
[mmh] / man / fmtdump.man
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH FMTDUMP %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 fmtdump \- decode nmh format files
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B %libdir%/fmtdump
11 .RB [ \-form
12 .IR formatfile ]
13 .RB [ \-format
14 .IR string ]
15 .RB [ \-version ]
16 .RB [ \-help ]
17 .ad
18 .SH DESCRIPTION
19 .B Fmtdump
20 is a program that parses an
21 .B nmh
22 format file and produces a pseudo-language listing of the how
23 .B nmh
24 interprets the file.  This is useful when debugging a complicated format file.
25 .PP
26 The
27 .B \-format
28 .I string
29 and
30 .B \-form
31 .I formatfile
32 switches may be
33 used to specify a format string or format file to read.  The string
34 is simply a format string and the file is simply a format file.
35 See
36 .BR mh-format (5)
37 for the details.
38
39 .SH FILES
40 .fc ^ ~
41 .nf
42 .ta \w'%etcdir%/ExtraBigFileName  'u
43 ^$HOME/.mmh/profile~^The user profile
44 ^%etcdir%/scan.default~^The default format file
45 .fi
46
47 .SH "PROFILE COMPONENTS"
48 .fc ^ ~
49 .nf
50 .ta 2.4i
51 .ta \w'ExtraBigProfileName  'u
52 ^Path:~^To determine the user's mail storage
53 .fi
54
55 .SH "SEE ALSO"
56 mh-format(5), mh-sequences(8)
57
58 .SH CONTEXT
59 None
60
61 .SH BUGS
62 The output may not be useful unless you are familiar
63 with the internals of the mh-format subroutines.