New 'Command' Translations Coming Soon

[flatcap]

Hi @neomutt/translators

I'm planning to add one-line help description for all of the NeoMutt Commands, e.g. :color

This is a draft.
If you have any questions / suggestions, please let me know.

Cheers ❤️ @flatcap

(click to expand)

Command Help

account-hook        Run a command when switching to a matching account
alias               Define an alias (name to email address)
alternates          Define a list of alternate email addresses for the user
alternative_order   Set preference order for multipart alternatives
append-hook         Define command to append to a compressed mailbox
attachments         Set attachment counting rules
auto_view           Automatically display specified MIME types inline
bind                Bind a key to a function
cd                  Change NeoMutt's current working directory
charset-hook        Define charset alias for languages
close-hook          Define command to close a compressed mailbox
color               Define colors for the user interface
crypt-hook          Specify which keyid to use for recipients matching regex
echo                Print a message to the status line
exec                Execute a function
fcc-hook            Pattern rule to set the save location for outgoing mail
fcc-save-hook       Equivalent to both 'fcc-hook' and 'save-hook'
finish              Stop reading current config file
folder-hook         Run a command upon entering a folder matching regex
group               Add addresses to an address group
hdr_order           Define custom order of headers displayed
hooks               Show a list of all the hooks
iconv-hook          Define a system-specific alias for a character set
ifdef               Conditionally include config commands if symbol defined
ifndef              Conditionally include if symbol is not defined
ignore              Hide specified headers when displaying messages
index-format-hook   Create dynamic index format strings
lists               Add address to the list of mailing lists
lua                 Run a Lua expression or call a Lua function
lua-source          Execute a Lua script file
macro               Define a keyboard macro
mailboxes           Define a list of mailboxes to watch
mailto_allow        Permit specific header-fields in mailto URL processing
mbox-hook           On leaving a mailbox, move read messages matching a regex
message-hook        Run a command when viewing a message matching patterns
mime_lookup         Map specified MIME types/subtypes to display handlers
mono                Deprecated: Use 'color'
my_hdr              Add a custom header to outgoing messages
named-mailboxes     Define a list of labelled mailboxes to watch
nospam              Remove a spam detection rule
open-hook           Define command to open a compressed mailbox
push                Push a string into NeoMutt's input queue (simulate typing)
reply-hook          Run a command when replying to messages matching a pattern
reset               Reset a config option to its initial value
save-hook           Set default save folder for messages
score               Set a score value on emails matching a pattern
send-hook           Run a command when sending a message, new or reply, matching a pattern
send2-hook          Run command whenever a composed message is edited
set                 Set a config variable
setenv              Set an environment variable
shutdown-hook       Run a command before NeoMutt exits
sidebar_pin         Pin a mailbox in the sidebar (keep visible)
sidebar_unpin       Unpin a previously pinned mailbox in the sidebar
source              Read and execute commands from a config file
spam                Define rules to parse spam detection headers
startup-hook        Run a command when NeoMutt starts up
subjectrx           Apply regex-based rewriting to message subjects
subscribe           Add address to the list of subscribed mailing lists
subscribe-to        Subscribe to an IMAP mailbox
tag-formats         Define expandos tags
tag-transforms      Rules to transform tags into icons
timeout-hook        Run a command after a specified timeout or idle period
toggle              Toggle the value of a boolean/quad config option
unalias             Remove an alias definition
unalternates        Remove addresses from 'alternates' list
unalternative_order Remove MIME types from preference order
unattachments       Remove attachment counting rules
unauto_view         Remove MIME types from 'auto_view' list
unbind              Remove a key binding
uncolor             Remove a 'color' definition
ungroup             Remove addresses from an address 'group'
unhdr_order         Remove header from 'hdr_order' list
unhook              Remove hooks of a given type
unignore            Remove a header from the 'hdr_order' list
unlists             Remove address from the list of mailing lists
unmacro             Remove a keyboard 'macro'
unmailboxes         Remove mailboxes from the watch list
unmailto_allow      Disallow header-fields in mailto processing
unmime_lookup       Remove custom MIME-type handlers
unmono              Deprecated: Use 'uncolor'
unmy_hdr            Remove a header previously added with 'my_hdr'
unscore             Remove scoring rules for matching patterns
unset               Reset a config option to false/empty
unsetenv            Unset an environment variable
unsubjectrx         Remove subject-rewriting rules
unsubscribe         Remove address from the list of subscribed mailing lists
unsubscribe-from    Unsubscribe from an IMAP mailbox
version             Show NeoMutt version and build information

