tahoe-lafs/docs/using.html

<!DOCtype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
  <head>
    <title>Using Tahoe</title>
    <link rev="made" class="mailto" href="mailto:zooko[at]zooko[dot]com">
    <meta name="description" content="how to use Tahoe">
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <meta name="keywords" content="tahoe secure decentralized filesystem operation">
  </head>

  <body>
    <p>This is how to use your Tahoe node.  First, you have to run your own local Tahoe node, as described in <a href="running.html">running.html</a>.</p>

    <h1>The WUI</h1>

    <p>Point your web browser to <a href="http://127.0.0.1:3456">http://127.0.0.1:3456</a> -- which is the URL of your own local computer -- to use your newly created node.</p>

    <p>Create a new directory (with the button labelled "create a directory").  Your web browser will load the new directory.  Now if you want to be able to come back to this directory later, you have to bookmark it, or otherwise save the URL of it.  If you lose URL to this directory, then you can never again come back to this directory.</p>

    <p>You can do more or less everything you want to do with a decentralized filesystem through the WUI.</p>

    <p>P.S.  "WUI" is pronounced "wooey".</p>

    <h1>The CLI</h1>

    <p>Prefer the command-line? Run "<cite>tahoe --help</cite>" (the same
    command-line tool that is used to start and stop nodes serves to navigate
    and use the decentralized filesystem). To get started, create a new
    directory and mark it as the 'tahoe:' alias by running "<cite>tahoe
    add-alias tahoe `tahoe mkdir`</cite>". Once you've done that, you can do
    "<cite>tahoe ls tahoe:</cite>" and "<cite>tahoe cp LOCALFILE
    tahoe:foo.txt</cite>" to work with your filesystem. The Tahoe CLI uses
    the same syntax as the well-known scp and rsync tools. See <a
    href="frontends/CLI.txt">CLI.txt</a> for more details.</p>

    <p>As with the WUI (and with all current interfaces to Tahoe), you are
    responsible for remembering directory capabilities yourself. If you
    create a new directory and lose the capability to it, then you cannot
    access that directory ever again.</p>

    <p>P.S.  "CLI" is pronounced "clee".</p>

    <h1>The FUSE Extension</h1>

    <p>You can plug Tahoe into your computer's local filesystem using the FUSE extension, found in the <cite>contrib</cite> directory.  Warning: unlike most of Tahoe, and unlike the rest of the user interfaces described on this page, the FUSE plugin doesn't have extensive unit tests that are automatically run on every check-in of the source.  Therefore, we can't be sure how complete and reliable it is.</p>

    <p>P.S.  "FUSE" rhymes with "muse".</p>

    <h1>The WAPI</h1>

    <p>Want to program your Tahoe node to do your bidding?  Easy!  See <a href="frontends/webapi.txt">webapi.txt</a>.</p>

    <p>P.S.  "WAPI" is pronounced "wappy".</p>

    <h2>Socialize</h2>

    <p>You can chat with other users of and hackers of this software at <a href="http://allmydata.org/">http://allmydata.org</a>.</p>

  </body>

</html>
docs: some documentation updates for 0.7.0 2008-01-08 17:32:41 +00:00			`<!DOCtype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">`
			`<html lang="en">`
			`<head>`
			`<title>Using Tahoe</title>`
			`<link rev="made" class="mailto" href="mailto:zooko[at]zooko[dot]com">`
			`<meta name="description" content="how to use Tahoe">`
			`<meta http-equiv="Content-Type" content="text/html; charset=utf-8">`
			`<meta name="keywords" content="tahoe secure decentralized filesystem operation">`
			`</head>`

			`<body>`
docs: update install and usage docs, improve cli "usage" output, make new example directories, add unit test that fails code which prints out sentences that don't end with punctuation marks 2008-02-15 20:11:02 +00:00			`<p>This is how to use your Tahoe node. First, you have to run your own local Tahoe node, as described in <a href="running.html">running.html</a>.</p>`

docs: some documentation updates for 0.7.0 2008-01-08 17:32:41 +00:00			`<h1>The WUI</h1>`

