* mu: update the server command and (use 'cmd:' for commands)

This commit is contained in:
djcb
2013-05-20 05:11:49 +03:00
parent dfb6382c04
commit 2f5d6e246b
3 changed files with 57 additions and 71 deletions

View File

@ -19,14 +19,14 @@ In this man-page, we document the commands \fBmu server\fR accepts, as well as
their responses. In general, the commands sent to the server are of the form
.nf
<command> [<parameters>]*
cmd:<command> [<parameters>]*
.fi
where each of the parameters is prefixed by their name and a colon. For
example, to view a certain message, the command would be:
.nf
view docid:12345
cmd:view docid:12345
.fi
Parameters can be sent in any order, and parameters not used by a certain
@ -58,7 +58,7 @@ UTF-8 (in which the s-expressions are encoded).
Using the \fBadd\fR command, we can add a message to the database.
.nf
-> add path:<path> maildir:<maildir>
-> cmd:add path:<path> maildir:<maildir>
<- (:info add :path <path> :docid <docid>)
.fi
@ -73,7 +73,7 @@ e.g. set the subject, sender and recipient for a reply message.
Messages of type 'new' don't use the docid: parameter, the other ones do.
.nf
-> compose type:<reply|forward|edit|new> [docid:<docid>]
-> cmd:compose type:<reply|forward|edit|new> [docid:<docid>]
<- (:compose <reply|forward|edit|new> :original <s-exp> :include (<list-of-attachments))
.fi
@ -93,7 +93,7 @@ Using the \fBcompose\fR command, we can retrieve an s-expression with all known
contacts (name + e-mail address). For the details, see \fBmu-cfind(1)\fR.
.nf
-> contacts [personal:true|false] [after:<time_t>]
-> cmd:contacts [personal:true|false] [after:<time_t>]
<- (:contacts ((:name abc :mail foo@example.com ...) ...)
.fi
@ -103,7 +103,7 @@ contacts (name + e-mail address). For the details, see \fBmu-cfind(1)\fR.
Using the \fBextract\fR command we can save and open attachments.
.nf
-> extract action:<save|open|temp> index:<index> [path:<path>] [what:<what> [param:<param>]]
-> cmd:extract action:<save|open|temp> index:<index> [path:<path>] [what:<what> [param:<param>]]
.fi
If the action is 'save', the path argument is required; the attachment will
@ -135,7 +135,7 @@ to a shell command.
Using the \fBfind\fR command we can search for messages.
.nf
-> find query:"<query>" [threads:true|false] [sortfield:<sortfield>]
-> cmd:find query:"<query>" [threads:true|false] [sortfield:<sortfield>]
[reverse:true|false] [maxnum:<maxnum>]
.fi
The \fBquery\fR-parameter provides the search query; the
@ -179,7 +179,7 @@ registers 'my' email addresses; see the documentation for
\fBmu_store_set_my_addresses\fR.
.nf
-> index path:<path> [my-addresses:<comma-separated-list-of-email-addresses>]
-> cmd:index path:<path> [my-addresses:<comma-separated-list-of-email-addresses>]
.fi
As a response, it will send (for each 500 messages):
.nf
@ -197,7 +197,7 @@ and finally:
Using the \fBmkdir\fR command, we can create a new maildir.
.nf
-> mkdir path:<path>
-> cmd:mkdir path:<path>
<- (:info mkdir :message "<maildir> has been created")
.fi
@ -211,7 +211,7 @@ s-exp describing the updated message, so that it can be updated in the user
interface.
.nf
-> move docid:<docid>|msgid:<msgid> [maildir:<maildir>] [flags:<flags>]
-> cmd:move docid:<docid>|msgid:<msgid> [maildir:<maildir>] [flags:<flags>]
<- (:update <s-exp> :move t)
.fi
@ -225,7 +225,7 @@ of maildir and flags must be specified.
The \fBping\fR command provokes a \fBpong\fR response. It is used for the initial
handshake between \fBmu4e\fR and \fBmu server\fR.
.nf
-> ping
-> cmd:ping
<- (:pong "mu" :version <version> :doccount <doccount>)
.fi
@ -236,7 +236,7 @@ Using the \fBremove\fR command, we can remove the message from disk, and
update the database accordingly.
.nf
-> remove docid:<docid>
-> cmd:remove docid:<docid>
<- (:remove <docid>)
.fi
@ -257,18 +257,17 @@ If the optional parameter \fBauto-retrieve-key\fR is \fBtrue\fR, attempt to
retrieve public keys online automatically.
.nf
-> view docid:<docid>|msgid:<msgid> [extract-images:true] [use-agent:false] [auto-retrieve-key:false]
-> cmd:view docid:<docid>|msgid:<msgid> [extract-images:true] [use-agent:false] [auto-retrieve-key:false]
<- (:view <s-exp>)
.fi
or, alternatively:
.nf
-> view path:<path-to-msg> [extract-images:true] [use-agent:false] [auto-retrieve-key:false]
-> cmd:view path:<path-to-msg> [extract-images:true] [use-agent:false] [auto-retrieve-key:false]
<- (:view <s-exp>)
.fi
.SH AUTHOR
Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>