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