diff options
| author | Danilo M. <danix@danix.xyz> | 2026-08-04 10:09:59 +0200 |
|---|---|---|
| committer | Danilo M. <danix@danix.xyz> | 2026-08-04 12:54:34 +0200 |
| commit | 4df7edfc259fb3bdb3814ffe6549ecd3ee448578 (patch) | |
| tree | 2b27cbff8bcf82a7f60a35c85c8d5c727387666a /README.md | |
| parent | 0e149dfb514de8eada2c8c8430352ac984d3c5ba (diff) | |
| download | qtmaildir-4df7edfc259fb3bdb3814ffe6549ecd3ee448578.tar.gz qtmaildir-4df7edfc259fb3bdb3814ffe6549ecd3ee448578.zip | |
docs: comment out the live example config in the README
The configuration block is presented as something to copy, and every
optional key in it is commented out with ';' except two. Copying the
block therefore activated whatever those two happened to say: three
extra mimetypes nobody chose, and a sync command pointing at a path
that does not exist on the reader's machine.
Neither was harmful (extra_mimetypes only appends to the built-in list,
and an unresolvable sync command just disables the button with a
tooltip), but both are config acquired by accident rather than by
decision.
Comment them out verbatim. The extra_mimetypes line in particular has
to stay legible rather than be deleted: it is the only worked example
of the '|' and ',' separators, and the reason those two characters
differ is subtle enough that the prose above it needs the illustration.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -122,11 +122,11 @@ identity. ; from its optional description. The two characters differ because QSettings ; splits comma lists itself, so a description containing a comma would ; otherwise be read as two entries. Neither character is legal in a mimetype. -extra_mimetypes = application/vnd.oasis.opendocument.text|ODT document, message/rfc822|forwarded mail, text/calendar +; extra_mimetypes = application/vnd.oasis.opendocument.text|ODT document, message/rfc822|forwarded mail, text/calendar [sync] ; Optional. Omit and the Sync button disables itself with a tooltip. -command = /home/you/bin/mailsync.sh +; command = /home/you/bin/mailsync.sh ; Section names use a dot, not a slash: QSettings treats "/" as its own ; group separator, so [account/work] would be parsed as a nested group. |