I may also add Command Prototypes to the help.
It's another 90 translations (sorry), but it should be a quick search/replace of a few keywords.
This needs a bit more work, but it's representative.

Command Prototypes

account-hook        <regex> <command>
alias               [ -group <name> ... ] <key> <address> [, <address> ... ]
alternates          [ -group <name> ... ] <regex> [ <regex> ... ]
alternative_order   <mime-type>[/<mime-subtype> ] [ <mime-type>[/<mime-subtype> ] ... ]
append-hook         <regex> <shell-command>
attachments         { + | - }<disposition> <mime-type> [ <mime-type> ... ] | ?
auto_view           <mime-type>[/<mime-subtype> ] [ <mime-type>[/<mime-subtype> ] ... ]
bind                <map>[,<map> ... ] <key> <function>
cd                  [ <directory> ]
charset-hook        <alias> <charset>
close-hook          <regex> <shell-command>
color               <object> [ <attribute> ... ] <foreground> <background> [ <regex> [ <num> ]]
crypt-hook          <regex> <keyid>
echo                <message>
exec                <function> [ <function> ... ]
fcc-hook            <pattern> <mailbox>
fcc-save-hook       <pattern> <mailbox>
finish
folder-hook         [ -noregex ] <regex> <command>
group               [ -group <name> ... ] { -rx <regex> ... | -addr <address> ... }
hdr_order           <header> [ <header> ... ]
hooks               hooks
iconv-hook          <charset> <local-charset>
ifdef               <symbol> '<config-command> [ <args> ... ]'
ifndef              <symbol> '<config-command> [ <args> ... ]'
ignore              { * | <string> ... }
index-format-hook   <name> [ ! ]<pattern> <format-string>
lists               [ -group <name> ... ] <regex> [ <regex> ... ]
lua                 '<lua-commands>'
lua-source          <file>
macro               <menu>[,<menu> ... ] <key> <sequence> [ <description> ]
mailboxes           [[ -label <label> ] | -nolabel ] [[ -notify | -nonotify ] [ -poll | -nopoll ] <mailbox> ] [ ... ]
mailto_allow        { * | <header-field> ... }
mbox-hook           [ -noregex ] <regex> <mailbox>
message-hook        <pattern> <command>
mime_lookup         <mime-type>[/<mime-subtype> ] [ <mime-type>[/<mime-subtype> ] ... ]
mono                <object> <attribute> [ <pattern> | <regex> ]
my_hdr              <string>
named-mailboxes     <description> <mailbox> [ <description> <mailbox> ... ]
nospam              { * | <regex> }
open-hook           <regex> <shell-command>
push                <string>
reply-hook          <pattern> <command>
reset               <variable> [ <variable> ... ]
save-hook           <pattern> <mailbox>
score               <pattern> <value>
send-hook           <pattern> <command>
send2-hook          <pattern> <command>
set                 { [ no | inv | & ] <variable> [?] | <variable> [=|+=|-=] value } [ ... ]
setenv              { <variable>? | <variable> <value> }
shutdown-hook       <command>
sidebar_pin         <mailbox> [ <mailbox> ... ]
sidebar_unpin       { * | <mailbox> ... }
source              <filename>
spam                <regex> <format>
startup-hook        <command>
subjectrx           <regex> <replacement>
subscribe           [ -group <name> ... ] <regex> [ <regex> ... ]
subscribe-to        <imap-folder-uri>
tag-formats         <tag> <format-string> { tag format-string ... }
tag-transforms      <tag> <transformed-string> { tag transformed-string ... }
timeout-hook        <command>
toggle              <variable> [ <variable> ... ]
unalias             { * | <key> ... }
unalternates        { * | <regex> ... }
unalternative_order { * | [ <mime-type>[/<mime-subtype> ] ... ] }
unattachments       { * | { + | - }<disposition> <mime-type> [ <mime-type> ... ] }
unauto_view         { * | [ <mime-type>[/<mime-subtype> ] ... ] }
unbind              { * | <menu>[,<menu> ... ] } [ <key> ]
uncolor             <object> { * | <pattern> ... }
ungroup             [ -group <name> ... ] { * | -rx <regex> ... | -addr <address> ... }
unhdr_order         { * | <header> ... }
unhook              { * | <hook-type> }
unignore            { * | <string> ... }
unlists             { * | <regex> ... }
unmacro             { * | <menu>[,<menu> ... ] } [ <key> ]
unmailboxes         { * | <mailbox> ... }
unmailto_allow      { * | <header-field> ... }
unmime_lookup       { * | [ <mime-type>[/<mime-subtype> ] ... ] }
unmono              <object> { * | <pattern> ... }
unmy_hdr            { * | <field> ... }
unscore             { * | <pattern> ... }
unset               <variable> [ <variable> ... ]
unsetenv            <variable>
unsubjectrx         { * | <regex> }
unsubscribe         { * | <regex> ... }
unsubscribe-from    <imap-folder-uri>
version

