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