Initial revision
[mmh] / man / fmtdump.man
1 .\"
2 .\" %nmhwarning%
3 .\" $Id$
4 .\"
5 .\" include the -mh macro file
6 .so %etcdir%/tmac.h
7 .\"
8 .TH FMTDUMP %manext8% MH.6.8 [%nmhversion%]
9 .SH NAME
10 fmtdump \- decode nmh format files
11 .SH SYNOPSIS
12 .in +.5i
13 .ti -.5i
14 %libdir%/fmtdump
15 \%[\-form\ formatfile]
16 .br
17 \%[\-format\ string]
18 \%[\-version]
19 \%[\-help]
20 .in -.5i
21 .SH DESCRIPTION
22 \fIFmtdump\fR is a program that parses an \fInmh\fP format file and
23 produces a pseudo-language listing of the how \fInmh\fP interprets
24 the file.  This is useful when debugging a complicated format file.
25
26 The `\-format\ string' and `\-form\ formatfile' switches may be
27 used to specify a format string or format file to read.  The string
28 is simply a format string and the file is simply a format file.
29 See \fImh-format\fR\|(5) for the details.
30 .Fi
31 ^$HOME/\&.mh\(ruprofile~^The user profile
32 ^%etcdir%/scan.default~^The default format file
33 .Pr
34 ^Path:~^To determine the user's nmh directory
35 .Sa
36 mh-format(5), mh-sequences(8)
37 .Co
38 None
39 .Bu
40 The output may not be useful unless you are familiar
41 with the internals of the mh-format subroutines.
42 .En