Factor trim format function out
[mmh] / man / fmtdump.man8
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH FMTDUMP %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 fmtdump \- decode mh format files
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B %libdir%/fmtdump
11 .RB [ \-form
12 .IR formatfile ]
13 .RB [ \-Version ]
14 .RB [ \-help ]
15 .ad
16 .SH DESCRIPTION
17 .B Fmtdump
18 is a program that parses an
19 .B mh
20 format file and produces a pseudo-language listing of the how
21 .B mmh
22 interprets the file.  This is useful when debugging a complicated format file.
23 .PP
24 The
25 .B \-form
26 .I formatfile
27 switch may be used to specify a format file to read.
28 It may also be a format string directly, if prepended with an equal sign `='.
29 See
30 .BR mh-format (5)
31 for the details.
32
33 .SH FILES
34 .fc ^ ~
35 .nf
36 .ta \w'%etcdir%/ExtraBigFileName  'u
37 ^$HOME/.mmh/profile~^The user profile
38 ^%etcdir%/scan.default~^The default format file
39 .fi
40
41 .SH "PROFILE COMPONENTS"
42 .fc ^ ~
43 .nf
44 .ta 2.4i
45 .ta \w'ExtraBigProfileName  'u
46 ^Path:~^To determine the user's mail storage
47 .fi
48
49 .SH "SEE ALSO"
50 mh-format(5), mh-sequence(7)
51
52 .SH CONTEXT
53 None