[catagits/CatalystX-Script-Server-Starman.git] / README

NAME
    CatalystX::Script::Server::Starman - Replace the development server with
    Starman

SYNOPSIS
        myapp_server.pl [options]

           -d --debug           force debug mode
           -f --fork            handle each request in a new process
                                (defaults to false)
           -? --help            display this help and exits
           -h --host            host (defaults to all)
           -p --port            port (defaults to 3000)
           --follow_symlinks    follow symlinks in search directories
                                (defaults to false. this is a no-op on Win32)
           --background         run the process in the background
           --pidfile            specify filename for pid file
           --workers            Initial number of workers to spawn (defaults to 5)
           --min_servers        Minimum number of worker processes runnning
           --min_spare_servers  Minimum number of spare workers (more are forked
                                if there are less spare than this)
           --max_spare_servers  Maximum number of spare workers (workers are killed
                                if there are more spare than this)
           --max_servers        Maximum number of workers in total.
           --max_requests       Maximum number of requests each worker will handle
           --backlog            Number of backlogged connections allowed
           --user               User to run as
           --group              Group to run as

         See also:
           perldoc Starman
           perldoc plackup
           perldoc Catalyst::PSGI

DESCRIPTION
    A Catalyst extension to replace the development server with Starman.

    This module replaces the functionality of
    Catalyst::Engine::HTTP::Prefork, which is now deprecated.

    It provides access to the prefork engine specific options which were
    previously added by hacking your server script.

Adding this to your application
    Just add a server script module to your application which inherits from
    this package.

    Catalyst::ScriptRunner will automatically detect and use it when
    script/myapp_server.pl is started.

    For example:

        package MyApp::Script::Server;
        use Moose;
        use namespace::autoclean;

        extends 'CatalystX::Script::Server::Starman';

        1;

SEE ALSO
    plackup - can be used to start your application ".psgi" under Starman

    Catalyst::PSGI

AUTHOR
    Tomas Doran (t0m) "<bobtfish@bobtfish.net>"

COPYRIGHT & LICENSE
    Copyright 2009 the above author(s).

    This sofware is free software, and is licensed under the same terms as
    perl itself.
Commit	Line	Data
7d386bce	1	NAME
	2	CatalystX::Script::Server::Starman - Replace the development server with
	3	Starman
	4
	5	SYNOPSIS
	6	myapp_server.pl [options]
	7
	8	-d --debug force debug mode
	9	-f --fork handle each request in a new process
	10	(defaults to false)
	11	-? --help display this help and exits
	12	-h --host host (defaults to all)
	13	-p --port port (defaults to 3000)
	14	--follow_symlinks follow symlinks in search directories
	15	(defaults to false. this is a no-op on Win32)
	16	--background run the process in the background
	17	--pidfile specify filename for pid file
	18	--workers Initial number of workers to spawn (defaults to 5)
	19	--min_servers Minimum number of worker processes runnning
	20	--min_spare_servers Minimum number of spare workers (more are forked
	21	if there are less spare than this)
	22	--max_spare_servers Maximum number of spare workers (workers are killed
	23	if there are more spare than this)
	24	--max_servers Maximum number of workers in total.
	25	--max_requests Maximum number of requests each worker will handle
	26	--backlog Number of backlogged connections allowed
	27	--user User to run as
	28	--group Group to run as
	29
	30	See also:
	31	perldoc Starman
	32	perldoc plackup
	33	perldoc Catalyst::PSGI
	34
	35	DESCRIPTION
	36	A Catalyst extension to replace the development server with Starman.
	37
	38	This module replaces the functionality of
	39	Catalyst::Engine::HTTP::Prefork, which is now deprecated.
	40
	41	It provides access to the prefork engine specific options which were
	42	previously added by hacking your server script.
	43
	44	Adding this to your application
3b5703c8	45	Just add a server script module to your application which inherits from
	46	this package.
	47
	48	Catalyst::ScriptRunner will automatically detect and use it when
	49	script/myapp_server.pl is started.
7d386bce	50
	51	For example:
	52
	53	package MyApp::Script::Server;
	54	use Moose;
	55	use namespace::autoclean;
	56
	57	extends 'CatalystX::Script::Server::Starman';
	58
	59	1;
	60
	61	SEE ALSO
	62	plackup - can be used to start your application ".psgi" under Starman
	63
	64	Catalyst::PSGI
	65
	66	AUTHOR
3b5703c8	67	Tomas Doran (t0m) "<bobtfish@bobtfish.net>"
7d386bce	68
	69	COPYRIGHT & LICENSE
	70	Copyright 2009 the above author(s).
	71
	72	This sofware is free software, and is licensed under the same terms as
	73	perl itself.
	74