Skip to content

Commit

Permalink
docs: light tidying
Browse files Browse the repository at this point in the history
- substitute mutt with neomutt
- fix openSUSE capitalisation
  • Loading branch information
flatcap committed Mar 13, 2018
1 parent f68e325 commit dc786a4
Show file tree
Hide file tree
Showing 20 changed files with 98 additions and 98 deletions.
4 changes: 2 additions & 2 deletions ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- browser: `<goto-parent>` function bound to "p"
- editor: `<history-search>` function bound to "Ctrl-r"
- Cygwin support: https://www.neomutt.org/distro/cygwin
- OpenSUSE support: https://www.neomutt.org/distro/suse
- openSUSE support: https://www.neomutt.org/distro/suse
- Upstream Homebrew support: Very soon - https://www.neomutt.org/distro/homebrew
* Bug Fixes
- gmail server-size search
Expand All @@ -19,7 +19,7 @@
- Updated French translation
* Website
- Installation guide for Cygwin
- Installation guide for OpenSUSE
- Installation guide for openSUSE
- Installation guide for CRUX
* Build
- check that DTDs are installed
Expand Down
46 changes: 23 additions & 23 deletions INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,23 @@ Notes
or
S-Lang, ftp://space.mit.edu/pub/davis/slang/

- Mutt needs an implementation of the iconv API for character set
- NeoMutt needs an implementation of the iconv API for character set
conversions. A free one can be found under the following URL:

http://www.gnu.org/software/libiconv/

- For building the manual, mutt needs the DocBook XSL stylesheets
- For building the manual, neomutt needs the DocBook XSL stylesheets
as well as the DocBook DTD as of version 4.2 installed locally.


Installation
============

Installing Mutt is rather painless through the use of the GNU
autoconf package. Simply untar the Mutt distribution, and run the
Installing NeoMutt is rather painless through the use of the GNU
autoconf package. Simply untar the NeoMutt distribution, and run the
``configure'' script. If you have obtained the distribution from
the Mercurial repository, run the ``prepare'' script with the same command
line parameters you would pass to configure. It will set up mutt's
line parameters you would pass to configure. It will set up neomutt's
build environment and add the files which are present in the tar
balls, but not in the Mercurial repository.

Expand All @@ -35,7 +35,7 @@ needs to know in order to compile. However, there are a few options
to ``configure'' to help it out, or change the default behavior:

--prefix=DIR
install Mutt in DIR instead of /usr/local
install NeoMutt in DIR instead of /usr/local

--with-curses=DIR
use the curses lib in DIR/lib. If you have ncurses, ``configure''
Expand All @@ -46,7 +46,7 @@ to ``configure'' to help it out, or change the default behavior:
use the S-Lang library instead of ncurses. This library seems to
work better for some people because it is less picky about proper
termcap entries than ncurses. It is recommended that you use at
*least* version 0.99-38 with Mutt.
*least* version 0.99-38 with NeoMutt.

--with-mailpath=DIR
specify where the spool mailboxes are located on your system
Expand Down Expand Up @@ -76,25 +76,25 @@ to ``configure'' to help it out, or change the default behavior:
Use the Cyrus SASL library for IMAP or POP authentication. This
library provides generic support for several authentication methods,
and more may be added by the system administrator without recompiling
mutt. SASL may also be able to encrypt your mail session even if
neomutt. SASL may also be able to encrypt your mail session even if
SSL is not available.

--disable-nls
This switch disables mutt's native language support.
This switch disables neomutt's native language support.

--enable-flock
use flock() to lock files.

--disable-fcntl
by default, Mutt uses fcntl() to lock files. Over NFS this can
by default, NeoMutt uses fcntl() to lock files. Over NFS this can
result in poor performance on read/write.

--enable-locales-fix
on some systems, the result of isprint() can't be used reliably
to decide which characters are printable, even if you set the
LANG environment variable. If you set this option, Mutt will
LANG environment variable. If you set this option, NeoMutt will
assume all characters in the ISO-8859-* range are printable. If
you leave it unset, Mutt will attempt to use isprint() if either
you leave it unset, NeoMutt will attempt to use isprint() if either
of the environment variables LANG, LC_ALL or LC_CTYPE is set,
and will revert to the ISO-8859-* range if they aren't.
If you need --enable-locales-fix then you will probably need
Expand All @@ -103,22 +103,22 @@ to ``configure'' to help it out, or change the default behavior:
LC_ALL or LC_CTYPE instead).

