Received: by 2002:a05:6a10:206:0:0:0:0 with SMTP id 6csp2392763pxj; Mon, 17 May 2021 00:06:32 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyMXZ9aRj7xXIMmlL/9LkHyqu2fG9tnYmu8uarHuxCL6r499moBl4D/pByaSdbmtrOoJOtj X-Received: by 2002:a02:5d44:: with SMTP id w65mr11762645jaa.15.1621235192415; Mon, 17 May 2021 00:06:32 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1621235192; cv=none; d=google.com; s=arc-20160816; b=fQ07Oi0nVP0D+DMbCoxQmZxc/5CylSk5igIyJgLGeop6BTeCPFTbZPG3mzLjTt6Xui hXchavQtDSBRdmtBqqo6A/ha4ma5iZb+AzsWz2z1FXYsnEwqaYDG8J79UTX1FmgwdsNw D84G91Tq865tQQpJc5WCCNzr9MIG1aFQDFFNJtUTtNS//1aO5QTJ3nl6CdAS1veEiju6 Xodl8rr0hOp7iHUxau5xg/l67/a+gxsuMSABfXQZRuU/4TvVTxS7sIx2OKqWOPg2iSDQ tHx/LNQTACyVgx/I2LYbDDGZLWfirWOyWhHzT7WzHiqSUS9SEAS49SNu3VAueuFCWUZ5 Z+qw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:ironport-sdr:ironport-sdr; bh=t1LLvATYcpF3U1Ep6DMy5YUR+hzv4uyCXpl4LYlgdcU=; b=kOftivdCbAXTiZQeGj6pyGVf0MxfVQNTGQCOGHHu3yv5qvVrvdWYqDOCT5iBMH1vWQ Kv7BxG+leQMADR+YuygNv9DGEdV3u4fJ2xrSONPCyDWn/LJxFBWXJLLGD0IEk1tNCO8e WG1vcbZNHnSxPsS7g0bC7oeIKq98EOvlHfww/KeOxhTdVYgQUOCRA3fzVJSqjc9puvuw B7eFdJgmtpeBBAvkHpyEbyJ0jtcS8xZyeTYAI0bltxsXJd+czi4ZlEfsVEuul/zDM2J3 Am6ZFGYTEoM1nps9JqaloMim87vBdQABvJYunpLzdAaYiJouGnzvJuTcPK4XTHJhHPHH ZAwg== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-bluetooth-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-bluetooth-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=intel.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id x17si9519324jan.4.2021.05.17.00.06.06; Mon, 17 May 2021 00:06:32 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-bluetooth-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-bluetooth-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-bluetooth-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=intel.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233919AbhEQFZU (ORCPT + 99 others); Mon, 17 May 2021 01:25:20 -0400 Received: from mga11.intel.com ([192.55.52.93]:14898 "EHLO mga11.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229625AbhEQFZU (ORCPT ); Mon, 17 May 2021 01:25:20 -0400 IronPort-SDR: mPU6UVhx2ySKY+ron/M0rpppCULqnKE14JO5waMCBWX1haq0evle9p7NfPrsL3ZK/TlXZw9nl5 w2rjdeWleWyQ== X-IronPort-AV: E=McAfee;i="6200,9189,9986"; a="197298863" X-IronPort-AV: E=Sophos;i="5.82,306,1613462400"; d="scan'208";a="197298863" Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 16 May 2021 22:24:04 -0700 IronPort-SDR: IV5GaB7+2lLo+roz6EgGVW54nIMF5iZbhFhWYXRmFxvpjaWZtiYf/bgXZ60nh9Zah9QZo95Ala pIi1jxiOC6dg== X-IronPort-AV: E=Sophos;i="5.82,306,1613462400"; d="scan'208";a="437539958" Received: from jard-mobl.amr.corp.intel.com (HELO istotlan-desk.intel.com) ([10.209.127.145]) by fmsmga008-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 16 May 2021 22:24:04 -0700 From: Inga Stotland To: linux-bluetooth@vger.kernel.org Cc: Inga Stotland Subject: [PATCH BlueZ] mesh: Add manpage for bluetooth-meshd daemon Date: Sun, 16 May 2021 22:23:57 -0700 Message-Id: <20210517052357.360724-1-inga.stotland@intel.com> X-Mailer: git-send-email 2.26.3 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org This adds manpage with a brief description of BLuettoth Mesh daemon command line options. --- .gitignore | 2 + Makefile.mesh | 5 +++ configure.ac | 3 +- mesh/bluetooth-meshd.rst.in | 74 +++++++++++++++++++++++++++++++++++++ 4 files changed, 83 insertions(+), 1 deletion(-) create mode 100644 mesh/bluetooth-meshd.rst.in diff --git a/.gitignore b/.gitignore index 9c8393a81..9f57aa193 100644 --- a/.gitignore +++ b/.gitignore @@ -145,6 +145,8 @@ tools/meshctl tools/mesh-cfgclient tools/mesh-cfgtest mesh/bluetooth-meshd +mesh/bluetooth-meshd.8 +mesh/bluetooth-meshd.rst src/bluetoothd.8 src/bluetoothd.rst diff --git a/Makefile.mesh b/Makefile.mesh index 73eaded4a..fc28b0557 100644 --- a/Makefile.mesh +++ b/Makefile.mesh @@ -47,6 +47,11 @@ mesh_bluetooth_meshd_LDADD = src/libshared-ell.la $(ell_ldadd) -ljson-c mesh_bluetooth_meshd_DEPENDENCIES = $(ell_dependencies) src/libshared-ell.la \ mesh/bluetooth-mesh.service +if MANPAGES +man_MANS += mesh/bluetooth-meshd.8 +endif +manual_pages += mesh/bluetooth-meshd.8 + CLEANFILES += mesh/bluetooth-mesh.service endif diff --git a/configure.ac b/configure.ac index 5157da1b5..af700eb13 100644 --- a/configure.ac +++ b/configure.ac @@ -392,6 +392,7 @@ AC_SUBST(CONFIGDIR, "${configdir}") AC_DEFINE_UNQUOTED(MESH_STORAGEDIR, "${storagedir}/mesh", [Directory for the mesh daemon storage files]) +AC_SUBST(MESH_STORAGEDIR, "${storagedir}/mesh") AC_ARG_ENABLE(android, AC_HELP_STRING([--enable-android], [enable BlueZ for Android]), @@ -415,4 +416,4 @@ fi AC_DEFINE_UNQUOTED(ANDROID_STORAGEDIR, "${storagedir}/android", [Directory for the Android daemon storage files]) -AC_OUTPUT(Makefile src/bluetoothd.rst lib/bluez.pc) +AC_OUTPUT(Makefile src/bluetoothd.rst lib/bluez.pc mesh/bluetooth-meshd.rst) diff --git a/mesh/bluetooth-meshd.rst.in b/mesh/bluetooth-meshd.rst.in new file mode 100644 index 000000000..06cdb69da --- /dev/null +++ b/mesh/bluetooth-meshd.rst.in @@ -0,0 +1,74 @@ +=============== +bluetooth-meshd +=============== + +--------------------- +Bluetooth Mesh daemon +--------------------- + +:Version: BlueZ +:Copyright: Free use of this software is granted under ther terms of the GNU + Lesser General Public Licenses (LGPL). +:Date: March 2021 +:Manual section: 8 +:Manual group: Linux Connectivity + +SYNOPSIS +======== + +**bluetooth-meshd** [*options* ...] + +DESCRIPTION +=========== + +Daemon for managing Bluetooth Mesh connections on Linux. + +OPTIONS +======= + +-h, --help + Print bluetooth-meshd options and exit. + +-n, --nodetach + Enable logging in foreground. Directs log output to the controlling + terminal in addition to syslog. + +-i , --io + Specifies I/O interface type: + + *hci* - Use generic HCI io on interface hci, + or, if no idex is specified, the first available one. + + *unit:*- Specifies open file descriptor for + daemon testing. + + By default, if no type is specified, uses generic I/O + on the first available HCI interface. + +-c , --config + Specifies an explicit config file path instead of relying on the + default path(*@CONFIGDIR@/mesh-main.conf*) for the config file. + +-s , --storage + Specifies an explicit storage directory path instead of the default + path(*@MESH_STORAGEDIR@*) for storing mesh node(s) configuration. + +-d, --debug Enable debug output. + +-b, --dbus-debug Enable D-Bus debug output. + +FILES +===== + +*@CONFIGDIR@/mesh-main.conf* + Location of the global configuration file containing mesh daemon settings. + +RESOURCES +========= + +http://www.bluez.org + +REPORTING BUGS +============== + +linux-bluetooth@vger.kernel.org -- 2.26.3