summaryrefslogtreecommitdiff
path: root/docs/source/usage/modes/global.rst
blob: ce105f2f83c768b37b7ea6583b599f41204609e8 (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
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
.. CAUTION: THIS FILE IS AUTO-GENERATED!


Global Commands
---------------
The following commands are available globally

.. _cmd.global.bclose:

.. describe:: bclose

    close a buffer


.. _cmd.global.bprevious:

.. describe:: bprevious

    focus previous buffer


.. _cmd.global.search:

.. describe:: search

    open a new search buffer

    argument
        search string

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

.. _cmd.global.compose:

.. describe:: compose

    compose a new email

    optional arguments
        :---sender: sender.
        :---template: path to a template message file.
        :---subject: subject line.
        :---to: recipients.
        :---cc: copy to.
        :---bcc: blind copy to.
        :---attach: attach files.
        :---omit_signature: do not add signature.
        :---spawn: spawn editor in new terminal.

.. _cmd.global.prompt:

.. describe:: prompt

    prompts for commandline and interprets it upon select

    argument
        initial content


.. _cmd.global.help:

.. describe:: help

    
    display help for a command. Use 'bindings' to
    display all keybings interpreted in current mode.'
    

    argument
        command or 'bindings'


.. _cmd.global.move:

.. describe:: move

    move focus

    argument
        direction


.. _cmd.global.shellescape:

.. describe:: shellescape

    run external command

    argument
        command line to execute

    optional arguments
        :---spawn: run in terminal window.
        :---thread: run in separate thread.
        :---refocus: refocus current buffer                      after command has finished.

.. _cmd.global.refresh:

.. describe:: refresh

    refresh the current buffer


.. _cmd.global.cancel:

.. describe:: cancel

    send cancel event


.. _cmd.global.pyshell:

.. describe:: pyshell

    open an interactive python shell for introspection


.. _cmd.global.exit:

.. describe:: exit

    shut down cleanly


.. _cmd.global.flush:

.. describe:: flush

    flush write operations or retry until committed


.. _cmd.global.bufferlist:

.. describe:: bufferlist

    open a list of active buffers


.. _cmd.global.call:

.. describe:: call

     Executes python code 

    argument
        python command string to call


.. _cmd.global.bnext:

.. describe:: bnext

    focus next buffer


.. _cmd.global.select:

.. describe:: select

    send select event


.. _cmd.global.taglist:

.. describe:: taglist

    opens taglist buffer