veyron2/vlog: get rid of -vv flag, use --vmodule=*=2 instead.
Change-Id: I5a6190dcd00b9c0ea235bdaab6961542e77562dd
diff --git a/tools/application/doc.go b/tools/application/doc.go
index 5c8f11f..ba58393 100644
--- a/tools/application/doc.go
+++ b/tools/application/doc.go
@@ -9,7 +9,8 @@
application <command>
The application commands are:
- match Shows the first matching envelope that matches the given profiles.
+ match Shows the first matching envelope that matches the given
+ profiles.
put Add the given envelope to the application for the given profiles.
remove removes the application envelope for the given profile.
edit edits the application envelope for the given profile.
@@ -17,15 +18,32 @@
Run "application help [command]" for command usage.
The global flags are:
- -alsologtostderr=true: log to standard error as well as files
- -log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
- -log_dir=: if non-empty, write log files to this directory
- -logtostderr=false: log to standard error instead of files
- -max_stack_buf_size=4292608: max size in bytes of the buffer to use for logging stack traces
- -stderrthreshold=2: logs at or above this threshold go to stderr
- -v=0: log level for V logs
- -vmodule=: comma-separated list of pattern=N settings for file-filtered logging
- -vv=0: log level for V logs
+ -alsologtostderr=true
+ log to standard error as well as files
+ -log_backtrace_at=:0
+ when logging hits line file:N, emit a stack trace
+ -log_dir=
+ if non-empty, write log files to this directory
+ -logtostderr=false
+ log to standard error instead of files
+ -max_stack_buf_size=4292608
+ max size in bytes of the buffer to use for logging stack traces
+ -stderrthreshold=2
+ logs at or above this threshold go to stderr
+ -v=0
+ log level for V logs
+ -veyron.credentials=
+ directory to use for storing security credentials
+ -veyron.namespace.root=[/proxy.envyor.com:8101]
+ local namespace root; can be repeated to provided multiple roots
+ -veyron.vtrace.cache_size=1024
+ The number of vtrace traces to store in memory.
+ -veyron.vtrace.dump_on_shutdown=false
+ If true, dump all stored traces on runtime shutdown.
+ -veyron.vtrace.sample_rate=0
+ Rate (from 0.0 to 1.0) to sample vtrace traces.
+ -vmodule=
+ comma-separated list of pattern=N settings for file-filtered logging
Application Match
@@ -34,8 +52,8 @@
Usage:
application match <application> <profiles>
-<application> is the full name of the application.
-<profiles> is a comma-separated list of profiles.
+<application> is the full name of the application. <profiles> is a
+comma-separated list of profiles.
Application Put
@@ -44,9 +62,9 @@
Usage:
application put <application> <profiles> <envelope>
-<application> is the full name of the application.
-<profiles> is a comma-separated list of profiles.
-<envelope> is the file that contains a JSON-encoded envelope.
+<application> is the full name of the application. <profiles> is a
+comma-separated list of profiles. <envelope> is the file that contains a
+JSON-encoded envelope.
Application Remove
@@ -55,8 +73,7 @@
Usage:
application remove <application> <profile>
-<application> is the full name of the application.
-<profile> is a profile.
+<application> is the full name of the application. <profile> is a profile.
Application Edit
@@ -65,21 +82,29 @@
Usage:
application edit <application> <profile>
-<application> is the full name of the application.
-<profile> is a profile.
+<application> is the full name of the application. <profile> is a profile.
Application Help
Help with no args displays the usage of the parent command.
+
Help with args displays the usage of the specified sub-command or help topic.
+
"help ..." recursively displays help for all commands and topics.
+The output is formatted to a target width in runes. The target width is
+determined by checking the environment variable CMDLINE_WIDTH, falling back on
+the terminal width from the OS, falling back on 80 chars. By setting
+CMDLINE_WIDTH=x, if x > 0 the width is x, if x < 0 the width is unlimited, and
+if x == 0 or is unset one of the fallbacks is used.
+
Usage:
application help [flags] [command/topic ...]
[command/topic ...] optionally identifies a specific sub-command or help topic.
-The help flags are:
- -style=text: The formatting style for help output, either "text" or "godoc".
+The application help flags are:
+ -style=text
+ The formatting style for help output, either "text" or "godoc".
*/
package main
diff --git a/tools/application/main.go b/tools/application/main.go
index 66c4112..3723981 100644
--- a/tools/application/main.go
+++ b/tools/application/main.go
@@ -1,5 +1,5 @@
// The following enables go generate to generate the doc.go file.
-//go:generate go run $VEYRON_ROOT/lib/cmdline/testdata/gendoc.go .
+//go:generate go run $VEYRON_ROOT/veyron/go/src/veyron.io/lib/cmdline/testdata/gendoc.go .
package main
diff --git a/tools/binary/doc.go b/tools/binary/doc.go
index 04afd49..daae844 100644
--- a/tools/binary/doc.go
+++ b/tools/binary/doc.go
@@ -15,15 +15,32 @@
Run "binary help [command]" for command usage.
The global flags are:
- -alsologtostderr=true: log to standard error as well as files
- -log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
- -log_dir=: if non-empty, write log files to this directory
- -logtostderr=false: log to standard error instead of files
- -max_stack_buf_size=4292608: max size in bytes of the buffer to use for logging stack traces
- -stderrthreshold=2: logs at or above this threshold go to stderr
- -v=0: log level for V logs
- -vmodule=: comma-separated list of pattern=N settings for file-filtered logging
- -vv=0: log level for V logs
+ -alsologtostderr=true
+ log to standard error as well as files
+ -log_backtrace_at=:0
+ when logging hits line file:N, emit a stack trace
+ -log_dir=
+ if non-empty, write log files to this directory
+ -logtostderr=false
+ log to standard error instead of files
+ -max_stack_buf_size=4292608
+ max size in bytes of the buffer to use for logging stack traces
+ -stderrthreshold=2
+ logs at or above this threshold go to stderr
+ -v=0
+ log level for V logs
+ -veyron.credentials=
+ directory to use for storing security credentials
+ -veyron.namespace.root=[/proxy.envyor.com:8101]
+ local namespace root; can be repeated to provided multiple roots
+ -veyron.vtrace.cache_size=1024
+ The number of vtrace traces to store in memory.
+ -veyron.vtrace.dump_on_shutdown=false
+ If true, dump all stored traces on runtime shutdown.
+ -veyron.vtrace.sample_rate=0
+ Rate (from 0.0 to 1.0) to sample vtrace traces.
+ -vmodule=
+ comma-separated list of pattern=N settings for file-filtered logging
Binary Delete
@@ -42,8 +59,8 @@
Usage:
binary download <von> <filename>
-<von> is the veyron object name of the binary to download
-<filename> is the name of the file where the binary will be written
+<von> is the veyron object name of the binary to download <filename> is the name
+of the file where the binary will be written
Binary Upload
@@ -53,21 +70,30 @@
Usage:
binary upload <von> <filename>
-<von> is the veyron object name of the binary to upload
-<filename> is the name of the file to upload
+<von> is the veyron object name of the binary to upload <filename> is the name
+of the file to upload
Binary Help
Help with no args displays the usage of the parent command.
+
Help with args displays the usage of the specified sub-command or help topic.
+
"help ..." recursively displays help for all commands and topics.
+The output is formatted to a target width in runes. The target width is
+determined by checking the environment variable CMDLINE_WIDTH, falling back on
+the terminal width from the OS, falling back on 80 chars. By setting
+CMDLINE_WIDTH=x, if x > 0 the width is x, if x < 0 the width is unlimited, and
+if x == 0 or is unset one of the fallbacks is used.
+
Usage:
binary help [flags] [command/topic ...]
[command/topic ...] optionally identifies a specific sub-command or help topic.
-The help flags are:
- -style=text: The formatting style for help output, either "text" or "godoc".
+The binary help flags are:
+ -style=text
+ The formatting style for help output, either "text" or "godoc".
*/
package main
diff --git a/tools/binary/main.go b/tools/binary/main.go
index 66c4112..3723981 100644
--- a/tools/binary/main.go
+++ b/tools/binary/main.go
@@ -1,5 +1,5 @@
// The following enables go generate to generate the doc.go file.
-//go:generate go run $VEYRON_ROOT/lib/cmdline/testdata/gendoc.go .
+//go:generate go run $VEYRON_ROOT/veyron/go/src/veyron.io/lib/cmdline/testdata/gendoc.go .
package main
diff --git a/tools/build/doc.go b/tools/build/doc.go
index 9d7fc7e..347c55a 100644
--- a/tools/build/doc.go
+++ b/tools/build/doc.go
@@ -13,49 +13,76 @@
Run "build help [command]" for command usage.
The global flags are:
- -alsologtostderr=true: log to standard error as well as files
- -log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
- -log_dir=: if non-empty, write log files to this directory
- -logtostderr=false: log to standard error instead of files
- -max_stack_buf_size=4292608: max size in bytes of the buffer to use for logging stack traces
- -stderrthreshold=2: logs at or above this threshold go to stderr
- -v=0: log level for V logs
- -vmodule=: comma-separated list of pattern=N settings for file-filtered logging
- -vv=0: log level for V logs
+ -alsologtostderr=true
+ log to standard error as well as files
+ -log_backtrace_at=:0
+ when logging hits line file:N, emit a stack trace
+ -log_dir=
+ if non-empty, write log files to this directory
+ -logtostderr=false
+ log to standard error instead of files
+ -max_stack_buf_size=4292608
+ max size in bytes of the buffer to use for logging stack traces
+ -stderrthreshold=2
+ logs at or above this threshold go to stderr
+ -v=0
+ log level for V logs
+ -veyron.credentials=
+ directory to use for storing security credentials
+ -veyron.namespace.root=[/proxy.envyor.com:8101]
+ local namespace root; can be repeated to provided multiple roots
+ -veyron.vtrace.cache_size=1024
+ The number of vtrace traces to store in memory.
+ -veyron.vtrace.dump_on_shutdown=false
+ If true, dump all stored traces on runtime shutdown.
+ -veyron.vtrace.sample_rate=0
+ Rate (from 0.0 to 1.0) to sample vtrace traces.
+ -vmodule=
+ comma-separated list of pattern=N settings for file-filtered logging
Build Build
-Build veyron Go packages using a remote build server. The command
-collects all source code files that are not part of the Go standard
-library that the target packages depend on, sends them to a build
-server, and receives the built binaries.
+Build veyron Go packages using a remote build server. The command collects all
+source code files that are not part of the Go standard library that the target
+packages depend on, sends them to a build server, and receives the built
+binaries.
Usage:
build build [flags] <name> <packages>
-<name> is a veyron object name of a build server
-<packages> is a list of packages to build, specified as arguments for
-each command. The format is similar to the go tool. In its simplest
-form each package is an import path; e.g. "veyron/tools/build". A
-package that ends with "..." does a wildcard match against all
-packages with that prefix.
+<name> is a veyron object name of a build server <packages> is a list of
+packages to build, specified as arguments for each command. The format is
+similar to the go tool. In its simplest form each package is an import path;
+e.g. "veyron/tools/build". A package that ends with "..." does a wildcard match
+against all packages with that prefix.
-The build flags are:
- -arch=amd64: Target architecture.
- -os=linux: Target operating system.
+The build build flags are:
+ -arch=amd64
+ Target architecture.
+ -os=darwin
+ Target operating system.
Build Help
Help with no args displays the usage of the parent command.
+
Help with args displays the usage of the specified sub-command or help topic.
+
"help ..." recursively displays help for all commands and topics.
+The output is formatted to a target width in runes. The target width is
+determined by checking the environment variable CMDLINE_WIDTH, falling back on
+the terminal width from the OS, falling back on 80 chars. By setting
+CMDLINE_WIDTH=x, if x > 0 the width is x, if x < 0 the width is unlimited, and
+if x == 0 or is unset one of the fallbacks is used.
+
Usage:
build help [flags] [command/topic ...]
[command/topic ...] optionally identifies a specific sub-command or help topic.
-The help flags are:
- -style=text: The formatting style for help output, either "text" or "godoc".
+The build help flags are:
+ -style=text
+ The formatting style for help output, either "text" or "godoc".
*/
package main
diff --git a/tools/build/main.go b/tools/build/main.go
index 66c4112..3723981 100644
--- a/tools/build/main.go
+++ b/tools/build/main.go
@@ -1,5 +1,5 @@
// The following enables go generate to generate the doc.go file.
-//go:generate go run $VEYRON_ROOT/lib/cmdline/testdata/gendoc.go .
+//go:generate go run $VEYRON_ROOT/veyron/go/src/veyron.io/lib/cmdline/testdata/gendoc.go .
package main
diff --git a/tools/debug/doc.go b/tools/debug/doc.go
index e611553..ded0837 100644
--- a/tools/debug/doc.go
+++ b/tools/debug/doc.go
@@ -8,7 +8,8 @@
debug <command>
The debug commands are:
- glob Returns all matching entries from the namespace
+ glob Returns all matching entries from the namespace.
+ vtrace Returns vtrace traces.
logs Accesses log files
stats Accesses stats
pprof Accesses profiling data
@@ -16,15 +17,32 @@
Run "debug help [command]" for command usage.
The global flags are:
- -alsologtostderr=true: log to standard error as well as files
- -log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
- -log_dir=: if non-empty, write log files to this directory
- -logtostderr=false: log to standard error instead of files
- -max_stack_buf_size=4292608: max size in bytes of the buffer to use for logging stack traces
- -stderrthreshold=2: logs at or above this threshold go to stderr
- -v=0: log level for V logs
- -vmodule=: comma-separated list of pattern=N settings for file-filtered logging
- -vv=0: log level for V logs
+ -alsologtostderr=true
+ log to standard error as well as files
+ -log_backtrace_at=:0
+ when logging hits line file:N, emit a stack trace
+ -log_dir=
+ if non-empty, write log files to this directory
+ -logtostderr=false
+ log to standard error instead of files
+ -max_stack_buf_size=4292608
+ max size in bytes of the buffer to use for logging stack traces
+ -stderrthreshold=2
+ logs at or above this threshold go to stderr
+ -v=0
+ log level for V logs
+ -veyron.credentials=
+ directory to use for storing security credentials
+ -veyron.namespace.root=[/proxy.envyor.com:8101]
+ local namespace root; can be repeated to provided multiple roots
+ -veyron.vtrace.cache_size=1024
+ The number of vtrace traces to store in memory.
+ -veyron.vtrace.dump_on_shutdown=false
+ If true, dump all stored traces on runtime shutdown.
+ -veyron.vtrace.sample_rate=0
+ Rate (from 0.0 to 1.0) to sample vtrace traces.
+ -vmodule=
+ comma-separated list of pattern=N settings for file-filtered logging
Debug Glob
@@ -35,6 +53,15 @@
<pattern> is a glob pattern to match.
+Debug Vtrace
+
+Returns matching vtrace traces (or all stored traces if no ids are given).
+
+Usage:
+ debug vtrace <name> [id ...]
+
+<name> is the name of a vtrace object. [id] is a vtrace trace id.
+
Debug Logs
Accesses log files
@@ -42,9 +69,9 @@
Usage:
debug logs <command>
-The logs commands are:
+The debug logs commands are:
read Reads the content of a log file object.
- size Returns the size of the a log file object
+ size Returns the size of a log file object.
Debug Logs Read
@@ -55,15 +82,20 @@
<name> is the name of the log file object.
-The read flags are:
- -f=false: When true, read will wait for new log entries when it reaches the end of the file.
- -n=-1: The number of log entries to read.
- -o=0: The position, in bytes, from which to start reading the log file.
- -v=false: When true, read will be more verbose.
+The debug logs read flags are:
+ -f=false
+ When true, read will wait for new log entries when it reaches the end of the
+ file.
+ -n=-1
+ The number of log entries to read.
+ -o=0
+ The position, in bytes, from which to start reading the log file.
+ -v=false
+ When true, read will be more verbose.
Debug Logs Size
-Returns the size of the a log file object.
+Returns the size of a log file object.
Usage:
debug logs size <name>
@@ -77,35 +109,41 @@
Usage:
debug stats <command>
-The stats commands are:
- value Returns the value of the a stats object
- watchglob Returns a stream of all matching entries and their values
+The debug stats commands are:
+ read Returns the value of stats objects.
+ watch Returns a stream of all matching entries and their values as they
+ change.
-Debug Stats Value
+Debug Stats Read
-Returns the value of the a stats object.
+Returns the value of stats objects.
Usage:
- debug stats value [flags] <name>
+ debug stats read [flags] <name> ...
-<name> is the name of the stats object.
+<name> is the name of a stats object, or a glob pattern to match against stats
+object names.
-The value flags are:
- -raw=false: When true, the command will display the raw value of the object.
- -type=false: When true, the type of the values will be displayed.
+The debug stats read flags are:
+ -raw=false
+ When true, the command will display the raw value of the object.
+ -type=false
+ When true, the type of the values will be displayed.
-Debug Stats Watchglob
+Debug Stats Watch
-Returns a stream of all matching entries and their values
+Returns a stream of all matching entries and their values as they change.
Usage:
- debug stats watchglob [flags] <pattern> ...
+ debug stats watch [flags] <pattern> ...
<pattern> is a glob pattern to match.
-The watchglob flags are:
- -raw=false: When true, the command will display the raw value of the object.
- -type=false: When true, the type of the values will be displayed.
+The debug stats watch flags are:
+ -raw=false
+ When true, the command will display the raw value of the object.
+ -type=false
+ When true, the type of the values will be displayed.
Debug Pprof
@@ -114,31 +152,31 @@
Usage:
debug pprof <command>
-The pprof commands are:
- run Runs the pprof tool
- proxy Runs an http proxy to a pprof object
+The debug pprof commands are:
+ run Runs the pprof tool.
+ proxy Runs an http proxy to a pprof object.
Debug Pprof Run
-Runs the pprof tool
+Runs the pprof tool.
Usage:
debug pprof run [flags] <name> <profile> [passthru args] ...
-<name> is the name of the pprof object.
-<profile> the name of the profile to use.
+<name> is the name of the pprof object. <profile> the name of the profile to
+use.
All the [passthru args] are passed to the pprof tool directly, e.g.
-$ debug pprof run a/b/c heap --text --lines
-$ debug pprof run a/b/c profile -gv
+$ debug pprof run a/b/c heap --text $ debug pprof run a/b/c profile -gv
-The run flags are:
- -pprofcmd=veyron go tool pprof: The pprof command to use.
+The debug pprof run flags are:
+ -pprofcmd=veyron go tool pprof
+ The pprof command to use.
Debug Pprof Proxy
-Runs an http proxy to a pprof object
+Runs an http proxy to a pprof object.
Usage:
debug pprof proxy <name>
@@ -148,15 +186,24 @@
Debug Help
Help with no args displays the usage of the parent command.
+
Help with args displays the usage of the specified sub-command or help topic.
+
"help ..." recursively displays help for all commands and topics.
+The output is formatted to a target width in runes. The target width is
+determined by checking the environment variable CMDLINE_WIDTH, falling back on
+the terminal width from the OS, falling back on 80 chars. By setting
+CMDLINE_WIDTH=x, if x > 0 the width is x, if x < 0 the width is unlimited, and
+if x == 0 or is unset one of the fallbacks is used.
+
Usage:
debug help [flags] [command/topic ...]
[command/topic ...] optionally identifies a specific sub-command or help topic.
-The help flags are:
- -style=text: The formatting style for help output, either "text" or "godoc".
+The debug help flags are:
+ -style=text
+ The formatting style for help output, either "text" or "godoc".
*/
package main
diff --git a/tools/debug/main.go b/tools/debug/main.go
index 66c4112..3723981 100644
--- a/tools/debug/main.go
+++ b/tools/debug/main.go
@@ -1,5 +1,5 @@
// The following enables go generate to generate the doc.go file.
-//go:generate go run $VEYRON_ROOT/lib/cmdline/testdata/gendoc.go .
+//go:generate go run $VEYRON_ROOT/veyron/go/src/veyron.io/lib/cmdline/testdata/gendoc.go .
package main
diff --git a/tools/mgmt/nodex/doc.go b/tools/mgmt/nodex/doc.go
index 6b3ff6d..2ea903d 100644
--- a/tools/mgmt/nodex/doc.go
+++ b/tools/mgmt/nodex/doc.go
@@ -47,8 +47,6 @@
Rate (from 0.0 to 1.0) to sample vtrace traces.
-vmodule=
comma-separated list of pattern=N settings for file-filtered logging
- -vv=0
- log level for V logs
Nodex Install
diff --git a/tools/mgmt/nodex/main.go b/tools/mgmt/nodex/main.go
index 9e5d556..b0e270d 100644
--- a/tools/mgmt/nodex/main.go
+++ b/tools/mgmt/nodex/main.go
@@ -1,5 +1,5 @@
// The following enables go generate to generate the doc.go file.
-//go:generate go run $VEYRON_ROOT/lib/cmdline/testdata/gendoc.go .
+//go:generate go run $VEYRON_ROOT/veyron/go/src/veyron.io/lib/cmdline/testdata/gendoc.go .
package main
diff --git a/tools/mounttable/doc.go b/tools/mounttable/doc.go
index fc63e5a..6e8eb92 100644
--- a/tools/mounttable/doc.go
+++ b/tools/mounttable/doc.go
@@ -16,24 +16,41 @@
Run "mounttable help [command]" for command usage.
The global flags are:
- -alsologtostderr=true: log to standard error as well as files
- -log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
- -log_dir=: if non-empty, write log files to this directory
- -logtostderr=false: log to standard error instead of files
- -max_stack_buf_size=4292608: max size in bytes of the buffer to use for logging stack traces
- -stderrthreshold=2: logs at or above this threshold go to stderr
- -v=0: log level for V logs
- -vmodule=: comma-separated list of pattern=N settings for file-filtered logging
- -vv=0: log level for V logs
+ -alsologtostderr=true
+ log to standard error as well as files
+ -log_backtrace_at=:0
+ when logging hits line file:N, emit a stack trace
+ -log_dir=
+ if non-empty, write log files to this directory
+ -logtostderr=false
+ log to standard error instead of files
+ -max_stack_buf_size=4292608
+ max size in bytes of the buffer to use for logging stack traces
+ -stderrthreshold=2
+ logs at or above this threshold go to stderr
+ -v=0
+ log level for V logs
+ -veyron.credentials=
+ directory to use for storing security credentials
+ -veyron.namespace.root=[/proxy.envyor.com:8101]
+ local namespace root; can be repeated to provided multiple roots
+ -veyron.vtrace.cache_size=1024
+ The number of vtrace traces to store in memory.
+ -veyron.vtrace.dump_on_shutdown=false
+ If true, dump all stored traces on runtime shutdown.
+ -veyron.vtrace.sample_rate=0
+ Rate (from 0.0 to 1.0) to sample vtrace traces.
+ -vmodule=
+ comma-separated list of pattern=N settings for file-filtered logging
Mounttable Glob
returns all matching entries in the mount table
Usage:
- mounttable glob <mount name> <pattern>
+ mounttable glob [<mount name>] <pattern>
-<mount name> is a mount name on a mount table.
+<mount name> is a mount name on a mount table. Defaults to namespace root.
<pattern> is a glob pattern that is matched against all the entries below the
specified mount name.
@@ -44,10 +61,10 @@
Usage:
mounttable mount <mount name> <name> <ttl>
-<mount name> is a mount name on a mount table.
-<name> is the rooted object name of the server.
-<ttl> is the TTL of the new entry. It is a decimal number followed by a unit
-suffix (s, m, h). A value of 0s represents an infinite duration.
+<mount name> is a mount name on a mount table. <name> is the rooted object name
+of the server. <ttl> is the TTL of the new entry. It is a decimal number
+followed by a unit suffix (s, m, h). A value of 0s represents an infinite
+duration.
Mounttable Unmount
@@ -56,8 +73,8 @@
Usage:
mounttable unmount <mount name> <name>
-<mount name> is a mount name on a mount table.
-<name> is the rooted object name of the server.
+<mount name> is a mount name on a mount table. <name> is the rooted object name
+of the server.
Mounttable Resolvestep
@@ -71,15 +88,24 @@
Mounttable Help
Help with no args displays the usage of the parent command.
+
Help with args displays the usage of the specified sub-command or help topic.
+
"help ..." recursively displays help for all commands and topics.
+The output is formatted to a target width in runes. The target width is
+determined by checking the environment variable CMDLINE_WIDTH, falling back on
+the terminal width from the OS, falling back on 80 chars. By setting
+CMDLINE_WIDTH=x, if x > 0 the width is x, if x < 0 the width is unlimited, and
+if x == 0 or is unset one of the fallbacks is used.
+
Usage:
mounttable help [flags] [command/topic ...]
[command/topic ...] optionally identifies a specific sub-command or help topic.
-The help flags are:
- -style=text: The formatting style for help output, either "text" or "godoc".
+The mounttable help flags are:
+ -style=text
+ The formatting style for help output, either "text" or "godoc".
*/
package main
diff --git a/tools/mounttable/main.go b/tools/mounttable/main.go
index 66c4112..3723981 100644
--- a/tools/mounttable/main.go
+++ b/tools/mounttable/main.go
@@ -1,5 +1,5 @@
// The following enables go generate to generate the doc.go file.
-//go:generate go run $VEYRON_ROOT/lib/cmdline/testdata/gendoc.go .
+//go:generate go run $VEYRON_ROOT/veyron/go/src/veyron.io/lib/cmdline/testdata/gendoc.go .
package main
diff --git a/tools/namespace/doc.go b/tools/namespace/doc.go
index addc28d..a6e8159 100644
--- a/tools/namespace/doc.go
+++ b/tools/namespace/doc.go
@@ -4,9 +4,10 @@
/*
The namespace tool facilitates interaction with the Veyron namespace.
-The namespace roots are set from environment variables that have a name
-starting with NAMESPACE_ROOT, e.g. NAMESPACE_ROOT, NAMESPACE_ROOT_2,
-NAMESPACE_ROOT_GOOGLE, etc.
+The namespace roots are set from the command line via veyron.namespace.root
+options or from environment variables that have a name starting with
+NAMESPACE_ROOT, e.g. NAMESPACE_ROOT, NAMESPACE_ROOT_2, NAMESPACE_ROOT_GOOGLE,
+etc. The command line options override the environment.
Usage:
namespace <command>
@@ -22,15 +23,32 @@
Run "namespace help [command]" for command usage.
The global flags are:
- -alsologtostderr=true: log to standard error as well as files
- -log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
- -log_dir=: if non-empty, write log files to this directory
- -logtostderr=false: log to standard error instead of files
- -max_stack_buf_size=4292608: max size in bytes of the buffer to use for logging stack traces
- -stderrthreshold=2: logs at or above this threshold go to stderr
- -v=0: log level for V logs
- -vmodule=: comma-separated list of pattern=N settings for file-filtered logging
- -vv=0: log level for V logs
+ -alsologtostderr=true
+ log to standard error as well as files
+ -log_backtrace_at=:0
+ when logging hits line file:N, emit a stack trace
+ -log_dir=
+ if non-empty, write log files to this directory
+ -logtostderr=false
+ log to standard error instead of files
+ -max_stack_buf_size=4292608
+ max size in bytes of the buffer to use for logging stack traces
+ -stderrthreshold=2
+ logs at or above this threshold go to stderr
+ -v=0
+ log level for V logs
+ -veyron.credentials=
+ directory to use for storing security credentials
+ -veyron.namespace.root=[/proxy.envyor.com:8101]
+ local namespace root; can be repeated to provided multiple roots
+ -veyron.vtrace.cache_size=1024
+ The number of vtrace traces to store in memory.
+ -veyron.vtrace.dump_on_shutdown=false
+ If true, dump all stored traces on runtime shutdown.
+ -veyron.vtrace.sample_rate=0
+ Rate (from 0.0 to 1.0) to sample vtrace traces.
+ -vmodule=
+ comma-separated list of pattern=N settings for file-filtered logging
Namespace Glob
@@ -49,10 +67,10 @@
Usage:
namespace mount <name> <server> <ttl>
-<name> is the name to add to the namespace.
-<server> is the object address of the server to add.
-<ttl> is the TTL of the new entry. It is a decimal number followed by a unit
-suffix (s, m, h). A value of 0s represents an infinite duration.
+<name> is the name to add to the namespace. <server> is the object address of
+the server to add. <ttl> is the TTL of the new entry. It is a decimal number
+followed by a unit suffix (s, m, h). A value of 0s represents an infinite
+duration.
Namespace Unmount
@@ -61,8 +79,8 @@
Usage:
namespace unmount <name> <server>
-<name> is the name to remove from the namespace.
-<server> is the object address of the server to remove.
+<name> is the name to remove from the namespace. <server> is the object address
+of the server to remove.
Namespace Resolve
@@ -94,15 +112,24 @@
Namespace Help
Help with no args displays the usage of the parent command.
+
Help with args displays the usage of the specified sub-command or help topic.
+
"help ..." recursively displays help for all commands and topics.
+The output is formatted to a target width in runes. The target width is
+determined by checking the environment variable CMDLINE_WIDTH, falling back on
+the terminal width from the OS, falling back on 80 chars. By setting
+CMDLINE_WIDTH=x, if x > 0 the width is x, if x < 0 the width is unlimited, and
+if x == 0 or is unset one of the fallbacks is used.
+
Usage:
namespace help [flags] [command/topic ...]
[command/topic ...] optionally identifies a specific sub-command or help topic.
-The help flags are:
- -style=text: The formatting style for help output, either "text" or "godoc".
+The namespace help flags are:
+ -style=text
+ The formatting style for help output, either "text" or "godoc".
*/
package main
diff --git a/tools/namespace/main.go b/tools/namespace/main.go
index 66c4112..3723981 100644
--- a/tools/namespace/main.go
+++ b/tools/namespace/main.go
@@ -1,5 +1,5 @@
// The following enables go generate to generate the doc.go file.
-//go:generate go run $VEYRON_ROOT/lib/cmdline/testdata/gendoc.go .
+//go:generate go run $VEYRON_ROOT/veyron/go/src/veyron.io/lib/cmdline/testdata/gendoc.go .
package main
diff --git a/tools/profile/doc.go b/tools/profile/doc.go
index 6a71540..1054a09 100644
--- a/tools/profile/doc.go
+++ b/tools/profile/doc.go
@@ -17,15 +17,32 @@
Run "profile help [command]" for command usage.
The global flags are:
- -alsologtostderr=true: log to standard error as well as files
- -log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
- -log_dir=: if non-empty, write log files to this directory
- -logtostderr=false: log to standard error instead of files
- -max_stack_buf_size=4292608: max size in bytes of the buffer to use for logging stack traces
- -stderrthreshold=2: logs at or above this threshold go to stderr
- -v=0: log level for V logs
- -vmodule=: comma-separated list of pattern=N settings for file-filtered logging
- -vv=0: log level for V logs
+ -alsologtostderr=true
+ log to standard error as well as files
+ -log_backtrace_at=:0
+ when logging hits line file:N, emit a stack trace
+ -log_dir=
+ if non-empty, write log files to this directory
+ -logtostderr=false
+ log to standard error instead of files
+ -max_stack_buf_size=4292608
+ max size in bytes of the buffer to use for logging stack traces
+ -stderrthreshold=2
+ logs at or above this threshold go to stderr
+ -v=0
+ log level for V logs
+ -veyron.credentials=
+ directory to use for storing security credentials
+ -veyron.namespace.root=[/proxy.envyor.com:8101]
+ local namespace root; can be repeated to provided multiple roots
+ -veyron.vtrace.cache_size=1024
+ The number of vtrace traces to store in memory.
+ -veyron.vtrace.dump_on_shutdown=false
+ If true, dump all stored traces on runtime shutdown.
+ -veyron.vtrace.sample_rate=0
+ Rate (from 0.0 to 1.0) to sample vtrace traces.
+ -vmodule=
+ comma-separated list of pattern=N settings for file-filtered logging
Profile Label
@@ -75,15 +92,24 @@
Profile Help
Help with no args displays the usage of the parent command.
+
Help with args displays the usage of the specified sub-command or help topic.
+
"help ..." recursively displays help for all commands and topics.
+The output is formatted to a target width in runes. The target width is
+determined by checking the environment variable CMDLINE_WIDTH, falling back on
+the terminal width from the OS, falling back on 80 chars. By setting
+CMDLINE_WIDTH=x, if x > 0 the width is x, if x < 0 the width is unlimited, and
+if x == 0 or is unset one of the fallbacks is used.
+
Usage:
profile help [flags] [command/topic ...]
[command/topic ...] optionally identifies a specific sub-command or help topic.
-The help flags are:
- -style=text: The formatting style for help output, either "text" or "godoc".
+The profile help flags are:
+ -style=text
+ The formatting style for help output, either "text" or "godoc".
*/
package main
diff --git a/tools/profile/main.go b/tools/profile/main.go
index 66c4112..8423078 100644
--- a/tools/profile/main.go
+++ b/tools/profile/main.go
@@ -1,5 +1,5 @@
// The following enables go generate to generate the doc.go file.
-//go:generate go run $VEYRON_ROOT/lib/cmdline/testdata/gendoc.go .
+//go:generate go run $VEYRON_ROOT/tools/go/src/tools/lib/cmdline/testdata/gendoc.go .
package main
diff --git a/tools/vrpc/doc.go b/tools/vrpc/doc.go
index a2cb64e..69f90d6 100644
--- a/tools/vrpc/doc.go
+++ b/tools/vrpc/doc.go
@@ -2,9 +2,9 @@
// DO NOT UPDATE MANUALLY
/*
-The vrpc tool facilitates interaction with Veyron RPC servers. In particular,
-it can be used to 1) find out what API a Veyron RPC server exports and
-2) send requests to a Veyron RPC server.
+The vrpc tool facilitates interaction with Veyron RPC servers. In particular, it
+can be used to 1) find out what API a Veyron RPC server exports and 2) send
+requests to a Veyron RPC server.
Usage:
vrpc <command>
@@ -16,59 +16,103 @@
Run "vrpc help [command]" for command usage.
The global flags are:
- -alsologtostderr=true: log to standard error as well as files
- -log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
- -log_dir=: if non-empty, write log files to this directory
- -logtostderr=false: log to standard error instead of files
- -max_stack_buf_size=4292608: max size in bytes of the buffer to use for logging stack traces
- -stderrthreshold=2: logs at or above this threshold go to stderr
- -v=0: log level for V logs
- -vmodule=: comma-separated list of pattern=N settings for file-filtered logging
- -vv=0: log level for V logs
+ -acl=
+ acl is an optional JSON-encoded security.ACL that is used to construct a
+ security.Authorizer. Example: {"In":{"veyron/alice/...":"RW"}} is a
+ JSON-encoded ACL that allows all delegates of "veyron/alice" to access all
+ methods with ReadLabel or WriteLabel. If this flag is provided then the
+ \"--acl_file\" must be absent.
+ -acl_file=
+ acl_file is an optional path to a file containing a JSON-encoded security.ACL
+ that is used to construct a security.Authorizer. If this flag is provided
+ then the "--acl_file" flag must be absent.
+ -alsologtostderr=true
+ log to standard error as well as files
+ -log_backtrace_at=:0
+ when logging hits line file:N, emit a stack trace
+ -log_dir=
+ if non-empty, write log files to this directory
+ -logtostderr=false
+ log to standard error instead of files
+ -max_stack_buf_size=4292608
+ max size in bytes of the buffer to use for logging stack traces
+ -stderrthreshold=2
+ logs at or above this threshold go to stderr
+ -v=0
+ log level for V logs
+ -veyron.credentials=
+ directory to use for storing security credentials
+ -veyron.namespace.root=[/proxy.envyor.com:8101]
+ local namespace root; can be repeated to provided multiple roots
+ -veyron.proxy=
+ object name of proxy service to use to export services across network
+ boundaries
+ -veyron.tcp.address=:0
+ address to listen on
+ -veyron.tcp.protocol=tcp
+ protocol to listen with
+ -veyron.vtrace.cache_size=1024
+ The number of vtrace traces to store in memory.
+ -veyron.vtrace.dump_on_shutdown=false
+ If true, dump all stored traces on runtime shutdown.
+ -veyron.vtrace.sample_rate=0
+ Rate (from 0.0 to 1.0) to sample vtrace traces.
+ -vmodule=
+ comma-separated list of pattern=N settings for file-filtered logging
Vrpc Describe
-Describe connects to the Veyron RPC server identified by <server>, finds out what
-its API is, and outputs a succint summary of this API to the standard output.
+Describe connects to the Veyron RPC server identified by <server>, finds out
+what its API is, and outputs a succint summary of this API to the standard
+output.
Usage:
vrpc describe <server>
-<server> identifies the Veyron RPC server. It can either be the object address of
-the server or an Object name in which case the vrpc will use Veyron's name
+<server> identifies the Veyron RPC server. It can either be the object address
+of the server or an Object name in which case the vrpc will use Veyron's name
resolution to match this name to an end-point.
Vrpc Invoke
-Invoke connects to the Veyron RPC server identified by <server>, invokes the method
-identified by <method>, supplying the arguments identified by <args>, and outputs
-the results of the invocation to the standard output.
+Invoke connects to the Veyron RPC server identified by <server>, invokes the
+method identified by <method>, supplying the arguments identified by <args>, and
+outputs the results of the invocation to the standard output.
Usage:
vrpc invoke <server> <method> <args>
-<server> identifies the Veyron RPC server. It can either be the object address of
-the server or an Object name in which case the vrpc will use Veyron's name
+<server> identifies the Veyron RPC server. It can either be the object address
+of the server or an Object name in which case the vrpc will use Veyron's name
resolution to match this name to an end-point.
<method> identifies the name of the method to be invoked.
<args> identifies the arguments of the method to be invoked. It should be a list
-of values in a VOM JSON format that can be reflected to the correct type
-using Go's reflection.
+of values in a VOM JSON format that can be reflected to the correct type using
+Go's reflection.
Vrpc Help
Help with no args displays the usage of the parent command.
+
Help with args displays the usage of the specified sub-command or help topic.
+
"help ..." recursively displays help for all commands and topics.
+The output is formatted to a target width in runes. The target width is
+determined by checking the environment variable CMDLINE_WIDTH, falling back on
+the terminal width from the OS, falling back on 80 chars. By setting
+CMDLINE_WIDTH=x, if x > 0 the width is x, if x < 0 the width is unlimited, and
+if x == 0 or is unset one of the fallbacks is used.
+
Usage:
vrpc help [flags] [command/topic ...]
[command/topic ...] optionally identifies a specific sub-command or help topic.
-The help flags are:
- -style=text: The formatting style for help output, either "text" or "godoc".
+The vrpc help flags are:
+ -style=text
+ The formatting style for help output, either "text" or "godoc".
*/
package main
diff --git a/tools/vrpc/main.go b/tools/vrpc/main.go
index 66c4112..3723981 100644
--- a/tools/vrpc/main.go
+++ b/tools/vrpc/main.go
@@ -1,5 +1,5 @@
// The following enables go generate to generate the doc.go file.
-//go:generate go run $VEYRON_ROOT/lib/cmdline/testdata/gendoc.go .
+//go:generate go run $VEYRON_ROOT/veyron/go/src/veyron.io/lib/cmdline/testdata/gendoc.go .
package main