[flatcap]

I've committed the changes in c0d35ec847293229f3c4c35f72fca36611eecdc3

There are 88 Commands, each with two translations:

• First is a simple description of the Command
• Second is the Command's prototype -- its name and the arguments it takes

e.g.

#: commands/commands.c:66
msgid "Define a list of alternate email addresses for the user"
msgstr ""

#: commands/commands.c:67
#, fuzzy
msgid "alternates [ -group <name> ... ] <regex> [ <regex> ... ]"
msgstr "alternates [ -group <name> ... ] <regex> [ <regex> ... ]"

Notes:

• The prototype is in the style of a man page
• The first word is the Command name, which should not be translated
• Options, prefixed by - (dash) should not be translated
• Arguments in <>s should be* translated

I've pre-populated all the prototypes so they can be quickly translated.

---

There's no rush to translate as I have more refactoring work to do.

If you have any questions, let me know.
Cheers ❤️ @flatcap

[bitigchi]

It’s a great addition!

Maybe as a cosmetic idea, would it be okay to make sure all command specifications are formatted for an 80-column display? Newline characters can be used to make use they align nicely when too long. It just looks not so ideal when the line wraps are all random.

[flatcap]

Thanks, @bitigchi.

The help is now visible for all commands with the :COMMAND? syntax, e.g.

:send-hook?

shows

Run a command when sending a message, new or reply, matching a pattern
:send-hook <pattern> <command>
file:///usr/share/doc/neomutt/configuration.html#send-hook

command specifications are formatted for an 80-column display

Good idea.

Newline characters can be used

I'd prefer it if we crammed the specs into 80 chars, even if we have a cheat a little.
The Message Window is limited to three lines.

The majority of specs are 70 chars or fewer (in English).
There are ten, we might need to fix (in translation):

                                                                     |         |         |         |
                                                                     |         |         |         |
alternative_order <mime-type>[/<mime-subtype> ] [ <mime-type>[/<mime-subtype> ] ... ]
auto_view <mime-type>[/<mime-subtype> ] [ <mime-type>[/<mime-subtype> ] ... ]
color <object> [ <attribute> ... ] <foreground> <background> [ <regex> [ <num> ]]
mailboxes [[ -label <label> ] | -nolabel ] [[ -notify | -nonotify ] [ -poll | -nopoll ] <mailbox> ] [ ... ]
mime_lookup <mime-type>[/<mime-subtype> ] [ <mime-type>[/<mime-subtype> ] ... ]
named-mailboxes <description> <mailbox> [ <description> <mailbox> ... ]
set { [ no | inv | & ] <variable> [?] | <variable> [=|+=|-=] value } [ ... ]
tag-transforms <tag> <transformed-string> { tag transformed-string ... }
unattachments { * | { + | - }<disposition> <mime-type> [ <mime-type> ... ] }
ungroup [ -group <name> ... ] { * | -rx <regex> ... | -addr <address> ... }
                                                                     |         |         |         |
                                                                     |         |         |         |
                                                                     70        80        90        100

