diff --git a/src/Symfony/Bundle/WebServerBundle/Command/ServerLogCommand.php b/src/Symfony/Bundle/WebServerBundle/Command/ServerLogCommand.php index 858ce6c918437..2925d783bc81d 100644 --- a/src/Symfony/Bundle/WebServerBundle/Command/ServerLogCommand.php +++ b/src/Symfony/Bundle/WebServerBundle/Command/ServerLogCommand.php @@ -47,11 +47,22 @@ protected function configure() } $this - ->setDescription('Start a log server that displays logs in real time') ->addOption('host', null, InputOption::VALUE_REQUIRED, 'The server host', '0:9911') ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The line format', ConsoleFormatter::SIMPLE_FORMAT) ->addOption('date-format', null, InputOption::VALUE_REQUIRED, 'The date format', ConsoleFormatter::SIMPLE_DATE) ->addOption('filter', null, InputOption::VALUE_REQUIRED, 'An expression to filter log. Example: "level > 200 or channel in [\'app\', \'doctrine\']"') + ->setDescription('Starts a log server that displays logs in real time') + ->setHelp(<<<'EOF' +%command.name% starts a log server to display in real time the log +messages generated by your application: + + php %command.full_name% + +To get the information as a machine readable format, use the +--filter option: + +php %command.full_name% --filter=port +EOF ; } diff --git a/src/Symfony/Bundle/WebServerBundle/Command/ServerRunCommand.php b/src/Symfony/Bundle/WebServerBundle/Command/ServerRunCommand.php index cfedd309578c8..53ce350e7fae2 100644 --- a/src/Symfony/Bundle/WebServerBundle/Command/ServerRunCommand.php +++ b/src/Symfony/Bundle/WebServerBundle/Command/ServerRunCommand.php @@ -47,16 +47,22 @@ protected function configure() $this ->setDefinition(array( new InputArgument('addressport', InputArgument::OPTIONAL, 'The address to listen to (can be address:port, address, or port)'), - new InputOption('docroot', 'd', InputOption::VALUE_REQUIRED, 'Document root'), + new InputOption('docroot', 'd', InputOption::VALUE_REQUIRED, 'Document root, usually where your front controllers are stored'), new InputOption('router', 'r', InputOption::VALUE_REQUIRED, 'Path to custom router script'), )) ->setName('server:run') ->setDescription('Runs a local web server') ->setHelp(<<<'EOF' -The %command.name% runs a local web server: +%command.name% runs a local web server: By default, the server +listens on 127.0.0.1 address and the port number is automatically selected +as the first free port starting from 8000: %command.full_name% +This command blocks the console. If you want to run other commands, stop it by +pressing Control+C or use the non-blocking server:start +command instead. + Change the default address and port by passing them as an argument: %command.full_name% 127.0.0.1:8080 diff --git a/src/Symfony/Bundle/WebServerBundle/Command/ServerStartCommand.php b/src/Symfony/Bundle/WebServerBundle/Command/ServerStartCommand.php index c0888e944e136..7cf83ab54e14e 100644 --- a/src/Symfony/Bundle/WebServerBundle/Command/ServerStartCommand.php +++ b/src/Symfony/Bundle/WebServerBundle/Command/ServerStartCommand.php @@ -53,10 +53,15 @@ protected function configure() )) ->setDescription('Starts a local web server in the background') ->setHelp(<<<'EOF' -The %command.name% runs a local web server: +%command.name% runs a local web server: By default, the server +listens on 127.0.0.1 address and the port number is automatically selected +as the first free port starting from 8000: php %command.full_name% +The server is run in the background and you can keep executing other commands. +Execute server:stop to stop it. + Change the default address and port by passing them as an argument: php %command.full_name% 127.0.0.1:8080 diff --git a/src/Symfony/Bundle/WebServerBundle/Command/ServerStatusCommand.php b/src/Symfony/Bundle/WebServerBundle/Command/ServerStatusCommand.php index eff8e6be7db4e..3e7d4c7ec4fd4 100644 --- a/src/Symfony/Bundle/WebServerBundle/Command/ServerStatusCommand.php +++ b/src/Symfony/Bundle/WebServerBundle/Command/ServerStatusCommand.php @@ -38,6 +38,20 @@ protected function configure() new InputOption('filter', null, InputOption::VALUE_REQUIRED, 'The value to display (one of port, host, or address)'), )) ->setDescription('Outputs the status of the local web server for the given address') + ->setHelp(<<<'EOF' +%command.name% shows the details of the given local web +server, such as the address and port where it is listening to: + + php %command.full_name% + +To get the information as a machine readable format, use the +--filter option: + +php %command.full_name% --filter=port + +Supported values are port, host, and address. +EOF + ) ; } diff --git a/src/Symfony/Bundle/WebServerBundle/Command/ServerStopCommand.php b/src/Symfony/Bundle/WebServerBundle/Command/ServerStopCommand.php index 18f3d4b8de0b7..ccfb733066b80 100644 --- a/src/Symfony/Bundle/WebServerBundle/Command/ServerStopCommand.php +++ b/src/Symfony/Bundle/WebServerBundle/Command/ServerStopCommand.php @@ -37,7 +37,7 @@ protected function configure() )) ->setDescription('Stops the local web server that was started with the server:start command') ->setHelp(<<<'EOF' -The %command.name% stops the local web server: +%command.name% stops the local web server: php %command.full_name% EOF diff --git a/src/Symfony/Bundle/WebServerBundle/README.md b/src/Symfony/Bundle/WebServerBundle/README.md index 15c45b1a1a431..09e514dcb809d 100644 --- a/src/Symfony/Bundle/WebServerBundle/README.md +++ b/src/Symfony/Bundle/WebServerBundle/README.md @@ -1,6 +1,11 @@ WebServerBundle =============== +WebServerBundle provides commands for running applications using the PHP +built-in web server. It simplifies your local development setup because you +don't have to configure a proper web server such as Apache or Nginx to run your +application. + Resources ---------