From 036df6c373df6d7f52005fbbd3196646934329d3 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Thu, 25 Feb 2010 14:56:26 -0800 Subject: doc: clarify the intent of `unicorn_rails` --- Documentation/unicorn_rails.1.txt | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/Documentation/unicorn_rails.1.txt b/Documentation/unicorn_rails.1.txt index d2d8190..267e425 100644 --- a/Documentation/unicorn_rails.1.txt +++ b/Documentation/unicorn_rails.1.txt @@ -4,7 +4,7 @@ # NAME -unicorn_rails - a rackup-like command to launch the Unicorn HTTP server +unicorn_rails - a script/server-like command to launch the Unicorn HTTP server # SYNOPSIS @@ -16,6 +16,11 @@ A rackup(1)-like command to launch Rails applications using Unicorn. It is expected to be started in your Rails application root (RAILS_ROOT), but the "working_directory" directive may be used in the CONFIG_FILE. +It is designed to help Rails 1.x and 2.y users transition to Rack, but +it is NOT needed for Rails 3 applications. Rails 3 users are encouraged +to use unicorn(1) instead of unicorn_rails(1). Users of Rails 1.x/2.y +may also use unicorn(1) instead of unicorn_rails(1). + The outward interface resembles rackup(1), the internals and default middleware loading is designed like the `script/server` command distributed with Rails. -- cgit v1.2.3-24-ge0c7