--without-wc-funcs
by default Mutt uses the functions mbrtowc(), wctomb() and
by default NeoMutt uses the functions mbrtowc(), wctomb() and
wcwidth() provided by the system, when they are available.
With this option Mutt will use its own version of those
With this option NeoMutt will use its own version of those
functions, which should work with 8-bit display charsets, UTF-8,
euc-jp or shift_jis, even if the system doesn't normally support
those multibyte charsets.

If you find Mutt is displaying non-ascii characters as octal
If you find NeoMutt is displaying non-ascii characters as octal
escape sequences (e.g. \243), even though you have set LANG and
LC_CTYPE correctly, then you might find you can solve the problem
with either or both of --enable-locales-fix and --without-wc-funcs.

Once ``configure'' has completed, simply type ``make install.''

Mutt should compile cleanly (without errors) and you should end up with a
binary called ``mutt.'' If you get errors about undefined symbols like
NeoMutt should compile cleanly (without errors) and you should end up with a
binary called ``neomutt.'' If you get errors about undefined symbols like
A_NORMAL or KEY_MIN, then you probably don't have a SysV compliant curses
library. You should install either ncurses or S-Lang (see above), and then
run the ``configure'' script again.
Expand All @@ -130,10 +130,10 @@ Please note that "VPATH" builds currently only work with GNU make (gmake).
Character set support
=====================

Mutt no longer contains functions for doing character set conversion.
NeoMutt no longer contains functions for doing character set conversion.
Instead, it expects the iconv functions (iconv_open, iconv,
iconv_close) to be provided. Most up-to-date systems provide these
functions, often as part of the C library. If you are installing Mutt
functions, often as part of the C library. If you are installing NeoMutt
on a system which does not have them, it is recommended that you
install Bruno Haible's portable libiconv library, which you can obtain
from:
Expand All @@ -146,21 +146,21 @@ version of iconv.


If you decide to use your system's iconv implementation, you may
need to tell mutt about implementation-defined names for some
need to tell neomutt about implementation-defined names for some
character sets. Sample configuration files for various systems can
be found in the directory contrib/iconv/ in this source
distribution, and will be installed in the samples/iconv directory
as part of mutt's documentation.
as part of neomutt's documentation.

In order to use these sample configuration files, just put a line
like

source /usr/local/doc/mutt/samples/iconv/iconv.osf1-4.0d.rc
source /usr/local/doc/neomutt/samples/iconv/iconv.osf1-4.0d.rc

into your system's global Muttrc, which normally resides in /etc or
/usr/local/etc.


If you really want to, you can configure Mutt --disable-iconv, but
If you really want to, you can configure NeoMutt --disable-iconv, but
there will then be no character set conversion.

18 changes: 9 additions & 9 deletions README.SSL
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
IMAP/SSL in mutt
IMAP/SSL in neomutt
================

