redis-3.0-annotated

haojunyu ecacc3d9a9 add .vscode 11 months ago
.vscode ecacc3d9a9 add .vscode 11 months ago
deps 9ddb6e87fa 合并上游代码,但并未对新出现的代码进行注释 8 years ago
src b70b8b0760 Update dict.c comments 7 years ago
tests ea591967c7 fix a bug in test 8 years ago
utils 9ddb6e87fa 合并上游代码,但并未对新出现的代码进行注释 8 years ago
.gitignore d04afd62d6 Redis/Jemalloc Gitignore were too aggressive. 9 years ago
00-RELEASENOTES 9ddb6e87fa 合并上游代码,但并未对新出现的代码进行注释 8 years ago
BUGS 61e02c4f6c Switched issues URL to Github in BUGS 11 years ago
CONTRIBUTING 839ed7a60b Grammar fix. 9 years ago
COPYING 9ddb6e87fa 合并上游代码,但并未对新出现的代码进行注释 8 years ago
INSTALL 3508899944 INSTALL now redirects the user to README 10 years ago
MANIFESTO 3244d8bc0c Format to fit 80 columns 9 years ago
Makefile f16d090c72 Fix `install` target on OSX (see #495) 10 years ago
README 9ddb6e87fa 合并上游代码,但并未对新出现的代码进行注释 8 years ago
README.rst 23e7396f3c 修改 README.rst 7 years ago
redis.conf 9ddb6e87fa 合并上游代码,但并未对新出现的代码进行注释 8 years ago
runtest a405979f5f Check available tcl versions 9 years ago
runtest-cluster 9ddb6e87fa 合并上游代码,但并未对新出现的代码进行注释 8 years ago
runtest-sentinel 9ddb6e87fa 合并上游代码,但并未对新出现的代码进行注释 8 years ago
sentinel.conf 9ddb6e87fa 合并上游代码,但并未对新出现的代码进行注释 8 years ago

README

Where to find complete Redis documentation?
-------------------------------------------

This README is just a fast "quick start" document. You can find more detailed
documentation at http://redis.io

Building Redis
--------------

Redis can be compiled and used on Linux, OSX, OpenBSD, NetBSD, FreeBSD.
We support big endian and little endian architectures.

It may compile on Solaris derived systems (for instance SmartOS) but our
support for this platform is "best effort" and Redis is not guaranteed to
work as well as in Linux, OSX, and *BSD there.

It is as simple as:

% make

You can run a 32 bit Redis binary using:

% make 32bit

After building Redis is a good idea to test it, using:

% make test

Fixing problems building 32 bit binaries
---------

If after building Redis with a 32 bit target you need to rebuild it
with a 64 bit target, or the other way around, you need to perform a
"make distclean" in the root directory of the Redis distribution.

In case of build errors when trying to build a 32 bit binary of Redis, try
the following steps:

* Install the packages libc6-dev-i386 (also try g++-multilib).
* Try using the following command line instead of "make 32bit":

make CFLAGS="-m32 -march=native" LDFLAGS="-m32"

Allocator
---------

Selecting a non-default memory allocator when building Redis is done by setting
the `MALLOC` environment variable. Redis is compiled and linked against libc
malloc by default, with the exception of jemalloc being the default on Linux
systems. This default was picked because jemalloc has proven to have fewer
fragmentation problems than libc malloc.

To force compiling against libc malloc, use:

% make MALLOC=libc

To compile against jemalloc on Mac OS X systems, use:

% make MALLOC=jemalloc

Verbose build
-------------

Redis will build with a user friendly colorized output by default.
If you want to see a more verbose output use the following:

% make V=1

Running Redis
-------------

To run Redis with the default configuration just type:

% cd src
% ./redis-server

If you want to provide your redis.conf, you have to run it using an additional
parameter (the path of the configuration file):

% cd src
% ./redis-server /path/to/redis.conf

It is possible to alter the Redis configuration passing parameters directly
as options using the command line. Examples:

% ./redis-server --port 9999 --slaveof 127.0.0.1 6379
% ./redis-server /etc/redis/6379.conf --loglevel debug

All the options in redis.conf are also supported as options using the command
line, with exactly the same name.

Playing with Redis
------------------

You can use redis-cli to play with Redis. Start a redis-server instance,
then in another terminal try the following:

% cd src
% ./redis-cli
redis> ping
PONG
redis> set foo bar
OK
redis> get foo
"bar"
redis> incr mycounter
(integer) 1
redis> incr mycounter
(integer) 2
redis>

You can find the list of all the available commands here:

http://redis.io/commands

Installing Redis
-----------------

In order to install Redis binaries into /usr/local/bin just use:

% make install

You can use "make PREFIX=/some/other/directory install" if you wish to use a
different destination.

Make install will just install binaries in your system, but will not configure
init scripts and configuration files in the appropriate place. This is not
needed if you want just to play a bit with Redis, but if you are installing
it the proper way for a production system, we have a script doing this
for Ubuntu and Debian systems:

% cd utils
% ./install_server.sh

The script will ask you a few questions and will setup everything you need
to run Redis properly as a background daemon that will start again on
system reboots.

You'll be able to stop and start Redis using the script named
/etc/init.d/redis_, for instance /etc/init.d/redis_6379.

Code contributions
---

Note: by contributing code to the Redis project in any form, including sending
a pull request via Github, a code fragment or patch via private email or
public discussion groups, you agree to release your code under the terms
of the BSD license that you can find in the COPYING file included in the Redis
source distribution.

Please see the CONTRIBUTING file in this source distribution for more
information.

Enjoy!