4 .TH MHL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
6 mhl \- produce formatted listings of mh messages
24 command for filtering and/or displaying text
25 messages. It is the default method of displaying text messages for
33 switch sets the screen width. This defaults to the value indicated by
35 if appropriate, otherwise it defaults to 80.
37 The default format file used by
42 will first search for this file in the user's
44 directory, and will then search in the directory
47 can be changed by using the
51 Note: In contrast to any other
55 switch does only take file names, but no format strings with a prepended
59 operates in two phases: 1) read and parse the format file, and
60 2) process each message (file). During phase 1, an internal description
61 of the format is produced as a structured list. In phase 2, this list
62 is walked for each message, outputting message information under the
63 format constraints from the format file.
65 The format file can contain information controlling
66 screen size, wrap\-around control, transparent text, component ordering,
67 and component formatting. Also, a list of components to ignore may be
68 specified, and a couple of `special' components are defined
69 to provide added functionality. Message output will be in the order
70 specified by the order in the format file.
72 Each line of a format file has one of the following forms:
78 variable[,variable...]
79 component:[variable,...]
84 A line beginning with a `;' is a comment, and is ignored.
86 A line beginning with a `:' is clear text, and is output exactly as is.
88 A line containing only a `:' produces a blank line in the output.
90 A line beginning with `component:' defines the format for the specified
93 Remaining lines define the global environment.
95 For example, the line:
98 width=80,overflowtext="***",overflowoffset=5
101 defines the screen size to be 80 columns by 40 rows, specifies that the
103 is 5, and that overflow text should be flagged with `***'.
105 Following are all of the current variables and their arguments. If they
106 follow a component, they apply only to that component, otherwise, their
107 affect is global. Since the whole format is parsed before any output
108 processing, the last global switch setting for a variable applies to
109 the whole message if that variable is used in a global context (i.e.,
114 .ta \w'xxxxxxxxxxxxx 'u +\w'integer/G 'u
115 .I "variable type semantics
116 width integer screen width or component width
117 length integer component length
118 offset integer positions to indent `component: '
119 overflowtext string text to use at the beginning of an
121 overflowoffset integer positions to indent overflow lines
122 compwidth integer positions to indent component text
123 after the first line is output
124 uppercase flag output text of this component in all
126 nouppercase flag don't uppercase
127 component string/L name to use instead of `component' for
129 nocomponent flag don't output `component: ' for this
131 center flag center component on line (works for
132 one\-line components only)
133 nocenter flag don't center
134 leftadjust flag strip off leading whitespace on each
136 noleftadjust flag don't leftadjust
137 compress flag change newlines in text to spaces
138 nocompress flag don't compress
139 rtrim flag trim whitespace at end of text lines
140 nortrim flag retain whitespace at end of text lines (default)
141 split flag don't combine multiple fields into
143 nosplit flag combine multiple fields into
145 newline flag print newline at end of components
146 (this is the default)
147 nonewline flag don't print newline at end of components
148 formatfield string format string for this component
150 decode flag decode text as RFC-2047 encoded
152 addrfield flag field contains addresses
153 datefield flag field contains dates
157 To specify the value of integer\-valued and string\-valued variables,
158 follow their name with an equals\-sign and the value. Integer\-valued
159 variables are given decimal values, while string\-valued variables
160 are given arbitrary text bracketed by double\-quotes. If a value is
161 suffixed by `/G' or `/L', then its value is useful in
162 a global\-only or local\-only context (respectively).
167 ignores=component,...
170 specifies a list of components which are never output.
172 The component `MessageName' (case\-insensitive) will output the
173 message file name as a one-line header, similar to
175 E.g. ``(Message 42)''
177 The component `Extras' will output all of the components of the
178 message which were not matched by explicit components, or included in
179 the ignore list. If this component is not specified, an ignore list is
180 not needed since all non\-specified components will be ignored.
182 If `nocomponent' is NOT specified, then the component name will
183 be output as it appears in the format file.
185 The default format file is:
193 The variable `formatfield' specifies a format string (see
195 The flag variables `addrfield' and
196 `datefield' (which are mutually exclusive), tell
198 to interpret the escapes in the format string as either addresses or
203 does not apply any formatting string to fields
204 containing address or dates (see
207 fields). Note that this results in faster operation since
209 must parse both addresses and dates in order to apply a format string
212 can be given a default format string for
213 either address or date fields (but not both). To do this, on a global
214 line specify: either the flag addrfield or datefield, along with the
215 appropriate formatfield variable string.
220 .ta \w'%etcdir%/ExtraBigFileName 'u
221 ^%etcdir%/mhl.format~^The message template
222 ^or $HOME/.mmh/mhl.format~^Rather than the standard template
223 ^$HOME/.mmh/profile~^The user profile
226 .SH "PROFILE COMPONENTS"
230 show(1), ap(8), dp(8)
241 In contrast to any other
245 switch does only take file names, but no format strings with a prepended
248 The `nonewline' option interacts badly with `compress'
projects / mmh / blob