Compilation
-----------
If you want to have SSL support in mutt, you need to install OpenSSL
If you want to have SSL support in neomutt, you need to install OpenSSL
(http://www.openssl.org) libraries and headers before compiling.
OpenSSL versions 0.9.3 through 1.0.1c have been tested.

Expand All @@ -29,7 +29,7 @@ or
mailboxes imaps://localhost/inbox
mailboxes imaps://localhost:994/inbox

If you get errors about lack of entropy, it means that Mutt was unable
If you get errors about lack of entropy, it means that NeoMutt was unable
to find a source of random data to initialize SSL library with. Should
this happen, you need to generate the data yourself and save it in a
file pointed by $entropy_file or $RANDFILE (environment) variables or
Expand All @@ -40,10 +40,10 @@ generates unpredictable output, for example 'ps aluxww' in Linux, and
calculating the MD5-sum from the output and saving it in a file.

** Note: The contents of the file pointed by $RANDFILE environment
** variable (or ~/.rnd if unset) will be overwritten every time Mutt
** variable (or ~/.rnd if unset) will be overwritten every time NeoMutt
** is run so don't put anything you can't afford to lose in that file.

The files Mutt will try to use to initialize SSL library with are files
The files NeoMutt will try to use to initialize SSL library with are files
pointed by $entropy_file and $RANDFILE (or ~/.rnd if unset.) If your
OpenSSL is version 0.9.5 or later, the previous files can also be EGD
sockets (see http://www.lothar.com/tech/crypto/ for more information
Expand All @@ -66,7 +66,7 @@ can also be saved so that further connections to the server are
automatically accepted.

If OpenSSL was built with support for ServerNameIndication (SNI) and TLS
is used in the negotiation, mutt will send its idea of the server-name
is used in the negotiation, neomutt will send its idea of the server-name
as part of the TLS negotiation. This allows the server to select an
appropriate certificate, in the event that one server handles multiple
hostnames with different certificates.
Expand All @@ -75,7 +75,7 @@ If your organization has several equivalent IMAP-servers, each of them
should have a unique certificate which is signed with a common
certificate. If you want to use all of those servers, you don't need to
save each server certificate on the first connect. Instead, you can get
the signer certificate and save it instead. That way, mutt will
the signer certificate and save it instead. That way, neomutt will
automatically accept all certificates signed with the saved certificate.

System-wide certificates are by default considered trusted when checking
Expand All @@ -90,7 +90,7 @@ certificates each time you connect to a server, you have set this
variable to some reasonable value.

For example:
set certificate_file=~/.mutt/certificates
set certificate_file=~/.neomutt/certificates


Troubleshooting
Expand Down Expand Up @@ -119,4 +119,4 @@ [email protected]

Updated by:
Jeremy Katz <[email protected]>
Phil Pennock <mutt[email protected]>
Phil Pennock <neomutt[email protected]>
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ sorted through them, fixed them up and documented them.
| Encrypt-to-Self | Save a self-encrypted copy of emails
| Fmemopen | Replace some temporary files with memory buffers
| Forgotten Attachment | Alert user when (s)he forgets to attach a file to an outgoing email.
| Global Hooks | Define actions to run globally within Mutt
| Global Hooks | Define actions to run globally within NeoMutt
| Ifdef | Conditional config options
| Index Color | Custom rules for theming the email index
| Initials Expando | Expando for author's initials
Expand Down Expand Up @@ -56,8 +56,8 @@ sorted through them, fixed them up and documented them.
| ---------------------- | ---------------------------------------------
| Header Cache Benchmark | Script to test the speed of the header cache
| Keybase | Keybase Integration
| Useful programs | List of useful programs interacting with mutt
| Vi Keys | Easy and clean Vi-keys for Mutt
| Useful programs | List of useful programs interacting with NeoMutt
| Vi Keys | Easy and clean Vi-keys for NeoMutt
| Vim Syntax | Vim Syntax File

## Where is NeoMutt?
Expand Down
2 changes: 1 addition & 1 deletion contrib/keybase/keybase.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def encryptSign(parameters):
print("Type help to learn how to use me.")

while exitVar.lower() != 'quit':
inputStuffs = input('mutt#: ')
inputStuffs = input('neomutt#: ')
if (inputStuffs.lower() == 'help'):
helpfunc()

Expand Down
26 changes: 13 additions & 13 deletions doc/PGP-Notes.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
USING PGP FROM WITHIN MUTT
USING PGP FROM WITHIN NEOMUTT


WARNING: The configuration interface has completely changed as of
Expand All @@ -9,12 +9,12 @@ WARNING: The configuration interface has completely changed as of
USERS' GUIDE


How do I use mutt with PGP, PGP5, or GnuPG?
How do I use neomutt with PGP, PGP5, or GnuPG?
-------------------------------------------

Go to the contrib subdirectory of the source tree. You'll find
three files there, pgp2.rc, pgp5.rc, and gpg.rc. These files
contain ready-to-use configurations for using mutt with pgp2, pgp5,
contain ready-to-use configurations for using neomutt with pgp2, pgp5,
and gpg.

Include one of these files with your ~/.muttrc, and things should
Expand All @@ -28,10 +28,10 @@ given to the PGP binaries match your needs.
Frequently Asked Questions and Tips
-----------------------------------

Q: "People are sending PGP messages which mutt doesn't
Q: "People are sending PGP messages which neomutt doesn't
recognize. What can I do?"

The new way is to leave headers alone and use mutt's
The new way is to leave headers alone and use neomutt's
check-traditional-pgp function, which can detect PGP messages at
run-time, and adjust content-types.

Expand Down Expand Up @@ -96,7 +96,7 @@ if (/^$BPGPS/:b && /^$EPGPS/:b)

Q: "I don't like that PGP/MIME stuff, but want to use the
old way of PGP-signing my mails. Can't you include
that with mutt?"
that with neomutt?"

The old answer to this question used to be this:

Expand All @@ -113,7 +113,7 @@ The old answer to this question used to be this:

There's a new answer, though: Set the $pgp_autoinline
configuration variable (it's a quad-option) to something different
from "no" (that's the default). Mutt will then try to use
from "no" (that's the default). NeoMutt will then try to use
application/pgp wherever it makes sense. In particular, it does
not make any sense with multiparts, or non-ASCII or non-text bodies.
In all other cases, PGP/MIME is used unconditionally.
Expand All @@ -127,7 +127,7 @@ Q: "I don't like all the ^Gs and various other verbosity

Roland Rosenfeld <[email protected]> has found a quite
elegant solution to this problem: PGP has some pretty good foreign
language support. So we just introduce a language called "mutt"
language support. So we just introduce a language called "neomutt"
which contains empty strings for the messages we don't want to see.
To use this, copy either language.txt or language50.txt (depending
on what PGP version you are using) to your $PGPPATH. Make sure the
Expand Down Expand Up @@ -157,15 +157,15 @@ or exim.
Auxiliary Programs
------------------

Mutt needs two auxiliary programs for its PGP support: pgpewrap and
NeoMutt needs two auxiliary programs for its PGP support: pgpewrap and
pgpring.


1. pgpring

pgpring is a key ring dumper. It extracts information from PGP's
binary key ring and emits it in an (almost) readable output format
understood by mutt's key selection routines. This output format
understood by neomutt's key selection routines. This output format
mimics the one used by the GNU Privacy Guard (GPG).

You'll need this program with PGP 2 and PGP 5.
Expand Down Expand Up @@ -203,14 +203,14 @@ will execute:
pgpe file -r a -r b -r c

This script is needed with PGP 5 and with GPG, since their command
line interfaces can't be properly served by mutt's format mechanism.
line interfaces can't be properly served by neomutt's format mechanism.



The Configuration Interface
---------------------------

As usual within mutt, the configuration interface for the PGP
As usual within neomutt, the configuration interface for the PGP
commands relies on printf-like formats. For all PGP commands, the
following %-sequences are defined.

Expand All @@ -230,7 +230,7 @@ following %-sequences are defined.
configuration variable $pgp_sign_as. You probably need to
use this within a conditional % sequence.

%r In many contexts, mutt passes key IDs to pgp. %r expands to
%r In many contexts, neomutt passes key IDs to pgp. %r expands to
a list of key IDs.

The following command formats are defined:
Expand Down
4 changes: 2 additions & 2 deletions doc/mbox.5
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ into
before storing it. Besides \fBMBOXO\fP and \fBMBOXRD\fP there is also
\fBMBOXCL\fP which is \fBMBOXO\fP with a "Content-Length:"\-field with the
number of bytes in the message body; some MUAs (like
.BR mutt (1))
.BR neomutt (1))
do automatically transform \fBMBOXO\fP mailboxes into \fBMBOXCL\fP ones when
ever they write them back as \fBMBOXCL\fP can be read by any \fBMBOXO\fP-MUA
without any problems.
Expand Down Expand Up @@ -147,7 +147,7 @@ format folders.
.PP
.\"
.SH "SEE ALSO"
.BR mutt (1),
.BR neomutt (1),
.BR fcntl (2),
.BR flock (2),
.BR link (2),
Expand Down
Loading

0 comments on commit dc786a4

Please sign in to comment.