wui/wapi: change the default port number from 8123 to 3456 to avoid conflict with TorButton See ticket #536 for details. 2008-11-26 00:57:37 +00:00			`<p>Point your web browser to <a href="http://127.0.0.1:3456">http://127.0.0.1:3456</a> -- which is the URL of your own local computer -- to use your newly created node.</p>`
docs: some documentation updates for 0.7.0 2008-01-08 17:32:41 +00:00
			`<p>Create a new directory (with the button labelled "create a directory"). Your web browser will load the new directory. Now if you want to be able to come back to this directory later, you have to bookmark it, or otherwise save the URL of it. If you lose URL to this directory, then you can never again come back to this directory.</p>`

			`<p>You can do more or less everything you want to do with a decentralized filesystem through the WUI.</p>`

			`<p>P.S. "WUI" is pronounced "wooey".</p>`

			`<h1>The CLI</h1>`

docs/using.html: update CLI section to reflect the new alias: scheme. Closes #431 2008-06-03 01:00:16 +00:00			`<p>Prefer the command-line? Run "<cite>tahoe --help</cite>" (the same`
			`command-line tool that is used to start and stop nodes serves to navigate`
			`and use the decentralized filesystem). To get started, create a new`
			`directory and mark it as the 'tahoe:' alias by running "<cite>tahoe`
			add-alias tahoe `tahoe mkdir`</cite>". Once you've done that, you can do
			`"<cite>tahoe ls tahoe:</cite>" and "<cite>tahoe cp LOCALFILE`
			`tahoe:foo.txt</cite>" to work with your filesystem. The Tahoe CLI uses`
			`the same syntax as the well-known scp and rsync tools. See <a`
docs: rename frontends/webapi.txt to frontends/wapi.txt rename CLI.txt to frontends/CLI.txt change a few mentions of "webapi" to "wapi" fixes #582 2009-01-14 03:51:43 +00:00			`href="frontends/CLI.txt">CLI.txt</a> for more details.</p>`
docs/using.html: update CLI section to reflect the new alias: scheme. Closes #431 2008-06-03 01:00:16 +00:00
			`<p>As with the WUI (and with all current interfaces to Tahoe), you are`
			`responsible for remembering directory capabilities yourself. If you`
			`create a new directory and lose the capability to it, then you cannot`
			`access that directory ever again.</p>`
docs: some documentation updates for 0.7.0 2008-01-08 17:32:41 +00:00
			`<p>P.S. "CLI" is pronounced "clee".</p>`

			`<h1>The FUSE Extension</h1>`

docs: update install and usage docs, improve cli "usage" output, make new example directories, add unit test that fails code which prints out sentences that don't end with punctuation marks 2008-02-15 20:11:02 +00:00			`<p>You can plug Tahoe into your computer's local filesystem using the FUSE extension, found in the <cite>contrib</cite> directory. Warning: unlike most of Tahoe, and unlike the rest of the user interfaces described on this page, the FUSE plugin doesn't have extensive unit tests that are automatically run on every check-in of the source. Therefore, we can't be sure how complete and reliable it is.</p>`
docs: some documentation updates for 0.7.0 2008-01-08 17:32:41 +00:00
docs: a couple of tiny edits 2008-06-19 19:26:19 +00:00			`<p>P.S. "FUSE" rhymes with "muse".</p>`
docs: some documentation updates for 0.7.0 2008-01-08 17:32:41 +00:00
			`<h1>The WAPI</h1>`

docs: rename wapi.txt to webapi.txt Because Brian argues that the file contains a description of the wui as well as of the wapi, and because the name "webapi.txt" might be more obvious to the untrained eye. 2009-01-14 20:53:48 +00:00			`<p>Want to program your Tahoe node to do your bidding? Easy! See <a href="frontends/webapi.txt">webapi.txt</a>.</p>`
docs: some documentation updates for 0.7.0 2008-01-08 17:32:41 +00:00
			`<p>P.S. "WAPI" is pronounced "wappy".</p>`

			`<h2>Socialize</h2>`

			`<p>You can chat with other users of and hackers of this software at <a href="http://allmydata.org/">http://allmydata.org</a>.</p>`

			`</body>`

			`</html>`