From patchwork Tue Apr 27 17:43:10 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tedd Ho-Jeong An X-Patchwork-Id: 428010 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-10.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH, MAILING_LIST_MULTI, SPF_HELO_NONE, SPF_PASS, URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 87EBAC433B4 for ; Tue, 27 Apr 2021 17:43:17 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 678226109E for ; Tue, 27 Apr 2021 17:43:17 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238296AbhD0RoA (ORCPT ); Tue, 27 Apr 2021 13:44:00 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41728 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235647AbhD0Rn5 (ORCPT ); Tue, 27 Apr 2021 13:43:57 -0400 Received: from mail-pl1-x62c.google.com (mail-pl1-x62c.google.com [IPv6:2607:f8b0:4864:20::62c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1A46DC061574 for ; Tue, 27 Apr 2021 10:43:13 -0700 (PDT) Received: by mail-pl1-x62c.google.com with SMTP id h20so31305582plr.4 for ; Tue, 27 Apr 2021 10:43:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:date:message-id:mime-version :content-transfer-encoding; bh=5hK9mwe7yNzOikrmifuDlytwvVqDnrjH4YxG88PQ7n0=; b=OUKe+KbD7ImxGjQyVoG3diFbSesbd/d4kYFzR2dZXro4EH31lMKoIg3HBndgjx9piy aD9ZVvPisGBcHagpK+YZhqGp2vCgVN9ZcAPbzlsNJ6lqpV2yG73dYe8NrhkEcec0d+FO /dNN7EAsl1UbhLh3JWHszkGjuNeYkaRNME4ul7sZ+vE8nG+rb6xwsB3NysPh6Yg7RnkE pxOAS8HCoES+0iepVafP4mEHslVK0vYUA0VMEsZP1WD+tk/bXNUeKO8xRQyg6rue8byU orgK9fXZfGj2n26Uj4Fkxaj/1h3imU04nZWnnuZrfNyeBHXdtYTKEulpFvZveQ4nFgpE XcjQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:mime-version :content-transfer-encoding; bh=5hK9mwe7yNzOikrmifuDlytwvVqDnrjH4YxG88PQ7n0=; b=FTZjd3Nsx7l27olQiHr1KtejNZclxwN7pXHRhQGv7PZRCcQAoUKrNqkziugr2r5y+q cbs8yguKv+7wYgosr1feyi1CGtc9mzt+MnWcpscoy+EoeMmc6TQk6+inNO6KtE6h7H9r 5tuWFgA6+zSO8ZJP+Es9JeCxhDLODeNrz2kxhmRNbNcMGzLcD7WQj6EPIvO4kOusOFi8 4p6LQMN3ooSyUrMSSldr/sM/hOyvg5IZOP/v5gwIN4C8XtM0+FIrY8pgdY/Y8GyLoMfw W94aN4pMunDubHazV4sC4YOqUvHHEnG5i3egNAu3ij6DM9yz2uqiXGcni7nlW2lF1089 C41A== X-Gm-Message-State: AOAM530MZ3QRZw0w9cWrHUoZqDl91G97H9x+ulp6n2OtaJz/PlnyMyXR sgejwcQJUJexIK8ADiV5QpStXBDtQ4Q= X-Google-Smtp-Source: ABdhPJyRQHTrgZMMSMdhq7UahAiuD5yT4g4U+z726YW/u+HPfALbyMUMzIqsk97dAR9Ns8uu7rY98Q== X-Received: by 2002:a17:90a:5885:: with SMTP id j5mr28604803pji.102.1619545392286; Tue, 27 Apr 2021 10:43:12 -0700 (PDT) Received: from han1-XPS-13-9350.hsd1.or.comcast.net ([2601:1c0:6a01:d830:6e5:bd32:3019:cc30]) by smtp.gmail.com with ESMTPSA id a26sm3136987pff.149.2021.04.27.10.43.11 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Apr 2021 10:43:11 -0700 (PDT) From: Tedd Ho-Jeong An To: linux-bluetooth@vger.kernel.org Subject: [BlueZ] monitor: Update manpage Date: Tue, 27 Apr 2021 10:43:10 -0700 Message-Id: <20210427174310.100632-1-hj.tedd.an@gmail.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org From: Tedd Ho-Jeong An This patch updates the manpage for btmon. --- Makefile.am | 10 +--- Makefile.tools | 3 + doc/btmon.txt | 35 ----------- monitor/btmon.1 | 152 ++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 156 insertions(+), 44 deletions(-) delete mode 100644 doc/btmon.txt create mode 100644 monitor/btmon.1 diff --git a/Makefile.am b/Makefile.am index f98243f72..625a7ce3d 100644 --- a/Makefile.am +++ b/Makefile.am @@ -579,14 +579,6 @@ if LIBRARY pkgconfig_DATA = lib/bluez.pc endif -manual_pages = doc/btmon.1 - -if MANPAGES -dist_noinst_MANS += $(manual_pages) -endif - -EXTRA_DIST += $(manual_pages:.1=.txt) - DISTCHECK_CONFIGURE_FLAGS = --disable-datafiles --enable-library \ --enable-health \ --enable-midi \ @@ -597,7 +589,7 @@ DISTCHECK_CONFIGURE_FLAGS = --disable-datafiles --enable-library \ --disable-systemd \ --disable-udev -DISTCLEANFILES = $(pkgconfig_DATA) $(unit_tests) $(manual_pages) +DISTCLEANFILES = $(pkgconfig_DATA) $(unit_tests) MAINTAINERCLEANFILES = Makefile.in \ aclocal.m4 configure config.h.in config.sub config.guess \ diff --git a/Makefile.tools b/Makefile.tools index 57e858290..069f40ec8 100644 --- a/Makefile.tools +++ b/Makefile.tools @@ -49,6 +49,9 @@ monitor_btmon_SOURCES = monitor/main.c monitor/bt.h \ monitor/tty.h monitor_btmon_LDADD = lib/libbluetooth-internal.la \ src/libshared-mainloop.la $(UDEV_LIBS) -ldl +dist_man_MANS += monitor/btmon.1 +else +EXTRA_DIST += monitor/btmon.1 endif if LOGGER diff --git a/doc/btmon.txt b/doc/btmon.txt deleted file mode 100644 index 7a7fc537b..000000000 --- a/doc/btmon.txt +++ /dev/null @@ -1,35 +0,0 @@ -BTMON(1) -======== -:doctype: manpage - - -NAME ----- -btmon - Bluetooth monitor - - -SYNOPSIS --------- -*btmon* ['OPTIONS'] - - -DESCRIPTION ------------ -The btmon(1) command provides access to the Bluetooth subsystem monitor -infrastructure for reading HCI traces. - - -AUTHOR ------- -btmon was originally written by Marcel Holtmann. - - -RESOURCES ---------- -See - - -COPYING -------- -Free use of this software is granted under ther terms of the GNU Lesser -General Public Licenses (LGPL). diff --git a/monitor/btmon.1 b/monitor/btmon.1 new file mode 100644 index 000000000..a9d8430c8 --- /dev/null +++ b/monitor/btmon.1 @@ -0,0 +1,152 @@ +.\" Manpage for btmon +.TH btmon 1 "April 2021" BlueZ "Linux System Administration" + +.SH NAME +btmon - Bluetooth monitor + +.SH SYNOPSIS +.B btmon +.RI [ OPTIONS ] +.SH DESCRIPTION +The btmon(1) command provides access to the Bluetooth subsystem monitor +infrastructure for reading HCI traces. +.SH OPTIONS +.TP +.BR \-r , " \-\-read " \fIFILE\fR +Read traces in btsnoop format. + +.TP +.BR \-w , " \-\-write " \fIFILE\fR +Save traces in btsnoop format. + +.TP +.BR \-a , " \-\-analyze " \fIFILE\fR +Analyze traces in btsnoop format. It displays the devices found in the +\fIFILE\fR with its packets by type. + +.TP +.BR \-s , " \-\-server " \fISOCKET\fR +Start monitor server socket. + +.TP +.BR \-p , " \-\-priority " \fIPRIORITY\fR +Show only priority or lower for user log. +.sp +\fIPRIORITY\fR +.IP +.TS +tab(:); +l l. +3:Error +4:Warning +6:Information (default) +7:Debug. 'debug' can be to use. +.TE + +.TP +.BR \-i , " \-\-index " \fINUM\fR +Show only specified controller. \fBhci\fINUM\fR is also acceptable. +This is useful to capture the traces from the specific controller when the +multiple controllers are presented. + +.TP +.BR \-d , " \-\-tty " \fITTY\fR +Read data from TTY. + +.TP +.BR \-B , " \-\-rate " \fISPEED\fR +Set TTY speed. The default \fISPEED\fR is 115300q + +.TP +.BR \-V , " \-\-vendor " \fICOMPID\fR +Set the default company identifier. The \fICOMPID\fR is a unique number +assigned by the Bluetooth SIG to a member company and can be found/searched +from the Bluetooth SIG webpage. For example, Intel is 2 and Realtek is 93. + +.TP +.BR \-M ", " \-\-mgmt +Open channel for mgmt events. + +.TP +.BR \-t ", " \-\-time +Show a time instead of time offset. + +.TP +.BR \-T ", " \-\-date +Show a time and date information instead of time offset. + +.TP +.BR \-S ", " \-\-sco +Dump SCO traffic in raw hex format. + +.TP +.BR \-A ", " \-\-a2dp +Dump A2DP stream traffic in a raw hex format. + +.TP +.BR \-E , " \-\-ellisys " \fIIP\fR +Send Ellisys HCI Injection. + +.TP +.BR \-P ", " \-\-no\-pager +Disable pager usage while reading the log file. + +.TP +.BR \-J , " \-\-jlink " \fIDEVICE\fR,[\fISERIALNO\fR],[\fIINTERFACE\fR],[\fISPEED\fR] +Read data from RTT + +.TP +.BR \-R , " \-\-rtt " [\fIADDRESS\fR],[\fIAREA\fR],[\fINAME\fR] +RTT control block parameters + +.TP +.BR \-C , " \-\-columns " \fIWIDTH\fR +Output width if not a terminal + +.TP +.BR \-c , " \-\-color " \fIMODE\fR +Set output color. The possible \fImode\fR values are: +.sp +\fIMODE\fR +.IP +.TS +l. +auto +always +never +.TE + +.TP +.BR \-v , " \-\-version +Show version + +.TP +.BR \-h , " \-\-help +Show help options + +.SH EXAMPLES +.TP +.B Capture the traces from hci0 to hcidump.log file +.IP +$ btmon -i hci0 -w hcidump.log + +.TP +.B Open the trace file +.IP +$ btmon -r hcidump.log + +.SH RESOURCES +.TP + + +.SH AUTHOR +Written by Marcel Holtmann . +.sp +man page by Tedd Ho-Jeong An . + +.SH REPORTING BUGS +linux-bluetooth@vger.kernel.org + +.SH COPYRIGHT +Free use of this software is granted under ther terms of the GNU Lesser +General Public Licenses (LGPL).