alx/mu4e
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

man: update label manpage

Browse Source
This commit is contained in:
Dirk-Jan C. Binnema
2025-08-30 10:44:28 +03:00
committed by Seth Ladygo
parent c074c138f8
commit 71b5f31f99
1 changed files with 25 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
man/mu-label.1.org
View File

@ -32,19 +32,24 @@ A label is a string associated with a message.
- *export* to write the label information to a file - *export* to write the label information to a file
- *import* the read label information from a file - *import* the read label information from a file
Unlike other message metadata stored by *mu*, labels _cannot_ be restored by Important: unlike other message metadata stored by *mu*, labels _cannot_ be restored
re-indexing messages. Hence, to avoid loosing label information, you must *export* by merely re-indexing messages. Hence, to avoid loosing label information, you
it before re-indexing, and *import* afterwards. must *export* it before re-indexing, and *import* afterwards.
* UPDATE OPTIONS * UPDATE OPTIONS
The *update* command changes the labels for messages that match some query. Make sure the query is recognized as a single parameter, i.e., quote it when using from a shell. The *update* coxmmand changes the labels for messages that match some query. The
query must be recognized as a single parameter; hence, it must be quoted when
using from a shell.
** --labels ** --labels
a comma-separated list of labels, each prefixed with either *+* to add that a comma-separated list of labels, each prefixed with either *+* to add that
label, or *-* to remove it. See *VALID LABELS*. label, or *-* to remove it. See *VALID LABELS*.
*mu4e* users: note the difference, in *mu4e* the label expressions are
_space_-separated, here they are _comma_-separated.
** --dry-run ** --dry-run
only print what /would/ change, but do not change anything only print what /would/ change, but do not change anything
@ -53,13 +58,13 @@ The *update* command changes the labels for messages that match some query. Make
* CLEAR OPTIONS * CLEAR OPTIONS
The *clear* command removes all labels from messages that match some query. Make The *clear* command removes all labels from messages that match some query. As
sure the query is recognized as a single parameter, i.e., quote it when using with *update*, the must be recognized as a single parameter, i.e., quote it when
from a shell. using from a shell.
** --dry-run ** --dry-run
only print what would change, but do not change anything only print what /would/ change, but do not change anything
#+include: "muhome.inc" :minlevel 2 #+include: "muhome.inc" :minlevel 2
@ -67,16 +72,17 @@ from a shell.
The *list* command lists all the labels that are currently in use in the store. The *list* command lists all the labels that are currently in use in the store.
* EXPORT OPTIONS * EXPORT OPTIONS
The *export* command outputs /all/ labels in the store to a file, so you can *import* The *export* command takes the labels in the store and the messages they apply to,
it later. The command takes a path to a file or a directory (ending in '/') as and writes this information to a file. You can *import* this file later, to
its argument. restore the labels. The command takes a path to a file or a directory (ending in
'/') as its argument.
If a file is specified, *mu* writes the export to it. If a file is specified, *mu* writes the export to it.
If a directory is specified, *mu* writes to a file in that directory. The directory must already exist. If a directory is specified, *mu* writes to a file in that directory. The
directory must already exist.
When neither is specified, *mu* writes to a file in the current directory. When neither is specified, *mu* writes to a file in the current directory.
@ -119,19 +125,18 @@ second line starts with ~message-id:~ followed by the message-id for the message
Finally, the third line starts with ~tag:~ followed by space-separated tags for Finally, the third line starts with ~tag:~ followed by space-separated tags for
the message the message
With this, the labels for a message can be restored.
#+begin_example #+begin_example
path:/home/user/Maildir/inbox/cur/1720645394.99f64f5d81f42ba4.hyperion:2,S path:/home/user/Maildir/inbox/cur/1720645394.99f64f5d81f42ba4.hyperion:2,S
message-id:669338009127192q7821feh1t826d0c4c90bd8fdf@mail.gmail.com message-id:669338009127192q7821feh1t826d0c4c90bd8fdf@mail.gmail.com
labels:foo,bar,cuux labels:foo,bar,cuux
#+end_example #+end_example
Note, the ~message-id:~ is only used if the message cannot be found at ~path:. Note, the ~message-id:~ is only used if the message cannot be found using ~path:~.
This adds some tolerance for the case where the precise file-system positions
have changed since the labels were exported. The upshot of that is that if there This adds some fault-tolerance for the case where the precise file-system
are _duplicate_ messages (messages with the same message-id), the tags are applied positions have changed since the labels were exported. The upshot of that is
to all of them. that if there are _duplicate_ messages (messages with the same message-id), the
tags are applied to all of them.
#+include: "exit-code.inc" :minlevel 1 #+include: "exit-code.inc" :minlevel 1
@ -146,7 +151,6 @@ have "pluto" in their subject:
$ mu label update "subject:pluto" --labels -planet,+dwarf-planet $ mu label update "subject:pluto" --labels -planet,+dwarf-planet
#+end_export #+end_export
Clear all labels from messages with the label "boring": Clear all labels from messages with the label "boring":
#+begin_export #+begin_export
$ mu label clear "label:boring" $ mu label clear "label:boring"