Bryan Fink  committed 4b6e77d

add verbatim/example markers for better org-mode export

  • Participants
  • Parent commits ec5c681

Comments (0)

Files changed (1)

    Assuming you have a working Erlang (R13B03 or later) installation,
    building Riak should be as simple as:
    $ cd $RIAK
    $ make all rel
 ** Starting Riak
    Once you have successfully built Riak, you can start the server with the
    following commands:
    $ cd $RIAK/rel/riak
    $ bin/riak start
    Now, verify that the server started up cleanly and is working:
-   $ bin/riak-admin test
+   : $ bin/riak-admin test
    Note that the $RIAK/rel/riak directory is a complete, self-contained instance
    of Riak and Erlang. It is strongly suggested that you move this directory
    Now that you have a functional server, let's try storing some data in
    it. First, start up a erlang node using our embedded version of erlang:
    $ erts-<vsn>/bin/erl -name riaktest -setcookie riak
    Eshell V5.7.4  (abort with ^G)
    Now construct the node name of Riak server and make sure we can talk to it:
    (> RiakNode = riak_util:str_to_node(riak).
    (> net_adm:ping(RiakNode).
    We are now ready to start the Riak client:
    (> {ok, C} = riak:client_connect(RiakNode).
    Let's create a shopping list for bread at /groceries/mine:
    (> O0 = riak_object:new(<<"groceries">>, <<"mine">>, ["bread"]).
    O0 = riak_object:new(<<"groceries">>, <<"mine">>, ["bread"]).
     (> C:put(O0, 1).
     Now, read the list back from the Riak server and extract the value
     (> {ok, O1} = C:get(<<"groceries">>, <<"mine">>, 1).
      (> %% extract the value
      (> V = riak_object:get_value(O1).
      Add milk to our list of groceries and write the new value to Riak:
      (> %% add milk to the list
      (> O2 = riak_object:update_value(O1, ["milk" | V]).
      (> %% store the new list
      (> C:put(O2, 1).
      Finally, see what other keys are available in groceries bucket:
      (> C:list_keys(<<"groceries">>).
 * Server Management
     To start a daemonized (background) instance of Riak:
-    $ bin/riak start 
+    : $ bin/riak start 
     Once a server is running in the background you can attach to the Erlang
     console via:
-    $ bin/riak attach
+    : $ bin/riak attach
     Alternatively, if you want to run a foreground instance of Riak, start it
-    $ bin/riak console
+    : $ bin/riak console
     Stopping a foreground or background instance of Riak can be done from a
     shell prompt via:
-    $ bin/riak stop 
+    : $ bin/riak stop 
     Or if you are attached/on the Erlang console:
-    (> q().
+    : (> q().
     You can determine if the server is running by:
-    $ bin/riak ping
+    : $ bin/riak ping
 *** bin/riak-admin
     This script provides access to general administration of the Riak server. 
     To join a new Riak node to an existing cluster:
     $ bin/riak start # If a local server is not already running
     $ bin/riak-admin join <node in cluster>
     (Note that you must have a local node already running for this to work)
     To verify that the local Riak node is able to read/write data:
-    $ bin/riak-admin test
+    : $ bin/riak-admin test