about summary refs log tree commit homepage
path: root/Documentation
DateCommit message (Collapse)
2010-07-06doc: recommend absolute paths for -c/--config-file
Suggested-by: Jeremy Evans ref: http://mid.gmane.org/AANLkTintT4vHGEdueuG45_RwJqFCToHi5pm2-WKDSUMz@mail.gmail.com (cherry picked from commit d7695c25c5e3b1c90e63bf15a5c5fdf68bfd0c34)
2010-05-18doc: unicorn.1: the command name is "unicorn"
2010-02-25doc: clarify the intent of `unicorn_rails`
2009-12-25doc: update manpages since we got new features
working_directory and Worker#user got added over time, so recommending Dir.chdir and Process::UID.change_privilege is bad.
2009-11-06unicorn.1: document RACK_ENV changes in 0.94.0
2009-09-30manpages: document environment variables
Mostly for `unicorn_rails`, but TMPDIR is universal.
2009-09-30unicorn_rails: undeprecate --path switch
..but keep -P deprecated. --path is still useful for testing ad-hoc changes when you don't want to commit your changes permanently to a configuration file.
2009-09-18man1/unicorn_rails: fix unescaped underscore
2009-09-18man1/unicorn: split out RACK ENVIRONMENT section
The inline formatting for the CLI switch was too hard to get right and was too long anyways.
2009-09-18pandoc needs the standalone switch for manpages
Otherwise we end up with unreadable manpages.
2009-09-17doc: begin integration of HTML manpages into RDoc
Kinda sorta works, still some Markdown => HTML formatting issues to work out but it gives the site a reasonably consistent look.
2009-09-17Simplify and standardize manpages build/install
setup.rb users will now be able to install manpages under man/man1 automatically, no solution for Rubygems users yet. gzipped manpages are no longer created by default, either, it's probably up to distros to do it.
2009-09-17Documentation: don't force --rsyncable flag with gzip(1)
It may not be portable to older versions of gzip
2009-09-17Add unicorn_rails(1) manpage
2009-09-17man1/unicorn: avoid unnecessary emphasis
SCREAMING is already sufficient without *BOLDNESS*
2009-09-17launchers: deprecate ambiguous -P/--p* switches
`unicorn` tries to mimic `rackup` on the command-line to ease adoption. `unicorn_rails` tries to be somewhat like `rackup` as well, but then also tries to be consistent with `script/server` resulting some amount of confusion with regard to the -P/(--path|--pid) switch. Outright removal of these switches will probably not happen any time soon because we have command-lines inherited across processes, but we can stop advertising them. Since our (Unicorn) config file format is fortunately consistent between Rails and !Rails, recommend the "pid" directive be used instead. User interfaces are really, really tough to get right...
2009-09-15Add new Documentation section for manpages
Only "unicorn(1)" is documented right now, but more will be added. Manpages are written Markdown since it's easy to write, easy to read (in source form) and a widely-implemented format. As of September 2009, pandoc is the only Markdown processor I know of capable of turning Markdown into manpages. So despite adding a dependency on Haskell (not yet very common these days) for documentation, the features and performance of pandoc+Markdown outweigh the drawbacks compared to other lightweight markup systems.