Added index entry for the protocol.

Fixed typo (extra char in the word "character").

Minor nits.
This commit is contained in:
Fred Drake 1998-01-07 13:17:20 +00:00
parent 15bac5d6e4
commit 1566a1d72c
2 changed files with 16 additions and 14 deletions

View file

@ -1,6 +1,7 @@
\section{Standard Module \sectcode{gopherlib}} \section{Standard Module \sectcode{gopherlib}}
\label{module-gopherlib} \label{module-gopherlib}
\stmodindex{gopherlib} \stmodindex{gopherlib}
\indexii{Gopher}{protocol}
\renewcommand{\indexsubitem}{(in module gopherlib)} \renewcommand{\indexsubitem}{(in module gopherlib)}
@ -10,16 +11,16 @@ URLs that use the Gopher protocol.
The module defines the following functions: The module defines the following functions:
\begin{funcdesc}{send_selector}{selector\, host\optional{\, port}} \begin{funcdesc}{send_selector}{selector, host\optional{, port}}
Send a \var{selector} string to the gopher server at \var{host} and Send a \var{selector} string to the gopher server at \var{host} and
\var{port} (default 70). Return an open file object from which the \var{port} (default \code{70}). Returns an open file object from
returned document can be read. which the returned document can be read.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{send_query}{selector\, query\, host\optional{\, port}} \begin{funcdesc}{send_query}{selector, query, host\optional{, port}}
Send a \var{selector} string and a \var{query} string to a gopher Send a \var{selector} string and a \var{query} string to a gopher
server at \var{host} and \var{port} (default 70). Return an open file server at \var{host} and \var{port} (default \code{70}). Returns an
object from which the returned document can be read. open file object from which the returned document can be read.
\end{funcdesc} \end{funcdesc}
Note that the data returned by the Gopher server can be of any type, Note that the data returned by the Gopher server can be of any type,
@ -27,5 +28,5 @@ depending on the first character of the selector string. If the data
is text (first character of the selector is \samp{0}), lines are is text (first character of the selector is \samp{0}), lines are
terminated by CRLF, and the data is terminated by a line consisting of terminated by CRLF, and the data is terminated by a line consisting of
a single \samp{.}, and a leading \samp{.} should be stripped from a single \samp{.}, and a leading \samp{.} should be stripped from
lines that begin with \samp{..}. Directory listings (first charactger lines that begin with \samp{..}. Directory listings (first character
of the selector is \samp{1}) are transferred using the same protocol. of the selector is \samp{1}) are transferred using the same protocol.

View file

@ -1,6 +1,7 @@
\section{Standard Module \sectcode{gopherlib}} \section{Standard Module \sectcode{gopherlib}}
\label{module-gopherlib} \label{module-gopherlib}
\stmodindex{gopherlib} \stmodindex{gopherlib}
\indexii{Gopher}{protocol}
\renewcommand{\indexsubitem}{(in module gopherlib)} \renewcommand{\indexsubitem}{(in module gopherlib)}
@ -10,16 +11,16 @@ URLs that use the Gopher protocol.
The module defines the following functions: The module defines the following functions:
\begin{funcdesc}{send_selector}{selector\, host\optional{\, port}} \begin{funcdesc}{send_selector}{selector, host\optional{, port}}
Send a \var{selector} string to the gopher server at \var{host} and Send a \var{selector} string to the gopher server at \var{host} and
\var{port} (default 70). Return an open file object from which the \var{port} (default \code{70}). Returns an open file object from
returned document can be read. which the returned document can be read.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{send_query}{selector\, query\, host\optional{\, port}} \begin{funcdesc}{send_query}{selector, query, host\optional{, port}}
Send a \var{selector} string and a \var{query} string to a gopher Send a \var{selector} string and a \var{query} string to a gopher
server at \var{host} and \var{port} (default 70). Return an open file server at \var{host} and \var{port} (default \code{70}). Returns an
object from which the returned document can be read. open file object from which the returned document can be read.
\end{funcdesc} \end{funcdesc}
Note that the data returned by the Gopher server can be of any type, Note that the data returned by the Gopher server can be of any type,
@ -27,5 +28,5 @@ depending on the first character of the selector string. If the data
is text (first character of the selector is \samp{0}), lines are is text (first character of the selector is \samp{0}), lines are
terminated by CRLF, and the data is terminated by a line consisting of terminated by CRLF, and the data is terminated by a line consisting of
a single \samp{.}, and a leading \samp{.} should be stripped from a single \samp{.}, and a leading \samp{.} should be stripped from
lines that begin with \samp{..}. Directory listings (first charactger lines that begin with \samp{..}. Directory listings (first character
of the selector is \samp{1}) are transferred using the same protocol. of the selector is \samp{1}) are transferred using the same protocol.