blob: 7aee2a4ec24fd80cd580eccd2708df8afdbb0e1b [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
Todd Wang0d12d712014-10-06 17:25:41 -070021 help Display help for commands or topics
22Run "namespace help [command]" for command usage.
23
24The global flags are:
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080025 -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 Simsa3540e3a2014-12-26 07:54:09 -080039 -vanadium.i18n_catalogue=
40 18n catalogue files to load, comma separated
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080041 -veyron.credentials=
42 directory to use for storing security credentials
Robin Thellend8fea01c2014-12-11 13:48:10 -080043 -veyron.namespace.root=[/ns.dev.v.io:8101]
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080044 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 Wang0d12d712014-10-06 17:25:41 -070053
54Namespace Glob
55
56Returns all matching entries from the namespace.
57
58Usage:
59 namespace glob <pattern>
60
61<pattern> is a glob pattern that is matched against all the names below the
62specified mount name.
63
64Namespace Mount
65
66Adds server <server> to the namespace with name <name>.
67
68Usage:
69 namespace mount <name> <server> <ttl>
70
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080071<name> is the name to add to the namespace. <server> is the object address of
72the server to add. <ttl> is the TTL of the new entry. It is a decimal number
73followed by a unit suffix (s, m, h). A value of 0s represents an infinite
74duration.
Todd Wang0d12d712014-10-06 17:25:41 -070075
76Namespace Unmount
77
78Removes server <server> with name <name> from the namespace.
79
80Usage:
81 namespace unmount <name> <server>
82
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080083<name> is the name to remove from the namespace. <server> is the object address
84of the server to remove.
Todd Wang0d12d712014-10-06 17:25:41 -070085
86Namespace Resolve
87
88Translates a object name to its object address(es).
89
90Usage:
91 namespace resolve <name>
92
93<name> is the name to resolve.
94
95Namespace Resolvetomt
96
97Finds the address of the mounttable that holds an object name.
98
99Usage:
100 namespace resolvetomt <name>
101
102<name> is the name to resolve.
103
Todd Wang0d12d712014-10-06 17:25:41 -0700104Namespace Help
105
106Help with no args displays the usage of the parent command.
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -0800107
Todd Wang0d12d712014-10-06 17:25:41 -0700108Help with args displays the usage of the specified sub-command or help topic.
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -0800109
Todd Wang0d12d712014-10-06 17:25:41 -0700110"help ..." recursively displays help for all commands and topics.
111
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -0800112The output is formatted to a target width in runes. The target width is
113determined by checking the environment variable CMDLINE_WIDTH, falling back on
114the terminal width from the OS, falling back on 80 chars. By setting
115CMDLINE_WIDTH=x, if x > 0 the width is x, if x < 0 the width is unlimited, and
116if x == 0 or is unset one of the fallbacks is used.
117
Todd Wang0d12d712014-10-06 17:25:41 -0700118Usage:
119 namespace help [flags] [command/topic ...]
120
121[command/topic ...] optionally identifies a specific sub-command or help topic.
122
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -0800123The namespace help flags are:
124 -style=text
125 The formatting style for help output, either "text" or "godoc".
Todd Wang0d12d712014-10-06 17:25:41 -0700126*/
127package main