diff options
author | Steven Rostedt (Google) <rostedt@goodmis.org> | 2022-04-20 11:26:37 -0400 |
---|---|---|
committer | Steven Rostedt (Google) <rostedt@goodmis.org> | 2022-04-26 20:50:18 -0400 |
commit | d9a502f00f591998ad195fd13ed7d95327d558d7 (patch) | |
tree | 4d2c6c7e079d34a60c6bd5af15d6785ec3a8fe45 | |
parent | bcfcb50e4e8fa4ca73da600b215c35b8af3e8692 (diff) | |
download | trace-cmd-d9a502f00f591998ad195fd13ed7d95327d558d7.tar.gz |
trace-cmd agent: Add documentation
Add a man page for trace-cmd agent, and also update the usage to include
the new -N option.
Link: https://lore.kernel.org/linux-trace-devel/20220420152637.13105-12-rostedt@goodmis.org
Link: https://lore.kernel.org/linux-trace-devel/20220417211315.1049221-3-rostedt@goodmis.org
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
-rw-r--r-- | Documentation/trace-cmd/trace-cmd-agent.1.txt | 62 | ||||
-rw-r--r-- | tracecmd/trace-usage.c | 3 |
2 files changed, 65 insertions, 0 deletions
diff --git a/Documentation/trace-cmd/trace-cmd-agent.1.txt b/Documentation/trace-cmd/trace-cmd-agent.1.txt new file mode 100644 index 00000000..f247d41d --- /dev/null +++ b/Documentation/trace-cmd/trace-cmd-agent.1.txt @@ -0,0 +1,62 @@ +TRACE-CMD-AGENT(1) +================== + +NAME +---- +trace-cmd-agent - Run as an agent on a machine (to be controlled by another machine) + +SYNOPSIS +-------- +*trace-cmd agent* ['OPTIONS'] + +DESCRIPTION +----------- +The trace-cmd(1) agent listens over a vsocket (for virtual machines) or a TCP port +for connections to control the tracing of the machine. The agent will then start +tracing on the local machine and pass the data to the controlling connection. + +OPTIONS +------- +*-N* 'client':: + Listen over TCP instead of a vsocket. Must pass in a client host name or IP address + to allow connection to. It will only connect to the specified client. Note, any process + on that client can control the agent. + + *This is a very insecure setting. Only use on a trusted network* + *Only use if the client machine is totally trusted* + +*-p* 'port':: + This option will specify the port to listen to. + +*-D*:: + This options causes trace-cmd agent to go into a daemon mode and run in + the background. + +*--verbose*[='level']:: + Set the log level. Supported log levels are "none", "critical", "error", "warning", + "info", "debug", "all" or their identifiers "0", "1", "2", "3", "4", "5", "6". Setting the log + level to specific value enables all logs from that and all previous levels. + The level will default to "info" if one is not specified. + + Example: enable all critical, error and warning logs + + trace-cmd listen --verbose=warning + +SEE ALSO +-------- +trace-cmd(1), trace-cmd-record(1), trace-cmd-report(1), trace-cmd-start(1), +trace-cmd-stop(1), trace-cmd-extract(1), trace-cmd-reset(1), +trace-cmd-split(1), trace-cmd-list(1) + +AUTHOR +------ +Written by Steven Rostedt, <rostedt@goodmis.org> + +RESOURCES +--------- +https://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git/ + +COPYING +------- +Copyright \(C) 2010 Red Hat, Inc. Free use of this software is granted under +the terms of the GNU Public License (GPL). diff --git a/tracecmd/trace-usage.c b/tracecmd/trace-usage.c index 88eac10a..2cfa64f5 100644 --- a/tracecmd/trace-usage.c +++ b/tracecmd/trace-usage.c @@ -330,6 +330,9 @@ static struct usage_help usage_help[] = { "listen on a vsocket for trace clients", " %s agent -p port[-D]\n" " Creates a vsocket to listen for clients.\n" + " -N Connect to IP via TCP instead of vsockets\n" + " *** Insecure setting, only use on a trusted network ***\n" + " *** Only use if the client is totally trusted. ***\n" " -p port number to listen on.\n" " -D run in daemon mode.\n" " --verbose 'level' Set the desired log level\n" |