lsm/mdbtools
1
0
Fork 0
mirror of https://github.com/mdbtools/mdbtools.git synced 2025-04-05 08:12:58 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Man page and usage updates

Browse Source 
* MDBOPTS=no_memo is not used anywhere; mark deprecated and print a
  warning if enabled

* Mark MDBOPTS=use_index as experimental in the man pages

* MDBOPTS need to be colon separated

* Document new long forms of mdb-queries options
This commit is contained in:
Evan Miller 2021-01-19 16:27:36 -05:00
parent 0aa88f85d5
commit 8c91654426
16 changed files with 49 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/mdb-array.txt
View File

@ -13,9 +13,7 @@ DESCRIPTION
ENVIRONMENT
MDB_JET3_CHARSET Defines the charset of the input JET3 (access 97) file. Default is CP1252. See iconv(1).
MDBICONV Defines the output charset. Default is UTF-8. mdbtools must have been compiled with iconv.
MDBOPTS semi-column separated list of options:
* use_index
* no_memo
MDBOPTS Colon-separated list of options:
* debug_like
* debug_write
* debug_usage
@ -23,6 +21,8 @@ ENVIRONMENT
* debug_row
* debug_props
* debug_all is a shortcut for all debug_* options
* no_memo (deprecated; has no effect)
* use_index (experimental; requires libmswstr)
FUTURE DIRECTIONS
mdb-array is deprecated. Soon, it will no longer be distributed.

6
doc/mdb-count.txt
View File

@ -16,9 +16,7 @@ NOTES
ENVIRONMENT
MDB_JET3_CHARSET Defines the charset of the input JET3 (access 97) file. Default is CP1252. See iconv(1).
MDBICONV Defines the output charset. Default is UTF-8. mdbtools must have been compiled with iconv.
MDBOPTS semi-column separated list of options:
* use_index
* no_memo
MDBOPTS Colon-separated list of options:
* debug_like
* debug_write
* debug_usage
@ -26,6 +24,8 @@ ENVIRONMENT
* debug_row
* debug_props
* debug_all is a shortcut for all debug_* options
* no_memo (deprecated; has no effect)
* use_index (experimental; requires libmswstr)
HISTORY
mdb-count first appeared in MDB Tools 0.9.

6
doc/mdb-export.txt
View File

@ -36,9 +36,7 @@ NOTES
ENVIRONMENT
MDB_JET3_CHARSET Defines the charset of the input JET3 (access 97) file. Default is CP1252. See iconv(1).
MDBICONV Defines the output charset to use for the SQL file. Default is UTF-8. mdbtools must have been compiled with iconv.
MDBOPTS semi-column separated list of options:
* use_index
* no_memo
MDBOPTS Colon-separated list of options:
* debug_like
* debug_write
* debug_usage
@ -46,6 +44,8 @@ ENVIRONMENT
* debug_row
* debug_props
* debug_all is a shortcut for all debug_* options
* no_memo (deprecated; has no effect)
* use_index (experimental; requires libmswstr)
SEE ALSO
mdb-array(1) mdb-count(1) mdb-header(1) mdb-hexdump(1)

6
doc/mdb-header.txt
View File

@ -15,9 +15,7 @@ DESCRIPTION
ENVIRONMENT
MDB_JET3_CHARSET Defines the charset of the input JET3 (access 97) file. Default is CP1252. See iconv(1).
MDBICONV Defines the output charset. Default is UTF-8. mdbtools must have been compiled with iconv.
MDBOPTS semi-column separated list of options:
* use_index
* no_memo
MDBOPTS Colon-separated list of options:
* debug_like
* debug_write
* debug_usage
@ -25,6 +23,8 @@ ENVIRONMENT
* debug_row
* debug_props
* debug_all is a shortcut for all debug_* options
* no_memo (deprecated; has no effect)
* use_index (experimental; requires libmswstr)
EXIT STATUS
mdb-header exits with error code 1 if there was anunsupported type.

6
doc/mdb-hexdump.txt
View File

@ -12,9 +12,7 @@ DESCRIPTION
ENVIRONMENT
MDB_JET3_CHARSET Defines the charset of the input JET3 (access 97) file. Default is CP1252. See iconv(1).
MDBICONV Defines the output charset. Default is UTF-8. mdbtools must have been compiled with iconv.
MDBOPTS semi-column separated list of options:
* use_index
* no_memo
MDBOPTS Colon-separated list of options:
* debug_like
* debug_write
* debug_usage
@ -22,6 +20,8 @@ ENVIRONMENT
* debug_row
* debug_props
* debug_all is a shortcut for all debug_* options
* no_memo (deprecated; has no effect)
* use_index (experimental; requires libmswstr)
SEE ALSO
mdb-array(1) mdb-count(1) mdb-export(1) mdb-header(1)

6
doc/mdb-import.txt
View File

