New functions yaz_file_glob2, yaz_xml_include_glob

[yaz-moved-to-github.git] / include / yaz / options.h

diff --git a/include/yaz/options.h b/include/yaz/options.h
index 2202fd6..5cd9510 100644 (file)
--- a/include/yaz/options.h
+++ b/include/yaz/options.h
@@ -1,5 +1,5 @@
 /* This file is part of the YAZ toolkit.
- * Copyright (C) 1995-2008 Index Data.
+ * Copyright (C) 1995-2013 Index Data.
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -31,7 +31,7 @@
  */
 
 #ifndef YAZ_OPTIONS_H
-#define TAZ_OPTIONS_H
+#define YAZ_OPTIONS_H
 #include <yaz/yconfig.h>
 
 YAZ_BEGIN_CDECL
@@ -46,17 +46,20 @@ YAZ_BEGIN_CDECL
     \retval -1 unknown option (error). arg is name of unknown option
     \retval -2 no more options (end of options)
     \retval c option char
-    
+
     This function is called repeatedly for each option. Both single
     char options (-x) as well as GNU long options are supported (--long).
-    The description is a sequence specs where each spec is if the form: 
+    The description is a sequence specs where each spec is if the form:
     [a-zA-Z0-9]({[a-zA-Z0-9]*})+:? . For example: h{help}f{filename}{fname}:
 
     The first char is what is returned when met (single char option char).
     The second is zero ore more long option values (synonum for single char)
     If colon is appended, it means the option takes an argument.
+    If argv includes empty long option (--) that means "end of options" :
+    all argv data following that is considered non-options .. (0 returned
+    for each).
 */
-YAZ_EXPORT int options (const char *desc, char **argv, int argc, char **arg);
+YAZ_EXPORT int options(const char *desc, char **argv, int argc, char **arg);
 
 #define YAZ_OPTIONS_ERROR (-1)
 #define YAZ_OPTIONS_EOF (-2)
@@ -64,10 +67,11 @@ YAZ_EXPORT int options (const char *desc, char **argv, int argc, char **arg);
 YAZ_END_CDECL
 
 #endif
-        
+
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab