summaryrefslogtreecommitdiffhomepage
path: root/docs/copt_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-12-31 12:31:31 +0100
committerTyge Løvset <[email protected]>2020-12-31 12:31:31 +0100
commitde498e1649d1f57d4d79f81f47157ee3513ce122 (patch)
tree481e09de4041a76c68fb38940399cbc1b728dcbe /docs/copt_api.md
parenteb77562a0d74062cd046bdca45d937360c96697c (diff)
downloadSTC-modified-de498e1649d1f57d4d79f81f47157ee3513ce122.tar.gz
STC-modified-de498e1649d1f57d4d79f81f47157ee3513ce122.zip
Added links to documentation of similar C++ classes.
Diffstat (limited to 'docs/copt_api.md')
-rw-r--r--docs/copt_api.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/copt_api.md b/docs/copt_api.md
index 2ced17ce..1973cec5 100644
--- a/docs/copt_api.md
+++ b/docs/copt_api.md
@@ -1,6 +1,7 @@
# Module [copt](../stc/copt.h): Command line argument parsing
This describes the API of string type *copt_get()* function for command line argument parsing.
+See [getopt_long](https://www.freebsd.org/cgi/man.cgi?getopt_long(3)) for a similar freebsd function.
## Types
@@ -16,7 +17,7 @@ typedef struct {
const char *arg; /* equivalent to optarg */
const char *faulty; /* points to the faulty option, if any */
int longindex; /* index of long option; or -1 if short */
- ...
+ ...
} copt_t;
typedef struct {
@@ -45,7 +46,7 @@ int copt_get(copt_t *opt, int argc, char *argv[],
int main(int argc, char *argv[]) {
static copt_long_t long_options[] = {
{"verbose", copt_no_argument, 'V'},
- {"help", copt_no_argument, 'H'},
+ {"help", copt_no_argument, 'H'},
{"add", copt_no_argument, 'a'},
{"append", copt_no_argument, 'b'},
{"delete", copt_required_argument, 'd'},