Fix single-quoting style in PDF manuals
[gnus] / texi / emacs-mime.texi
index 676fd38..640d0e9 100644 (file)
@@ -1,7 +1,10 @@
 \input texinfo
 
-@setfilename emacs-mime
+@include gnus-overrides.texi
+
+@setfilename emacs-mime.info
 @settitle Emacs MIME Manual
+@include docstyle.texi
 @synindex fn cp
 @synindex vr cp
 @synindex pg cp
 @copying
 This file documents the Emacs MIME interface functionality.
 
-Copyright @copyright{} 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
+Copyright @copyright{} 1998--2015 Free Software Foundation, Inc.
 
 @quotation
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
 any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
+Invariant Sections, with the Front-Cover Texts being ``A GNU Manual'',
 and with the Back-Cover Texts as in (a) below.  A copy of the license
 is included in the section entitled ``GNU Free Documentation License''.
 
 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
-modify this GNU manual.  Buying copies from the FSF supports it in
-developing GNU and promoting software freedom.''
+modify this GNU manual.''
 @end quotation
 @end copying
 
-@c Node ``Interface Functions'' uses Latin-1 characters
-@documentencoding ISO-8859-1
+@c Node ``Interface Functions'' uses non-ASCII characters
 
-@dircategory Emacs
+@dircategory Emacs lisp libraries
 @direntry
 * Emacs MIME: (emacs-mime).     Emacs MIME de/composition library.
 @end direntry
@@ -39,7 +39,12 @@ developing GNU and promoting software freedom.''
 @setchapternewpage odd
 
 @titlepage
+@ifset WEBHACKDEVEL
+@title Emacs MIME Manual (DEVELOPMENT VERSION)
+@end ifset
+@ifclear WEBHACKDEVEL
 @title Emacs MIME Manual
+@end ifclear
 
 @author by Lars Magne Ingebrigtsen
 @page
@@ -374,12 +379,18 @@ message as follows:
 @vindex mm-inline-large-images
 When displaying inline images that are larger than the window, Emacs
 does not enable scrolling, which means that you cannot see the whole
-image.  To prevent this, the library tries to determine the image size
+image. To prevent this, the library tries to determine the image size
 before displaying it inline, and if it doesn't fit the window, the
-library will display it externally (e.g. with @samp{ImageMagick} or
-@samp{xv}).  Setting this variable to @code{t} disables this check and
+library will display it externally (e.g., with @samp{ImageMagick} or
+@samp{xv}). Setting this variable to @code{t} disables this check and
 makes the library display all inline images as inline, regardless of
-their size.
+their size. If you set this variable to @code{resize}, the image will
+be displayed resized to fit in the window, if Emacs has the ability to
+resize images.
+
+@item mm-inline-large-images-proportion
+@vindex mm-inline-images-max-proportion
+The proportion used when resizing large images.
 
 @item mm-inline-override-types
 @vindex mm-inline-override-types
@@ -394,7 +405,7 @@ variable will cause @samp{text/html} parts to be treated as attachments.
 @item mm-text-html-renderer
 @vindex mm-text-html-renderer
 This selects the function used to render @acronym{HTML}.  The predefined
