Update mmh-intro(7) man page

[mmh] / man / mh-format.man5

diff --git a/man/mh-format.man5 b/man/mh-format.man5
index 80021df..e86e9ce 100644 (file)
--- a/man/mh-format.man5
+++ b/man/mh-format.man5
@@ -1,5 +1,5 @@
 .\"
 .\"

-.\" THIS FILE HAS BEEN AUTOMATICALLY GENERATED.  DO NOT EDIT.
+.\" %nmhwarning%

 .\"
 .TH MH-FORMAT %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
 .\"
 .TH MH-FORMAT %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME

@@ -68,7 +68,7 @@ escape is specified as
 and
 exists for each header found in the message being processed.  For example
 .RI `%{ date }'
 and
 exists for each header found in the message being processed.  For example
 .RI `%{ date }'

-refers to the \*(lqDate:\*(rq field of the appropriate message.
+refers to the `Date:' field of the appropriate message.

 All component escapes have a string value.  Normally, component values are
 compressed by converting any control characters (tab and newline included)
 to spaces, then eliding any leading or multiple spaces.  However, commands
 All component escapes have a string value.  Normally, component values are
 compressed by converting any control characters (tab and newline included)
 to spaces, then eliding any leading or multiple spaces.  However, commands

@@ -145,7 +145,7 @@ these include:
 .RS 5
 .nf
 .ta +\w'Argument 'u +\w'An optional component, 'u
 .RS 5
 .nf
 .ta +\w'Argument 'u +\w'An optional component, 'u

-.I Argument    Description     Example Syntax
+.I "Argument   Description     Example Syntax

 literal        A literal number        %(\fIfunc\fR 1234)
        or string               %(\fIfunc\fR text string)
 comp   Any component           %(\fIfunc\fR\^{\fIin-reply-to\fR\^})
 literal        A literal number        %(\fIfunc\fR 1234)
        or string               %(\fIfunc\fR text string)
 comp   Any component           %(\fIfunc\fR\^{\fIin-reply-to\fR\^})

@@ -185,7 +185,7 @@ For example,
 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-writes  the  value of the header component \*(lqFrom:\*(rq to the
+writes  the  value of the header component `From:' to the

 internal register named str; then (\fImymbox\fR\^) reads str and
 writes its result to the internal register named
 .IR num ;
 internal register named str; then (\fImymbox\fR\^) reads str and
 writes its result to the internal register named
 .IR num ;

@@ -194,8 +194,8 @@ then the control escape evaluates
 If
 .IR num
 is non-zero, the
 If
 .IR num
 is non-zero, the

-string \*(lqTo:\*(rq is printed  followed  by  the  value  of  the
-header component \*(lqTo:\*(rq.
+string `To:' is printed  followed  by  the  value  of  the
+header component `To:'.

 .SS Evaluation
 The evaluation of format strings is performed
 by a small virtual machine.
 .SS Evaluation
 The evaluation of format strings is performed
 by a small virtual machine.

@@ -243,7 +243,7 @@ The function escapes may be roughly grouped into a few categories.
 .RS 5
 .nf
 .ta \w'Fformataddr 'u +\w'Aboolean 'u +\w'Rboolean 'u
 .RS 5
 .nf
 .ta \w'Fformataddr 'u +\w'Aboolean 'u +\w'Rboolean 'u

-.I Function    Argument   Result       Description
+.I "Function   Argument   Result       Description

 msg            integer message number
 cur            integer message is current (0 or 1)
 unseen         integer message is unseen (0 or 1)
 msg            integer message number
 cur            integer message is current (0 or 1)
 unseen         integer message is unseen (0 or 1)

@@ -276,7 +276,7 @@ null        expr    boolean \fIstr\fR is empty
 nonnull        expr    boolean \fIstr\fR is non-empty
 void   expr            Set \fIstr\fR or \fInum\fR
 comp   comp    string  Set \fIstr\fR to component text
 nonnull        expr    boolean \fIstr\fR is non-empty
 void   expr            Set \fIstr\fR or \fInum\fR
 comp   comp    string  Set \fIstr\fR to component text

-compval        comp    integer Set \fInum\fR to \*(lq\fBatoi\fR(\fIcomp\fR\^)\*(rq
+compval        comp    integer Set \fInum\fR to `\fBatoi\fR(\fIcomp\fR\^)'

 .\" compflag   comp    integer Set \fInum\fR to component flags bits (internal)
 .\" decodecomp comp    string  Set \fIstr\fR to RFC-2047 decoded component text
 decode expr    string  decode \fIstr\fR as RFC-2047 (MIME-encoded)
 .\" compflag   comp    integer Set \fInum\fR to component flags bits (internal)
 .\" decodecomp comp    string  Set \fIstr\fR to RFC-2047 decoded component text
 decode expr    string  decode \fIstr\fR as RFC-2047 (MIME-encoded)

@@ -287,7 +287,6 @@ putstr      expr            print \fIstr\fR
 putstrf        expr            print \fIstr\fR in a fixed width
 putnum expr            print \fInum\fR
 putnumf        expr            print \fInum\fR in a fixed width
 putstrf        expr            print \fIstr\fR in a fixed width
 putnum expr            print \fInum\fR
 putnumf        expr            print \fInum\fR in a fixed width

-.\" addtoseq literal    add msg to sequence (LBL option)

 nodate string  integer Argument not a date string (0 or 1)
 formataddr     expr            append \fIarg\fR to \fIstr\fR as a
                        (comma separated) address list
 nodate string  integer Argument not a date string (0 or 1)
 formataddr     expr            append \fIarg\fR to \fIstr\fR as a
                        (comma separated) address list

@@ -302,7 +301,7 @@ The following functions require a date component as an argument:
 .RS 5
 .nf
 .ta \w'Fformataddr 'u +\w'Aboolean 'u +\w'Rboolean 'u
 .RS 5
 .nf
 .ta \w'Fformataddr 'u +\w'Aboolean 'u +\w'Rboolean 'u

-.I Function    Argument        Return  Description
+.I "Function   Argument        Return  Description

 sec    date    integer seconds of the minute
 min    date    integer minutes of the hour
 hour   date    integer hours of the day (0-23)
 sec    date    integer seconds of the minute
 min    date    integer minutes of the hour
 hour   date    integer hours of the day (0-23)

@@ -338,7 +337,7 @@ the first address present in the header component.
 .RS 5
 .nf
 .ta \w'Fformataddr 'u +\w'Aboolean 'u +\w'Rboolean 'u
 .RS 5
 .nf
 .ta \w'Fformataddr 'u +\w'Aboolean 'u +\w'Rboolean 'u

-.I Function    Argument        Return  Description
+.I "Function   Argument        Return  Description

 proper addr    string  official 822 rendering
 friendly       addr    string  user-friendly rendering
 addr   addr    string  mbox@host or host!mbox rendering*
 proper addr    string  official 822 rendering
 friendly       addr    string  user-friendly rendering
 addr   addr    string  mbox@host or host!mbox rendering*

@@ -358,10 +357,10 @@ gname     addr    string  name of group*
 .PP
 (A clarification on (\fImymbox\fR\^{\fIcomp\fR\^}) is in order.
 This function checks each of the addresses in the header component
 .PP
 (A clarification on (\fImymbox\fR\^{\fIcomp\fR\^}) is in order.
 This function checks each of the addresses in the header component

-\*(lq\fIcomp\fR\*(rq against the user's mailbox name and any
-.RI \*(lq Alternate-Mailboxes \*(rq.
+`\fIcomp\fR' against the user's mailbox name and any
+.RI ` Alternate-Mailboxes '.

 It returns true if any address matches,
 It returns true if any address matches,

-however, it also returns true if the \*(lq\fIcomp\fR\*(rq header is not
+however, it also returns true if the `\fIcomp\fR' header is not

 present in the message.  If needed, the (\fInull\fR\^) function can be
 used to explicitly test for this case.)
 .SS Formatting
 present in the message.  If needed, the (\fInull\fR\^) function can be
 used to explicitly test for this case.)
 .SS Formatting

@@ -380,7 +379,7 @@ print their result in exactly the number of characters
 specified by their leading field width argument.  For example,
 %06(\fIputnumf\fR\^(\fIsize\fR\^)) will print the message
 size in a field six characters wide filled with leading zeros;
 specified by their leading field width argument.  For example,
 %06(\fIputnumf\fR\^(\fIsize\fR\^)) will print the message
 size in a field six characters wide filled with leading zeros;

-%14(\fIputstrf\^\fR{\fIfrom\^\fR}) will print the \*(lqFrom:\*(rq header
+%14(\fIputstrf\^\fR{\fIfrom\^\fR}) will print the `From:' header

 component in fourteen characters with trailing spaces added as needed.
 For \fIputstrf\fR, using a negative value for the field width causes
 right-justification of the string within the field, with padding on
 component in fourteen characters with trailing spaces added as needed.
 For \fIputstrf\fR, using a negative value for the field width causes
 right-justification of the string within the field, with padding on

@@ -400,15 +399,14 @@ The first part is:
 .PP
 .RS
 .nf
 .PP
 .RS
 .nf

-%4(msg)%<(cur)+%| %>%<{replied}\-%?{encrypted}E%| %>
+%4(msg)%<(cur)+%| %>%<{replied}\-%| %>

 .fi
 .RE
 .PP
 which says that the message number should be printed in four digits.
 If the message is the current message then a `+' else a space should
 .fi
 .RE
 .PP
 which says that the message number should be printed in four digits.
 If the message is the current message then a `+' else a space should

-be printed; if a \*(lqReplied:\*(rq field is present then a `\-'
-else if an \*(lqEncrypted:\*(rq field is present then an `E' otherwise
-a space should be printed.  Next:
+be printed; if a `Replied:' field is present then a `\-'
+else a space should be printed.  Next:

 .PP
 .RS
 .nf
 .PP
 .RS
 .nf

@@ -425,7 +423,7 @@ a slash. Next,
 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-If a \*(lqDate:\*(rq field was present,
+If a `Date:' field was present,

 then a space is printed, otherwise a `*'.
 Next,
 .PP
 then a space is printed, otherwise a `*'.
 Next,
 .PP

@@ -435,9 +433,9 @@ Next,
 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-if the message is from me, and there is a \*(lqTo:\*(rq header,
-print \*(lqTo:\*(rq followed by a \*(lquser-friendly\*(rq rendering of the
-first address in the \*(lqTo:\*(rq field; any MIME-encoded
+if the message is from me, and there is a `To:' header,
+print `To:' followed by a `user-friendly' rendering of the
+first address in the `To:' field; any MIME-encoded

 characters are decoded into the actual characters.
 Continuing,
 .PP
 characters are decoded into the actual characters.
 Continuing,
 .PP

@@ -448,17 +446,17 @@ Continuing,
 .RE
 .PP
 if either of the above two tests failed,
 .RE
 .PP
 if either of the above two tests failed,

-then the \*(lqFrom:\*(rq address is printed
-in a mime-decoded, \*(lquser-friendly\*(rq format.
+then the `From:' address is printed
+in a mime-decoded, `user-friendly' format.

 And finally,
 .PP
 .RS 5
 .nf
 And finally,
 .PP
 .RS 5
 .nf

-%(decode{subject})%<{body}<<%{body}>>%>
+%(decode{subject})

 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-the mime-decoded subject and initial body (if any) are printed.
+the mime-decoded subject is printed.

 .PP
 For a more complicated example, next consider
 a possible
 .PP
 For a more complicated example, next consider
 a possible

@@ -473,7 +471,7 @@ format file.
 .PP
 This clears
 .I str
 .PP
 This clears
 .I str

-and formats the \*(lqReply-To:\*(rq header
+and formats the `Reply-To:' header

 if present.  If not present, the else-if clause is executed.
 .PP
 .RS 5
 if present.  If not present, the else-if clause is executed.
 .PP
 .RS 5

@@ -483,7 +481,7 @@ if present.  If not present, the else-if clause is executed.
 .RE
 .PP
 This formats the
 .RE
 .PP
 This formats the

-\*(lqFrom:\*(rq, \*(lqSender:\*(rq and \*(lqReturn-Path:\*(rq
+`From:', `Sender:' and `Return-Path:'

 headers, stopping as soon as one of them is present.  Next:
 .PP
 .RS 5
 headers, stopping as soon as one of them is present.  Next:
 .PP
 .RS 5

@@ -494,7 +492,7 @@ headers, stopping as soon as one of them is present.  Next:
 .PP
 If the \fIformataddr\fR result is non-null, it is printed as
 an address (with line folding if needed) in a field \fIwidth\fR
 .PP
 If the \fIformataddr\fR result is non-null, it is printed as
 an address (with line folding if needed) in a field \fIwidth\fR

-wide with a leading label of \*(lqTo:\*(rq.
+wide with a leading label of `To:'.

 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf

@@ -503,9 +501,9 @@ wide with a leading label of \*(lqTo:\*(rq.
 .RE
 .PP
 .I str
 .RE
 .PP
 .I str

-is cleared, and the \*(lqTo:\*(rq and \*(lqCc:\*(rq headers, along with the user's
+is cleared, and the `To:' and `Cc:' headers, along with the user's

 address (depending on what was specified with
 address (depending on what was specified with

-the \*(lq\-cc\*(rq switch to \fIrepl\fR\^) are formatted.
+the `\-cc' switch to \fIrepl\fR\^) are formatted.

 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf

@@ -514,23 +512,7 @@ the \*(lq\-cc\*(rq switch to \fIrepl\fR\^) are formatted.
 .RE
 .PP
 If the result is non-null, it is printed as above with a
 .RE
 .PP
 If the result is non-null, it is printed as above with a

-leading label of \*(lqcc:\*(rq.
-.PP
-.RS 5
-.nf
-%<{fcc}Fcc: %{fcc}\\n%>\\
-.fi
-.RE
-.PP
-If a
-.B \-fcc
-.I folder
-switch was given to
-.B repl
-(see
-.BR repl (1)
-for more details about %{\fIfcc\fR\^}),
-an \*(lqFcc:\*(rq header is output.
+leading label of `Cc:'.

 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf

@@ -550,8 +532,8 @@ a suitable reply subject is output.
 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-If a message-id component was present, an \*(lqIn-Reply-To:\*(rq header is
-output including the message-id, followed by a \*(lqReferences:\*(rq
+If a message-id component was present, an `In-Reply-To:' header is
+output including the message-id, followed by a `References:'

 header with references, if present, and the message-id.
 As with all
 plain-text, the row of dashes are output as-is.
 header with references, if present, and the message-id.
 As with all
 plain-text, the row of dashes are output as-is.

@@ -563,17 +545,17 @@ Here's that part again in pseudo-code:
 .nf
 .ta .5i 1i 1.5i 2i
 if (comp_exists(message-id))  then
 .nf
 .ta .5i 1i 1.5i 2i
 if (comp_exists(message-id))  then

-       print (\*(lqIn-reply-to: \*(rq)
+       print (`In-reply-to: ')

        print (message-id.value)
        print (message-id.value)

-       print (\*(lq\\n\*(rq)
+       print (`\\n')

 endif
 if (comp_exists(message-id)) then
 endif
 if (comp_exists(message-id)) then

-       print (\*(lqReferences: \*(rq)
+       print (`References: ')

        if (comp_exists(references)) then
              print(references.value);
        endif
        print (message-id.value)
        if (comp_exists(references)) then
              print(references.value);
        endif
        print (message-id.value)

-       print (\*(lq\\n\*(rq)
+       print (`\\n')

 endif
 .fi
 .RE
 endif
 .fi
 .RE