@ -19,9 +19,7 @@ NOTES
ENVIRONMENT
MDB_JET3_CHARSET Defines the charset of the JET3 (access 97) file. Default is CP1252. See iconv(1).
MDBICONV Defines the input charset to use for the SQL file. Default is UTF-8. mdbtools must have been compiled with iconv.
MDBOPTS semi-column separated list of options:
* use_index
* no_memo
MDBOPTS Colon-separated list of options:
* debug_like
* debug_write
* debug_usage
@ -29,6 +27,8 @@ ENVIRONMENT
* debug_row
* debug_props
* debug_all is a shortcut for all debug_* options
* no_memo (deprecated; has no effect)
* use_index (experimental; requires libmswstr)
SEE ALSO
mdb-array(1) mdb-count(1) mdb-export(1) mdb-header(1) mdb-hexdump(1)

6
doc/mdb-json.txt
View File

@ -20,9 +20,7 @@ NOTES
ENVIRONMENT
MDB_JET3_CHARSET Defines the charset of the input JET3 (access 97) file. Default is CP1252. See iconv(1).
MDBICONV Defines the output charset to use for the SQL file. Default is UTF-8. mdbtools must have been compiled with iconv.
MDBOPTS semi-column separated list of options:
* use_index
* no_memo
MDBOPTS Colon-separated list of options:
* debug_like
* debug_write
* debug_usage
@ -30,6 +28,8 @@ ENVIRONMENT
* debug_row
* debug_props
* debug_all is a shortcut for all debug_* options
* no_memo (deprecated; has no effect)
* use_index (experimental; requires libmswstr)
SEE ALSO
mdb-array(1) mdb-count(1) mdb-export(1) mdb-header(1) mdb-hexdump(1)

6
doc/mdb-parsecsv.txt
View File

@ -20,9 +20,7 @@ NOTES
ENVIRONMENT
MDB_JET3_CHARSET Defines the charset of the input JET3 (access 97) file. Default is CP1252. See iconv(1).
MDBICONV Defines the output charset to use for the SQL file. Default is UTF-8. mdbtools must have been compiled with iconv.
MDBOPTS semi-column separated list of options:
* use_index
* no_memo
MDBOPTS Colon-separated list of options:
* debug_like
* debug_write
* debug_usage
@ -30,6 +28,8 @@ ENVIRONMENT
* debug_row
* debug_props
* debug_all is a shortcut for all debug_* options
* no_memo (deprecated; has no effect)
* use_index (experimental; requires libmswstr)
FUTURE DIRECTIONS
mdb-parsecsv is deprecated. Soon, it will no longer be distributed.

6
doc/mdb-prop.txt
View File

@ -16,9 +16,7 @@ DESCRIPTION
ENVIRONMENT
MDB_JET3_CHARSET Defines the charset of the input JET3 (access 97) file. Default is CP1252. See iconv(1).
MDBICONV Defines the output charset. Default is UTF-8. mdbtools must have been compiled with iconv.
MDBOPTS semi-column separated list of options:
* use_index
* no_memo
MDBOPTS Colon-separated list of options:
* debug_like
* debug_write
* debug_usage
@ -26,6 +24,8 @@ ENVIRONMENT
* debug_row
* debug_props
* debug_all is a shortcut for all debug_* options
* no_memo (deprecated; has no effect)
* use_index (experimental; requires libmswstr)
SEE ALSO
mdb-array(1) mdb-count(1) mdb-export(1) mdb-header(1) mdb-hexdump(1)

12
doc/mdb-queries.txt
View File

@ -11,18 +11,16 @@ DESCRIPTION
It produces a list of queries in the database, and dump the SQL associated with a specific query.
OPTIONS
-L List queries in the database (default if no query name is passed)
-1 Use newline as the delimiter (used in conjunction with listing)
-d delim Specify delimiter to use
-L, --list List queries in the database (default if no query name is passed)
-1, --newline Use newline as the delimiter (used in conjunction with listing)
-d, --delimiter delim Specify delimiter to use
NOTES
ENVIRONMENT
MDB_JET3_CHARSET Defines the charset of the input JET3 (access 97) file. Default is CP1252. See iconv(1).
MDBICONV Defines the output charset. Default is UTF-8. mdbtools must have been compiled with iconv.
MDBOPTS semi-column separated list of options:
* use_index
* no_memo
MDBOPTS Colon-separated list of options:
* debug_like
* debug_write
* debug_usage
@ -30,6 +28,8 @@ ENVIRONMENT
* debug_row
* debug_props
* debug_all is a shortcut for all debug_* options
* no_memo (deprecated; has no effect)
* use_index (experimental; requires libmswstr)
HISTORY
mdb-queries first appeared in MDB Tools 0.9.

6
doc/mdb-schema.txt
View File

