[Spread-cvs] commit: r295 - trunk/docs
jonathan at spread.org
jonathan at spread.org
Thu Feb 16 16:24:20 EST 2006
Author: jonathan
Date: 2006-02-16 16:24:20 -0500 (Thu, 16 Feb 2006)
New Revision: 295
Added:
trunk/docs/libspread.3
Removed:
trunk/docs/libsp.3
Modified:
trunk/docs/SP_connect.3
trunk/docs/SP_disconnect.3
trunk/docs/SP_equal_group_ids.3
trunk/docs/SP_error.3
trunk/docs/SP_get_first_vs_set_offset_memb_mess.3
trunk/docs/SP_get_gid_offset_memb_mess.3
trunk/docs/SP_get_local_vs_set_offset_memb_mess.3
trunk/docs/SP_get_local_vs_set_offset_memb_scat.3
trunk/docs/SP_get_num_vs_sets_offset_memb_mess.3
trunk/docs/SP_get_vs_set_members_offset_vs_set.3
trunk/docs/SP_get_vs_set_size_offset_vs_set.3
trunk/docs/SP_join.3
trunk/docs/SP_kill.3
trunk/docs/SP_leave.3
trunk/docs/SP_multicast.3
trunk/docs/SP_poll.3
trunk/docs/SP_receive.3
trunk/docs/SP_version.3
trunk/docs/spflooder.1
trunk/docs/spmonitor.1
trunk/docs/spread.1
trunk/docs/spuser.1
Log:
Update name of library from libsp to libspread. Update year, email addresses
and other boilerplate from man pages.
Modified: trunk/docs/SP_connect.3
===================================================================
--- trunk/docs/SP_connect.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_connect.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -120,7 +120,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp (3)
+.BR libspread (3)
Modified: trunk/docs/SP_disconnect.3
===================================================================
--- trunk/docs/SP_disconnect.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_disconnect.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -40,7 +40,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp (3)
+.BR libspread (3)
Modified: trunk/docs/SP_equal_group_ids.3
===================================================================
--- trunk/docs/SP_equal_group_ids.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_equal_group_ids.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -26,7 +26,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp (3)
+.BR libspread (3)
Modified: trunk/docs/SP_error.3
===================================================================
--- trunk/docs/SP_error.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_error.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -20,7 +20,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp(3)
+.BR libspread(3)
Modified: trunk/docs/SP_get_first_vs_set_offset_memb_mess.3
===================================================================
--- trunk/docs/SP_get_first_vs_set_offset_memb_mess.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_get_first_vs_set_offset_memb_mess.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -20,7 +20,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp(3)
+.BR libspread(3)
Modified: trunk/docs/SP_get_gid_offset_memb_mess.3
===================================================================
--- trunk/docs/SP_get_gid_offset_memb_mess.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_get_gid_offset_memb_mess.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -20,7 +20,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp(3)
+.BR libspread(3)
Modified: trunk/docs/SP_get_local_vs_set_offset_memb_mess.3
===================================================================
--- trunk/docs/SP_get_local_vs_set_offset_memb_mess.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_get_local_vs_set_offset_memb_mess.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -24,7 +24,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp(3)
+.BR libspread(3)
Modified: trunk/docs/SP_get_local_vs_set_offset_memb_scat.3
===================================================================
--- trunk/docs/SP_get_local_vs_set_offset_memb_scat.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_get_local_vs_set_offset_memb_scat.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -24,7 +24,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp(3)
+.BR libspread(3)
Modified: trunk/docs/SP_get_num_vs_sets_offset_memb_mess.3
===================================================================
--- trunk/docs/SP_get_num_vs_sets_offset_memb_mess.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_get_num_vs_sets_offset_memb_mess.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -21,7 +21,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp(3)
+.BR libspread(3)
Modified: trunk/docs/SP_get_vs_set_members_offset_vs_set.3
===================================================================
--- trunk/docs/SP_get_vs_set_members_offset_vs_set.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_get_vs_set_members_offset_vs_set.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -21,7 +21,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp(3)
+.BR libspread(3)
Modified: trunk/docs/SP_get_vs_set_size_offset_vs_set.3
===================================================================
--- trunk/docs/SP_get_vs_set_size_offset_vs_set.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_get_vs_set_size_offset_vs_set.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -21,7 +21,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp(3)
+.BR libspread(3)
Modified: trunk/docs/SP_join.3
===================================================================
--- trunk/docs/SP_join.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_join.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -44,7 +44,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp (3)
+.BR libspread (3)
Modified: trunk/docs/SP_kill.3
===================================================================
--- trunk/docs/SP_kill.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_kill.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -45,7 +45,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp (3)
+.BR libspread (3)
Modified: trunk/docs/SP_leave.3
===================================================================
--- trunk/docs/SP_leave.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_leave.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -44,7 +44,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp (3)
+.BR libspread (3)
Modified: trunk/docs/SP_multicast.3
===================================================================
--- trunk/docs/SP_multicast.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_multicast.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -111,7 +111,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp (3)
+.BR libspread (3)
Modified: trunk/docs/SP_poll.3
===================================================================
--- trunk/docs/SP_poll.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_poll.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -28,7 +28,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp (3)
+.BR libspread (3)
Modified: trunk/docs/SP_receive.3
===================================================================
--- trunk/docs/SP_receive.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_receive.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -1,7 +1,7 @@
.\" Process this file with
.\" groff -man -Tascii foo.1
.\"
-.TH SP_RECEIVE 3 "September 2002" Spread "User Manuals"
+.TH SP_RECEIVE 3 "February 2006" Spread "User Manuals"
.SH NAME
SP_receive, SP_scat_receive \- Receive message from Spread
.SH SYNOPSIS
@@ -390,7 +390,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp (3)
+.BR libspread (3)
Modified: trunk/docs/SP_version.3
===================================================================
--- trunk/docs/SP_version.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/SP_version.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -22,7 +22,7 @@
.br
Jonathan Stanton <jonathan at cnds.jhu.edu>
.br
-Commedia Project <commedia at cnds.jhu.edu>
+
.SH "SEE ALSO"
-.BR libsp (3)
+.BR libspread (3)
Deleted: trunk/docs/libsp.3
===================================================================
--- trunk/docs/libsp.3 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/libsp.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -1,59 +0,0 @@
-.\" Process this file with
-.\" groff -man -Tascii foo.1
-.\"
-.TH SP 3 "April 2002" Spread "User Manuals"
-.SH "NAME"
-libsp \- Spread Group Communication Client Library
-.SH "SYNOPSIS"
-.SH "DESCRIPTION"
-The Spread
-.B libsp
-library implements the client SP interface to the Spread
-group communication or multicast message bus system.
-.SH "DATA STRUCTURES"
-.SH "HEADER FILES"
-.I sp.h
-is the main header and includes necessary defines and types. It also
-includes the other header files sp_events.h and sp_func.h.
-
-.I sp_events.h
-declares the types and functions that make up the E Event-management
-library.
-
-.I sp_func.h
-declares the functions of the SP interface. Since sp.h includes this you
-should not include this directly.
-.SH "FILES"
-No files are required for client applications using the SP library.
-.SH "DIAGNOSTICS"
-The library will not output any debugging information except in fatal errors.
-The
-.B SP_error(3)
-function can be used to print an informative error message when SP functions
-return an error code.
-.SH "BUGS"
-None currently known. Library is only thread-safe if the program
-is linked with libtsp.a not libsp.a. The non-thread-safe library is
-provided for those who are writing single-threaded applications and do not
-want to pay the minimal performance penalty for locking.
-.SH AUTHOR
-Yair Amir <yairamir at cnds.jhu.edu>
-.PP
-Jonathan Stanton <jonathan at cnds.jhu.edu>
-.PP
-Spread Project <spread at spread.org>
-.SH "SEE ALSO"
-.BR spread (1)
-.BR SP_connect (3)
-.BR SP_disconnect (3)
-.BR SP_equal_group_ids (3)
-.BR SP_error (3)
-.BR SP_join (3)
-.BR SP_leave (3)
-.BR SP_multicast (3)
-.BR SP_scat_multicast (3)
-.BR SP_multigroup_multicast (3)
-.BR SP_multigroup_scat_multicast (3)
-.BR SP_poll (3)
-.BR SP_receive (3)
-.BR SP_scat_receive (3)
Copied: trunk/docs/libspread.3 (from rev 294, trunk/docs/libsp.3)
===================================================================
--- trunk/docs/libspread.3 (rev 0)
+++ trunk/docs/libspread.3 2006-02-16 21:24:20 UTC (rev 295)
@@ -0,0 +1,69 @@
+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.TH SP 3 "Februrary 2006" Spread "User Manuals"
+.SH "NAME"
+libspread \- Spread Group Communication Client Library
+.SH "SYNOPSIS"
+.SH "DESCRIPTION"
+The Spread
+.B libspread
+library implements the client SP interface to the Spread
+group communication or multicast message bus system.
+.SH "DATA STRUCTURES"
+.SH "HEADER FILES"
+.I sp.h
+is the main header and includes necessary defines and types. It also
+includes the other header files sp_events.h and sp_func.h.
+
+.I sp_events.h
+declares the types and functions that make up the E Event-management
+library.
+
+.I sp_func.h
+declares the functions of the SP interface. Since sp.h includes this you
+should not include this directly.
+.SH "FILES"
+No files are required for client applications using the SP library.
+.SH "DIAGNOSTICS"
+The library will not output any debugging information except in fatal errors.
+The
+.B SP_error(3)
+function can be used to print an informative error message when SP functions
+return an error code.
+.SH "BUGS"
+None currently known. The libspread library is thread-safe. However,
+the libspread-core.a library is not thread-safe. The libtspread-core.a
+library is the version to use if you need a thread-safe version of the core.
+The non-thread-safe library is
+provided for those who are writing single-threaded applications and do not
+want to pay the minimal performance penalty for locking.
+.SH AUTHOR
+Yair Amir <yairamir at cnds.jhu.edu>
+.PP
+Jonathan Stanton <jonathan at cnds.jhu.edu>
+.PP
+Spread Project <spread at spread.org>
+.SH "SEE ALSO"
+.BR spread (1)
+.BR SP_connect (3)
+.BR SP_disconnect (3)
+.BR SP_equal_group_ids (3)
+.BR SP_error (3)
+.BR SP_get_first_vs_set_offset_memb_mess (3)
+.BR SP_get_gid_offset_memb_mess (3)
+.BR SP_get_local_vs_set_offset_memb_mess (3)
+.BR SP_get_local_vs_set_offset_memb_scat (3)
+.BR SP_get_num_vs_sets_offset_memb_mess (3)
+.BR SP_get_vs_set_members_offset_vs_set (3)
+.BR SP_get_vs_set_size_offset_vs_set (3)
+.BR SP_join (3)
+.BR SP_leave (3)
+.BR SP_multicast (3)
+.BR SP_multigroup_multicast (3)
+.BR SP_multigroup_scat_multicast (3)
+.BR SP_poll (3)
+.BR SP_receive (3)
+.BR SP_scat_multicast (3)
+.BR SP_scat_receive (3)
+.BR SP_version (3)
Modified: trunk/docs/spflooder.1
===================================================================
--- trunk/docs/spflooder.1 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/spflooder.1 2006-02-16 21:24:20 UTC (rev 295)
@@ -36,7 +36,7 @@
Jonathan Stanton <jonathan at cnds.jhu.edu>
-Spflooder is Copyright 1998-2001 Spread Concepts, LLC.
+Spflooder is Copyright 1998-2006 Spread Concepts, LLC.
.SH "SEE ALSO"
-.BR libsp (3)
+.BR libspread (3)
.BR spread (1)
Modified: trunk/docs/spmonitor.1
===================================================================
--- trunk/docs/spmonitor.1 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/spmonitor.1 2006-02-16 21:24:20 UTC (rev 295)
@@ -43,7 +43,7 @@
Jonathan Stanton <jonathan at cnds.jhu.edu>
-Spuser is Copyright 1998-2001 Spread Concepts, LLC.
+Spuser is Copyright 1998-2006 Spread Concepts, LLC.
.SH "SEE ALSO"
-.BR libsp (3)
+.BR libspread (3)
.BR spread (1)
Modified: trunk/docs/spread.1
===================================================================
--- trunk/docs/spread.1 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/spread.1 2006-02-16 21:24:20 UTC (rev 295)
@@ -33,8 +33,10 @@
standard out to a file or using the EventLogFile directive in the spread.conf
file is recommended if you are interested in log messages.
.SH BUGS
-None currently known. Library is only thread-safe if the program
-is linked with libtsp.a not libsp.a. The non-thread-safe library is
+None currently known. The libspread library is thread-safe. However,
+the libspread-core.a library is not thread-safe. The libtspread-core.a
+library is the version to use if you need a thread-safe version of the core.
+The non-thread-safe library is
provided for those who are writing single-threaded applications and do not
want to pay the minimal performance penalty for locking.
.SH AUTHOR
@@ -42,6 +44,5 @@
Jonathan Stanton <jonathan at cnds.jhu.edu>
-Spread Project <spread at cnds.jhu.edu>
.SH "SEE ALSO"
-.BR libsp (3)
+.BR libspread (3)
Modified: trunk/docs/spuser.1
===================================================================
--- trunk/docs/spuser.1 2006-02-16 19:21:53 UTC (rev 294)
+++ trunk/docs/spuser.1 2006-02-16 21:24:20 UTC (rev 295)
@@ -32,7 +32,7 @@
Jonathan Stanton <jonathan at cnds.jhu.edu>
-Spuser is Copyright 1998-2001 Spread Concepts, LLC.
+Spuser is Copyright 1998-2006 Spread Concepts, LLC.
.SH "SEE ALSO"
-.BR libsp (3)
+.BR libspread (3)
.BR spread (1)
More information about the Spread-cvs
mailing list