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