| 1 | *** docs/man/tahoe.1.orig 2011-07-24 14:54:40.028693005 +0100 |
|---|
| 2 | --- docs/man/tahoe.1 2011-07-24 18:17:21.958693005 +0100 |
|---|
| 3 | *************** |
|---|
| 4 | *** 1,3 **** |
|---|
| 5 | ! .TH TAHOE 1 "" "tahoe User Manual" |
|---|
| 6 | .SH NAME |
|---|
| 7 | .PP |
|---|
| 8 | --- 1,3 ---- |
|---|
| 9 | ! .TH TAHOE 1 "July 2011" "Tahoe-LAFS \[em] tahoe command" "User Commands" |
|---|
| 10 | .SH NAME |
|---|
| 11 | .PP |
|---|
| 12 | *************** |
|---|
| 13 | *** 5,9 **** |
|---|
| 14 | .SH SYNOPSIS |
|---|
| 15 | .PP |
|---|
| 16 | ! tahoe [general options] [command] [command options] |
|---|
| 17 | .SH GENERAL OPTIONS |
|---|
| 18 | .TP |
|---|
| 19 | --- 5,9 ---- |
|---|
| 20 | .SH SYNOPSIS |
|---|
| 21 | .PP |
|---|
| 22 | ! tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]PARAMETER\f[]]... |
|---|
| 23 | .SH GENERAL OPTIONS |
|---|
| 24 | .TP |
|---|
| 25 | *************** |
|---|
| 26 | *** 34,38 **** |
|---|
| 27 | .SS ADMINISTRATION |
|---|
| 28 | .PP |
|---|
| 29 | ! tahoe [command] [command options] [NODEDIR] |
|---|
| 30 | .RS |
|---|
| 31 | .SS COMMANDS |
|---|
| 32 | --- 34,38 ---- |
|---|
| 33 | .SS ADMINISTRATION |
|---|
| 34 | .PP |
|---|
| 35 | ! tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] |
|---|
| 36 | .RS |
|---|
| 37 | .SS COMMANDS |
|---|
| 38 | *************** |
|---|
| 39 | *** 59,63 **** |
|---|
| 40 | .B \f[B]-d,\ --node-directory=\f[] |
|---|
| 41 | Specify which Tahoe node directory should be used. |
|---|
| 42 | ! (default for most commands: \f[B]$HOME/.tahoe/\f[]). |
|---|
| 43 | .TP |
|---|
| 44 | .B \f[B]-n,\ --nickname=\f[] |
|---|
| 45 | --- 59,64 ---- |
|---|
| 46 | .B \f[B]-d,\ --node-directory=\f[] |
|---|
| 47 | Specify which Tahoe node directory should be used. |
|---|
| 48 | ! (default for \f[B]create-node\f[] and \f[B]create-client\f[]: |
|---|
| 49 | ! `$HOME/.tahoe/'). |
|---|
| 50 | .TP |
|---|
| 51 | .B \f[B]-n,\ --nickname=\f[] |
|---|
| 52 | *************** |
|---|
| 53 | *** 72,76 **** |
|---|
| 54 | Specify which TCP port to run the HTTP interface on. |
|---|
| 55 | Use `none' to disable. |
|---|
| 56 | ! Default: tcp:3456:interface=127.0.0.1 (\f[B]create-node\f[] and |
|---|
| 57 | \f[B]create-client\f[] only). |
|---|
| 58 | .TP |
|---|
| 59 | --- 73,77 ---- |
|---|
| 60 | Specify which TCP port to run the HTTP interface on. |
|---|
| 61 | Use `none' to disable. |
|---|
| 62 | ! Default: `tcp:3456:interface=127.0.0.1' (\f[B]create-node\f[] and |
|---|
| 63 | \f[B]create-client\f[] only). |
|---|
| 64 | .TP |
|---|
| 65 | *************** |
|---|
| 66 | *** 81,85 **** |
|---|
| 67 | .SS CONTROLLING NODES |
|---|
| 68 | .PP |
|---|
| 69 | ! tahoe [command] [command options] [NODEDIR] |
|---|
| 70 | .SS COMMANDS |
|---|
| 71 | .TP |
|---|
| 72 | --- 82,86 ---- |
|---|
| 73 | .SS CONTROLLING NODES |
|---|
| 74 | .PP |
|---|
| 75 | ! tahoe \f[I]COMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]NODEDIR\f[]] |
|---|
| 76 | .SS COMMANDS |
|---|
| 77 | .TP |
|---|
| 78 | *************** |
|---|
| 79 | *** 124,129 **** |
|---|
| 80 | .TP |
|---|
| 81 | .B \f[B]-d,\ --node-directory=\f[] |
|---|
| 82 | ! Specify which Tahoe node directory should be used (default for most |
|---|
| 83 | ! commands: `$HOME/.tahoe/'). |
|---|
| 84 | .RS |
|---|
| 85 | .RE |
|---|
| 86 | --- 125,130 ---- |
|---|
| 87 | .TP |
|---|
| 88 | .B \f[B]-d,\ --node-directory=\f[] |
|---|
| 89 | ! Specify which Tahoe node directory should be used (default for commands |
|---|
| 90 | ! other than \f[B]run\f[]: `$HOME/.tahoe/'). |
|---|
| 91 | .RS |
|---|
| 92 | .RE |
|---|
| 93 | *************** |
|---|
| 94 | *** 175,185 **** |
|---|
| 95 | .RE |
|---|
| 96 | .TP |
|---|
| 97 | ! .B \f[B]rm\f[] |
|---|
| 98 | Unlink a file or directory on the grid. |
|---|
| 99 | .RS |
|---|
| 100 | .RE |
|---|
| 101 | .TP |
|---|
| 102 | ! .B \f[B]unlink\f[] |
|---|
| 103 | ! Unlink a file or directory on the grid (same as \f[B]rm\f[]). |
|---|
| 104 | .RS |
|---|
| 105 | .RE |
|---|
| 106 | --- 176,186 ---- |
|---|
| 107 | .RE |
|---|
| 108 | .TP |
|---|
| 109 | ! .B \f[B]unlink\f[] |
|---|
| 110 | Unlink a file or directory on the grid. |
|---|
| 111 | .RS |
|---|
| 112 | .RE |
|---|
| 113 | .TP |
|---|
| 114 | ! .B \f[B]rm\f[] |
|---|
| 115 | ! Unlink a file or directory on the grid (same as \f[B]unlink\f[]). |
|---|
| 116 | .RS |
|---|
| 117 | .RE |
|---|
| 118 | *************** |
|---|
| 119 | *** 226,234 **** |
|---|
| 120 | .SS OPTIONS |
|---|
| 121 | .PP |
|---|
| 122 | ! Please run `tahoe COMMAND \[em]help' for more details on each |
|---|
| 123 | command. |
|---|
| 124 | .SS DEBUGGING |
|---|
| 125 | .PP |
|---|
| 126 | ! tahoe debug SUBCOMMAND |
|---|
| 127 | .SS SUBCOMMANDS |
|---|
| 128 | .TP |
|---|
| 129 | --- 227,235 ---- |
|---|
| 130 | .SS OPTIONS |
|---|
| 131 | .PP |
|---|
| 132 | ! Please run `tahoe \f[I]COMMAND\f[] --help' for more details on each |
|---|
| 133 | command. |
|---|
| 134 | .SS DEBUGGING |
|---|
| 135 | .PP |
|---|
| 136 | ! tahoe debug \f[I]SUBCOMMAND\f[] [\f[I]OPTION\f[]]... [\f[I]PARAMETER\f[]]... |
|---|
| 137 | .SS SUBCOMMANDS |
|---|
| 138 | .TP |
|---|
| 139 | *************** |
|---|
| 140 | *** 268,305 **** |
|---|
| 141 | .RE |
|---|
| 142 | .PP |
|---|
| 143 | ! Please run e.g.\ `tahoe debug dump-share \[em]help' for more |
|---|
| 144 | details on each subcommand. |
|---|
| 145 | - .PP |
|---|
| 146 | - Another debugging feature is that bin/tahoe allows executing an |
|---|
| 147 | - arbitrary \[lq]runner\[rq] command (typically an installed Python |
|---|
| 148 | - script, such as `coverage'), with the Tahoe libraries on the |
|---|
| 149 | - PYTHONPATH. |
|---|
| 150 | - The runner command name is prefixed with `\@', and any occurrences |
|---|
| 151 | - of `\@tahoe' in its arguments are replaced by the full path to the |
|---|
| 152 | - tahoe script. |
|---|
| 153 | - .PP |
|---|
| 154 | - For example, if `coverage' is installed and on the PATH, you can |
|---|
| 155 | - use: |
|---|
| 156 | - .PP |
|---|
| 157 | - \f[CR] |
|---|
| 158 | - tahoe\ \@coverage\ run\ --branch\ \@tahoe\ debug\ trial |
|---|
| 159 | - \f[] |
|---|
| 160 | - .PP |
|---|
| 161 | - to get branch coverage for the Tahoe test suite. |
|---|
| 162 | - Or, to run python with the \[en]3 option that warns about Python 3 |
|---|
| 163 | - incompatibilities: |
|---|
| 164 | - .PP |
|---|
| 165 | - \f[CR] |
|---|
| 166 | - tahoe\ \@python\ -3\ \@tahoe\ command\ [options] |
|---|
| 167 | - \f[] |
|---|
| 168 | .SH AUTHORS |
|---|
| 169 | .PP |
|---|
| 170 | ! Tahoe-lafs has been written by Brian Warner, Zooko Wilcox-O'Hearn |
|---|
| 171 | and dozens of others. |
|---|
| 172 | ! This manpage has been written by bertagaz. |
|---|
| 173 | .SH COPYRIGHT |
|---|
| 174 | .PP |
|---|
| 175 | 2006\[en]2011 \@ AllMyData, Inc. |
|---|
| 176 | - .SH AUTHORS |
|---|
| 177 | - May 10, 2011. |
|---|
| 178 | |
|---|
| 179 | --- 269,291 ---- |
|---|
| 180 | .RE |
|---|
| 181 | .PP |
|---|
| 182 | ! Please run e.g.\ `tahoe debug dump-share --help' for more |
|---|
| 183 | details on each subcommand. |
|---|
| 184 | .SH AUTHORS |
|---|
| 185 | .PP |
|---|
| 186 | ! Tahoe-LAFS has been written by Brian Warner, Zooko Wilcox-O'Hearn |
|---|
| 187 | and dozens of others. |
|---|
| 188 | ! This manpage was originally written by bertagaz. |
|---|
| 189 | ! .SH REPORTING BUGS |
|---|
| 190 | ! .PP |
|---|
| 191 | ! Please see <http://tahoe-lafs.org/trac/tahoe-lafs/wiki/HowToReportABug>. |
|---|
| 192 | ! .PP |
|---|
| 193 | ! For known security issues see |
|---|
| 194 | ! <http://tahoe-lafs.org/trac/tahoe-lafs/browser/docs/known_issues.rst>. |
|---|
| 195 | ! .PP |
|---|
| 196 | ! Tahoe-LAFS home page: <http://tahoe-lafs.org/> |
|---|
| 197 | ! .PP |
|---|
| 198 | ! tahoe-dev mailing list: <http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev> |
|---|
| 199 | .SH COPYRIGHT |
|---|
| 200 | .PP |
|---|
| 201 | 2006\[en]2011 \@ AllMyData, Inc. |
|---|
| 202 | |
|---|
