From 071536e6556f2b00b206e948560982298e79f39c Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Wed, 19 Aug 1998 20:45:19 +0000 Subject: Renamed files ... just about to produce the first copy of the manual. --- doc/networking/Makefile | 20 ++++---- doc/networking/driver.t | 2 +- doc/networking/network.texi | 107 ----------------------------------------- doc/networking/networkapp.t | 6 +-- doc/networking/networking.texi | 107 +++++++++++++++++++++++++++++++++++++++++ doc/networking/preface.t | 23 --------- doc/networking/preface.texi | 23 +++++++++ 7 files changed, 144 insertions(+), 144 deletions(-) delete mode 100644 doc/networking/network.texi create mode 100644 doc/networking/networking.texi delete mode 100644 doc/networking/preface.t create mode 100644 doc/networking/preface.texi (limited to 'doc') diff --git a/doc/networking/Makefile b/doc/networking/Makefile index f0d8b85deb..f3dd1b8d53 100644 --- a/doc/networking/Makefile +++ b/doc/networking/Makefile @@ -44,28 +44,28 @@ $(PROJECT).ps: $(PROJECT).dvi $(PROJECT).dvi: $(FILES) $(TEXI2DVI) $(PROJECT).texi -networktasks.texi: networktasks.t +networktasks.texi: networktasks.t Makefile $(BMENU) -p "Preface" \ -u "Top" \ - -n "Writing RTEMS/KA9Q Network Device Drivers" ${*}.t + -n "Writing RTEMS Network Device Drivers" ${*}.t -driver.texi: driver.t - $(BMENU) -p "KA9Q Task Structure and Data Flow" \ +driver.texi: driver.t Makefile + $(BMENU) -p "Network Task Structure and Data Flow" \ -u "Top" \ - -n "Using KA9Q networking in an RTEMS Application" ${*}.t + -n "Using Networking in an RTEMS Application" ${*}.t -networkapp.texi: networkapp.t - $(BMENU) -p "Writing RTEMS/KA9Q Network Device Drivers Write your driver show function" \ +networkapp.texi: networkapp.t Makefile + $(BMENU) -p " Writing RTEMS Network Device Drivers Write Your Driver Statistic-Printing Function" \ -u "Top" \ -n "Testing the Driver" ${*}.t -testing.texi: testing.t - $(BMENU) -p "Using KA9Q networking in an RTEMS Application Domain Name Service" \ +testing.texi: testing.t Makefile + $(BMENU) -p "Using Networking in an RTEMS Application Network Statistics" \ -u "Top" \ -n "Command and Variable Index" ${*}.t html: dirs $(FILES) - -mkdir -p $(WWW_INSTALL)/networking + -mkdir -p $(WWW_INSTALL)/network rm -f $(WWW_INSTALL)/$(PROJECT)/networking.gif cp networking.gif $(WWW_INSTALL)/$(PROJECT)/networking.gif $(TEXI2WWW) $(TEXI2WWW_ARGS) -dir $(WWW_INSTALL)/$(PROJECT) \ diff --git a/doc/networking/driver.t b/doc/networking/driver.t index 43589aa694..d762223449 100644 --- a/doc/networking/driver.t +++ b/doc/networking/driver.t @@ -272,7 +272,7 @@ Do nothing. -@section Write your driver statistic-printing function +@section Write Your Driver Statistic-Printing Function This function should print the values of any statistic/diagnostic counters your driver may use. The driver ioctl function should call the statistic-printing function when the ioctl command is diff --git a/doc/networking/network.texi b/doc/networking/network.texi deleted file mode 100644 index 87867a522f..0000000000 --- a/doc/networking/network.texi +++ /dev/null @@ -1,107 +0,0 @@ -\input texinfo @c -*-texinfo-*- -@c %**start of header -@setfilename ka9q -@syncodeindex vr fn -@synindex ky cp -@paragraphindent 0 -@c @smallbook -@c %**end of header - -@c -@c COPYRIGHT (c) 1988-1998. -@c On-Line Applications Research Corporation (OAR). -@c All rights reserved. -@c -@c $Id$ -@c - -@c -@c Master file for the network Supplement -@c - -@include ../common/setup.texi - -@ignore -@ifinfo -@format -START-INFO-DIR-ENTRY -* RTEMS Network Supplement: -END-INFO-DIR-ENTRY -@end format -@end ifinfo -@end ignore - -@c -@c Title Page Stuff -@c - -@set edition @value{RTEMS-EDITION} -@set version @value{RTEMS-VERSION} -@set update-date @value{RTEMS-UPDATE-DATE} -@set update-month @value{RTEMS-UPDATE-MONTH} - -@c -@c I don't really like having a short title page. --joel -@c -@c @shorttitlepage RTEMS Network Supplement - -@setchapternewpage odd -@settitle RTEMS Network Supplement -@titlepage -@finalout - -@title RTEMS Network Supplement -@subtitle Edition @value{edition}, for RTEMS @value{version} -@sp 1 -@subtitle @value{update-month} -@author On-Line Applications Research Corporation -@page -@include ../common/cpright.texi -@end titlepage - -@c This prevents a black box from being printed on "overflow" lines. -@c The alternative is to rework a sentence to avoid this problem. - -@include preface.t -@include networktasks.t -@include driver.t -@include networkapp.t -@c@include testing.texi -@ifinfo -@node Top, Preface, (dir), (dir) -@top ka9q - -This is the online version of the RTEMS Network Supplement. - -@menu -* Preface:: -* Network Task Structure and Data Flow:: -* Writing RTEMS Network Device Drivers:: -* Using Networking in an RTEMS Application:: -* Testing the Driver:: -* Command and Variable Index:: -* Concept Index:: -@end menu - -@end ifinfo -@c -@c -@c Need to copy the emacs stuff and "trailer stuff" (index, toc) into here -@c - -@node Command and Variable Index, Concept Index, Testing the Driver Throughput, Top -@unnumbered Command and Variable Index - -There are currently no Command and Variable Index entries. - -@c @printindex fn - -@node Concept Index, , Command and Variable Index, Top -@unnumbered Concept Index - -There are currently no Concept Index entries. -@c @printindex cp - -@c @contents -@bye - diff --git a/doc/networking/networkapp.t b/doc/networking/networkapp.t index 778cf51400..59a3293e10 100644 --- a/doc/networking/networkapp.t +++ b/doc/networking/networkapp.t @@ -8,7 +8,7 @@ @c $Id$ @c -@chapter Using networking in an RTEMS application +@chapter Using Networking in an RTEMS Application @section Makefile changes @subsection Including the required managers @@ -207,7 +207,7 @@ The RTEMS network package provides almost a complete set of BSD network services. The network functions work like their BSD counterparts with the following exceptions: -@itemize +@itemize @bullet @item A given socket can be read or written by only one task at a time. @item There is no @code{select} function. @item You must call @code{openlog} before calling any of the @code{syslog} functions. @@ -223,7 +223,7 @@ buffer which remains valid only until the next call: @end table @end itemize -@subsection Network statistics +@subsection Network Statistics There are a number of functions to print statistics gathered by the network stack: @table @code @item rtems_bsdnet_show_if_stats diff --git a/doc/networking/networking.texi b/doc/networking/networking.texi new file mode 100644 index 0000000000..988e7b1985 --- /dev/null +++ b/doc/networking/networking.texi @@ -0,0 +1,107 @@ +\input texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename networking +@syncodeindex vr fn +@synindex ky cp +@paragraphindent 0 +@c @smallbook +@c %**end of header + +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@c +@c Master file for the network Supplement +@c + +@include ../common/setup.texi + +@ignore +@ifinfo +@format +START-INFO-DIR-ENTRY +* RTEMS Network Supplement: +END-INFO-DIR-ENTRY +@end format +@end ifinfo +@end ignore + +@c +@c Title Page Stuff +@c + +@set edition @value{RTEMS-EDITION} +@set version @value{RTEMS-VERSION} +@set update-date @value{RTEMS-UPDATE-DATE} +@set update-month @value{RTEMS-UPDATE-MONTH} + +@c +@c I don't really like having a short title page. --joel +@c +@c @shorttitlepage RTEMS Network Supplement + +@setchapternewpage odd +@settitle RTEMS Network Supplement +@titlepage +@finalout + +@title RTEMS Network Supplement +@subtitle Edition @value{edition}, for RTEMS @value{version} +@sp 1 +@subtitle @value{update-month} +@author On-Line Applications Research Corporation +@page +@include ../common/cpright.texi +@end titlepage + +@c This prevents a black box from being printed on "overflow" lines. +@c The alternative is to rework a sentence to avoid this problem. + +@include preface.texi +@include networktasks.texi +@include driver.texi +@include networkapp.texi +@include testing.texi +@ifinfo +@node Top, Preface, (dir), (dir) +@top networking + +This is the online version of the RTEMS Network Supplement. + +@menu +* Preface:: +* Network Task Structure and Data Flow:: +* Writing RTEMS Network Device Drivers:: +* Using Networking in an RTEMS Application:: +* Testing the Driver:: +* Command and Variable Index:: +* Concept Index:: +@end menu + +@end ifinfo +@c +@c +@c Need to copy the emacs stuff and "trailer stuff" (index, toc) into here +@c + +@node Command and Variable Index, Concept Index, Testing the Driver Throughput, Top +@unnumbered Command and Variable Index + +There are currently no Command and Variable Index entries. + +@c @printindex fn + +@node Concept Index, , Command and Variable Index, Top +@unnumbered Concept Index + +There are currently no Concept Index entries. +@c @printindex cp + +@c @contents +@bye + diff --git a/doc/networking/preface.t b/doc/networking/preface.t deleted file mode 100644 index 4f76f1f0fc..0000000000 --- a/doc/networking/preface.t +++ /dev/null @@ -1,23 +0,0 @@ -@c -@c COPYRIGHT (c) 1988-1998. -@c On-Line Applications Research Corporation (OAR). -@c All rights reserved. -@c -@c $Id$ -@c - -@ifinfo -@node Preface, Network Task Structure and Data Flow, Top, Top -@end ifinfo -@unnumbered Preface - -This document describes the RTEMS specific parts of the FreeBSD TCP/IP -stack. Much of this documentation was written by Eric Norum -@ifset use-html -(@href{eric@@skatter.usask.ca,,,mailto:eric@@skatter.usask.ca}) -@end ifset -@ifclear use-html -(eric@@skatter.usask.ca) -@end ifclear -of the Saskatchewan Accelerator Laboratory -who also ported the FreeBSD TCP/IP stack to RTEMS. diff --git a/doc/networking/preface.texi b/doc/networking/preface.texi new file mode 100644 index 0000000000..4f76f1f0fc --- /dev/null +++ b/doc/networking/preface.texi @@ -0,0 +1,23 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@ifinfo +@node Preface, Network Task Structure and Data Flow, Top, Top +@end ifinfo +@unnumbered Preface + +This document describes the RTEMS specific parts of the FreeBSD TCP/IP +stack. Much of this documentation was written by Eric Norum +@ifset use-html +(@href{eric@@skatter.usask.ca,,,mailto:eric@@skatter.usask.ca}) +@end ifset +@ifclear use-html +(eric@@skatter.usask.ca) +@end ifclear +of the Saskatchewan Accelerator Laboratory +who also ported the FreeBSD TCP/IP stack to RTEMS. -- cgit v1.2.3