File: search.rst

package info (click to toggle)
alot 0.12-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,748 kB
  • sloc: python: 11,317; makefile: 125; sh: 8
file content (138 lines) | stat: -rw-r--r-- 2,877 bytes parent folder | download
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
.. CAUTION: THIS FILE IS AUTO-GENERATED!


Commands in 'search' mode
-------------------------
The following commands are available in search mode:

.. _cmd.search.limit:

.. describe:: limit

    limit number of results

    argument
        the thread count limit


.. _cmd.search.move:

.. describe:: move

    move focus in search buffer

    argument
        last


.. _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'
        :---limit: limit number of results

.. _cmd.search.refineprompt:

.. describe:: refineprompt

    prompt to change this buffers querystring


.. _cmd.search.retag:

.. describe:: retag

    set tags to all messages in the selected thread

    argument
        comma separated list of tags

    optional arguments
        :---no-flush: postpone a writeout to the index (defaults to: 'True')
        :---all: retag all messages that match the current query

.. _cmd.search.retagprompt:

.. describe:: retagprompt

    prompt to retag selected thread's or message's tags


.. _cmd.search.savequery:

.. describe:: savequery

    store query string as a "named query" in the database. This falls back to the current search query in search buffers.

    positional arguments
        0: alias to use for query string
        1: query string to store


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

.. _cmd.search.select:

.. describe:: select

    open thread in a new buffer

    optional arguments
        :---all-folded: do not unfold matching messages

.. _cmd.search.sort:

.. describe:: sort

    set sort order

    argument
        sort order; valid choices are: 'oldest_first','newest_first','message_id','unsorted'


.. _cmd.search.tag:

.. describe:: tag

    add tags to all messages in the selected thread

    argument
        comma separated list of tags

    optional arguments
        :---no-flush: postpone a writeout to the index (defaults to: 'True')
        :---all: tag all messages that match the current search query

.. _cmd.search.toggletags:

.. describe:: toggletags

    flip presence of tags on the selected thread: a tag is considered present and will be removed if at least one message in this thread is tagged with it

    argument
        comma separated list of tags

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

.. _cmd.search.untag:

.. describe:: untag

    remove tags from all messages in the selected thread

    argument
        comma separated list of tags

    optional arguments
        :---no-flush: postpone a writeout to the index (defaults to: 'True')
        :---all: untag all messages that match the current query