github/RRG-Proxmark3
1
0
Fork 0
mirror of https://github.com/RfidResearchGroup/proxmark3.git synced 2025-08-21 05:43:48 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Merge pull request #990 from mwalker33/cliparser

Browse source 
Cliparser
This commit is contained in:
Iceman 2020-10-03 11:13:13 +02:00 • committed by GitHub
commit 8cea993287
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

7
client/deps/cliparser/argtable3.c
View file

@ -4270,10 +4270,15 @@ static void arg_cat_optionv(char *dest,
} }
if (datatype) { if (datatype) {
if (longopts) /* if (longopts)
arg_cat(&dest, "=", &ndest); arg_cat(&dest, "=", &ndest);
else if (shortopts) else if (shortopts)
arg_cat(&dest, " ", &ndest); arg_cat(&dest, " ", &ndest);
*/
if (longopts)
arg_cat(&dest, " ", &ndest);
else if (shortopts)
arg_cat(&dest, " ", &ndest);
if (optvalue) { if (optvalue) {
arg_cat(&dest, "[", &ndest); arg_cat(&dest, "[", &ndest);

33
doc/cliparser.md
View file

@ -28,11 +28,11 @@ It will also add the `-h --help` option automatic.
## design comments ## design comments
* where possiable all options should be lowercase. * where possible all options should be lowercase.
* extended options preceeded with -- should be short * extended options preceded with -- should be short
* options provided directly (without an option identifier) should be avoided. * options provided directly (without an option identifier) should be avoided.
* -vv for extra verbos should be avoided; use of debug level is prefered. * -vv for extra verbos should be avoided; use of debug level is preferred.
* with --options the equal is not needed (will work with and without) so dont use '=' * with --options the equal is not needed (will work with and without) so don't use '='
e.g. cmd --cn 12345 e.g. cmd --cn 12345
@ -62,10 +62,10 @@ In the command function, setup the context
CLIParserContext *ctx; CLIParserContext *ctx;
### define the text ### define the context
CLIParserInit (\<context\>, \<description\>, \<notes\n examples ... \>); CLIParserInit (\<context\>, \<description\>, \<notes\n examples ... \>);
use -> to seperate example and example comment and \\n to seperate examples. use -> to separate example and example comment and \\n to separate examples.
e.g. lf indala clone -r a0000000a0002021 -> this uses ..... e.g. lf indala clone -r a0000000a0002021 -> this uses .....
CLIParserInit(&ctx, "lf indala clone", CLIParserInit(&ctx, "lf indala clone",
@ -92,18 +92,25 @@ _All options has a parameter index, since `-h --help` is added automatic, it wi
Hence all options you add will start at index 1 and upwards._ Hence all options you add will start at index 1 and upwards._
**Notes:** **Notes:**
booleen : arg_lit0 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>) **bool option. true if supplied**
bool : arg_lit0 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)
**integer** **integer that is optional**
optional integer : arg_int0 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)\ optional integer : arg_int0 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)
**integer that is required**
required integer : arg_int1 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>) required integer : arg_int1 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)
**Strings 0 or 1** **String option that is optional and only one instance can be provided**
optional string : arg_str0("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)\ optional string : arg_str0("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)
**String option that is required and only one instance can be provided**
required string : arg_str1("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>) required string : arg_str1("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)
**Strings x to 250** **String option that is optional and can have up to 250 instances provided**
optional string : arg_strx0 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)\ optional string : arg_strx0 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)
**String option that is required/at least one instance and can have up to 250 instances**
required string : arg_strx1 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>) required string : arg_strx1 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)
**if an option does not have a short or long option, use NULL in its place** **if an option does not have a short or long option, use NULL in its place**