Expanded mhpath(1) man page discussion of its handling of out-of-range

[nmh] / h / mhparse.h

diff --git a/h/mhparse.h b/h/mhparse.h
index 1dfd7ed8df65abd47bc325a05ab5755b4fd50481..62e6c0b390983f48b75c51db0c792e0b04140e23 100644 (file)
--- a/h/mhparse.h
+++ b/h/mhparse.h
@@ -290,15 +290,23 @@ CT parse_mime (char *);
  * Translate a composition file into a MIME data structure.  Arguments are:
  *
  * infile      - Name of input filename
+ * autobuild    - A flag to indicate if the composition file parser is
+ *               being run in automatic mode or not.  In auto mode,
+ *               if a MIME-Version header is encountered it is assumed
+ *               that the composition file is already in MIME format
+ *               and will not be processed further.  Otherwise, an
+ *               error is generated.
  * directives  - A flag to control whether or not build directives are
  *               processed by default.
  * encoding    - The default encoding to use when doing RFC 2047 header
  *               encoding.  Must be one of CE_UNKNOWN, CE_BASE64, or
  *               CE_QUOTED;
  *
- * Returns a CT structure describing the resulting MIME message.
+ * Returns a CT structure describing the resulting MIME message.  If the
+ * -auto flag is set and a MIME-Version header is encountered, the return
+ * value is NULL.
  */
-CT build_mime (char *infile, int directives, int encoding);
+CT build_mime (char *infile, int autobuild, int directives, int encoding);
 
 int add_header (CT, char *, char *);
 int get_ctinfo (char *, CT, int);