Todd Wang | 0d12d71 | 2014-10-06 17:25:41 -0700 | [diff] [blame] | 1 | // This file was auto-generated via go generate. |
| 2 | // DO NOT UPDATE MANUALLY |
| 3 | |
| 4 | /* |
| 5 | The namespace tool facilitates interaction with the Veyron namespace. |
| 6 | |
Cosmos Nicolaou | d83b90b | 2014-11-30 15:01:31 -0800 | [diff] [blame] | 7 | The namespace roots are set from the command line via veyron.namespace.root |
| 8 | options or from environment variables that have a name starting with |
| 9 | NAMESPACE_ROOT, e.g. NAMESPACE_ROOT, NAMESPACE_ROOT_2, NAMESPACE_ROOT_GOOGLE, |
| 10 | etc. The command line options override the environment. |
Todd Wang | 0d12d71 | 2014-10-06 17:25:41 -0700 | [diff] [blame] | 11 | |
| 12 | Usage: |
| 13 | namespace <command> |
| 14 | |
| 15 | The namespace commands are: |
| 16 | glob Returns all matching entries from the namespace |
| 17 | mount Adds a server to the namespace |
| 18 | unmount Removes a server from the namespace |
| 19 | resolve Translates a object name to its object address(es) |
| 20 | resolvetomt Finds the address of the mounttable that holds an object name |
Todd Wang | 0d12d71 | 2014-10-06 17:25:41 -0700 | [diff] [blame] | 21 | help Display help for commands or topics |
| 22 | Run "namespace help [command]" for command usage. |
| 23 | |
| 24 | The global flags are: |
Cosmos Nicolaou | d83b90b | 2014-11-30 15:01:31 -0800 | [diff] [blame] | 25 | -alsologtostderr=true |
| 26 | log to standard error as well as files |
| 27 | -log_backtrace_at=:0 |
| 28 | when logging hits line file:N, emit a stack trace |
| 29 | -log_dir= |
| 30 | if non-empty, write log files to this directory |
| 31 | -logtostderr=false |
| 32 | log to standard error instead of files |
| 33 | -max_stack_buf_size=4292608 |
| 34 | max size in bytes of the buffer to use for logging stack traces |
| 35 | -stderrthreshold=2 |
| 36 | logs at or above this threshold go to stderr |
| 37 | -v=0 |
| 38 | log level for V logs |
Jiri Simsa | 3540e3a | 2014-12-26 07:54:09 -0800 | [diff] [blame] | 39 | -vanadium.i18n_catalogue= |
| 40 | 18n catalogue files to load, comma separated |
Cosmos Nicolaou | d83b90b | 2014-11-30 15:01:31 -0800 | [diff] [blame] | 41 | -veyron.credentials= |
| 42 | directory to use for storing security credentials |
Robin Thellend | 8fea01c | 2014-12-11 13:48:10 -0800 | [diff] [blame] | 43 | -veyron.namespace.root=[/ns.dev.v.io:8101] |
Cosmos Nicolaou | d83b90b | 2014-11-30 15:01:31 -0800 | [diff] [blame] | 44 | local namespace root; can be repeated to provided multiple roots |
| 45 | -veyron.vtrace.cache_size=1024 |
| 46 | The number of vtrace traces to store in memory. |
| 47 | -veyron.vtrace.dump_on_shutdown=false |
| 48 | If true, dump all stored traces on runtime shutdown. |
| 49 | -veyron.vtrace.sample_rate=0 |
| 50 | Rate (from 0.0 to 1.0) to sample vtrace traces. |
| 51 | -vmodule= |
| 52 | comma-separated list of pattern=N settings for file-filtered logging |
Todd Wang | 0d12d71 | 2014-10-06 17:25:41 -0700 | [diff] [blame] | 53 | |
| 54 | Namespace Glob |
| 55 | |
| 56 | Returns all matching entries from the namespace. |
| 57 | |
| 58 | Usage: |
| 59 | namespace glob <pattern> |
| 60 | |
| 61 | <pattern> is a glob pattern that is matched against all the names below the |
| 62 | specified mount name. |
| 63 | |
| 64 | Namespace Mount |
| 65 | |
| 66 | Adds server <server> to the namespace with name <name>. |
| 67 | |
| 68 | Usage: |
| 69 | namespace mount <name> <server> <ttl> |
| 70 | |
Cosmos Nicolaou | d83b90b | 2014-11-30 15:01:31 -0800 | [diff] [blame] | 71 | <name> is the name to add to the namespace. <server> is the object address of |
| 72 | the server to add. <ttl> is the TTL of the new entry. It is a decimal number |
| 73 | followed by a unit suffix (s, m, h). A value of 0s represents an infinite |
| 74 | duration. |
Todd Wang | 0d12d71 | 2014-10-06 17:25:41 -0700 | [diff] [blame] | 75 | |
| 76 | Namespace Unmount |
| 77 | |
| 78 | Removes server <server> with name <name> from the namespace. |
| 79 | |
| 80 | Usage: |
| 81 | namespace unmount <name> <server> |
| 82 | |
Cosmos Nicolaou | d83b90b | 2014-11-30 15:01:31 -0800 | [diff] [blame] | 83 | <name> is the name to remove from the namespace. <server> is the object address |
| 84 | of the server to remove. |
Todd Wang | 0d12d71 | 2014-10-06 17:25:41 -0700 | [diff] [blame] | 85 | |
| 86 | Namespace Resolve |
| 87 | |
| 88 | Translates a object name to its object address(es). |
| 89 | |
| 90 | Usage: |
| 91 | namespace resolve <name> |
| 92 | |
| 93 | <name> is the name to resolve. |
| 94 | |
| 95 | Namespace Resolvetomt |
| 96 | |
| 97 | Finds the address of the mounttable that holds an object name. |
| 98 | |
| 99 | Usage: |
| 100 | namespace resolvetomt <name> |
| 101 | |
| 102 | <name> is the name to resolve. |
| 103 | |
Todd Wang | 0d12d71 | 2014-10-06 17:25:41 -0700 | [diff] [blame] | 104 | Namespace Help |
| 105 | |
| 106 | Help with no args displays the usage of the parent command. |
Cosmos Nicolaou | d83b90b | 2014-11-30 15:01:31 -0800 | [diff] [blame] | 107 | |
Todd Wang | 0d12d71 | 2014-10-06 17:25:41 -0700 | [diff] [blame] | 108 | Help with args displays the usage of the specified sub-command or help topic. |
Cosmos Nicolaou | d83b90b | 2014-11-30 15:01:31 -0800 | [diff] [blame] | 109 | |
Todd Wang | 0d12d71 | 2014-10-06 17:25:41 -0700 | [diff] [blame] | 110 | "help ..." recursively displays help for all commands and topics. |
| 111 | |
Cosmos Nicolaou | d83b90b | 2014-11-30 15:01:31 -0800 | [diff] [blame] | 112 | The output is formatted to a target width in runes. The target width is |
| 113 | determined by checking the environment variable CMDLINE_WIDTH, falling back on |
| 114 | the terminal width from the OS, falling back on 80 chars. By setting |
| 115 | CMDLINE_WIDTH=x, if x > 0 the width is x, if x < 0 the width is unlimited, and |
| 116 | if x == 0 or is unset one of the fallbacks is used. |
| 117 | |
Todd Wang | 0d12d71 | 2014-10-06 17:25:41 -0700 | [diff] [blame] | 118 | Usage: |
| 119 | namespace help [flags] [command/topic ...] |
| 120 | |
| 121 | [command/topic ...] optionally identifies a specific sub-command or help topic. |
| 122 | |
Cosmos Nicolaou | d83b90b | 2014-11-30 15:01:31 -0800 | [diff] [blame] | 123 | The namespace help flags are: |
| 124 | -style=text |
| 125 | The formatting style for help output, either "text" or "godoc". |
Todd Wang | 0d12d71 | 2014-10-06 17:25:41 -0700 | [diff] [blame] | 126 | */ |
| 127 | package main |