summaryrefslogtreecommitdiff
path: root/docs/source/usage/modes/search.rst
blob: ed632e83af0d4dd7fcd8d6491af8f6a2ead654d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
.. CAUTION: THIS FILE IS AUTO-GENERATED!


Commands in `search` mode
-------------------------
The following commands are available in search mode

.. _cmd.search.sort:

.. describe:: sort

    set sort order

    argument
        sort order. valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`.


.. _cmd.search.retagprompt:

.. describe:: retagprompt

    prompt to retag selected threads' tags


.. _cmd.search.untag:

.. describe:: untag

    remove tags from all messages in the thread that match the query

    argument
        comma separated list of tags

    optional arguments
        :---no-flush: postpone a writeout to the index (Defaults to: 'True').
        :---all: retag all messages in search result.

.. _cmd.search.move:

.. describe:: move

    move focus in search buffer

    argument
        last


.. _cmd.search.toggletags:

.. describe:: toggletags

    flip presence of tags on this thread. A tag is considered present if at least one message contained in this thread is tagged with it. In that case this command will remove the tag from every message in the thread.

    argument
        comma separated list of tags

    optional arguments
        :---no-flush: postpone a writeout to the index (Defaults to: 'True').

.. _cmd.search.tag:

.. describe:: tag

    add tags to all messages in the thread that match the current query

    argument
        comma separated list of tags

    optional arguments
        :---no-flush: postpone a writeout to the index (Defaults to: 'True').
        :---all: retag all messages in search result.

.. _cmd.search.refine:

.. describe:: refine

    refine query

    argument
        search string

    optional arguments
        :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`.

.. _cmd.search.refineprompt:

.. describe:: refineprompt

    prompt to change this buffers querystring


.. _cmd.search.retag:

.. describe:: retag

    set tags of all messages in the thread that match the current query

    argument
        comma separated list of tags

    optional arguments
        :---no-flush: postpone a writeout to the index (Defaults to: 'True').
        :---all: retag all messages in search result.

.. _cmd.search.select:

.. describe:: select

    open thread in a new buffer