diff options
| author | Mattias Andrée <maandree@operamail.com> | 2014-09-07 02:35:06 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@operamail.com> | 2014-09-07 02:35:06 +0200 |
| commit | aee345812d623304c5c83a8f85a150aaf031de4a (patch) | |
| tree | d2065ab57ca7378ae80834eb0e1752200ca8da70 /doc | |
| parent | move keyboard protocols into the info manual (diff) | |
| download | mds-aee345812d623304c5c83a8f85a150aaf031de4a.tar.gz mds-aee345812d623304c5c83a8f85a150aaf031de4a.tar.bz2 mds-aee345812d623304c5c83a8f85a150aaf031de4a.tar.xz | |
m + move echo proto into info manual
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/info/mds.texinfo | 64 | ||||
| -rw-r--r-- | doc/protocols | 21 |
2 files changed, 55 insertions, 30 deletions
diff --git a/doc/info/mds.texinfo b/doc/info/mds.texinfo index 9e26e9f..1c8dcef 100644 --- a/doc/info/mds.texinfo +++ b/doc/info/mds.texinfo @@ -1719,15 +1719,16 @@ simple, reference implementation of a, status icon tray. @chapter Protocols @menu -* Infrastructure protocols:: Infrastructure protocols. -* Virtual terminal protocols:: Virtual terminal protocols. -* Keyboard protocols:: Keyboard protocols. +* Infrastructure Protocols:: Infrastructure protocols. +* Virtual Terminal Protocols:: Virtual terminal protocols. +* Keyboard Protocols:: Keyboard protocols. +* Miscellaneous Protocols:: Miscellaneous protocols. @end menu -@node Infrastructure protocols -@section Infrastructure protocols +@node Infrastructure Protocols +@section Infrastructure Protocols @menu * assign-id:: Assign new ID to client, or fetch current ID. @@ -1938,8 +1939,8 @@ Optional. -@node Virtual terminal protocols -@section Virtual terminal protocols +@node Virtual terminal Protocols +@section Virtual terminal Protocols @menu * get-vt:: Get the index of the virtual terminal the server is display on. @@ -2104,8 +2105,8 @@ Required. -@node Keyboard protocols -@section Keyboard protocols +@node Keyboard Protocols +@section Keyboard Protocols @menu * key-sent:: Announce a keyboard input event. @@ -2628,6 +2629,51 @@ Recommended. +@node Miscellaneous Protocols +@section Miscellaneous Protocols + +@menu +* echo:: Echo back a message. +@end menu + + + +@node echo +@subsection echo + +@table @asis +@item Identifying header: +@command{Command: echo} + +@item Action: +Echo back a message. + +@item Required header: @code{Client ID} +Your ID, provided by the @code{ID assignment} header +in response to a @code{Command: assign-id} header. + +@item Optional header: @code{Length} +Length of the message. + +@item Message: +Message to echo. + +@item Purpose: +Debugging and testing. + +@item Purpose: +Network heartbeat. + +@item Compulsivity: +Recommended for network enabled servers. + +@item Reference implementation: +@command{mds-echo} +@end table + + + + @node libmdsserver @chapter libmdsserver diff --git a/doc/protocols b/doc/protocols index 0e3936f..cbfca47 100644 --- a/doc/protocols +++ b/doc/protocols @@ -1,26 +1,5 @@ --------------------------------------------------------------------- -Command: echo - Echo back a message - -Required header: Client ID - Your ID, provided by `ID assignment` - in response to `Command: assign-id` - -Optional header: Length - Length of the message - -Message: message to echo - -Purpose: debugging and testing -Purpose: network heartbeat - -Compulsivity: recommended for network enabled servers - -Reference implementation: mds-echo - ---------------------------------------------------------------------- - Command: clipboard Read or manipulate a clipboard |