]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blobdiff - README
rename bin/allmydata-tahoe to bin/tahoe. Closes #155.
[tahoe-lafs/tahoe-lafs.git] / README
diff --git a/README b/README
index 4bb568e959ea4eb462010faf83e8aedba2e40ed3..22a7b335c2d9f9f8dfb0ae920fe1ec4f0d579cb1 100644 (file)
--- a/README
+++ b/README
@@ -180,11 +180,11 @@ Running-In-Place Way, and The Debian Way.  Choose one:
 
   3. Build Tahoe by running "make".
 
-  4. Once you've built it then you can execute "./bin/allmydata-tahoe". (When
-     the allmydata-tahoe script is in a Tahoe source distribution, it adds
-     the necessary directory to the Python "sys.path".  It also looks for any
-     dependencies that you installed by "make build-deps" and includes them
-     in the sys.path.)  See the RUNNING section, below.
+  4. Once you've built it then you can execute "./bin/tahoe". (When the tahoe
+     script is in a Tahoe source distribution, it adds the necessary
+     directory to the Python "sys.path". It also looks for any dependencies
+     that you installed by "make build-deps" and includes them in the
+     sys.path.) See the RUNNING section, below.
 
  The Debian Way:
 
@@ -215,15 +215,15 @@ TESTING THAT IT IS PROPERLY INSTALLED
  slow computers.  There are a lot of tests and some of them do a lot of
  public-key cryptography.)
 
- Executing the allmydata-tahoe script from the "bin" subdirectory will work
- only if Tahoe itself is installed, either because it is installed into the
- local subdirectory (as per "The Running-In-Place Way") or because it is
- installed into your system (as per the other three ways of installing).
+ Executing the tahoe script from the "bin" subdirectory will work only if
+ Tahoe itself is installed, either because it is installed into the local
+ subdirectory (as per "The Running-In-Place Way") or because it is installed
+ into your system (as per the other three ways of installing).
 
 
 RUNNING:
 
- Run the "allmydata-tahoe" executable.
+ Run the "tahoe" executable.
 
  If you installed "The Running-In-Place Way", then it is in your source tree,
  in the "bin" subdirectory thereof.  If you installed in one of the other
@@ -231,10 +231,10 @@ RUNNING:
  filesystem, perhaps in "/usr/bin" on Unix, or in "C:\Python25\Scripts" on
  Window.
 
- The "allmydata-tahoe" utility is used to create, start, and stop nodes.
- Each node lives in a separate base directory, inside of which you can add
- files to configure and control the node.  Nodes also read and write files
within that directory.
+ The "tahoe" utility is used to create, start, and stop nodes. Each node
+ lives in a separate base directory, inside of which you can add files to
+ configure and control the node. Nodes also read and write files within that
+ directory.
 
  A grid consists of a single central 'introducer and vdrive' node and one or
  more 'client' nodes.  If you are joining an existing grid, the
@@ -243,28 +243,28 @@ RUNNING:
  create both an introducer-and-vdrive and a client (and then invite other
  people to create their own client nodes and join your grid).
 
- The introducer (-and-vdrive) node is constructed by running 'allmydata-tahoe
- create-introducer --basedir $HERE'.  Once constructed, you can start the
- introducer by running 'allmydata-tahoe start --basedir $HERE' (or, if you
- are already in the introducer's base directory, just type 'allmydata-tahoe
- start').  Inside that base directory, there will be a pair of files
- 'introducer.furl' and 'vdrive.furl'.  Make a copy of these, as they'll be
- needed on the client nodes.
+ The introducer (-and-vdrive) node is constructed by running 'tahoe
+ create-introducer --basedir $HERE'. Once constructed, you can start the
+ introducer by running 'tahoe start --basedir $HERE' (or, if you are already
+ in the introducer's base directory, just type 'tahoe start'). Inside that
+ base directory, there will be a pair of files 'introducer.furl' and
+ 'vdrive.furl'. Make a copy of these, as they'll be needed on the client
+ nodes.
 
  To construct a client node, pick a new working directory for it, then run
- 'allmydata-tahoe create-client --basedir $HERE'.  Copy the two .furl files
- from the introducer into this new directory, then run 'allmydata-tahoe start
- --basedir $HERE'.  After that, the client node should be off and running.
- The first thing it will do is connect to the introducer and introduce itself
- to all other nodes on the grid.  You can follow its progress by looking at
the $HERE/logs/twistd.log file.
+ 'tahoe create-client --basedir $HERE'. Copy the two .furl files from the
+ introducer into this new directory, then run 'tahoe start --basedir $HERE'.
+ After that, the client node should be off and running. The first thing it
+ will do is connect to the introducer and introduce itself to all other nodes
+ on the grid. You can follow its progress by looking at the
+ $HERE/logs/twistd.log file.
 
  To actually use the client, enable the web interface by writing a port
  number (like "8123") into a file named $HERE/webport and then restarting the
- node with 'allmydata-tahoe restart --basedir $HERE'. This will prompt the
- client node to run a webserver on the desired port, through which you can
- view, upload, download, and delete files. This 'webport' file is actually a
"strports specification", defined in
+ node with 'tahoe restart --basedir $HERE'. This will prompt the client node
+ to run a webserver on the desired port, through which you can view, upload,
+ download, and delete files. This 'webport' file is actually a "strports
+ specification", defined in
  http://twistedmatrix.com/documents/current/api/twisted.application.strports.html
  , so you can have it only listen on a local interface by writing
  "tcp:8123:interface=127.0.0.1" to this file, or make it use SSL by writing