Updated man page for CLI

hmatuschek · Jan 21, 2021 · 209fac1 · 209fac1
1 parent f6f94c0
commit 209fac1
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 12 deletions.
diff --git a/doc/dmrconf.1 b/doc/dmrconf.1
@@ -2,12 +2,12 @@
 .\"     Title: dmrconf
 .\"    Author: Hannes Matuschek <hmatuschek@gmail.com>
 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 12/13/2019
+.\"      Date: 01/21/2021
 .\"    Manual: User Commands
-.\"    Source: dmrconf 0.1.0
+.\"    Source: dmrconf 0.5.2
 .\"  Language: English
 .\"
-.TH "DMRCONF" "1" "12/13/2019" "dmrconf 0\&.1\&.0" "User Commands"
+.TH "DMRCONF" "1" "01/21/2021" "dmrconf 0\&.5\&.2" "User Commands"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -49,24 +49,31 @@ also allows to download codeplugs from the radio and to store it in the human\-r
 Detects a connected radio\&. This command does not take any additional options\&.
 .RE
 .PP
-\fBwrite\fR
+\fBread\fR
 .RS 4
-Writes the specified codeplug to the radio\&. This command may need the
+Reads a codeplug from the radio and stores it into the given file\&. This command may need the
 \fB\-c\fR
 or
 \fB\-b\fR
 options if the file type cannot be inferred from the filename\&.
 .RE
 .PP
-\fBread\fR
+\fBwrite\fR
 .RS 4
-Reads a codeplug from the radio and stores it into the given file\&. This command may need the
+Writes the specified codeplug to the radio\&. This command may need the
 \fB\-c\fR
 or
 \fB\-b\fR
 options if the file type cannot be inferred from the filename\&.
 .RE
 .PP
+\fBwrite\-db\fR
+.RS 4
+Writes the call\-sign database to the device\&. This command may need the
+\fB\-\-id\fR
+option to select call\-signs if the complete database does not fit into the device\&. If specified, all callsigns closest to the specified ID are used\&.
+.RE
+.PP
 \fBverify\fR
 .RS 4
 Verifies the codeplug with the connected radio or the specified radio passed with the
@@ -85,6 +92,15 @@ Encodes a CSV codeplug as a binary one for the connected or specified radio usin
 option\&.
 .RE
 .PP
+\fBencode\-db\fR
+.RS 4
+Encodes the call\-sign datavase as a binary one for the connected or specified radio using the
+\fB\-\-radio\fR
+option\&. This command may need the
+\fB\-\-id\fR
+option to select call\-signs if the complete database does not fit into the device\&. If specified, all callsigns closest to the specified ID are used\&.
+.RE
+.PP
 \fBdecode\fR
 .RS 4
 Decodes a binary codeplug and stores the result in human\-readable form\&.
@@ -131,12 +147,31 @@ or
 \fBdecode\fR
 commands\&.
 .RE
+.PP
+\fB\-I\fR or \fB\-\-id=\fRDMR_ID
+.RS 4
+Specifies the DMR ID for the
+\fBwrite\-db\fR
+or
+\fBencode\-db\fR
+commands\&.
+.RE
 .SH "SUPPORTED RADIOS"
 .PP
 The following list contains all supported radios and their names for the
 \fB\-\-radio\fR
 option\&.
 .PP
+\fBopengd77\fR
+.RS 4
+All radios running the Open GD77 firmeare
+.RE
+.PP
+\fBd878uv\fR
+.RS 4
+Anytone AT\-D878UV
+.RE
+.PP
 \fBmd390\fR
 .RS 4
 TYT MD\-390 or Retevis RT3S

diff --git a/doc/dmrconf.xml b/doc/dmrconf.xml
@@ -7,7 +7,7 @@
     <refentrytitle>dmrconf</refentrytitle>
     <manvolnum>1</manvolnum>
     <refmiscinfo class="source">dmrconf</refmiscinfo>
-    <refmiscinfo class="version">0.1.0</refmiscinfo>
+    <refmiscinfo class="version">0.5.2</refmiscinfo>
     <refmiscinfo class="manual">User Commands</refmiscinfo>
   </refmeta>
 
@@ -52,17 +52,24 @@
         <listitem><para>Detects a connected radio. This command does not take any
         additional options.</para></listitem>
       </varlistentry>
+      <varlistentry>
+        <term><command>read</command></term>
+        <listitem><para>Reads a codeplug from the radio and stores it into the given file. This
+          command may need the <option>-c</option> or <option>-b</option> options if the file type
+          cannot be inferred from the filename.</para></listitem>
+      </varlistentry>
       <varlistentry>
         <term><command>write</command></term>
         <listitem><para>Writes the specified codeplug to the radio. This command may need the
           <option>-c</option> or <option>-b</option> options if the file type cannot be inferred
           from the filename.</para></listitem>
       </varlistentry>
       <varlistentry>
-        <term><command>read</command></term>
-        <listitem><para>Reads a codeplug from the radio and stores it into the given file. This
-          command may need the <option>-c</option> or <option>-b</option> options if the file type
-          cannot be inferred from the filename.</para></listitem>
+        <term><command>write-db</command></term>
+        <listitem><para>Writes the call-sign database to the device. This command may need the
+          <option>--id</option> option to select call-signs if the complete database does not 
+          fit into the device. If specified, all callsigns closest to the specified ID are 
+          used. </para></listitem>
       </varlistentry>
       <varlistentry>
         <term><command>verify</command></term>
@@ -76,6 +83,14 @@
         <listitem><para>Encodes a CSV codeplug as a binary one for the connected or
           specified radio using the <option>--radio</option> option. </para></listitem>
       </varlistentry>
+      <varlistentry>
+        <term><command>encode-db</command></term>
+        <listitem><para>Encodes the call-sign datavase as a binary one for the connected or
+          specified radio using the <option>--radio</option> option. This command may need the
+          <option>--id</option> option to select call-signs if the complete database does not 
+          fit into the device. If specified, all callsigns closest to the specified ID are 
+          used. </para></listitem>
+      </varlistentry>
       <varlistentry>
         <term><command>decode</command></term>
         <listitem><para>Decodes a binary codeplug and stores the result in
@@ -112,6 +127,11 @@
         <listitem><para>Specifies the radio for the <command>verify</command>,
           <command>encode</command> or <command>decode</command> commands.</para></listitem>
       </varlistentry>
+      <varlistentry>
+        <term><option>-I</option> or <option>--id=</option>DMR_ID</term>
+        <listitem><para>Specifies the DMR ID for the <command>write-db</command> or
+          <command>encode-db</command> commands.</para></listitem>
+      </varlistentry>
     </variablelist>
   </refsect1>
 
@@ -120,6 +140,14 @@
     <para>The following list contains all supported radios and their names for the
       <option>--radio</option> option.</para>
     <variablelist>
+      <varlistentry>
+        <term><option>opengd77</option></term>
+        <listitem><para>All radios running the Open GD77 firmeare</para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>d878uv</option></term>
+        <listitem><para>Anytone AT-D878UV</para></listitem>
+      </varlistentry>
       <varlistentry>
         <term><option>md390</option></term>
         <listitem><para>TYT MD-390 or Retevis RT3S</para></listitem>