QPQ-AG/getopt
10
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix README format

Browse Source
This commit is contained in:
Juan Jose Comellas 2012-07-20 08:11:51 -03:00
parent 3f0ac07896
commit 08931e2394
1 changed files with 91 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

180
README.md
View File

@ -36,35 +36,35 @@ Usage
The *getopt* module provides four functions: The *getopt* module provides four functions:
``` erlang ``` erlang
parse([{Name, Short, Long, ArgSpec, Help}], Args :: string() | [string()]) -> parse([{Name, Short, Long, ArgSpec, Help}], Args :: string() | [string()]) ->
{ok, {Options, NonOptionArgs}} | {error, {Reason, Data}} {ok, {Options, NonOptionArgs}} | {error, {Reason, Data}}
usage([{Name, Short, Long, ArgSpec, Help}], ProgramName :: string()) -> ok usage([{Name, Short, Long, ArgSpec, Help}], ProgramName :: string()) -> ok
usage([{Name, Short, Long, ArgSpec, Help}], ProgramName :: string(), usage([{Name, Short, Long, ArgSpec, Help}], ProgramName :: string(),
CmdLineTail :: string()) -> ok CmdLineTail :: string()) -> ok
usage([{Name, Short, Long, ArgSpec, Help}], ProgramName :: string(), usage([{Name, Short, Long, ArgSpec, Help}], ProgramName :: string(),
CmdLineTail :: string(), OptionsTail :: [{string(), string}]) -> ok CmdLineTail :: string(), OptionsTail :: [{string(), string}]) -> ok
``` ```
The ``parse/2`` function receives a list of tuples with the command line option The ``parse/2`` function receives a list of tuples with the command line option
specifications. The type specification for the tuple is: specifications. The type specification for the tuple is:
``` erlang ``` erlang
-type arg_type() :: 'atom' | 'binary' | 'boolean' | 'float' | 'integer' | 'string'. -type arg_type() :: 'atom' | 'binary' | 'boolean' | 'float' | 'integer' | 'string'.
-type arg_value() :: atom() | binary() | boolean() | float() | integer() | string(). -type arg_value() :: atom() | binary() | boolean() | float() | integer() | string().
-type arg_spec() :: arg_type() | {arg_type(), arg_value()} | undefined. -type arg_spec() :: arg_type() | {arg_type(), arg_value()} | undefined.
-type option_spec() :: { -type option_spec() :: {
Name :: atom(), Name :: atom(),
Short :: char() | undefined, Short :: char() | undefined,
Long :: string() | undefined, Long :: string() | undefined,
ArgSpec :: arg_spec(), ArgSpec :: arg_spec(),
Help :: string() | undefined Help :: string() | undefined
}. }.
``` ```
The elements of the tuple are: The elements of the tuple are:
@ -78,7 +78,7 @@ The elements of the tuple are:
e.g. e.g.
``` erlang ``` erlang
{port, $p, "port", {integer, 5432}, "Database server port"} {port, $p, "port", {integer, 5432}, "Database server port"}
``` ```
The second parameter receives the list of arguments as passed to the ``main/1`` The second parameter receives the list of arguments as passed to the ``main/1``
@ -96,45 +96,45 @@ all the arguments that did not have corresponding options.
e.g. Given the following option specifications: e.g. Given the following option specifications:
``` erlang ``` erlang
OptSpecList = OptSpecList =
[ [
{host, $h, "host", {string, "localhost"}, "Database server host"}, {host, $h, "host", {string, "localhost"}, "Database server host"},
{port, $p, "port", integer, "Database server port"}, {port, $p, "port", integer, "Database server port"},
{dbname, undefined, "dbname", {string, "users"}, "Database name"}, {dbname, undefined, "dbname", {string, "users"}, "Database name"},
{xml, $x, undefined, undefined, "Output data in XML"}, {xml, $x, undefined, undefined, "Output data in XML"},
{verbose, $v, "verbose", integer, "Verbosity level"}, {verbose, $v, "verbose", integer, "Verbosity level"},
{file, undefined, undefined, string, "Output file"} {file, undefined, undefined, string, "Output file"}
]. ].
``` ```
And this command line: And this command line:
``` erlang ``` erlang
Args = "-h myhost --port=1000 -x myfile.txt -vvv dummy1 dummy2" Args = "-h myhost --port=1000 -x myfile.txt -vvv dummy1 dummy2"
``` ```
Which could also be passed in the format the ``main/1`` function receives the arguments in escripts: Which could also be passed in the format the ``main/1`` function receives the arguments in escripts:
``` erlang ``` erlang
Args = ["-h", "myhost", "--port=1000", "-x", "file.txt", "-vvv", "dummy1", "dummy2"]. Args = ["-h", "myhost", "--port=1000", "-x", "file.txt", "-vvv", "dummy1", "dummy2"].
``` ```
The call to ``getopt:parse/2``: The call to ``getopt:parse/2``:
``` erlang ``` erlang
getopt:parse(OptSpecList, Args). getopt:parse(OptSpecList, Args).
``` ```
Will return: Will return:
``` erlang ``` erlang
{ok,{[{host,"myhost"}, {ok,{[{host,"myhost"},
{port,1000}, {port,1000},
xml, xml,
{file,"file.txt"}, {file,"file.txt"},
{dbname,"users"}, {dbname,"users"},
{verbose,3}], {verbose,3}],
["dummy1","dummy2"]}} ["dummy1","dummy2"]}}
``` ```
The other functions exported by the ``getopt`` module (``usage/2``, ``usage/3`` The other functions exported by the ``getopt`` module (``usage/2``, ``usage/3``
@ -143,7 +143,7 @@ For example, given the above-mentioned option specifications, the call to
``getopt:usage/2``: ``getopt:usage/2``:
``` erlang ``` erlang
getopt:usage(OptSpecList, "ex1"). getopt:usage(OptSpecList, "ex1").
``` ```
Will show (on *standard_error*): Will show (on *standard_error*):
@ -159,7 +159,9 @@ Will show (on *standard_error*):
This call to ``getopt:usage/3`` will add a string after the usage command line: This call to ``getopt:usage/3`` will add a string after the usage command line:
``` erlang
getopt:usage(OptSpecList, "ex1", "[var=value ...] [command ...]"). getopt:usage(OptSpecList, "ex1", "[var=value ...] [command ...]").
```
Will show (on *standard_error*): Will show (on *standard_error*):
@ -176,9 +178,9 @@ Whereas this call to ``getopt:usage/3`` will also add some lines to the options
help text: help text:
``` erlang ``` erlang
getopt:usage(OptSpecList, "ex1", "[var=value ...] [command ...]", getopt:usage(OptSpecList, "ex1", "[var=value ...] [command ...]",
[{"var=value", "Variables that will affect the execution (e.g. debug=1)"}, [{"var=value", "Variables that will affect the execution (e.g. debug=1)"},
{"command", "Commands that will be executed (e.g. count)"}]). {"command", "Commands that will be executed (e.g. count)"}]).
``` ```
Will show (on *standard_error*): Will show (on *standard_error*):
@ -255,25 +257,25 @@ number that will be returned for that specific option.
e.g. Given an option specification list with the following format: e.g. Given an option specification list with the following format:
``` erlang ``` erlang
OptSpecList = OptSpecList =
[ [
{define, $D, "define", string, "Define a variable"}, {define, $D, "define", string, "Define a variable"},
{verbose, $v, "verbose", integer, "Verbosity level"} {verbose, $v, "verbose", integer, "Verbosity level"}
]. ].
``` ```
The following invocation: The following invocation:
``` erlang ``` erlang
getopt:parse(OptSpecList, "-DFOO -DVAR1=VAL1 -DBAR --verbose --verbose=3 -v -vvvv dummy"). getopt:parse(OptSpecList, "-DFOO -DVAR1=VAL1 -DBAR --verbose --verbose=3 -v -vvvv dummy").
``` ```
would return: would return:
``` erlang ``` erlang
{ok,{[{define,"FOO"}, {define,"VAR1=VAL1"}, {define,"BAR"}, {ok,{[{define,"FOO"}, {define,"VAR1=VAL1"}, {define,"BAR"},
{verbose,1}, {verbose,3}, {verbose,1}, {verbose,4}], {verbose,1}, {verbose,3}, {verbose,1}, {verbose,4}],
["dummy"]}} ["dummy"]}}
``` ```
@ -287,25 +289,25 @@ list passed to ``getopt:/parse2``.
For example, with the following option specifications: For example, with the following option specifications:
``` erlang ``` erlang
OptSpecList = OptSpecList =
[ [
{xml, $x, "xml", undefined, "Output data as XML"}, {xml, $x, "xml", undefined, "Output data as XML"},
{dbname, undefined, undefined, string, "Database name"}, {dbname, undefined, undefined, string, "Database name"},
{output_file, undefined, undefined, string, "File where the data will be saved to"} {output_file, undefined, undefined, string, "File where the data will be saved to"}
]. ].
``` ```
This call to ``getopt:parse/2``: This call to ``getopt:parse/2``:
``` erlang ``` erlang
getopt:parse(OptSpecList, "-x mydb file.out dummy dummy"). getopt:parse(OptSpecList, "-x mydb file.out dummy dummy").
``` ```
Will return: Will return:
``` erlang ``` erlang
{ok,{[xml,{dbname,"mydb"},{output_file,"file.out"}], {ok,{[xml,{dbname,"mydb"},{output_file,"file.out"}],
["dummy","dummy"]}} ["dummy","dummy"]}}
``` ```
@ -319,14 +321,14 @@ returned without being evaluated even if they follow the *getopt* syntax.
e.g. This invocation using the first option specification list in the document: e.g. This invocation using the first option specification list in the document:
``` erlang ``` erlang
getopt:parse(OptSpecList, "-h myhost -p 1000 -- --dbname mydb dummy"). getopt:parse(OptSpecList, "-h myhost -p 1000 -- --dbname mydb dummy").
``` ```
will return: will return:
``` erlang ``` erlang
{ok,{[{host,"myhost"}, {port,1000},{dbname,"users"}], {ok,{[{host,"myhost"}, {port,1000},{dbname,"users"}],
["--dbname","mydb","dummy"]}} ["--dbname","mydb","dummy"]}}
``` ```
Notice that the *dbname* option was assigned the value ``users`` instead of ``mydb``. Notice that the *dbname* option was assigned the value ``users`` instead of ``mydb``.
@ -342,14 +344,14 @@ The single ``-`` character is always considered as a non-option argument.
e.g. This invocation using the specification list from the previous example: e.g. This invocation using the specification list from the previous example:
``` erlang ``` erlang
getopt:parse(OptSpecList, "-h myhost -p 1000 - --dbname mydb dummy"). getopt:parse(OptSpecList, "-h myhost -p 1000 - --dbname mydb dummy").
``` ```
will return: will return:
``` erlang ``` erlang
{ok,{[{host,"myhost"}, {port,1000}, {dbname,"mydb"}], {ok,{[{host,"myhost"}, {port,1000}, {dbname,"mydb"}],
["-","dummy"]}} ["-","dummy"]}}
``` ```
@ -364,27 +366,27 @@ argument.
e.g. Given an option specification list with the following format: e.g. Given an option specification list with the following format:
``` erlang ``` erlang
OptSpecList = OptSpecList =
[ [
{define, $D, "define", string, "Define a variable"}, {define, $D, "define", string, "Define a variable"},
{user, $u, "user", string, "User name"} {user, $u, "user", string, "User name"}
]. ].
``` ```
The following invocation: The following invocation:
``` erlang ``` erlang
getopt:parse(OptSpecList, getopt:parse(OptSpecList,
"-D'FOO=VAR 123' --define \"VAR WITH SPACES\" -u\"my user name\""). "-D'FOO=VAR 123' --define \"VAR WITH SPACES\" -u\"my user name\"").
``` ```
would return: would return:
``` erlang ``` erlang
{ok,{[{define,"FOO=VAR 123"}, {ok,{[{define,"FOO=VAR 123"},
{define,"VAR WITH SPACES"}, {define,"VAR WITH SPACES"},
{user,"my user name"}], {user,"my user name"}],
[]}} []}}
``` ```
When parsing a command line with unclosed quotes the last argument When parsing a command line with unclosed quotes the last argument
@ -394,14 +396,14 @@ was entered.
e.g. The following invocation: e.g. The following invocation:
``` erlang ``` erlang
getopt:parse(OptSpecList, "--user ' my user ' \"argument with unclosed quotes"). getopt:parse(OptSpecList, "--user ' my user ' \"argument with unclosed quotes").
``` ```
would return: would return:
``` erlang ``` erlang
{ok,{[{user," my user "}], {ok,{[{user," my user "}],
["argument with unclosed quotes"]}} ["argument with unclosed quotes"]}}
``` ```
@ -412,9 +414,9 @@ Environment variable expansion
line that is passed as a single string. The formats that are supported line that is passed as a single string. The formats that are supported
for environment variable expansion are: for environment variable expansion are:
- $VAR (simple Unix/bash format) - $VAR (simple Unix/bash format)
- ${VAR} (full Unix/bash format) - ${VAR} (full Unix/bash format)
- %VAR% (Windows format) - %VAR% (Windows format)
If a variable is not present in the environment it will not be If a variable is not present in the environment it will not be
expanded. Variables can be expanded within double-quoted and free expanded. Variables can be expanded within double-quoted and free
@ -424,23 +426,23 @@ single-quoted arguments.
e.g. Given the following option specification list: e.g. Given the following option specification list:
``` erlang ``` erlang
OptSpecList = OptSpecList =
[ [
{path, $p, "path", string, "File path"} {path, $p, "path", string, "File path"}
]. ].
``` ```
The following invocation: The following invocation:
``` erlang ``` erlang
getopt:parse(OptSpecList, "--path ${PATH} $NONEXISTENT_DUMMY_VAR"). getopt:parse(OptSpecList, "--path ${PATH} $NONEXISTENT_DUMMY_VAR").
``` ```
would return (depending on the value of your PATH variable) something like: would return (depending on the value of your PATH variable) something like:
``` erlang ``` erlang
{ok,{[{path, "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"}], {ok,{[{path, "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"}],
["$NONEXISTENT_DUMMY_VAR"]}} ["$NONEXISTENT_DUMMY_VAR"]}}
``` ```
Currently, *getopt* does not perform wildcard expansion of file paths. Currently, *getopt* does not perform wildcard expansion of file paths.