@ -33,9 +33,7 @@ OPTIONS
ENVIRONMENT
MDB_JET3_CHARSET Defines the charset of the input JET3 (access 97) file. Default is CP1252. See iconv(1).
MDBICONV Defines the output charset to use for the SQL file. Default is UTF-8. mdbtools must have been compiled with iconv.
MDBOPTS semi-column separated list of options:
* use_index
* no_memo
MDBOPTS Colon-separated list of options:
* debug_like
* debug_write
* debug_usage
@ -43,6 +41,8 @@ ENVIRONMENT
* debug_row
* debug_props
* debug_all is a shortcut for all debug_* options
* no_memo (deprecated; has no effect)
* use_index (experimental; requires libmswstr)
NOTES

6
doc/mdb-sql.txt
View File

@ -60,9 +60,7 @@ NOTES
ENVIRONMENT
MDB_JET3_CHARSET Defines the charset of the input JET3 (access 97) file. Default is CP1252. See iconv(1).
MDBICONV Defines the output charset. Default is UTF-8. mdbtools must have been compiled with iconv.
MDBOPTS semi-column separated list of options:
* use_index
* no_memo
MDBOPTS Colon-separated list of options:
* debug_like
* debug_write
* debug_usage
@ -70,6 +68,8 @@ ENVIRONMENT
* debug_row
* debug_props
* debug_all is a shortcut for all debug_* options
* no_memo (deprecated; has no effect)
* use_index (experimental; requires libmswstr)
HISTORY
mdb-sql first appeared in MDB Tools 0.3.

6
doc/mdb-tables.txt
View File

@ -22,9 +22,7 @@ NOTES
ENVIRONMENT
MDB_JET3_CHARSET Defines the charset of the input JET3 (access 97) file. Default is CP1252. See iconv(1).
MDBICONV Defines the output charset. Default is UTF-8. mdbtools must have been compiled with iconv.
MDBOPTS semi-column separated list of options:
* use_index
* no_memo
MDBOPTS Colon-separated list of options:
* debug_like
* debug_write
* debug_usage
@ -32,6 +30,8 @@ ENVIRONMENT
* debug_row
* debug_props
* debug_all is a shortcut for all debug_* options
* no_memo (deprecated; has no effect)
* use_index (experimental; requires libmswstr)
HISTORY
mdb-tables first appeared in MDB Tools 0.3.

6
doc/mdb-ver.txt
View File

@ -21,9 +21,7 @@ NOTES
ENVIRONMENT
MDB_JET3_CHARSET Defines the charset of the input JET3 (access 97) file. Default is CP1252. See iconv(1).
MDBICONV Defines the output charset. Default is UTF-8. mdbtools must have been compiled with iconv.
MDBOPTS semi-column separated list of options:
* use_index
* no_memo
MDBOPTS Colon-separated list of options:
* debug_like
* debug_write
* debug_usage
@ -31,6 +29,8 @@ ENVIRONMENT
* debug_row
* debug_props
* debug_all is a shortcut for all debug_* options
* no_memo (deprecated; has no effect)
* use_index (experimental; requires libmswstr)
HISTORY
mdb-ver first appeared in MDB Tools 0.4.

4
src/libmdb/options.c
View File

@ -62,7 +62,9 @@ load_options()
fprintf(stderr, "The 'use_index' argument was supplied to MDBOPTS environment variable. However, this feature requires the libmswstr library, which was not found when libmdb was compiled. As a result, the 'use_index' argument will be ignored.\n\nTo enable indexes, you will need to download libmswstr from https://github.com/leecher1337/libmswstr and then recompile libmdb. Note that the 'use_index' feature is largely untested, and may have unexpected results.\n\nTo suppress this warning, run the program again after removing the 'use_index' argument from the MDBOPTS environment variable.\n");
#endif
}
if (!strcmp(opt, "no_memo")) opts |= MDB_NO_MEMO;
if (!strcmp(opt, "no_memo")) {
fprintf(stderr, "The 'no_memo' argument was supplied to MDBOPTS environment variable. This argument is deprecated, and has no effect.\n\nTo suppress this warning, run the program again after removing the 'no_memo' argument from the MDBOPTS environment variable.\n");
}
if (!strcmp(opt, "debug_like")) opts |= MDB_DEBUG_LIKE;
if (!strcmp(opt, "debug_write")) opts |= MDB_DEBUG_WRITE;
if (!strcmp(opt, "debug_usage")) opts |= MDB_DEBUG_USAGE;

2
src/util/mdb-queries.c
View File

@ -75,7 +75,7 @@ int main (int argc, char **argv) {
GOptionEntry entries[] = {
{"list", 'L', 0, G_OPTION_ARG_NONE, &list_only, "List queries in the database (default if no query name is passed)", NULL},
{"newline", '1', 0, G_OPTION_ARG_NONE, &line_break, "Use newline as the delimiter (used in conjunction with listing)", NULL},
{"delimiter", 'd', 0, G_OPTION_ARG_STRING, &delimiter, "Specify delimiter to use", "delimiter"},
{"delimiter", 'd', 0, G_OPTION_ARG_STRING, &delimiter, "Specify delimiter to use", "delim"},
{NULL}
};
opt_context = g_option_context_new("<file> <query name> - list or export queries from an Access database");