Daniele Tricoli avatar Daniele Tricoli committed 866ff6d

Added man pages for circuits.bench, circuits.sniff and circuits.web

Comments (0)

Files changed (3)

man/circuits.bench.1

+.TH circuits.bench 1 "Jun 2011" "circuits 1.6" "User Commands"
+.SH NAME
+circuits.bench \- simple benchmaking of the circuits library
+.SH SYNOPSIS
+.B circuits.bench
+[\fIoptions\fR]
+.SH DESCRIPTION
+circuits.bench does some simple benchmaking of the circuits library.
+.SH OPTIONS
+.TP
+\fB-b\fR \fIaddress:[port]\fR
+Bind to address:[port] (UDP) to test remote events. Default address is 0.0.0.0.
+.TP
+\fB-c\fR \fIinteger\fR
+Set concurrency level to \fIinteger\fR. Default is 1.
+.TP
+\fB-d\fR
+Enable debug mode.
+.TP
+\fB-e\fR \fInumber\fR
+Stop after specified \fInumber\fR of events. Default is 0.
+.TP
+\fB-f\fR \fInumber\fR
+\fInumber\fR of dummy events to fill queue with. Default is 0.
+.TP
+\fB-l\fR
+Listen on 0.0.0.0:8000 (UDP) to test remote events.
+.TP
+\fB-m\fR \fImode\fR
+Set operation mode. \fImode\fR can be \fIlatency\fR, \fIspeed\fR or \fIsync\fR.
+Default \fImode\fR is \fIspeed\fR.
+.TP
+\fB-o\fR \fIformat\fR
+Specify output format.
+For example \fIformat\fR can be:"cicuits.bench: events:%s, speed:%s, time:%s"
+.TP
+\fB-p\fR
+Enable execution profiling support.
+.TP
+\fB-q\fR
+Suppress output.
+.TP
+\fB-s\fR
+Enable psyco (circuits on speed!) if it is available.
+.TP
+\fB-t\fR \fIseconds\fR
+Stop after specified elapsed \fIseconds\fR.
+.TP
+\fB-w\fR
+Wait for remote nodes to connect.
+.TP
+\fB--version\fR
+Output version information and exit.
+.SH AUTHOR
+James Mills <prologic@shortcircuit.net.au>
+.PP
+This manual page was written by Daniele Tricoli <eriol@mornie.org>, for the
+Debian project (but may be used by others).

man/circuits.sniff.1

+.TH circuits.sniff 1 "Jun 2011" "circuits 1.6" "User Commands"
+.SH NAME
+circuits.sniff \- event sniffer of the circuits library
+.SH SYNOPSIS
+.B circuits.sniff
+[\fIoptions\fR]
+.SH DESCRIPTION
+circuits.sniff is an event sniffing tool. It can be used to sniff and debug
+Events as they occur in another system. As long as that system has an instance
+of the Bridge Component, events can be sniffed and printed.
+.SH OPTIONS
+.TP
+\fB-b\fR \fIaddress:port\fR
+Bind to address:port. Default address is 0.0.0.0:8000.
+.TP
+\fB--version\fR
+Output version information and exit.
+.SH AUTHOR
+James Mills <prologic@shortcircuit.net.au>
+.PP
+This manual page was written by Daniele Tricoli <eriol@mornie.org>, for the
+Debian project (but may be used by others).

man/circuits.web.1

+.TH circuits.web 1 "Jun 2011" "circuits 1.6" "User Commands"
+.SH NAME
+circuits.web \- Web Server and testing tool
+.SH SYNOPSIS
+.B circuits.web
+[\fIoptions\fR] [\fIdocroot\fR]
+.SH DESCRIPTION
+circuits.web is a component based, event-driven light weight and high
+performance HTTP/WSGI framework. circuits.web applications are stand-alone
+applications with a high performance, multi-process web server with great
+concurrent scalability with full support for WSGI and deployment with other web
+servers.
+.SH OPTIONS
+.TP
+\fB-b\fR \fIaddress:[port]\fR
+Bind to address:[port]. Default address is 0.0.0.0:8000.
+.TP
+\fB-d\fR
+Enable debug mode.
+.TP
+\fB-j\fR
+Use python JIT (psyco) if it is available.
+.TP
+\fB-m\fR \fInumber\fR
+Specify \fInumber\fR of processes to start (multiprocessing).
+.TP
+\fB-p\fR
+Enable execution profiling support.
+.TP
+\fB-s\fR \fIserver\fR
+Specify server to use.
+.TP
+\fB-t\fR \fItype\fR
+Specify type of poller to use. \fItype\fR can be \fIepoll\fR, \fIpoll\fR or
+\fIselect\fR.
+Default \fItype\fR is \fIselect\fR.
+.TP
+\fB-v\fR
+Enable WSGI validation mode.
+.SH AUTHOR
+James Mills <prologic@shortcircuit.net.au>
+.PP
+This manual page was written by Daniele Tricoli <eriol@mornie.org>, for the
+Debian project (but may be used by others).
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.