Author: dylan
Date: 2004-08-11 15:27:16 -0400 (Wed, 11 Aug 2004)
New Revision: 348
Added:
trunk/docs/manual/chap/commands/server.tex
trunk/docs/manual/ltags
Modified:
trunk/docs/manual/
trunk/docs/manual/Makefile
trunk/docs/manual/chap/commands.tex
trunk/docs/manual/chap/commands/client.tex
trunk/docs/manual/chap/concepts.tex
trunk/docs/manual/chap/formats.tex
trunk/docs/manual/chap/introduction.tex
trunk/docs/manual/chap/protocol.tex
trunk/docs/manual/haver.tex
trunk/docs/manual/macros.tex
trunk/docs/manual/style.tex
Log:
added ltags, which generates a tag file so
one can browse around the *.tex files
with control-]. See :help tags in vim.
make tags will generate the tags file.
Getting ready to write the server commands section.
Property changes on: trunk/docs/manual
___________________________________________________________________
Name: svn:ignore
- *.aux
*.pdf
*.ps
*.dvi
*.log
*.toc
*.bbl
*.blg
+ *.aux
*.pdf
*.ps
*.dvi
*.log
*.toc
*.bbl
*.blg
*.out
config.tex
tags
Modified: trunk/docs/manual/Makefile
===================================================================
--- trunk/docs/manual/Makefile 2004-08-10 21:14:09 UTC (rev 347)
+++ trunk/docs/manual/Makefile 2004-08-11 19:27:16 UTC (rev 348)
@@ -10,8 +10,9 @@
-or -name '*.toc' \
-or -name '*.out' \
-or -name 'config.tex'
-base=haver
-tex=$(wildcard chap/*.tex) $(filter-out haver.tex,$(wildcard *.tex)) haver.bib
config.m4
+base = haver
+tex = $(shell find -name '*.tex')
+files = $(tex) config.m4 haver.big
ARGS += -D VERSION=$(VERSION)
@@ -31,8 +32,11 @@
dvi: $(base).dvi
pdf: $(base).pdf
html: $(base)/$(base).html
-
+tags: ltags $(tex)
+ ./ltags $(tex) | sort > tags
+
+
clean:
find . \( $(clean) \) -exec rm -v {} \;
@@ -41,11 +45,11 @@
-rm $(base).dvi $(base).pdf
-$(base).dvi: $(base).tex $(tex)
+$(base).dvi: $(base).tex $(files)
./buildlatex -f DVI $(ARGS) $<
-$(base).pdf: $(base).tex $(tex)
+$(base).pdf: $(base).tex $(files)
./buildlatex -f PDF $(ARGS) -l pdflatex $<
#$(base)/$(base).html: $(base).tex $(tex)
Modified: trunk/docs/manual/chap/commands/client.tex
===================================================================
--- trunk/docs/manual/chap/commands/client.tex 2004-08-10 21:14:09 UTC (rev
347)
+++ trunk/docs/manual/chap/commands/client.tex 2004-08-11 19:27:16 UTC (rev
348)
@@ -1,3 +1,4 @@
+% vim: set isk=@,48-57,192-255,/,\:,.:
\section{Client Commands}
\label{commands.client}
@@ -226,13 +227,22 @@
\end{errors}
\end{cmddef}
- \begin{cmddef}{LIST}{\param{where} \param{ns}}
+ \begin{cmddef}{LIST}{\opt{where} \param{ns}}
\citem{\Desc}
Request a list of all things in \param{where}
with the namespace \param{ns}.
+ \param{where} defaults to ``*'', in which case
+ the server will list every user on the server
+ (even those joined to no channel). This may
+ be restricted to privledged users or services.
+
+ \comment{Perhaps \param{ns} can also be ``*''?}
+
\citem{\Res}
The server will send \scmd{LIST}.
+ If \param{where} is omitted, ``*'' will
+ be sent. So don't worry, \scmd{LIST} is not ambigous.
\citem{\Err}
\begin{errors}
@@ -243,6 +253,26 @@
\end{errors}
\end{cmddef}
+ \begin{cmddef}{POKE}{\opt{data}}
+ \citem{\Desc}
+ This command is used to check if the server is still
responding.
+
+ \citem{\Res}
+ The server will reply with \scmd{OUCH}.
+ If present, \param{data} will be part of this
+ reply.
+
+ If you poke more than once per reasonable
+ amount of time, the server may issue a warning or even
+ disconnect you. Generally, reasonable amount
+ of time is five seconds. In general you should at least
not
+ poke more than once per minute, however.
+
+ It is preferable if clients only poke when they have not
+ recieved a message from the server in a minute or two.
+
+ \citem{\Err} None.
+ \end{cmddef}
\end{commands}
Added: trunk/docs/manual/chap/commands/server.tex
===================================================================
--- trunk/docs/manual/chap/commands/server.tex 2004-08-10 21:14:09 UTC (rev
347)
+++ trunk/docs/manual/chap/commands/server.tex 2004-08-11 19:27:16 UTC (rev
348)
@@ -0,0 +1,25 @@
+% vim: set isk=@,48-57,192-255,/,\:,.:
+\section{Server Commands}
+\label{commands.server}
+
+This section describes the commands that servers may send to clients.
+
+
+\begin{commands}
+ \begin{cmddef}{HAVER}{\param{client}}
+ \citem{\Desc}
+ This command may only be sent once during
+ the liftetime the connection.
+
+ A client will send this command when it
+ first connects to the server. The argument
\param{client}
+ should be the name and version num\-ber of the user
agent.
+
+ \citem{\Res}
+ The server will send \scmd{HAVER} and \scmd{WANT}.
+
+ \citem{\Err} None.
+ \end{cmddef}
+
+\end{commands}
+
Modified: trunk/docs/manual/chap/commands.tex
===================================================================
--- trunk/docs/manual/chap/commands.tex 2004-08-10 21:14:09 UTC (rev 347)
+++ trunk/docs/manual/chap/commands.tex 2004-08-11 19:27:16 UTC (rev 348)
@@ -1,3 +1,4 @@
+% vim: set isk=@,48-57,192-255,/,\:,.:
\newenvironment{commands}{\begin{description}}{\end{description}}
\newenvironment{errors}{\begin{description}}{\end{description}}
@@ -25,9 +26,10 @@
\newcommand{\Res}{Results}
\newcommand{\Desc}{Description}
\newcommand{\Err}{Errors}
+\newcommand{\cmddefcmd}[1]{\cmd{#1}}
\newenvironment{cmddef}[2]{%
- \item[\cmd{#1}] #2
+ \item[\cmdcmd{#1}] #2
\begin{description}%
\nopagebreak[1]
@@ -67,10 +69,12 @@
\input{chap/commands/client}
-\section{Server Commands}
-\label{commands.server}
-To be written...
+% Change the formatting of command entries
+% in \begin{cmddef}.
+\renewcommand{\cmddefcmd}[1]{\scmd{#1}}
+\input{chap/commands/server}
+
\section{Errors}
\label{commands.errors}
Modified: trunk/docs/manual/chap/concepts.tex
===================================================================
--- trunk/docs/manual/chap/concepts.tex 2004-08-10 21:14:09 UTC (rev 347)
+++ trunk/docs/manual/chap/concepts.tex 2004-08-11 19:27:16 UTC (rev 348)
@@ -1,4 +1,4 @@
-
+% vim: set isk=@,48-57,192-255,/,\:,.:
\chapter{Concepts}
WRITE SUMMARY HERE.
Modified: trunk/docs/manual/chap/formats.tex
===================================================================
--- trunk/docs/manual/chap/formats.tex 2004-08-10 21:14:09 UTC (rev 347)
+++ trunk/docs/manual/chap/formats.tex 2004-08-11 19:27:16 UTC (rev 348)
@@ -1,3 +1,4 @@
+% vim: set isk=@,48-57,192-255,/,\:,.:
\chapter{Formats}
\label{format}
Modified: trunk/docs/manual/chap/introduction.tex
===================================================================
--- trunk/docs/manual/chap/introduction.tex 2004-08-10 21:14:09 UTC (rev
347)
+++ trunk/docs/manual/chap/introduction.tex 2004-08-11 19:27:16 UTC (rev
348)
@@ -1,3 +1,4 @@
+% vim: set isk=@,48-57,192-255,/,\:,.:
\chapter{Introduction}
Haver is a simple line based, tab delimited protocol. It is
Modified: trunk/docs/manual/chap/protocol.tex
===================================================================
--- trunk/docs/manual/chap/protocol.tex 2004-08-10 21:14:09 UTC (rev 347)
+++ trunk/docs/manual/chap/protocol.tex 2004-08-11 19:27:16 UTC (rev 348)
@@ -1,3 +1,4 @@
+% vim: set isk=@,48-57,192-255,/,\:,.:
\chapter{Protocol}
\label{protocol}
Modified: trunk/docs/manual/haver.tex
===================================================================
--- trunk/docs/manual/haver.tex 2004-08-10 21:14:09 UTC (rev 347)
+++ trunk/docs/manual/haver.tex 2004-08-11 19:27:16 UTC (rev 348)
@@ -1,4 +1,5 @@
% Date: Wednesday, May 26 at 7:45PM
+% vim: set isk=@,48-57,192-255,/,\:,.:
\documentclass[12pt]{report}
\usepackage{ifthen}
Added: trunk/docs/manual/ltags
===================================================================
--- trunk/docs/manual/ltags 2004-08-10 21:14:09 UTC (rev 347)
+++ trunk/docs/manual/ltags 2004-08-11 19:27:16 UTC (rev 348)
@@ -0,0 +1,19 @@
+#!/usr/bin/perl
+use strict;
+use warnings;
+
+my $bibfile = 'haver.bib';
+
+while (<ARGV>) {
+ while (s/\\include\{(.+?)\}//) {
+ print "$1\t$1.tex\t\n";
+ }
+ while (s/\\label\{(.+?)\}//) {
+ print "$1\t$ARGV\t/\\\\label\{$1\}\n";
+ }
+ while (s/\\cite\{(.+?)\}//) {
+ # For now we assume all citations are in one
+ # bibfile, $bibfile.
+ print join("\t", $1, $bibfile, "/$1"), "\n";
+ }
+}
Property changes on: trunk/docs/manual/ltags
___________________________________________________________________
Name: svn:executable
+ *
Modified: trunk/docs/manual/macros.tex
===================================================================
--- trunk/docs/manual/macros.tex 2004-08-10 21:14:09 UTC (rev 347)
+++ trunk/docs/manual/macros.tex 2004-08-11 19:27:16 UTC (rev 348)
@@ -1,3 +1,4 @@
+% vim: set isk=@,48-57,192-255,/,\:,.:
\newcommand{\ifhas}[2]{%
\ifthenelse{\boolean{have#1}}{#2}{ }%
Modified: trunk/docs/manual/style.tex
===================================================================
--- trunk/docs/manual/style.tex 2004-08-10 21:14:09 UTC (rev 347)
+++ trunk/docs/manual/style.tex 2004-08-11 19:27:16 UTC (rev 348)
@@ -1,5 +1,5 @@
+% vim: set isk=@,48-57,192-255,/,\:,.:
-
\ifhas{COLOR}{
\definecolor{cmd}{rgb}{0,0,0.5}
\definecolor{scmd}{rgb}{0.2,0,0.9}
