summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libgetopt.tex
diff options
context:
space:
mode:
authorMartin v. Löwis <martin@v.loewis.de>2002-06-06 10:58:36 (GMT)
committerMartin v. Löwis <martin@v.loewis.de>2002-06-06 10:58:36 (GMT)
commit446a25fa3ca845315259f0f491e8e3a239ff2a65 (patch)
tree3d8cea0ecdb486c6006d369fc03b587b3a38d0c6 /Doc/lib/libgetopt.tex
parentcdbc131f0370f6e3712d4167ba987d5e6b7f2802 (diff)
downloadcpython-446a25fa3ca845315259f0f491e8e3a239ff2a65.zip
cpython-446a25fa3ca845315259f0f491e8e3a239ff2a65.tar.gz
cpython-446a25fa3ca845315259f0f491e8e3a239ff2a65.tar.bz2
Patch 473512: add GNU style scanning as gnu_getopt.
Diffstat (limited to 'Doc/lib/libgetopt.tex')
-rw-r--r--Doc/lib/libgetopt.tex12
1 files changed, 12 insertions, 0 deletions
diff --git a/Doc/lib/libgetopt.tex b/Doc/lib/libgetopt.tex
index 1348921..49e6e03 100644
--- a/Doc/lib/libgetopt.tex
+++ b/Doc/lib/libgetopt.tex
@@ -55,6 +55,18 @@ thus allowing multiple occurrences. Long and short options may be
mixed.
\end{funcdesc}
+\begin{funcdesc}{gnu_getopt}{args, options\optional{, long_options}}
+This function works like \function{getopt()}, except that GNU style
+scanning mode is used by default. This means that option and
+non-option arguments may be intermixed. The \function{getopt()}
+function stops processing options as soon as a non-option argument is
+encountered.
+
+If the first character of the option string is `+', or if the
+environment variable POSIXLY_CORRECT is set, then option processing
+stops as soon as a non-option argument is encountered.
+\end{funcdesc}
+
\begin{excdesc}{GetoptError}
This is raised when an unrecognized option is found in the argument
list or when an option requiring an argument is given none.