[Spread-cvs] cvs commit: spread/daemon/docs spflooder.1 spmonitor.1 spuser.1 sptuser.1

[jonathan at spread.org]

jonathan    01/12/12 10:01:51

  Added:       daemon/docs spflooder.1 spmonitor.1 spuser.1 sptuser.1
  Log:
  Added Files:
  	spflooder.1 spmonitor.1 spuser.1 sptuser.1
  ----------------------------------------------------------------------
  Add new manpages for client apps.
  
  Revision  Changes    Path
  1.1                  spread/daemon/docs/spflooder.1
  
  Index: spflooder.1
  ===================================================================
  .\" Process this file with
  .\" groff -man -Tascii foo.1
  .\"
  .TH SPFLOODER 1 "DECEMBER 2001" Spread "User Manuals"
  .SH NAME
  spflooder \- Spread Performance Test Client
  .SH SYNOPSIS
  .BI "spflooder [-u " connection_name "] [-s " spread_address "] [-m " num_messages "] [-b " bytes_per_message "] [-ro] [-wo]"
  .SH DESCRIPTION
  .B spflooder
  is a Spread client program that can flood messages and measure the time
  required to send a certain number of messages. This can be used to 
  test the performance of Spread and the machines it runs on.
  By default it trys to connect to a Spread
  daemon running on port 4803 of the local machine.
  
  .SH OPTIONS
  .IP "-u connection_name"
  The name this connection to the daemon will use to uniquely identify itself.
  .IP "-s spread address"
  The port number, or port number and host to which the spuser 
  program should connect in order to reach a Spread daemon.
  .IP "-m num messages"
  The number of messages to flood. 
  .IP "-b num bytes"
  The size of each message to send in bytes.
  .IP "-ro"
  This flooder process will only receive messages sent by other flooders. It will not send any messages.
  .IP "-wo"
  This flooder process will only send messages to other flooders. It will not receive any messages.
  .SH BUGS
  Some limitations on message size and number of groups are hardcoded into spflooder.
  Some changes to the code may be necessary to get maximum performance in large Spread configuarations.
  .SH AUTHOR
  Yair Amir <yairamir at cnds.jhu.edu>
  
  Jonathan Stanton <jonathan at cnds.jhu.edu>
  
  Spflooder is Copyright 1998-2001 Spread Concepts, LLC.
  .SH "SEE ALSO"
  .BR libsp (3)
  .BR spread (1)
  
  
  
  1.1                  spread/daemon/docs/spmonitor.1
  
  Index: spmonitor.1
  ===================================================================
  .\" Process this file with
  .\" groff -man -Tascii foo.1
  .\"
  .TH SPMONITOR 1 "DECEMBER 2001" Spread "User Manuals"
  .SH NAME
  spmonitor \- Spread Monitoring and Adminstration client
  .SH SYNOPSIS
  .BI "spmonitor [-n " proc_name "] [-c " config_file "] [-t " status_timeout "] [-p " port "]"
  .SH DESCRIPTION
  .B spmonitor
  Provides a general monitoring and administrative tool for the Spread system. 
  The spmonitor program can send queries and commands to Spread daemons to either
  gather debugging or performance statistics, or to shut down specific daemons or
  change flow control parameters of the system to tune performance. 
  
  Some details about the effective use of the spmonitor program are contained
  in the Users Guide which is available from the Spread web site www.spread.org.
  .SH OPTIONS
  .IP "-t status_timeout"
  The seconds between every status report. The default is 10.
  .IP "-p port"
  The port number, to which the spmonitor 
  program should connect in order to reach a Spread daemon.
  .IP "-n proc_name"
  Force this daemon to be identified by a specific process name.
  .IP "-c config-file"
  Use an alternate configuration file
  .I config-file
  instead of
  .IR ./spread.conf .
  .SH FILES
  .I ./spread.conf
  .RS
  The default config file location. 
  .I /etc/spread.conf 
  is also searched if a local file is not found.
  .SH BUGS
  The spmonitor works by sending UDP packets to the Spread daemon, so if network 
  losses occur, commands or status reports can be lost. It can also lose reports
  when monitoring a large number of daemons. 
  .SH AUTHOR
  Yair Amir <yairamir at cnds.jhu.edu>
  
  Jonathan Stanton <jonathan at cnds.jhu.edu>
  
  Spuser is Copyright 1998-2001 Spread Concepts, LLC.
  .SH "SEE ALSO"
  .BR libsp (3)
  .BR spread (1)
  
  
  
  1.1                  spread/daemon/docs/spuser.1
  
  Index: spuser.1
  ===================================================================
  .\" Process this file with
  .\" groff -man -Tascii foo.1
  .\"
  .TH SPUSER 1 "DECEMBER 2001" Spread "User Manuals"
  .SH NAME
  spuser \- Spread Group Communication Client
  .SH SYNOPSIS
  .BI "spuser [-u " connection_name "] [-s " spread_address "] [-n " username "] [-p " password "] [-r]"
  .SH DESCRIPTION
  .B spuser
  is a Spread client program that can send and receive messages and 
  join and leave groups. By default it trys to connect to a Spread
  daemon running on port 4803 of the local machine.
  
  .SH OPTIONS
  .IP "-u connection_name"
  The name this connection to the daemon will use to uniquely identify itself.
  .IP "-s spread address"
  The port number, or port number and host to which the spuser 
  program should connect in order to reach a Spread daemon.
  .IP "-n username"
  The user name that one would like to authenticate with
  if password based authentication is enabled.
  .IP "-p password"
  The password to be used for authentication.
  .IP "-r"
  Use a random connection name.
  .SH BUGS
  Some limitations on message size and number of groups are hardcoded into spuser.
  .SH AUTHOR
  Yair Amir <yairamir at cnds.jhu.edu>
  
  Jonathan Stanton <jonathan at cnds.jhu.edu>
  
  Spuser is Copyright 1998-2001 Spread Concepts, LLC.
  .SH "SEE ALSO"
  .BR libsp (3)
  .BR spread (1)
  
  
  
  1.1                  spread/daemon/docs/sptuser.1
  
  Index: sptuser.1
  ===================================================================
  .\" Process this file with
  .\" groff -man -Tascii foo.1
  .\"
  .so man1/spuser.1