From 12a888988d2c10ab902aaa0f0e324e96f4c6ecc7 Mon Sep 17 00:00:00 2001
From: Evan Miller <emmiller@gmail.com>
Date: Wed, 4 Aug 2021 15:33:43 -0400
Subject: [PATCH] Update README and deprecate mdb-hexdump

---
 README.md             | 29 +++++++++++++++++++++--------
 src/extras/mdb-dump.c |  6 +++++-
 2 files changed, 26 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 0c5761b..cf9f1e6 100644
--- a/README.md
+++ b/README.md
@@ -12,11 +12,11 @@ The major pieces of MDB Tools are:
 
 ### libmdb
 
-The core library that allows access to MDB files programatically.
+The core library that allows access to MDB files programatically. See [mdbtools.h](./include/mdbtools.h.in) for the complete API.
 
 ### libmdbsql
 
-Builds on libmdb to provide a SQL engine (aka Jet)
+Builds on libmdb to provide a SQL engine (aka Jet). See [mdbsql.h](./include/mdbsql.h) for the complete API.
 
 ### utils
 
@@ -32,17 +32,24 @@ Provides command line utilities, including:
 | `mdb-count` | A simple count of number of rows in a table, to be used in shell scripts and ETL pipelines. |
 | `mdb-sql` | A simple SQL engine (also used by ODBC and gmdb). |
 | `mdb-queries` | List and print queries stored in the database. |
+| `mdb-hexdump`\* | (in src/extras) Simple hex dump utility to look at mdb files. |
+| `mdb-array`\* | Export data in an MDB database table to a C array. |
+| `mdb-header`\* | Generates a C header to be used in exporting mdb data to a C prog. |
+| `mdb-parsecsv`\* | Generates a C program given a CSV file made with mdb-export. |
+
+\* Deprecated
+
+See the man page of each program for usage instructions.
+
+The src/utils directory also contains a number of debugging tools, intended for developers. They are:
+
 | `prcat` | Prints the catalog table from an mdb file. |
 | `prkkd` | Dump of information about design view data given the offset to it. |
 | `prtable` | Dump of a table definition. |
 | `prdata` | Dump of the data given a table name. |
 | `prole` | Dump of ole columns given a table name and sargs. |
-| `mdb-hexdump` | (in src/extras) Simple hex dump utility that I've been using to look at mdb files. |
-| `mdb-array` | Export data in an MDB database table to a C array.\* |
-| `mdb-header` | Generates a C header to be used in exporting mdb data to a C prog.\* |
-| `mdb-parsecsv` | Generates a C program given a CSV file made with mdb-export.\* |
 
-\* Deprecated
+These tools are not installed on the host system.
 
 ### odbc
 
@@ -50,7 +57,7 @@ An ODBC driver for use with unixODBC or iODBC driver manager. Allows one to use
 
 ### gmdb2
 
-The Gnome MDB File Viewer and debugger. Alpha quality, moved to [mdbtools/gmdb2](https://github.com/mdbtools/gmdb2).
+The Gnome MDB File Viewer and debugger. Recently ported to GTK+3 and moved to [mdbtools/gmdb2](https://github.com/mdbtools/gmdb2).
 
 ## License
 
@@ -95,6 +102,12 @@ apt install mdbtools
 brew install mdbtools
 ```
 
+### MacPorts
+
+```bash
+port install mdbtools
+```
+
 ### From source
 
 If you have cloned the Git repository, you will first need to generate the
diff --git a/src/extras/mdb-dump.c b/src/extras/mdb-dump.c
index bedbcfb..9bf2b56 100644
--- a/src/extras/mdb-dump.c
+++ b/src/extras/mdb-dump.c
@@ -33,6 +33,10 @@ int main(int argc, char **argv)
 	fprintf(stderr, "Usage: mdb-dump <filename> [<page number>]\n\n");
 	exit(1);
    }
+   fputs("mdb-hexdump is deprecated and will disappear in a future version of mdbtools.\n", stderr);
+   fputs("Please drop us a line if you have any use of it.\n", stderr);
+   fputs("See https://github.com/mdbtools/mdbtools/issues/197\n", stderr);
+   fputs("\n", stderr);
    if (argc>2) {
 	   if (!strncmp(argv[2],"0x",2)) {
 		   for (i=2;i<strlen(argv[2]);i++) {
@@ -89,4 +93,4 @@ int main(int argc, char **argv)
    exit(0);
 } 
 
-/** @}*/
\ No newline at end of file
+/** @}*/