-renderers are selected by the symbols @code{gnus-article-html}, @code{w3},
+renderers are selected by the symbols @code{gnus-article-html},
 @code{w3m}@footnote{See @uref{http://emacs-w3m.namazu.org/} for more
 information about emacs-w3m}, @code{links}, @code{lynx},
 @code{w3m-standalone} or @code{html2text}.  If @code{nil} use an
@@ -405,17 +416,17 @@ called with a @acronym{MIME} handle as the argument.
 @vindex mm-inline-text-html-with-images
 Some @acronym{HTML} mails might have the trick of spammers using
 @samp{<img>} tags.  It is likely to be intended to verify whether you
-have read the mail.  You can prevent your personal informations from
+have read the mail.  You can prevent your personal information from
 leaking by setting this option to @code{nil} (which is the default).
-It is currently ignored by Emacs/w3.  For emacs-w3m, you may use the
-command @kbd{t} on the image anchor to show an image even if it is
-@code{nil}.@footnote{The command @kbd{T} will load all images.  If you
-have set the option @code{w3m-key-binding} to @code{info}, use @kbd{i}
-or @kbd{I} instead.}
+For emacs-w3m, you may use the command @kbd{t} on the image anchor to
+show an image even if it is @code{nil}.@footnote{The command @kbd{T}
+will load all images.  If you have set the option
+@code{w3m-key-binding} to @code{info}, use @kbd{i} or @kbd{I}
+instead.}
 
 @item mm-w3m-safe-url-regexp
 @vindex mm-w3m-safe-url-regexp
-A regular expression that matches safe URL names, i.e. URLs that are
+A regular expression that matches safe URL names, i.e., URLs that are
 unlikely to leak personal information when rendering @acronym{HTML}
 email (the default value is @samp{\\`cid:}).  If @code{nil} consider
 all URLs safe.  In Gnus, this will be overridden according to the value
@@ -477,7 +488,7 @@ Delete all control characters.
 @item mm-file-name-delete-gotchas
 @findex mm-file-name-delete-gotchas
 Delete characters that could have unintended consequences when used
-with flawed shell scripts, i.e. @samp{|}, @samp{>} and @samp{<}; and
+with flawed shell scripts, i.e., @samp{|}, @samp{>} and @samp{<}; and
 @samp{-}, @samp{.} as the first character.
 
 @item mm-file-name-delete-whitespace
@@ -637,6 +648,12 @@ The @acronym{MIME} type of the part (@code{Content-Type}).
 Use the contents of the file in the body of the part
 (@code{Content-Disposition}).
 
+@item recipient-filename
+Use this as the file name in the generated @acronym{MIME} message for
+the recipient.  That is, even if the file is called @file{foo.txt}
+locally, use this name instead in the @code{Content-Disposition} in
+the sent message.
+
 @item charset
 The contents of the body of the part are to be encoded in the character
 set specified (@code{Content-Type}). @xref{Charset Translation}.
@@ -860,15 +877,15 @@ by using the @code{encoding} @acronym{MML} tag (@pxref{MML Definition}).
 @vindex mm-coding-system-priorities
 Prioritize coding systems to use for outgoing messages.  The default
 is @code{nil}, which means to use the defaults in Emacs, but is
-@code{(iso-8859-1 iso-2022-jp iso-2022-jp-2 shift_jis utf-8)} when
-running Emacs in the Japanese language environment.  It is a list of
-coding system symbols (aliases of coding systems are also allowed, use
-@kbd{M-x describe-coding-system} to make sure you are specifying correct
-coding system names).  For example, if you have configured Emacs
-to prefer UTF-8, but wish that outgoing messages should be sent in
-ISO-8859-1 if possible, you can set this variable to
-@code{(iso-8859-1)}.  You can override this setting on a per-message
-basis by using the @code{charset} @acronym{MML} tag (@pxref{MML Definition}).
+@code{(iso-8859-1 iso-2022-jp utf-8)} when running Emacs in the Japanese
+language environment.  It is a list of coding system symbols (aliases of
+coding systems are also allowed, use @kbd{M-x describe-coding-system} to
+make sure you are specifying correct coding system names).  For example,
+if you have configured Emacs to prefer UTF-8, but wish that outgoing
+messages should be sent in ISO-8859-1 if possible, you can set this
+variable to @code{(iso-8859-1)}.  You can override this setting on a
+per-message basis by using the @code{charset} @acronym{MML} tag
+(@pxref{MML Definition}).
 
 As different hierarchies prefer different charsets, you may want to set
 @code{mm-coding-system-priorities} according to the hierarchy in Gnus.
@@ -893,7 +910,7 @@ Here's an example:
           (mm-coding-system-priorities '(iso-8859-15 iso-8859-1 utf-8)))
          ("^fj\\." ;; Japanese
           (mm-coding-system-priorities
-           '(iso-8859-1 iso-2022-jp iso-2022-jp-2 shift_jis utf-8)))
+           '(iso-8859-1 iso-2022-jp utf-8)))
          ("^ru\\." ;; Cyrillic
           (mm-coding-system-priorities
            '(koi8-r iso-8859-5 iso-8859-1 utf-8))))
@@ -910,7 +927,7 @@ each case the most efficient of quoted-printable and base64 should be
 used.
 
 @code{qp-or-base64} has another effect.  It will fold long lines so that
-MIME parts may not be broken by MTA.  So do @code{quoted-printable} and
+MIME parts may not be broken by MTA@.  So do @code{quoted-printable} and
 @code{base64}.
 
 Note that it affects body encoding only when a part is a raw forwarded
@@ -982,7 +999,7 @@ Customization}).
 The charset to be used can be overridden by setting the @code{charset}
 @acronym{MML} tag (@pxref{MML Definition}) when composing the message.
 
-The encoding of characters (quoted-printable, 8bit etc) is orthogonal
+The encoding of characters (quoted-printable, 8bit, etc.)@: is orthogonal
 to the discussion here, and is controlled by the variables
 @code{mm-body-charset-encoding-alist} and
 @code{mm-content-transfer-encoding-defaults} (@pxref{Encoding
@@ -1034,6 +1051,10 @@ flowed text, the default is to wrap after 66 characters.  If hard
 newline characters are not present in the buffer, no flow encoding
 occurs.
 
+You can customize the value of the @code{mml-enable-flowed} variable
+to enable or disable the flowed encoding usage when newline
+characters are present in the buffer.
+
 On decoding flowed text, lines with soft newline characters are filled
 together and wrapped after the column decided by
 @code{fill-flowed-display-column}.  The default is to wrap after
@@ -1206,7 +1227,7 @@ Return the value of the field under point.
 @item mail-encode-encoded-word-region
 @findex mail-encode-encoded-word-region
 Encode the non-@acronym{ASCII} words in the region.  For instance,
-@samp{Na@"{@dotless{i}}ve} is encoded as @samp{=?iso-8859-1?q?Na=EFve?=}.
+@samp{Naïve} is encoded as @samp{=?iso-8859-1?q?Na=EFve?=}.
 
 @item mail-encode-encoded-word-buffer
 @findex mail-encode-encoded-word-buffer
@@ -1219,7 +1240,7 @@ Encode the words that need encoding in a string, and return the result.
 
 @example
 (mail-encode-encoded-word-string
- "This is na@"{@dotless{i}}ve, baby")
+ "This is naïve, baby")
 @result{} "This is =?iso-8859-1?q?na=EFve,?= baby"
 @end example
 
@@ -1234,7 +1255,7 @@ Decode the encoded words in the string and return the result.
 @example
 (mail-decode-encoded-word-string
  "This is =?iso-8859-1?q?na=EFve,?= baby")
-@result{} "This is na@"{@dotless{i}}ve, baby"
+@result{} "This is naïve, baby"
 @end example
 
 @end table
@@ -1427,13 +1448,13 @@ This is a version from which the regexp for the Q encoding pattern of
 @item rfc2047-encode-encoded-words
 @vindex rfc2047-encode-encoded-words
 The boolean variable specifies whether encoded words
-(e.g. @samp{=?us-ascii?q?hello?=}) should be encoded again.
+(e.g., @samp{=?us-ascii?q?hello?=}) should be encoded again.
 @code{rfc2047-encoded-word-regexp} is used to look for such words.
 
 @item rfc2047-allow-irregular-q-encoded-words
 @vindex rfc2047-allow-irregular-q-encoded-words
 The boolean variable specifies whether irregular Q encoded words
-(e.g. @samp{=?us-ascii?q?hello??=}) should be decoded.  If it is
+(e.g., @samp{=?us-ascii?q?hello??=}) should be decoded.  If it is
 non-@code{nil}, @code{rfc2047-encoded-word-regexp-loose} is used instead
 of @code{rfc2047-encoded-word-regexp} to look for encoded words.
 
@@ -1496,20 +1517,20 @@ Here's a bunch of time/date/second/day examples:
 (date-to-time "Sat Sep 12 12:21:54 1998 +0200")
 @result{} (13818 19266)
 
-(time-to-seconds '(13818 19266))
+(float-time '(13818 19266))
 @result{} 905595714.0
 
 (seconds-to-time 905595714.0)
-@result{} (13818 19266 0)
+@result{} (13818 19266 0 0)
 
 (time-to-days '(13818 19266))
 @result{} 729644
 
 (days-to-time 729644)
-@result{} (961933 65536)
+@result{} (961933 512)
 
 (time-since '(13818 19266))
-@result{} (0 430)
+@result{} (6797 9607 984839 247000)
 
 (time-less-p '(13818 19266) '(13818 19145))
 @result{} nil
@@ -1530,7 +1551,7 @@ Here's a bunch of time/date/second/day examples:
 (time-to-number-of-days
  (time-since
   (date-to-time "Mon, 01 Jan 2001 02:22:26 GMT")))
-@result{} 4.146122685185185
+@result{} 4314.095589286675
 @end example
 
 And finally, we have @code{safe-date-to-time}, which does the same as
@@ -1545,7 +1566,7 @@ An RFC822 (or similar) date string.  For instance: @code{"Sat Sep 12
 12:21:54 1998 +0200"}.
 
 @item time
-An internal Emacs time.  For instance: @code{(13818 26466)}.
+An internal Emacs time.  For instance: @code{(13818 26466 0 0)}.
 
 @item seconds
 A floating point representation of the internal Emacs time.  For
@@ -1568,9 +1589,8 @@ These are the functions available:
 @item date-to-time
 Take a date and return a time.
 
-@item time-to-seconds
-Take a time and return seconds.  Note that Emacs has a built-in
-function, @code{float-time}, that does this.
+@item float-time
+Take a time and return seconds.  (This is a built-in function.)
 
 @item seconds-to-time
 Take seconds and return a time.
@@ -1592,14 +1612,14 @@ Take a date and return a time.  If the date is not syntactically valid,
 return a ``zero'' time.
 
 @item time-less-p
-Take two times and say whether the first time is less (i. e., earlier)
+Take two times and say whether the first time is less (i.e., earlier)
 than the second time.
 
 @item time-since
 Take a time and return a time saying how long it was since that time.
 
 @item subtract-time
-Take two times and subtract the second from the first.  I. e., return
+Take two times and subtract the second from the first.  I.e., return
 the time between the two times.
 
 @item days-between
@@ -1840,7 +1860,7 @@ Conformance Criteria and Examples
 Languages, and Continuations
 
 @item RFC1843
-HZ - A Data Format for Exchanging Files of Arbitrarily Mixed Chinese and
+HZ---A Data Format for Exchanging Files of Arbitrarily Mixed Chinese and
 @acronym{ASCII} characters
 
 @item draft-ietf-drums-msg-fmt-05.txt
@@ -1875,5 +1895,5 @@ Documentation of the text/plain format parameter for flowed text.
 \f
 @c Local Variables:
 @c mode: texinfo
-@c coding: iso-8859-1
+@c coding: utf-8
 @c End: