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