[Bug 1085724] [NEW] mutt incorrect / misleading documentation in manual.txt

[B Bobo]

Public bug reported:

The documentation in manual.txt is incorrect / misleading in several
places.

1. See under section 2, "Regular Expressions"

     "\" must be quoted if used for a regular expression in an
initialization command: “\\”.

"Quoted" is an incorrect and misleading word in this context. The
intended meaning is actually "escaped".  A better wording for the
sentence, also changing "for" to "in":

     "\" must be escaped if used in a regular expression in an
initialization command: “\\”.


2. Inconsistent terminology.

The documentation refers in various places to: "config commands",
"muttrc commands", and even "commands", but all of these terms actually
mean "muttrc commands".  It would be better to use consistent
terminology, e.g. change "commands" and "config commands" into "muttrc
commands" everywhere in the documentation.

In manual.txt it says under the section "Command-Line Options":

     │-e    │specify a config command to be run after initialization
files are read│

change to:
     │-e    │specify a muttrc command to be run after initialization files are read│     

and mutt's command-line help says:

  -e <command>  specify a command to be executed after initialization

This should be changed for consistency to:
  -e <command>	specify a muttrc command to be executed after initialization

** Affects: mutt (Ubuntu)
     Importance: Undecided
         Status: New


** Tags: documentation manpage mutt

-- 
You received this bug notification because you are a member of Ubuntu
Foundations Bugs, which is subscribed to mutt in Ubuntu.
https://bugs.launchpad.net/bugs/1085724

Title:
  mutt incorrect / misleading documentation in manual.txt

Status in “mutt” package in Ubuntu:
  New

Bug description:
  The documentation in manual.txt is incorrect / misleading in several
  places.

  1. See under section 2, "Regular Expressions"

       "\" must be quoted if used for a regular expression in an
  initialization command: “\\”.

  "Quoted" is an incorrect and misleading word in this context. The
  intended meaning is actually "escaped".  A better wording for the
  sentence, also changing "for" to "in":

       "\" must be escaped if used in a regular expression in an
  initialization command: “\\”.

  
  2. Inconsistent terminology.

  The documentation refers in various places to: "config commands",
  "muttrc commands", and even "commands", but all of these terms
  actually mean "muttrc commands".  It would be better to use consistent
  terminology, e.g. change "commands" and "config commands" into "muttrc
  commands" everywhere in the documentation.

  In manual.txt it says under the section "Command-Line Options":

       │-e    │specify a config command to be run after initialization
  files are read│

  change to:
       │-e    │specify a muttrc command to be run after initialization files are read│     

  and mutt's command-line help says:

    -e <command>  specify a command to be executed after initialization

  This should be changed for consistency to:
    -e <command>	specify a muttrc command to be executed after initialization

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/mutt/+bug/1085724/+subscriptions