Skip to content

Commit 9d9a4af

Browse files
committed
doc: highlight commands in event.8gx
1 parent b7f6669 commit 9d9a4af

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

doc/event.8gx

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -83,40 +83,42 @@ connection to the event daemon starts out in Enqueue Mode, and this is the only
8383
mode from which commands can be issued.
8484
.PP
8585
"FALSE" may be emitted by the server if there is a syntax error.
86-
.PP
86+
.SS ID
8787
The command "ID <res_id>" declares the particular connection to be a notification
8888
sender. res_id is generally the hostname and the PID. The server always
8989
responds with "TRUE". (The connection stays in Enqueue Mode.)
90-
.PP
90+
.SS LISTEN
9191
The command "LISTEN <res_id>" declares the particular connection to be a
9292
notification receiver. res_id follows the same pattern. The server responds
9393
with "TRUE" and the connection state changes to the Dequeue Mode (see below).
94-
.PP
94+
.SS SELECT
9595
The command "SELECT <username> <folder>" subscribes those connections that have
9696
registered \fBas a listener for res_id\fP to notifications. (This means that a
9797
process wishing to use event_stub(4gx) to listen for notifications strictly
9898
requires loading event_proxy(4gx) too, and, in essence, use two connections to
9999
event(8gx).) The server responds with "FALSE" if no listener exists, or "TRUE"
100100
on success.
101-
.PP
101+
.SS UNSELECT
102102
The command "UNSELECT <username> <folder>" unsubscribes those connections that
103103
had registered as a listener for res_id. The server always responds with
104104
"TRUE".
105-
.PP
106-
Auxiliary self-explanatory commands available are: "QUIT" and "PING".
107-
.PP
105+
.SS QUIT
106+
Terminate the connection.
107+
.SS PING
108+
Reset inactivity timer on connection.
109+
.SS Partially parsed commands
108110
Any other input is treated as a notification item and is not interpreted by
109111
event(8gx) beyond checking the number of fields:
110-
.PP
111-
The notification "FOLDER-TOUCH <username> <folder>" informs listeners that the
112+
.SS FOLDER-TOUCH
113+
The notification "FOLDER\-TOUCH <username> <folder>" informs listeners that the
112114
folder metadata has changed and warrants being reloaded.
113-
.PP
114-
The notification "MESSAGE-FLAG <username> <folder> <messageid>" informs
115+
.SS MESSAGE-FLAG
116+
The notification "MESSAGE\-FLAG <username> <folder> <messageid>" informs
115117
listeners that the message metadata has changed and warrants being reloaded.
116-
.PP
117-
The notification "MESSAGE-EXPUNGE <username> <folder> <messageid>" informs
118+
.SS MESSAGE-EXPUNGE
119+
The notification "MESSAGE\-EXPUNGE <username> <folder> <messageid>" informs
118120
listeners that the message was deleted.
119-
.PP
121+
.SS Client behavior
120122
Clients in Dequeue Mode will receive notifications. Each notification line
121123
received by the client needs to be acknowledged with a "TRUE" response. It is
122124
not possible to exit Dequeue Mode; connection termination is the only way out.

0 commit comments

Comments
 (0)