README

   1 This is beanstalkd, a fast, general-purpose work queue.
   2 See http://kr.github.com/beanstalkd/ for general info.
   3
   4 QUICK START
   5
   6     $ make
   7     $ ./beanstalkd
   8
   9 also,
  10
  11     $ make CFLAGS=-g
  12     $ make CC=clang
  13     $ make check
  14     $ make install
  15     $ make install PREFIX=/usr
  16
  17 You might need to type "gmake"; our build requires GNU make.
  18 Requires Linux (2.6.17 or later), Mac OS X, or FreeBSD.
  19 See doc/protocol.txt for details of the network protocol.
  20
  21
  22 SUBDIRECTORIES
  23
  24 adm             files useful for system administrators
  25 ct              testing tool; see https://github.com/kr/ct
  26 doc             documentation
  27 mk              include files for make
  28 pkg             miscelaneous files for packagers
  29 sh-tests        tests written as shell scripts
  30
  31
  32 TESTS
  33
  34 There are two kinds of tests here: unit tests and shell tests.
  35
  36 == Unit Tests ==
  37
  38 Test functions are in *-test.c.
  39
  40 == Shell Tests ==
  41
  42 Shell tests go in the sh-tests directory and are to be written in pairs:
  43
  44     my_test.commands
  45     my_test.expected
  46
  47 Each .commands file will be nc'd to beanstalkd, and the response diff'd
  48 with the appropriate .expected file.  If the response is not identical to the
  49 .expected file, the test fails.  At the moment, the test harness bails upon the
  50 first failure, but it could easily be extended to finish the tests and print
  51 full results.
  52
  53 IMPORTANT: Since beanstalkd expects \r\n line endings, you must be sure to
  54 include those in your files.  You can tell vim to do this with
  55   :set ff=dos
  56
  57 Copyright 2007-2011 the authors of beanstalkd.
  58 Copyright in contributions to beanstalkd is retained
  59 by the original copyright holder of each contribution.
  60 See the COPYING file for terms of use.