From: Dave Jiang <dave.jiang@intel.com>
To: linux-cxl@vger.kernel.org
Cc: alison.schofield@intel.com, vishal.l.verma@intel.com,
ira.weiny@intel.com, bwidawsk@kernel.org,
dan.j.williams@intel.com, nafonten@amd.com,
nvdimm@lists.linux.dev
Subject: [PATCH v2 9/9] cxl: add man page documentation for monitor
Date: Mon, 19 Sep 2022 16:47:27 -0700 [thread overview]
Message-ID: <166363124742.3861186.7691291186058723572.stgit@djiang5-desk3.ch.intel.com> (raw)
In-Reply-To: <166363103019.3861186.3067220004819656109.stgit@djiang5-desk3.ch.intel.com>
Add man page documentation to explain the usage of cxl monitor.
Signed-off-by: Dave Jiang <dave.jiang@intel.com>
---
Documentation/cxl/cxl-monitor.txt | 77 +++++++++++++++++++++++++++++++++++++
1 file changed, 77 insertions(+)
create mode 100644 Documentation/cxl/cxl-monitor.txt
diff --git a/Documentation/cxl/cxl-monitor.txt b/Documentation/cxl/cxl-monitor.txt
new file mode 100644
index 000000000000..43c2ece72220
--- /dev/null
+++ b/Documentation/cxl/cxl-monitor.txt
@@ -0,0 +1,77 @@
+// SPDX-License-Identifier: GPL-2.0
+
+cxl-monitor(1)
+================
+
+NAME
+----
+cxl-monitor - Monitor the CXL kernel trace events
+
+SYNOPSIS
+--------
+[verse]
+'cxl monitor' [<options>]
+
+DESCRIPTION
+-----------
+Cxl monitor is used for monitoring the CXL trace events emitted by
+the kernel and convert them to json objects and dumping the json format
+notifications to standard output or a logfile.
+
+Both, the values in configuration file and in options will work. If
+there is a conflict, the values in options will override the values in
+the configuration file. Any updated values in the configuration file will
+take effect only after the monitor process is restarted.
+
+EXAMPLES
+--------
+
+Run a monitor as a daemon to monitor events and output to a log file.
+[verse]
+cxl monitor --daemon --log=/var/log/cxl-monitor.log
+
+Run a monitor as a one-shot command and output the notifications to stdio.
+[verse]
+cxl monitor
+
+Run a monitor daemon as a system service
+[verse]
+systemctl start cxl-monitor.service
+
+OPTIONS
+-------
+-l::
+--log=::
+ Send log messages to the specified destination.
+ - "<file>":
+ Send log messages to specified <file>. When fopen() is not able
+ to open <file>, log messages will be forwarded to syslog.
+ - "standard":
+ Send messages to standard output.
+
+The default log destination is '/var/log/cxl-monitor.log' if "--daemon" is specified,
+otherwise 'standard'. Note that standard and relative path for <file>
+will not work if "--daemon" is specified.
+
+--daemon::
+ Run a monitor as a daemon.
+
+-u::
+--human::
+ Output monitor notification as human friendly json format instead
+ of the default machine friendly json format.
+
+-v::
+--verbose::
+ Emit extra debug messages to log.
+
+COPYRIGHT
+---------
+Copyright (c) 2022, Intel Corp. License GPLv2: GNU GPL version 2
+<http://gnu.org/licenses/gpl.html>. This is free software: you are
+free to change and redistribute it. There is NO WARRANTY, to the
+extent permitted by law.
+
+SEE ALSO
+--------
+linkcxl:cxl-list[1]
prev parent reply other threads:[~2022-09-19 23:47 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-19 23:46 [PATCH v2 0/9] cxl: add monitor support for trace events Dave Jiang
2022-09-19 23:46 ` [PATCH v2 1/9] cxl: add helper function to parse trace event to json object Dave Jiang
2022-09-19 23:46 ` [PATCH v2 2/9] cxl: add helper to parse through all current events Dave Jiang
2022-09-21 21:09 ` Alison Schofield
2022-09-21 21:46 ` Dave Jiang
2022-09-19 23:46 ` [PATCH v2 3/9] cxl: add common function to enable event trace Dave Jiang
2022-09-19 23:46 ` [PATCH v2 4/9] cxl: add common function to disable " Dave Jiang
2022-09-19 23:47 ` [PATCH v2 5/9] cxl: add monitor function for event trace events Dave Jiang
2022-09-19 23:47 ` [PATCH v2 6/9] cxl: add logging functions for monitor Dave Jiang
2022-09-19 23:47 ` [PATCH v2 7/9] cxl: add monitor command to cxl Dave Jiang
2022-09-19 23:47 ` [PATCH v2 8/9] cxl: add systemd service for monitor Dave Jiang
2022-09-19 23:47 ` Dave Jiang [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=166363124742.3861186.7691291186058723572.stgit@djiang5-desk3.ch.intel.com \
--to=dave.jiang@intel.com \
--cc=alison.schofield@intel.com \
--cc=bwidawsk@kernel.org \
--cc=dan.j.williams@intel.com \
--cc=ira.weiny@intel.com \
--cc=linux-cxl@vger.kernel.org \
--cc=nafonten@amd.com \
--cc=nvdimm@lists.linux.dev \
--cc=vishal.l.verma@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).