cpython-lru_cache-weakref: Misc/python.man annotate

annotate Misc/python.man @ 27998:e27f58a50737 legacy-trunk

SF bug #690377: Dud footnote reference in distutils docs

author	Raymond Hettinger <python@rcn.com>
date	Fri, 21 Feb 2003 02:47:09 +0000
parents	ba3038a27c1e
children	a9d778bd9653

rev	line source
19740 8e6e248dfdd8 Change the date field to use $Date$ so it won't be outrageously out of Guido van Rossum <guido@python.org> parents: 19739 diff changeset	1 .TH PYTHON "1" "$Date$"
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	2 .SH NAME
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	3 python \- an interpreted, interactive, object-oriented programming language
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	4 .SH SYNOPSIS
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	5 .B python
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	6 [
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	7 .B \-d
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	8 ]
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	9 [
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	10 .B \-E
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	11 ]
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	12 [
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	13 .B \-h
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	14 ]
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	15 [
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	16 .B \-i
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	17 ]
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	18 [
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	19 .B \-O
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	20 ]
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	21 .br
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	22 [
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	23 .B -Q
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	24 .I argument
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	25 ]
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	26 [
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	27 .B \-S
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	28 ]
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	29 [
7965 e8d0b87c8d6b Document -t flag. Guido van Rossum <guido@python.org> parents: 6273 diff changeset	30 .B \-t
e8d0b87c8d6b Document -t flag. Guido van Rossum <guido@python.org> parents: 6273 diff changeset	31 ]
e8d0b87c8d6b Document -t flag. Guido van Rossum <guido@python.org> parents: 6273 diff changeset	32 [
1601 57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint) Guido van Rossum <guido@python.org> parents: 1559 diff changeset	33 .B \-u
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	34 ]
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	35 [
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	36 .B \-U
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	37 ]
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	38 .br
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	39 [
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	40 .B \-v
14602 24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496 Barry Warsaw <barry@python.org> parents: 14360 diff changeset	41 ]
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496 Barry Warsaw <barry@python.org> parents: 14360 diff changeset	42 [
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496 Barry Warsaw <barry@python.org> parents: 14360 diff changeset	43 .B \-V
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496 Barry Warsaw <barry@python.org> parents: 14360 diff changeset	44 ]
15612 e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	45 [
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	46 .B \-W
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	47 .I argument
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	48 ]
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	49 [
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	50 .B \-x
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	51 ]
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	52 .br
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	53 [
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	54 .B \-c
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	55 .I command
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	56 \|
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	57 .I script
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	58 \|
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	59 \-
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	60 ]
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	61 [
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	62 .I arguments
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	63 ]
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	64 .SH DESCRIPTION
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	65 Python is an interpreted, interactive, object-oriented programming
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	66 language that combines remarkable power with very clear syntax.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	67 For an introduction to programming in Python you are referred to the
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	68 Python Tutorial.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	69 The Python Library Reference documents built-in and standard types,
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	70 constants, functions and modules.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	71 Finally, the Python Reference Manual describes the syntax and
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	72 semantics of the core language in (perhaps too) much detail.
14360 d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	73 (These documents may be located via the
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	74 .B "INTERNET RESOURCES"
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	75 below; they may be installed on your system as well.)
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	76 .PP
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	77 Python's basic power can be extended with your own modules written in
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	78 C or C++.
3875 2838db83d0ed Got rid of all references to stdwin. Guido van Rossum <guido@python.org> parents: 2068 diff changeset	79 On most systems such modules may be dynamically loaded.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	80 Python is also adaptable as an extension language for existing
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	81 applications.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	82 See the internal documentation for hints.
17315 6be8bb4808e1 Mention pydoc in the man page Andrew M. Kuchling <amk@amk.ca> parents: 15612 diff changeset	83 .PP
6be8bb4808e1 Mention pydoc in the man page Andrew M. Kuchling <amk@amk.ca> parents: 15612 diff changeset	84 Documentation for installed Python modules and packages can be
6be8bb4808e1 Mention pydoc in the man page Andrew M. Kuchling <amk@amk.ca> parents: 15612 diff changeset	85 viewed by running the
6be8bb4808e1 Mention pydoc in the man page Andrew M. Kuchling <amk@amk.ca> parents: 15612 diff changeset	86 .B pydoc
6be8bb4808e1 Mention pydoc in the man page Andrew M. Kuchling <amk@amk.ca> parents: 15612 diff changeset	87 program.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	88 .SH COMMAND LINE OPTIONS
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	89 .TP
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	90 .BI "\-c " command
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	91 Specify the command to execute (see next section).
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	92 This terminates the option list (following options are passed as
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	93 arguments to the command).
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	94 .TP
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	95 .B \-d
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	96 Turn on parser debugging output (for wizards only, depending on
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	97 compilation options).
1559 df0fb788c0c1 Fix weird messed up paragraphs Guido van Rossum <guido@python.org> parents: 1529 diff changeset	98 .TP
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	99 .B \-E
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	100 Ignore environment variables like PYTHONPATH and PYTHONHOME that modify
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	101 the behavior of the interpreter.
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	102 .TP
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	103 .B \-h
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	104 Prints the usage for the interpreter executable and exits.
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	105 .TP
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	106 .B \-i
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	107 When a script is passed as first argument or the \fB\-c\fP option is
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	108 used, enter interactive mode after executing the script or the
1559 df0fb788c0c1 Fix weird messed up paragraphs Guido van Rossum <guido@python.org> parents: 1529 diff changeset	109 command. It does not read the $PYTHONSTARTUP file. This can be
df0fb788c0c1 Fix weird messed up paragraphs Guido van Rossum <guido@python.org> parents: 1529 diff changeset	110 useful to inspect global variables or a stack trace when a script
df0fb788c0c1 Fix weird messed up paragraphs Guido van Rossum <guido@python.org> parents: 1529 diff changeset	111 raises an exception.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	112 .TP
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	113 .B \-O
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	114 Turn on basic optimizations. This changes the filename extension for
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	115 compiled (bytecode) files from
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	116 .I .pyc
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	117 to \fI.pyo\fP. Given twice, causes docstrings to be discarded.
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	118 .TP
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	119 .BI "\-Q " argument
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	120 Division control; see PEP 238. The argument must be one of "old" (the
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	121 default, int/int and long/long return an int or long), "new" (new
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	122 division semantics, i.e. int/int and long/long returns a float),
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	123 "warn" (old division semantics with a warning for int/int and
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	124 long/long), or "warnall" (old division semantics with a warning for
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	125 all use of the division operator). For a use of "warnall", see the
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	126 Tools/scripts/fixdiv.py script.
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	127 .TP
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	128 .B \-S
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	129 Disable the import of the module
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	130 .I site
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	131 and the site-dependent manipulations of
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	132 .I sys.path
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	133 that it entails.
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	134 .TP
7965 e8d0b87c8d6b Document -t flag. Guido van Rossum <guido@python.org> parents: 6273 diff changeset	135 .B \-t
e8d0b87c8d6b Document -t flag. Guido van Rossum <guido@python.org> parents: 6273 diff changeset	136 Issue a warning when a source file mixes tabs and spaces for
e8d0b87c8d6b Document -t flag. Guido van Rossum <guido@python.org> parents: 6273 diff changeset	137 indentation in a way that makes it depend on the worth of a tab
e8d0b87c8d6b Document -t flag. Guido van Rossum <guido@python.org> parents: 6273 diff changeset	138 expressed in spaces. Issue an error when the option is given twice.
e8d0b87c8d6b Document -t flag. Guido van Rossum <guido@python.org> parents: 6273 diff changeset	139 .TP
1601 57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint) Guido van Rossum <guido@python.org> parents: 1559 diff changeset	140 .B \-u
24696 ba3038a27c1e Document that -u puts stdin, stdout, and stderr in binary mode. Sjoerd Mullender <sjoerd@acm.org> parents: 24401 diff changeset	141 Force stdin, stdout and stderr to be totally unbuffered. On systems
ba3038a27c1e Document that -u puts stdin, stdout, and stderr in binary mode. Sjoerd Mullender <sjoerd@acm.org> parents: 24401 diff changeset	142 where it matters, also put stdin, stdout and stderr in binary mode.
ba3038a27c1e Document that -u puts stdin, stdout, and stderr in binary mode. Sjoerd Mullender <sjoerd@acm.org> parents: 24401 diff changeset	143 Note that there is internal buffering in xreadlines(), readlines() and
ba3038a27c1e Document that -u puts stdin, stdout, and stderr in binary mode. Sjoerd Mullender <sjoerd@acm.org> parents: 24401 diff changeset	144 file-object iterators ("for line in sys.stdin") which is not
ba3038a27c1e Document that -u puts stdin, stdout, and stderr in binary mode. Sjoerd Mullender <sjoerd@acm.org> parents: 24401 diff changeset	145 influenced by this option. To work around this, you will want to use
ba3038a27c1e Document that -u puts stdin, stdout, and stderr in binary mode. Sjoerd Mullender <sjoerd@acm.org> parents: 24401 diff changeset	146 "sys.stdin.readline()" inside a "while 1:" loop.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	147 .TP
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	148 .B \-v
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	149 Print a message each time a module is initialized, showing the place
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	150 (filename or built-in module) from which it is loaded. When given
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	151 twice, print a message for each file that is checked for when
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	152 searching for a module. Also provides information on module cleanup
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	153 at exit.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	154 .TP
14602 24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496 Barry Warsaw <barry@python.org> parents: 14360 diff changeset	155 .B \-V
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496 Barry Warsaw <barry@python.org> parents: 14360 diff changeset	156 Prints the Python version number of the executable and exits.
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496 Barry Warsaw <barry@python.org> parents: 14360 diff changeset	157 .TP
15612 e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	158 .BI "\-W " argument
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	159 Warning control. Python sometimes prints warning message to
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	160 .IR sys.stderr .
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	161 A typical warning message has the following form:
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	162 .IB file ":" line ": " category ": " message.
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	163 By default, each warning is printed once for each source line where it
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	164 occurs. This option controls how often warnings are printed.
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	165 Multiple
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	166 .B \-W
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	167 options may be given; when a warning matches more than one
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	168 option, the action for the last matching option is performed.
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	169 Invalid
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	170 .B \-W
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	171 options are ignored (a warning message is printed about invalid
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	172 options when the first warning is issued). Warnings can also be
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	173 controlled from within a Python program using the
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	174 .I warnings
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	175 module.
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	176
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	177 The simplest form of
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	178 .I argument
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	179 is one of the following
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	180 .I action
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	181 strings (or a unique abbreviation):
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	182 .B ignore
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	183 to ignore all warnings;
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	184 .B default
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	185 to explicitly request the default behavior (printing each warning once
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	186 per source line);
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	187 .B all
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	188 to print a warning each time it occurs (this may generate many
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	189 messages if a warning is triggered repeatedly for the same source
18844 045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	190 line, such as inside a loop);
15612 e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	191 .B module
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	192 to print each warning only only the first time it occurs in each
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	193 module;
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	194 .B once
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	195 to print each warning only the first time it occurs in the program; or
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	196 .B error
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	197 to raise an exception instead of printing a warning message.
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	198
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	199 The full form of
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	200 .I argument
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	201 is
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	202 .IB action : message : category : module : line.
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	203 Here,
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	204 .I action
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	205 is as explained above but only applies to messages that match the
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	206 remaining fields. Empty fields match all values; trailing empty
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	207 fields may be omitted. The
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	208 .I message
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	209 field matches the start of the warning message printed; this match is
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	210 case-insensitive. The
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	211 .I category
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	212 field matches the warning category. This must be a class name; the
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	213 match test whether the actual warning category of the message is a
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	214 subclass of the specified warning category. The full class name must
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	215 be given. The
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	216 .I module
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	217 field matches the (fully-qualified) module name; this match is
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	218 case-sensitive. The
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	219 .I line
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	220 field matches the line number, where zero matches all line numbers and
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	221 is thus equivalent to an omitted line number.
e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	222 .TP
19739 8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	223 .B \-x
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	224 Skip the first line of the source. This is intended for a DOS
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	225 specific hack only. Warning: the line numbers in error messages will
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical Guido van Rossum <guido@python.org> parents: 18844 diff changeset	226 be off by one!
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	227 .SH INTERPRETER INTERFACE
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	228 The interpreter interface resembles that of the UNIX shell: when
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	229 called with standard input connected to a tty device, it prompts for
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	230 commands and executes them until an EOF is read; when called with a
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	231 file name argument or with a file as standard input, it reads and
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	232 executes a
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	233 .I script
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	234 from that file;
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	235 when called with
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	236 .B \-c
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	237 .I command,
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	238 it executes the Python statement(s) given as
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	239 .I command.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	240 Here
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	241 .I command
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	242 may contain multiple statements separated by newlines.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	243 Leading whitespace is significant in Python statements!
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	244 In non-interactive mode, the entire input is parsed befored it is
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	245 executed.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	246 .PP
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	247 If available, the script name and additional arguments thereafter are
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	248 passed to the script in the Python variable
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	249 .I sys.argv ,
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	250 which is a list of strings (you must first
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	251 .I import sys
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	252 to be able to access it).
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	253 If no script name is given,
14360 d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	254 .I sys.argv[0]
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	255 is an empty string; if
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	256 .B \-c
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	257 is used,
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	258 .I sys.argv[0]
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	259 contains the string
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	260 .I '-c'.
3875 2838db83d0ed Got rid of all references to stdwin. Guido van Rossum <guido@python.org> parents: 2068 diff changeset	261 Note that options interpreted by the Python interpreter itself
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	262 are not placed in
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	263 .I sys.argv.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	264 .PP
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	265 In interactive mode, the primary prompt is `>>>'; the second prompt
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	266 (which appears when a command is not complete) is `...'.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	267 The prompts can be changed by assignment to
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	268 .I sys.ps1
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	269 or
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	270 .I sys.ps2.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	271 The interpreter quits when it reads an EOF at a prompt.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	272 When an unhandled exception occurs, a stack trace is printed and
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	273 control returns to the primary prompt; in non-interactive mode, the
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	274 interpreter exits after printing the stack trace.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	275 The interrupt signal raises the
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	276 .I Keyboard\%Interrupt
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	277 exception; other UNIX signals are not caught (except that SIGPIPE is
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	278 sometimes ignored, in favor of the
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	279 .I IOError
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	280 exception). Error messages are written to stderr.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	281 .SH FILES AND DIRECTORIES
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	282 These are subject to difference depending on local installation
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	283 conventions; ${prefix} and ${exec_prefix} are installation-dependent
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	284 and should be interpreted as for GNU software; they may be the same.
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	285 The default for both is \fI/usr/local\fP.
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	286 .IP \fI${exec_prefix}/bin/python\fP
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	287 Recommended location of the interpreter.
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	288 .PP
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	289 .I ${prefix}/lib/python<version>
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	290 .br
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	291 .I ${exec_prefix}/lib/python<version>
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	292 .RS
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	293 Recommended locations of the directories containing the standard
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	294 modules.
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	295 .RE
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	296 .PP
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	297 .I ${prefix}/include/python<version>
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	298 .br
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	299 .I ${exec_prefix}/include/python<version>
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	300 .RS
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	301 Recommended locations of the directories containing the include files
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	302 needed for developing Python extensions and embedding the
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	303 interpreter.
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	304 .RE
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	305 .IP \fI~/.pythonrc.py\fP
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	306 User-specific initialization file loaded by the \fIuser\fP module;
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	307 not used by default or by most applications.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	308 .SH ENVIRONMENT VARIABLES
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	309 .IP PYTHONHOME
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	310 Change the location of the standard Python libraries. By default, the
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	311 libraries are searched in ${prefix}/lib/python<version> and
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	312 ${exec_prefix}/lib/python<version>, where ${prefix} and ${exec_prefix}
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	313 are installation-dependent directories, both defaulting to
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	314 \fI/usr/local\fP. When $PYTHONHOME is set to a single directory, its value
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	315 replaces both ${prefix} and ${exec_prefix}. To specify different values
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	316 for these, set $PYTHONHOME to ${prefix}:${exec_prefix}.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	317 .IP PYTHONPATH
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	318 Augments the default search path for module files.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	319 The format is the same as the shell's $PATH: one or more directory
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	320 pathnames separated by colons.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	321 Non-existant directories are silently ignored.
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	322 The default search path is installation dependent, but generally
11214 96501cc3a663 Various updates, mostly to add information to the SEE ALSO and Fred Drake <fdrake@acm.org> parents: 7968 diff changeset	323 begins with ${prefix}/lib/python<version> (see PYTHONHOME above).
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	324 The default search path is always appended to $PYTHONPATH.
3875 2838db83d0ed Got rid of all references to stdwin. Guido van Rossum <guido@python.org> parents: 2068 diff changeset	325 If a script argument is given, the directory containing the script is
2838db83d0ed Got rid of all references to stdwin. Guido van Rossum <guido@python.org> parents: 2068 diff changeset	326 inserted in the path in front of $PYTHONPATH.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	327 The search path can be manipulated from within a Python program as the
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	328 variable
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	329 .I sys.path .
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	330 .IP PYTHONSTARTUP
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	331 If this is the name of a readable file, the Python commands in that
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	332 file are executed before the first prompt is displayed in interactive
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	333 mode.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	334 The file is executed in the same name space where interactive commands
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	335 are executed so that objects defined or imported in it can be used
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	336 without qualification in the interactive session.
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	337 You can also change the prompts
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	338 .I sys.ps1
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	339 and
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	340 .I sys.ps2
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	341 in this file.
18844 045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	342 .IP PYTHONY2K
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	343 Set this to a non-empty string to cause the \fItime\fP module to
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	344 require dates specified as strings to include 4-digit years, otherwise
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	345 2-digit years are converted based on rules described in the \fItime\fP
23406 e0ed68adba33 Fix typo Andrew M. Kuchling <amk@amk.ca> parents: 20401 diff changeset	346 module documentation.
20401 b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	347 .IP PYTHONOPTIMIZE
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	348 If this is set to a non-empty string it is equivalent to specifying
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	349 the \fB\-O\fP option. If set to an integer, it is equivalent to
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	350 specifying \fB\-O\fP multiple times.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	351 .IP PYTHONDEBUG
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	352 If this is set to a non-empty string it is equivalent to specifying
20401 b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	353 the \fB\-d\fP option. If set to an integer, it is equivalent to
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	354 specifying \fB\-d\fP multiple times.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	355 .IP PYTHONINSPECT
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	356 If this is set to a non-empty string it is equivalent to specifying
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	357 the \fB\-i\fP option.
1601 57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint) Guido van Rossum <guido@python.org> parents: 1559 diff changeset	358 .IP PYTHONUNBUFFERED
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	359 If this is set to a non-empty string it is equivalent to specifying
1601 57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint) Guido van Rossum <guido@python.org> parents: 1559 diff changeset	360 the \fB\-u\fP option.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	361 .IP PYTHONVERBOSE
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	362 If this is set to a non-empty string it is equivalent to specifying
20401 b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	363 the \fB\-v\fP option. If set to an integer, it is equivalent to
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson. Guido van Rossum <guido@python.org> parents: 19740 diff changeset	364 specifying \fB\-v\fP multiple times.
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	365 .SH AUTHOR
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	366 .nf
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	367 Guido van Rossum
c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	368 .PP
15612 e57f93ae4fe9 Document the -W option as best as I can. Guido van Rossum <guido@python.org> parents: 14602 diff changeset	369 E-mail: guido@python.org
1529 c9b3f77e18ba Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	370 .fi
6273 4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	371 .PP
4333775b55fd Brought up to date with new options and env vars. Guido van Rossum <guido@python.org> parents: 5876 diff changeset	372 And a cast of thousands.
3875 2838db83d0ed Got rid of all references to stdwin. Guido van Rossum <guido@python.org> parents: 2068 diff changeset	373 .SH INTERNET RESOURCES
18844 045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	374 Main website: http://www.python.org/
14360 d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	375 .br
18844 045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	376 Documentation: http://www.python.org/doc/
3875 2838db83d0ed Got rid of all references to stdwin. Guido van Rossum <guido@python.org> parents: 2068 diff changeset	377 .br
18844 045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	378 Community website: http://starship.python.net/
14360 d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	379 .br
18844 045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	380 Developer resources: http://sourceforge.net/project/python/
14360 d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	381 .br
18844 045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	382 FTP: ftp://ftp.python.org/pub/python/
14360 d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	383 .br
18844 045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	384 Module repository: http://www.vex.net/parnassus/
3875 2838db83d0ed Got rid of all references to stdwin. Guido van Rossum <guido@python.org> parents: 2068 diff changeset	385 .br
18844 045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this Fred Drake <fdrake@acm.org> parents: 18808 diff changeset	386 Newsgroups: comp.lang.python, comp.lang.python.announce
14360 d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	387 .SH LICENSING
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	388 Python is distributed under an Open Source license. See the file
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	389 "LICENSE" in the Python source distribution for information on terms &
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	390 conditions for accessing and otherwise using Python and for a
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation Guido van Rossum <guido@python.org> parents: 13255 diff changeset	391 DISCLAIMER OF ALL WARRANTIES.

Mercurial > cpython-lru_cache-weakref

annotate Misc/python.man @ 27998:e27f58a50737 legacy-trunk