From f2a0fc6a36ab5ae230281c9ce69f0d66b51069ea Mon Sep 17 00:00:00 2001
From: Carlos Daniel Ruvalcaba Valenzuela <clsdaniel@gmail.com>
Date: Thu, 19 Jul 2007 21:55:58 -0700
Subject: [PATCH] Updated IPC Message documentation

---
 docs/ipc.tex | 73 ++++++++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 49 insertions(+), 24 deletions(-)

diff --git a/docs/ipc.tex b/docs/ipc.tex
index 1f9e098..611de23 100644
--- a/docs/ipc.tex
+++ b/docs/ipc.tex
@@ -1,71 +1,96 @@
 \documentclass{article}
 
+\newcounter{paramc}
+\newenvironment{paramlist}
+{\begin{list}{\bfseries\upshape \hspace{4em}Parameter \arabic{paramc}:}
+{\usecounter{paramc}\setlength{\parsep}{0.0ex}\setlength}}
+{\end{list}}
+
+\newcommand{\ipcmsg}[1]{{\raggedleft\bfseries\upshape #1}}
+
 \begin{document}
 
 \section{Common Messages}
 
-ok
+\ipcmsg{ok}
 
-A positive response to another mensage, may include a
-return value.
+A positive response to another mensage, should include a return value.
 
-\begin{itemize}
+\begin{paramlist}
 \item Return Value
-\end{itemize}
+\end{paramlist}
 
-error
+\ipcmsg{error}
 
 An error message.
 
-\begin{itemize}
+\begin{paramlist}
 \item Message
-\end{itemize}
+\end{paramlist}
 
 \section{Authentication Server}
 \subsection{Messages}
 
-verify
+\ipcmsg{verify}
 
 Verify if a user exist, will return "ok" is the user
 exist, error otherwise.
 
-\begin{itemize}
+\begin{paramlist}
 \item Username
-\end{itemize}
+\end{paramlist}
 
-auth
+\ipcmsg{auth}
 
 Will authenticate a given user, will return ok if the
 user and password are right, error otherwise.
 
-\begin{itemize}
+\begin{paramlist}
 \item Username
 \item Password
-\end{itemize}
+\end{paramlist}
 
 \section{Mailbox Server}
 \subsection{Messages}
 
-listmail
+\ipcmsg{listmail}
 
-Will return a list of emails for a given user.
+It will return ok message with the amount of emails
+for a given user, after that it will push n "mailinfo"
+message. On failture it will return error.
 
-\begin{itemize}
+\begin{paramlist}
 \item username
-\end{itemize}
+\end{paramlist}
+
+\ipcmsg{mailinfo}
 
-mailinfo
+Return message with a given email detail.
 
-\begin{itemize}
+\begin{paramlist}
 \item Number
 \item Size
-\end{itemize}
+\end{paramlist}
+
+\ipcmsg{sendmail}
+
+Store an email, it will return ok if successful and
+begin using raw operations till read 'Data Length' 
+bytes.
 
-sendmail
-\begin{itemize}
+\begin{paramlist}
 \item To
 \item Recipent
 \item Data Length
-\end{itemize}
+\end{paramlist}
+
+\ipcmsg{retr}
+
+Retrieve an email for a given user.
+
+\begin{paramlist}
+\item username
+\item Number
+\end{paramlist}
 
 \end{document}
-- 
2.11.4.GIT