docs/man/man1/tahoe.1

   1 .TH TAHOE 1 "July 2011" "Tahoe-LAFS \[em] tahoe command" "User Commands"
   2 .SH NAME
   3 .PP
   4 tahoe - Secure distributed filesystem.
   5 .SH SYNOPSIS
   6 .PP
   7 tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]PARAMETER\f[]]...
   8 .SH GENERAL OPTIONS
   9 .TP
  10 .B \f[B]-q,\ --quiet\f[]
  11 Operate silently.
  12 .RS
  13 .RE
  14 .TP
  15 .B \f[B]-V,\ --version\f[]
  16 Display version numbers.
  17 .RS
  18 .RE
  19 .TP
  20 .B \f[B]--version-and-path\f[]
  21 Display version numbers and paths to their locations.
  22 .RS
  23 .RE
  24 .TP
  25 .B \f[B]-d,\ --node-directory\f[]
  26 Specify which Tahoe node directory should be used.
  27 (default for most commands: `$HOME/.tahoe')
  28 .RS
  29 .RE
  30 .SH COMMANDS
  31 .PP
  32 The \f[B]tahoe\f[] runner can be used for various tasks depending
  33 on the command used.
  34 .SS ADMINISTRATION
  35 .PP
  36 tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]]
  37 .RS
  38 .SS COMMANDS
  39 .TP
  40 .B \f[B]create-node\f[]
  41 Create a node that acts as a client, server or both.
  42 .TP
  43 .B \f[B]create-client\f[]
  44 Create a client node (with storage initially disabled).
  45 .TP
  46 .B \f[B]create-introducer\f[]
  47 Create an introducer node.
  48 .TP
  49 .B \f[B]create-key-generator\f[]
  50 Create a key generator service.
  51 .TP
  52 .B \f[B]create-stats-gatherer\f[]
  53 Create a stats-gatherer service.
  54 .SS OPTIONS
  55 .TP
  56 .B \f[B]-C,\ --basedir=\f[]
  57 Same as \[em]node-directory.
  58 .TP
  59 .B \f[B]-d,\ --node-directory=\f[]
  60 Specify which Tahoe node directory should be used.
  61 (default for \f[B]create-node\f[] and \f[B]create-client\f[]:
  62 `$HOME/.tahoe/').
  63 .TP
  64 .B \f[B]-n,\ --nickname=\f[]
  65 Specify the nickname for this node (\f[B]create-node\f[] and
  66 \f[B]create-client\f[] only).
  67 .TP
  68 .B \f[B]-i,\ --introducer=\f[]
  69 Specify the introducer FURL to use (\f[B]create-node\f[] and
  70 \f[B]create-client\f[] only).
  71 .TP
  72 .B \f[B]-p,\ --webport=\f[]
  73 Specify which TCP port to run the HTTP interface on.
  74 Use `none' to disable.
  75 Default: `tcp:3456:interface=127.0.0.1' (\f[B]create-node\f[] and
  76 \f[B]create-client\f[] only).
  77 .TP
  78 .B \f[B]--no-storage\f[]
  79 Do not offer storage service to other nodes (\f[B]create-node\f[]
  80 only).
  81 .RE
  82 .SS CONTROLLING NODES
  83 .PP
  84 tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]]
  85 .SS COMMANDS
  86 .TP
  87 .B \f[B]start\f[]
  88 Start a node (of any type).
  89 .RS
  90 .RE
  91 .TP
  92 .B \f[B]stop\f[]
  93 Stop a node.
  94 .RS
  95 .RE
  96 .TP
  97 .B \f[B]restart\f[]
  98 Restart a node.
  99 .RS
 100 .RE
 101 .TP
 102 .B \f[B]run\f[]
 103 Run a node synchronously.
 104 .RS
 105 .RE
 106 .SS OPTIONS
 107 .TP
 108 .B \f[B]-p,\ --profile\f[]
 109 Run under the Python profiler, putting results in
 110 `profiling_results.prof' (use with \f[B]start\f[] or
 111 \f[B]restart\f[] only).
 112 .RS
 113 .RE
 114 .TP
 115 .B \f[B]--syslog\f[]
 116 Tell the node to log to syslog, not a file (use with \f[B]start\f[]
 117 or \f[B]restart\f[] only).
 118 .RS
 119 .RE
 120 .TP
 121 .B \f[B]-C,\ --basedir=\f[]
 122 Same as \[em]node-directory.
 123 .RS
 124 .RE
 125 .TP
 126 .B \f[B]-d,\ --node-directory=\f[]
 127 Specify which Tahoe node directory should be used (default for commands
 128 other than \f[B]run\f[]: `$HOME/.tahoe/').
 129 .RS
 130 .RE
 131 .TP
 132 .B \f[B]--help\f[]
 133 Display help and exit
 134 .RS
 135 .RE
 136 .SS USING THE FILESYSTEM
 137 .TP
 138 .B \f[B]mkdir\f[]
 139 Create a new directory.
 140 .RS
 141 .RE
 142 .TP
 143 .B \f[B]add-alias\f[]
 144 Add a new alias cap.
 145 .RS
 146 .RE
 147 .TP
 148 .B \f[B]create-alias\f[]
 149 Create a new alias cap.
 150 .RS
 151 .RE
 152 .TP
 153 .B \f[B]list-aliases\f[]
 154 List all alias caps.
 155 .RS
 156 .RE
 157 .TP
 158 .B \f[B]ls\f[]
 159 List a directory.
 160 .RS
 161 .RE
 162 .TP
 163 .B \f[B]get\f[]
 164 Retrieve a file from the grid.
 165 .RS
 166 .RE
 167 .TP
 168 .B \f[B]put\f[]
 169 Upload a file into the grid.
 170 .RS
 171 .RE
 172 .TP
 173 .B \f[B]cp\f[]
 174 Copy one or more files or directories.
 175 .RS
 176 .RE
 177 .TP
 178 .B \f[B]unlink\f[]
 179 Unlink a file or directory on the grid.
 180 .RS
 181 .RE
 182 .TP
 183 .B \f[B]rm\f[]
 184 Unlink a file or directory on the grid (same as \f[B]unlink\f[]).
 185 .RS
 186 .RE
 187 .TP
 188 .B \f[B]mv\f[]
 189 Move a file within the grid.
 190 .RS
 191 .RE
 192 .TP
 193 .B \f[B]ln\f[]
 194 Make an additional link to an existing file or directory.
 195 .RS
 196 .RE
 197 .TP
 198 .B \f[B]backup\f[]
 199 Make target dir look like local dir.
 200 .RS
 201 .RE
 202 .TP
 203 .B \f[B]webopen\f[]
 204 Open a web browser to a grid file or directory.
 205 .RS
 206 .RE
 207 .TP
 208 .B \f[B]manifest\f[]
 209 List all files/directories in a subtree.
 210 .RS
 211 .RE
 212 .TP
 213 .B \f[B]stats\f[]
 214 Print statistics about all files/directories in a subtree.
 215 .RS
 216 .RE
 217 .TP
 218 .B \f[B]check\f[]
 219 Check a single file or directory.
 220 .RS
 221 .RE
 222 .TP
 223 .B \f[B]deep-check\f[]
 224 Check all files/directories reachable from a starting point
 225 .RS
 226 .RE
 227 .SS OPTIONS
 228 .PP
 229 Please run `tahoe \f[I]COMMAND\f[] --help' for more details on each
 230 command.
 231 .SS DEBUGGING
 232 .PP
 233 tahoe debug \f[I]SUBCOMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]PARAMETER\f[]]...
 234 .SS SUBCOMMANDS
 235 .TP
 236 .B \f[B]dump-share\f[]
 237 Unpack and display the contents of a share.
 238 .RS
 239 .RE
 240 .TP
 241 .B \f[B]dump-cap\f[]
 242 Unpack a read-cap or write-cap.
 243 .RS
 244 .RE
 245 .TP
 246 .B \f[B]find-shares\f[]
 247 Locate sharefiles in node directories.
 248 .RS
 249 .RE
 250 .TP
 251 .B \f[B]catalog-shares\f[]
 252 Describe all shares in node dirs.
 253 .RS
 254 .RE
 255 .TP
 256 .B \f[B]corrupt-share\f[]
 257 Corrupt a share by flipping a bit.
 258 .RS
 259 .RE
 260 .TP
 261 .B \f[B]repl\f[]
 262 Open a Python interpreter.
 263 .RS
 264 .RE
 265 .TP
 266 .B \f[B]trial\f[]
 267 Run tests using Twisted Trial with the right imports.
 268 .RS
 269 .RE
 270 .PP
 271 Please run e.g.\ `tahoe debug dump-share --help' for more
 272 details on each subcommand.
 273 .SH AUTHORS
 274 .PP
 275 Tahoe-LAFS has been written by Brian Warner, Zooko Wilcox-O'Hearn
 276 and dozens of others.
 277 This manpage was originally written by bertagaz.
 278 .SH REPORTING BUGS
 279 .PP
 280 Please see <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToReportABug>.
 281 .PP
 282 For known security issues see
 283 <https://tahoe-lafs.org/trac/tahoe-lafs/browser/docs/known_issues.rst>.
 284 .PP
 285 Tahoe-LAFS home page: <https://tahoe-lafs.org/>
 286 .PP
 287 tahoe-dev mailing list: <https://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev>
 288 .SH COPYRIGHT
 289 .PP
 290 Copyright \@ 2006\[en]2013 The Tahoe-LAFS Software Foundation