Adjusted the documentation for the new character conversion feature
authorJoey Schulze <joey@infodrom.org>
Wed, 8 Feb 2006 09:03:07 +0000 (09:03 +0000)
committerJoey Schulze <joey@infodrom.org>
Wed, 8 Feb 2006 09:03:07 +0000 (09:03 +0000)
newmail.1

index 8bd308e..4fc57ad 100644 (file)
--- a/newmail.1
+++ b/newmail.1
@@ -1,4 +1,4 @@
-.\"  Copyright (c) 2004  Joey Schulze <joey@infodrom.org>
+.\"  Copyright (c) 2004,6  Joey Schulze <joey@infodrom.org>
 .\"
 .\"  This program is free software; you can redistribute it and/or modify
 .\"  it under the terms of the GNU General Public License as published by
@@ -14,7 +14,7 @@
 .\"  along with this program; if not, write to the Free Software
 .\"  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 .\"
-.TH NEWMAIL 1 "November 22nd, 2004" "Infodrom Oldenburg" "Mail Utilities"
+.TH NEWMAIL 1 "February 8th, 2006" "Infodrom Oldenburg" "Mail Utilities"
 .SH NAME
 newmail \- biff like tool for the terminal
 .SH SYNOPSIS
@@ -50,6 +50,12 @@ then
 .I string
 will be used as prefix for mails received in the mailbox denoted by
 .IR path .
+
+.B newmail
+is able to decode header lines when non-ascii characters are
+transported.  They will be displayed properly if the locale
+.RB ( LC_CTYPE )
+is set accordingly.
 .SH OPTIONS
 .TP
 .B \-b
@@ -68,15 +74,14 @@ prudent.
 .TP
 .B \-r
 Emit raw data from the mail.  This will bypass routines to decode
-character encodings used for mail headers.  This may be useful for
+character encodings used for mail headers as described in RFC 2047.
+This may be useful for
 window applications that want to decode the strings on their own.
-Since these routines aren't implemented yet, this is the default
-behaviour.
 .TP
 .B \-w
 Run as window application.  This will prevent
 .B newmail
-from putting it self into the background so its output can be used as
+from moving itself into the background so its output can be used as
 input for a window application.  This will also change the output
 format slightly and prevent a bell to be rung after new mail has been
 received.
@@ -108,6 +113,12 @@ option.
 .B newmail
 supports the following environment variables:
 .TP
+LANG
+Locale setting for the output character set. 
+.TP
+LC_CTYPE
+Locale setting only for the output character set. 
+.TP
 MAIL
 Full path of the user's spool mailbox.
 .SH NOTES
@@ -120,5 +131,7 @@ Many thanks go to Dave Taylor and the Elm Development Group who have
 provided me with a great mail program for several years.  Many
 additional thanks go to the former lead developer Dave Taylor who
 started the program back in 1986.
+.SH "SEE ALSO"
+.BR locale (7).
 .SH AUTHOR
 Joey Schulze <joey@infodrom.org>