We could drop the repeated clauses, e.g.

alternative_order <mime-type>[/<mime-subtype> ] [ <mime-type>[/<mime-subtype> ] ... ]

alternative_order <mime-type>[/<mime-subtype> ] [ ... ]

and maybe abbreviate the mailboxes options

mailboxes [[ -label <label> ] | -nolabel ] [[ -notify | -nonotify ] [ -poll | -nopoll ] <mailbox> ] [ ... ]

mailboxes [[ -label <label> ] | -nolabel ] [[ -[no]notify ] [ -[no]poll ] <mailbox> ] [ ... ]

mailboxes [ -[no]label [ <label> ] ] [ -[no]notify ] [ -[no]poll ] <mailbox> ] [ ... ]

86 chars

mailboxes [ -[no]label [ <label> ] ] [ -[no]notify ] [ -[no]poll ] <mailbox> ]

78 chars

Suggestions welcome.

[kbcb]

Dear Rich, Before I commit I would like to ask you if you agree with my handling the line width issue:

…

--- Nowhere I changed the msgid line! commands/commands.c:line-number # 71: I did as you suggested above. ``` msgid "alternative_order <MIME-Typ>[/<MIME-Subtyp> ] [ <MIME-Typ>[/<MIME-Subtyp> ] ... ]" msgstr "alternative_order <MIME-Typ>[/<MIME-Subtyp> ] [ ... ]" ``` # 87: English version shorter than 80 chars. Had to abbreviate the german words 'Vordergrund' and 'Hintergrund'. I guess that's OK for Germans. ``` "color <Objekt> [ <Attribut> ... ] <Vordergrd> <Hintergrd> [ <regex> [ <Num> ]]" ``` # 123: I had to abbreviate the german word 'Postfach'. ``` "mailboxes [[ -label <Etikett> ] | -nolabel ] [[ -notify | -nonotify ] [ -poll | -nopoll ] <Postfach> ] [ ... ]" "mailboxes [ -[no]label [ <Etikett> ] ] [ -[no]notify ] [ -[no]poll ] <Postf> ]" ``` # 131: Stayed below 80chars in translation. ``` "mime_lookup <mime-type>[/<mime-subtype> ] [ <mime-type>[/<mime-subtype> ] ... ]" "mime_lookup <MIME-Typ>[/<MIME-Subtyp> ] [ <MIME-Typ>[/<MIME-Subtyp> ] ... ]" ``` # 183: Exactly 80chars. ``` msgstr "tag-transforms <Etikett> <umgeformte Zeichen> { Etikett umgeformte Zeichen ... }" ``` --- If you do not object I would commit. If you do object please provide some hints on how I can improve the contribution. Many many thanks! All the best kbcb

[flatcap]

Hi @kbcb

That looks pretty great.
Nice work!

It should be enough to remind the user what they need to know.
I'm probably going to also display a URL to the relevant docs.

---

I'm pretty happy with the wording of the Command Descriptions.

I have abbreviated the Prototypes, but I haven't committed them yet -- still thinking.
When I do, I'll merge them "magically" to avoid invalidating your translations.

[flatcap]

FYI, I've also renamed a bunch of commands, for consistency.

There's no work to do -- I've automagically updated all the translations.
For more info, see: neomutt/neomutt#4751

Old	New
alternative_order	alternative-order
auto_view	auto-view
hdr_order	hdr-order
mailto_allow	mailto-allow
mime_lookup	mime-lookup
my_hdr	my-hdr
sidebar_pin	sidebar-pin
sidebar_unpin	sidebar-unpin
unalternative_order	unalternative-order
unauto_view	unauto-view
unhdr_order	unhdr-order
unmailto_allow	unmailto-allow
unmime_lookup	unmime-lookup
unmy_hdr	unmy-hdr
hdr_order	header-order
my_hdr	my-header
unhdr_order	unheader-order
unmy_hdr	unmy-header
subjectrx	subject-regex